homebridge-serialsprinklers
v0.0.2
Published
Serial controlled sprinkler system to attach to Arduino
Downloads
2
Readme
homebridge-serialsprinklers
Description
This homebridge plugin exposes a serial-based sprinkler/valve to Apple's HomeKit and allows you to control it.
Installation
- Install homebridge
- Install this plugin:
npm install -g homebridge-serialsprinklers
- Update your
config.json
file
Configuration
Core
| Key | Description | Default |
| --- | --- | --- |
| accessory
| Must be SerialSprinkler
| N/A |
| name
| Name to appear in the Home app | N/A |
Optional fields
| Key | Description | Default |
| --- | --- | --- |
| icon
(optional) | Icon to be shown in the Home app (0
, 1
, 2
, 3
) | 0
|
| useTimer
(optional) | Indication if a timer can be used (yes
or no
) | no
|
| defaultTime
(optional) | Default time (in seconds) the timer should be set to if enabled | 300
|
Additional fields
| Key | Description | Default |
| --- | --- | --- |
| model
(optional) | Appears under the Model field for the accessory | homebridge-serialsprinkler
|
| serial
(optional) | Appears under the Serial field for the accessory | homebridge-serialsprinkler
|
| manufacturer
(optional) | Appears under the Manufacturer field for the accessory | cheese_PETE
|
Configuration Examples
Simple configuration:
"accessories": [
{
"accessory": "SerialSprinkler",
"name": "Sprinklers"
}
]