homebridge-hubitat-hubconnect

This is based off of @tonesto7 homebridge-hubitat-tonesto7

Current App version: 0.3.12

Table of Contents

Change Log Installation Configuration File Parameters Attribute Filtering Troubleshooting

Change Log:

Homebridge Plugin:

v0.1.0 - Reworked alot of the code to allow for communication with Hubitat HubConnect v0.1.4 - Support of HSM if enabled, Attribute filtering for devices is possible Fixed bug of not updating tiles in HomeKit after an hour expired Fixed issuse with Siri, Show version number in logging output Fixed issue with setting Thermostat temperature configure homebridge to use Celsius v0.1.5 - Fixed issue when a single device is assigned to several groups v0.2.0 - migrated to dynamic homebridge platform that removes the need of restarting homebridge after a device selection was changed in HubConnect, configure homebridge to use Celsius, fixed fan tile on/off functionallity, ability to create switch tiles for modes and switching of modes, HSM integration, perform daily version check against NPMJS and print logging statement on newer versions available, streamline code to share improvements with homebridge-hubitat-makerapi, ability to exclude attributes,allows correct usage of DNS host names instead of IP address to connect to hubitat, fans that support setLevel use setLevel instead of setSpeed to allow finer granularity, code baselined with homebridge-hubitat-makerapi plugin to allow faster cross-sharing of improvements,Fixed issue with multi sensors not updating temperature and humidity, fixed issue that temperature can't go negative v0.2.4 - changed parameter list for remote commands to hubConnect, fixed water valves v0.2.5 - fixed on/off for fan controllers with setLevel support v0.2.6 - fixed issues with setting HSM and modes from Homekit and receiving an update response to it v0.2.7 - always listen to event socket to receive mode updates v0.2.8 - Hampton Bay Fan Controllers say they have speed level even though they are off, let's fix that, fixed on/off for hampton bay controller, fixed water valve v0.2.9 Added some debug for fans....,Fixed garage door implementation and set obstruction when status is unknown/stopped,Added "debug" mode to see calls to MakerAPI in output. See description below on how to enable it, Added ability to write logging to file v0.2.10 Fixed rounding issue with thermostats in auto mode v0.2.11 Added thermostat fan switch support (thanks @swiss6th), added ping/pong for websockets (thanks @asj) v0.3.5 Device updates retrieved via websocket, Added thermostat fan switch support, Added support for colorTemperature bulbs, Fixed thermostat low battery warnings, fixed iOS13 duplicate calling of setThermostatOperationgMode, Added Button support, limited to "push" for 1 button, see "programmable_buttons" for advanced programmable button support (thanks to @swiss6th for the code base), Added automatic detection of free port, Added diagnostic website hosted by plugin to see/download log files and enable debug logging, implemented new support interface for HubConnect 1.5 v0.3.6 Fixed reset of alarm tile when custom HSM rule alert was cancelled v0.3.7 Escape mode names with special characters in set command v0.3.8 Removed trailing / from url reported to HubConnect v0.3.9 Fixed button push exceptions v0.3.11 Fixed tsVersion report v0.3.12 Validation of values for accessoires to prevent warning messages in Homebridge 1.3

Explanation:

Direct Updates

This method is nearly instant. This option allows the hub to send updates directly to your homebridge-hubitat-hubconnect installation. The hub must be setup as a HubConnect Server and a Remote Client has to be added. See here: (https://community.hubitat.com/t/release-hubconnect-share-devices-across-multiple-hubs-even-smartthings) The port used for this can be configured by the "local_port" setting and defaults to 20009. The program will attempt to determine your IP address automatically, but that can be overridden by "local_ip" which is useful if you have multiple addresses.

When properly setup, you should see something like this in your Homebridge startup immediately after the PIN:

[2019-4-12 12:46:45] Homebridge is running on port 51826.
[2019-4-12 12:46:45] [Hubitat Dev] homebridge-hubitat-hubconnect server listening on 20009

Installation:

Installation comes in two parts:

1. HubConnect Installation

• Follow the instructions provided by HubConnect here: https://community.hubitat.com/t/release-hubconnect-share-devices-across-multiple-hubs-even-smartthings
• Add a new Remote Client and save the Connection Key
• Select the devices you want to use with Homebridge under Connect local devices to Client Hub
• Your Done with the Hubitat install.

3. Homebridge Plugin Installation:

1. Install homebridge using: sudo npm i -g homebridge (For Homebridge Install: Homebridge Instructions)
2. Install Hubitat plugin using: sudo npm i -g homebridge-hubitat-hubconnect
3. Create your config.json configuration file. The config.json file has to be stored in the folder ~/.homebridge
4. To help creating your inital configuration file, click here for some assistance.
5. Start homebridge using the command: homebridge

Configuration File Parameters

Attribute Filtering

The homebridge-hubitat-hubconnect creates Homekit devices based on the attributes of devices. The following attributes are currently being handled:

| Attribute | HomeKit Devices | | ------------ | ------------ | | thermostatOperatingState | Thermostat | | switch and (level or hue or saturation) | Light Bulb | | switch | Switch | | motion | Motion Sensor | | presence | Occupancy Sensor | | lock | Lock Mechanism | | temperature (and not a thermostat) | Temperature Sensor| | contact | Contact Sensor | | door | Garage Door Opener | | smoke | Smoke Sensor | | carbonMonoxide | Carbon Monoxide Sensor | | carbonDioxideMeasurement | Carbon Dioxide Sensor | | water | Leak Sensor | | humidity | Humidity Sensor | | illuminance | Light Sensor | | battery | Battery Service | | position | Window Covering | | speed | Fan Controller | | valve | Valve |

The homebridge-hubitat-hubconnect plugin does not discriminate! The plugin will create multiple devices in Homekit if a device has multiple of these attributes. Let'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. This 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. To do so, you would add the following configuration to your config.json:

Troubleshooting

With version v0.3.0 a plugin dashboard is available to help troubeshooting. The dashboard is a website that can be reached while homebridge and the plugin are running. To reach the dashboard, you can follow these steps:

1. Open a browser and go to the URL http://[IF-OF-HOMEBRIDGE-SERVER]:[LOCAL-PORT-OF-THIS-PLUGIN]/
2. You will see a view like this, showing you the logging output of the plugin, the ability to download the log-file to your computer, enablign, disabling debug mode and see your current configuration