-
Notifications
You must be signed in to change notification settings - Fork 2
Accessories
All accessory types have the following fields available.
| Field | Required? | Description |
|---|---|---|
| id | yes | A unique ID to identify this accessory. Changing this value will result in a new accessory. |
| name | yes | The display name for the accessory in HomeKit |
| type | yes | The type of accessory. See the list of currently supported types below. |
| group | no | Items sharing the same group name will be grouped in the Home app UI |
| manufacturer | no | The accessory manufacturer that will display in HomeKit device details |
| model | no | The accessory model that will display in HomeKit device details |
| serialNumber | no | The accessory serial number that will display in HomeKit device details |
| version | no | The accessory software version which will display in HomeKit device details |
You will need to make sure to populate the appropriate topics based on the accessory type linked below. See Advanced Topic Notation for details on JSONPath and Value Transformer.
You will also need to populate the appropriate values based on the type. Note that while they are defined as strings, they will be auto-converted to the appropriate primitives (e.g. boolean or number) where appropriate. These values are used for both determining the current state and, if applicable, publishing the new state to MQTT.
Here is the list of the optional Topics & Values available to all accessories:
| Field | Description |
|---|---|
| topicGetAvailable | Whether or not the accessory is available/reachable |
| topicGetStatusActive | Whether or not the accessory is active/inactive |
| topicGetBatteryLow | Whether or not the accessory has a low battery |
| topicGetBatteryLevel | Battery percentage as a number |
| valueAvailable | Accessory is available/reachable, e.g. "true", "1", or "Alive" |
| valueStatusActive | Accessory is active, e.g. "true", "1", or "Active" |
| valueBatteryLow | Accessory has a low battery level |
By default, all accessory values are saved and reloaded when the plugin restarts. However, you may override this behavior by selecting Reset on Restart option and accessories will be reset to defaults whenever the plugin or Homebridge restarts.
"resetOnRestart": true
Available Topics & Values can be found for each accessory by visiting the page links.