{\r\n "platform": "Hubitat-MakerAPI",\r\n "name": "Hubitat",\r\n "app_url": "http://192.168.10.169/apps/api/YOUR_APPS_ID/",\r\n "access_token": "THIS-SHOULD-BE-YOUR-TOKEN",\r\n "local_ip": "10.0.0.70",\r\n "local_port": 20010,\r\n "polling_seconds": 300,\r\n "temperature_unit": \"F\",\r\n "mode_switches": true,\r\n "hsm": true, \r\n "debug": false,\r\n "programmable_buttons": [\r\n "97",\r\n "98"\r\n ],\r\n "excluded_capabilities": {\r\n "HUBITAT-DEVICE-ID-1": [\r\n "Switch",\r\n "TemperatureMeasurement"\r\n ]\r\n },\r\n "excluded_attributes": {\r\n "HUBITAT-DEVICE-ID-1": [\r\n "power",\r\n "humidity"\r\n ]\r\n },\r\n "logFile": {\r\n "enabled": true,\r\n "path": "",\r\n "file": "",\r\n "compress": true,\r\n "keep": 5,\r\n "size": "10m"\r\n }
}\r\n
platform & name Required
\r\n This information is used by homebridge to identify the plugin and should be the settings above.
app_url & access_token Required
\r\n This is the base URL and access token for MakerAPI, check step 1 of the installation instructions on how to obtain the value Notice: The app_url in the example above may be different for you.
local_ip Optional
\r\n Defaults to first available IP on your computer
Most installations won't need this, but if for any reason it can't identify your ip address correctly, use this setting to force the IP presented to Hubitat for the hub to send to.
local_port Optional
\r\n Defaults to 20010
This is the port that homebridge-hubitat-makerapi plugin will listen on for events from your hub. Make sure your firewall allows incoming traffic on this port from your hub's IP address.
polling_seconds Optional
\r\n Configures the how often (in seconds) the plugin should check if devices were removed or added from/to the selection in MakerAPI. Default is every 300 seconds. Almost no need to restart homebridge anymore! Name changes and changing a device driver still requires a restart.
excluded_capabilities Optional
\r\n Defaults to None
Specify the Hubitat device by ID and the associated capabilities you want the plugin to ignore
This prevents a Hubitat device from creating unwanted or redundant HomeKit accessories
excluded_attributes Optional
\r\n Defaults to None
Specify the Hubitat device by ID and the associated attributes you want homebridge-hubitat-makerapi to ignore. This prevents a Hubitat device from creating unwanted or redundant HomeKit accessories
programmable_buttons Optional
\r\n Defaults to None
By default, pressing Buttons in Homekit trigger a \"pushed\" event for button number 1 in Hubitat. The setting \"programmable_buttons\" allows Hubitat to trigger HomeKit specific scenes. You can assign scenes to three types of events: Pushed, Held and DoubleTapped. This can be helpful to interact with Homekit only devices. E.g. a button press in HE can trigger a HomeKit only lock to lock. Note: there is no feedback if the Homekit scene was executed successfully or not. Specify the Hubitat device by ID in this setting to create a programmable button.
temperature_unit Optional
\r\n Default to F
Ability to configure between Celsius and Fahrenheit. Possible values: \"F\" or \"C\"
mode_switches Optional
\r\n Default to false
Create switches for modes and ability to switch modes by enabling such switches Possible values: true or false
Requires HE fimrware 2.0.9 or newer
hsm Optional
\r\n Default to false
Integrates HSM into Home app and allow to arm/disarm the hsm and receive notifications on intrusions
Requires HE firmware 2.0.9 or newer
debug Optional
\r\n Default to false
Enables debugging of HTTP calls to MakerAPI to troubleshoot issues
logFile Optional
\r\n Settings to enable logging to file. Uses winston logging facility \r\n\r\n *
enabled Optional
\r\n Enable logging to file. Default is true. Set to true to enable file logging\r\n\r\n *
path Optional
\r\n Path to store log files. Defaults to path where config.json is stored - Only applicable if logFile -> enable is set to true\r\n\r\n *
file Optional
\r\n Filename of log file. Default is homebridge-hubitat.log - Only applicable if logFile -> enable is set to true\r\n\r\n *
compress Optional
\r\n Compress log files when they rotate. Default is true - Only applicable if logFile -> enable is set to true\r\n\r\n *
keep Optional
\r\n Number of log files to keep before deleting old log files. Default is 5 - Only applicable if logFile -> enable is set to true\r\n\r\n *
size Optional
\r\n Maximum size of log file. Default is 10m - Only applicable if logFile -> enable is set to true\r\n\r\n## Capability Filtering\r\nThe **homebridge-hubitat-makerapi** creates Homekit devices based on the attributes of devices. See ***Attribute Filtering*** below.\r\nTo allow backwards compatibilty to tonesto7's plugin, the homebridge-hubitat-makerapi plugin still allows filtering by capability. Capabilities are going to be matched to Hubitat's listed capabilities at [Driver Capability List](https://docs.hubitat.com/index.php?title=Driver_Capability_List) and the associated attributes are going to be removed.\r\n\r\n## Attribute Filtering\r\nThe **homebridge-hubitat-makerapi** creates Homekit devices based on the attributes of devices. \r\nThe following attributes are currently being handled: \r\n\r\n| **Attribute** | **HomeKit Devices** |\r\n| ------------ | ------------ |\r\n| thermostatOperatingState | Thermostat |\r\n| switch and (level or hue or saturation) | Light Bulb |\r\n| switch | Switch |\r\n| motion | Motion Sensor |\r\n| presence | Occupancy Sensor |\r\n| lock | Lock Mechanism |\r\n| temperature (and not a thermostat) | Temperature Sensor|\r\n| contact | Contact Sensor |\r\n| door | Garage Door Opener |\r\n| smoke | Smoke Sensor |\r\n| carbonMonoxide | Carbon Monoxide Sensor |\r\n| carbonDioxideMeasurement | Carbon Dioxide Sensor |\r\n| water | Leak Sensor |\r\n| humidity | Humidity Sensor |\r\n| illuminance | Light Sensor |\r\n| battery | Battery Service |\r\n| position | Window Covering |\r\n| speed | Fan Controller |\r\n| valve | Valve |\r\n\r\nThe **homebridge-hubitat-makerapi** plugin does not discriminate! The plugin will create multiple devices in Homekit if a device has multiple of these attributes.\r\nLet's take a window shade as an example. A window shade might have the attributes \"switch\" and \"position\" and would create two Homekit devices, one as a switch and one as window covering. \r\nThis might not be the desired behavior and you might want to only have one Homekit devices that sets the position of the shade. The plugin allows you to filter out the \"switch\" attribute and won't create a Homekit device for that attribute.\r\nTo do so, you would add the following configuration to your config.json:\r\n\r\n
\r\n "excluded_attributes": {\r\n "HUBITAT-DEVICE-ID": [\r\n "switch"\r\n ]\r\n }\r\n