Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/norman-thomas/homebridge-particle-io
Homebridge plugin for Particle Devices
https://github.com/norman-thomas/homebridge-particle-io
homebridge homebridge-plugin iot nodejs particle-io particle-photon
Last synced: 3 days ago
JSON representation
Homebridge plugin for Particle Devices
- Host: GitHub
- URL: https://github.com/norman-thomas/homebridge-particle-io
- Owner: norman-thomas
- Created: 2017-01-14T09:16:25.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-02-06T03:42:04.000Z (9 months ago)
- Last Synced: 2024-04-14T13:13:21.377Z (7 months ago)
- Topics: homebridge, homebridge-plugin, iot, nodejs, particle-io, particle-photon
- Language: JavaScript
- Size: 481 KB
- Stars: 24
- Watchers: 7
- Forks: 19
- Open Issues: 33
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[![npm][npm-image]][npm-url] [](https://snyk.io/test/github/norman-thomas/homebridge-particle-io)
[](https://www.codefactor.io/repository/github/norman-thomas/homebridge-particle-io) [](https://travis-ci.org/norman-thomas/homebridge-particle-io) [](https://coveralls.io/github/norman-thomas/homebridge-particle-io)
[npm-image]: https://img.shields.io/npm/v/homebridge-particle-io.svg?style=flat
[npm-url]: https://npmjs.org/package/homebridge-particle-io
**Particle.io device plugin for Homebridge**
-------------------------------------
As you all know in the new version of [Homebridge](https://github.com/nfarina/homebridge), the plugin architecture is changed. In new Homebridge, plugins are published through NPM with name starts with *homebridge-*. Users can install the plugin using NPM.
You can install it using NPM like all other modules, using:
`npm install -g homebridge-particle-io`.
In this version, I have made some changes from the older version. Mainly the plugin is now a Homebridge Platform. Also in this version accessories are defined in `config.json` file. The plugin loads the accessories from the `config.json` file and create accessory dynamically. A sample configuration file is like:
```JSON
{
"bridge": {
"name": "Homebridge",
"username": "CC:22:3D:E3:CE:39",
"port": 51826,
"pin": "031-45-154"
},
"description": "This is an example configuration file with one Particle platform and 3 accessories, two lights and a temperature sensor. You should replace the access token and device id placeholder with your access token and device id",
"platforms": [
{
"platform": "ParticleIO",
"name": "Particle Devices",
"access_token": "<>",
"cloud_url": "https://api.particle.io/v1/devices/",
"devices": [
{
"name": "Bedroom Light",
"type": "lightbulb",
"device_id": "<>",
"function_name": "onoff",
"args": "0={STATE}"
},
{
"name": "Kitchen Light",
"type": "lightbulb",
"device_id": "<>",
"function_name": "onoff",
"args": "1={STATE}"
},
{
"name": "Kitchen Temperature",
"type": "temperaturesensor",
"device_id": "<>",
"event_name": "tvalue",
"split_character": ":"
}
]
}
]
}
```
As you can see from the above example this `config.json` file defines 3 accessories. 2 Lights and one Temperature Sensor. The **access_token** defines the Particle Access Token and **cloud_url** defines the base Particle API url. If you are using the Particle Cloud, then the value of *cloud_url* should be https://api.particle.io/v1/devices/. If you are using local cloud, then replace with your sensor address.
The `devices` array contains all the accessories. You can see the accessory object defines following string objects:
- **name** - Display name, this is the name to be displayed on the HomeKit app.
- **type** - Type of the accessory. As of now, the plugin supports 3 types: `lightbulb`, `temperaturesensor` and `humiditysensor`.
- **device_id** - Device ID of the Particle Device (Core, Photon or Electron). It is defined in accessory so that you can use different Particle Devices for different accessory.
- **event_name** - The name of the event to listen for sensor value update. This is only valid if the accessory is a sensor (i.e. currently `temperaturesensor` or `humiditysensor`). The plugin listens for events published from a Particle Device (using `Particle.publish`). The device firmware should publish the sensor values as a raw number.
- **function_name** - The name of the particle function that will be called when an action is triggered via HomeKit. If there is no function provided, the default `power` will be used. This is only valid if the accessory is an actor (i.e. `lightbulb` or `switchaccessory`).
**Particle Event Data Format**
-------------------------------------
By default it expects the event data as "key=value".
```
Particle.publish("tvalue", "temperature=20.7")
```
In order to parse JSON format, a custom `split_character` can be configured.