Dynamic platform plugin for homebridge instances
Creating and maintaining Homebridge plugins consume a lot of time and effort, if you would like to share your appreciation, feel free to "Star" or donate.
This is a dynamic platform plugin for Homebridge to control your homebridge instance(s). It is capable to dynamically add or remove services, depending on if service is enabled or disabled! It is also possible to add a listener to your journalctl. The listener will listen on errors and will send a notification (via telegram) if a service crashes.
This plugin supports following functions:
Main Switch:
Services:
After Homebridge has been installed:
(sudo) npm i -g homebridge-instances-platform@latest
{
"bridge": {
...
},
"accessories": [
...
],
"platforms": [
{
"platform": "InstancesPlatform",
"startParam": "homebridge",
"clearCache": false,
"sudo": false,
"temperature": {
"active": true
},
"notifier":{
"active": true,
"token": "TELEGRAMTOKEN",
"chatID": "TELEGRAMCHATID",
"filter": ["Main process exited", "Error", "error", "ERROR"],
"filterInstances": ["homebridge-alexa"],
"spamInterval": 1,
"updatesPolling": 12
},
"exclude": ["homebridge-alexa"]
}
]
}
See Example Config for more details.
Attributes | Required | Usage |
---|---|---|
platform | Yes | Must be InstancesPlatform |
startParam | No | The word with which all .service files start (Default: "homebridge") |
clearCache | No | If true, the accessory will be removed from HomeKit (Default: false) |
sudo | No | If you have problems starting/stopping an instance, set this true (Default: false) |
polling | No | Polling interval in seconds (Default: 5s) |
temperature.active | No | Temperature Characteristic for CPU Temperature (Default: false) |
temperature.file | No | Custom file path to CPU Temperature (eg for Orange PI) |
temperature.multiplier | No | Custom multiplier (eg for Orange PI) |
notifier.active | No | Telegram notification (Default: false) |
notifier.token | No | Telegram Bot Token |
notifier.chatID | No | Telegram Chat ID |
notifier.filter | No | An array/string of matches to filter (Default: ['Main process exited']) |
notifier.filterInstances | No | An array/string of matches to filter instances (Default: false) |
notifier.spamInterval | No | Timer in minutes to block telegram spam (Default: 1 min) |
notifier.updatesPolling | No | Polling interval in hours for check plugin updates (Default: 12h) |
exclude | No | An array of services to exclude from discovery |
This plugin has been verified to work with the following apps on iOS 12.2 and iOS 12.3 Beta:
You can contribute to this homebridge plugin in following ways:
Pull requests are accepted.
Due to some major bugfixes, you need to remove the Accessory from HomeKit! After update, set "clearCache": true in your config.json and restart homebridge. This will remove the accessory from HomeKit and your cache. After this, set "clearCache": false in config.json and restart homebridge again. This will add the Accessory (Switch) to HomeKit again