User Tools

Site Tools


supported_hardware:hubitat

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
supported_hardware:hubitat [2021/02/02 15:04]
James Sentman [History:] thermostat
supported_hardware:hubitat [2021/11/05 15:44] (current)
James Sentman added gathering data for support section
Line 1: Line 1:
 =====Hubitat===== =====Hubitat=====
 {{:​supported_hardware:​hubitat_hero.jpg?​400 |}} {{:​supported_hardware:​hubitat_hero.jpg?​400 |}}
-The [[https://​hubitat.com/​|Hubitat]] is a ZWave and ZigBee hub that can be connected to XTension via the new Hubitat plugin. This plugin is currently in beta and you should not convert your entire Z-Wave network to one as it is not feature complete as of this writing. It offers a choice for ZWave connectivity in XTension beyond the older Vera units that we will continue to support. As of this moment both the plugin as well as the support for local connectivity in the Hubitat itself are under construction and so features and functions may continue to be added or removed as the protocols develop. Note that currently the plugin is not as feature complete as the Vera plugin and given that I don't know what will get added to the Hubitat protocols or when it may never be. Switching between the 2 devices cannot yet be done as a simple conversion from one plugin to the other. See more info below. ​+(v1.2) ​The [[https://​hubitat.com/​|Hubitat]] is a ZWave and ZigBee hub that can be connected to XTension via the new Hubitat plugin. This plugin is currently in beta and you should not convert your entire Z-Wave network to one as it is not feature complete as of this writing. It offers a choice for ZWave connectivity in XTension beyond the older Vera units that we will continue to support. As of this moment both the plugin as well as the support for local connectivity in the Hubitat itself are under construction and so features and functions may continue to be added or removed as the protocols develop. Note that currently the plugin is not as feature complete as the Vera plugin and given that I don't know what will get added to the Hubitat protocols or when it may never be. Switching between the 2 devices cannot yet be done as a simple conversion from one plugin to the other. See more info below. ​
  
  
Line 24: Line 24:
 in this case the API ID is the "​67"​ in the link and the Access Token is the long string of numbers and dashes at the end after the "​access_token="​ portion. Your API ID and access token will be different from the example above. Keep this page open as you will need to cut and paste those values into XTension in the next step. in this case the API ID is the "​67"​ in the link and the Access Token is the long string of numbers and dashes at the end after the "​access_token="​ portion. Your API ID and access token will be different from the example above. Keep this page open as you will need to cut and paste those values into XTension in the next step.
  
 +----
 ====XTension Settings:​==== ====XTension Settings:​====
 {{:​supported_hardware:​hubitat_settings.png?​600 |}} {{:​supported_hardware:​hubitat_settings.png?​600 |}}
Line 30: Line 31:
 If you have only a single Hubitat on your network you can leave the defaults for **Address** as "​hubitat.local"​ under normal circumstances the port should be left as "​80."​ If you have only a single Hubitat on your network you can leave the defaults for **Address** as "​hubitat.local"​ under normal circumstances the port should be left as "​80."​
  
-If you are running multiple Hubitat'​s on the network then you will need to provide them with Static IP addresses so you know which one XTension is connecting to. There is no interface to this inside the Hubitat itself so you will need to visit the configuration of your router and create a DHCP reservation for the 2 devices, then restart them to make sure they pick up the new address if you changed it from what they were using at the time. Then enter that into the address field. ​+If you are running multiple Hubitat'​s on the network then you will need to provide them with Static IP addresses so you know which one XTension is connecting to. There is no interface to this inside the Hubitat itself so you will need to visit the configuration of your router and create a DHCP reservation for the 2 devices, then restart them to make sure they pick up the new address if you changed it from what they were using at the time. Then enter that into the address field
 + 
 +**NOTE:** there is a bug somewhere either in their firmware or in the Mac implementation of the bonjour lookups that can make it take between 5 and 10 seconds or more to resolve the hubitat.local address. Until I or they figure out what changed and how to fix it please use a DHCP reservation or the static IP capabilities of the more recent firmware updates and change the address of the hubitat in the XTension address field to use the IP address instead of the mDNS name. This will remove the extended delay when controlling anything that many folks, including myself, but not all folks are seeing when using the hubitat.local address.
  
 If you have setup local access security on the Hubitat check the "Send Authentication"​ checkbox and enter the user and password. **NOTE:** as of this beta version sending passwords is not implemented. If this is something you need sooner please let me know and I will move it up the list of items yet to implement. It will be available before the plugin is promoted out of beta. If you have setup local access security on the Hubitat check the "Send Authentication"​ checkbox and enter the user and password. **NOTE:** as of this beta version sending passwords is not implemented. If this is something you need sooner please let me know and I will move it up the list of items yet to implement. It will be available before the plugin is promoted out of beta.
  
 Enter the API ID and Access Token from the URL's in the MakerAPI setup screen into the next section. Enter the API ID and Access Token from the URL's in the MakerAPI setup screen into the next section.
 +
 +The **Scan For New Devices Now** button will be enabled if the plugin interface is running and will perform a deep database scan when you click it. If you add new devices to the MakerAPI sharing list you can make them show up in XTension immediately by clicking that button. A deep scan is run every 5 minutes, this button runs it on demand.
  
 Click the Save button to save the Hubitat plugin instance in XTension. You can then enable the plugin in the Interfaces list window. Click the Save button to save the Hubitat plugin instance in XTension. You can then enable the plugin in the Interfaces list window.
 +
 +----
 +
 +====Unit Naming Conventions:​====
 +When XTension sees a new unit in the Hubitat it will automatically create a new unit for it with all the proper settings. It will also use the name you have given the unit in the Hubitat as it’s starting point. Once the unit is created the name of the unit is no longer important to the connection and you can change the name in XTension without changing it in the Hubitat. This can be useful if there are name length restrictions or if the naming convention you are using inside the hubitat would not be as useful as what you want to use in XTension.
  
 ====Using The Hubitat Plugin:==== ====Using The Hubitat Plugin:====
Line 68: Line 78:
  
  
-**Note:** as of this beta version there is not yet an "​insert"​ toolbar menu item to insert a default ​handler for these actionsThat will be added before ​the release.+**NOTE:** The default ​drivers in the hubitat supports only tap and double tap eventsI’m still looking into the practicality of maintaining separate community device drivers for the devices that support more than that.
  
-**NOTE:** Unlike ​the Vera it seems that the Hubitat ​only supports single and double clicks. Devices ​that support multiple clicks beyond ​that do not share that data with XTension ​yetWhen this becomes available ​in the Hubitat API I will make sure it works properly with XTension.+**Device Notifications:** If the device supports a notification such as the flashing light on some switches and you define ​that in the Hubitat that notification will show up as a separate unit in XTension ​that will allow you to turn on and off the notification display by turning on and off the unit. 
 + 
 +===Scene Controllers:​=== 
 +As of XTension ​9.4.41 scene controllers and other devices with buttons or inputs should again behave properly. Wireless scene controllers will now create a single unit in XTension. It will not change state itself, but it will receive central scene events about which button was pressed and the number of clicks as available. Hold and release are handled the same as the examples above for switches. 
 + 
 + 
 +====Controlling Status LEDs:==== 
 +As of XTension ​9.4.41 you can now control the status LED’s of the Home Seer WD200+ dimmers. Please see the [[supported_modules:​hs-wd200|article about the WD200]] for more info and code examples.
  
 ====Things That Are Not Implemented Yet:==== ====Things That Are Not Implemented Yet:====
Line 80: Line 97:
  
 Sensor type devices that should be controllable,​ for example door locks or garage door controllers may not be controllable yet from XTension. If you have a device like this that does not work properly please drop me a note and we can gather some data to help make this work properly. Sensor type devices that should be controllable,​ for example door locks or garage door controllers may not be controllable yet from XTension. If you have a device like this that does not work properly please drop me a note and we can gather some data to help make this work properly.
- 
-As of this moment it does not appear that setting of device firmware data is supported by the Hubitat protocol. So things like setting the LED display colors on the Innovelli or Home Seer switches is not yet possible. I hope to either have this sorted out or to have a feature request in to the Hubitat folks to implement it as soon as possible but since it is up to them on their side I cannot guarantee when or if this will ever work properly. It is something I make a lot of use through the Vera and so I will be pushing hard to find a way to make this work. It does appear that the hub itself supports setting this information. It is just a matter of bringing it out to the MakerAPI protocol so that we can do it remotely. 
  
 The support for location events, control of modes and control of the "​HSM"​ or security features of the Hubitat are completely untested as of this first beta. If you are using these things and they do not work as expected please drop me a note and we can collect some more data to make it easier for me to properly implement them on our side. The support for location events, control of modes and control of the "​HSM"​ or security features of the Hubitat are completely untested as of this first beta. If you are using these things and they do not work as expected please drop me a note and we can collect some more data to make it easier for me to properly implement them on our side.
Line 96: Line 111:
 Please make your desire for this to them via feature requests or posts on their community support boards! Please make your desire for this to them via feature requests or posts on their community support boards!
  
 +====Potential Issues:====
 +  * I cannot currently get my Hubitat to recognize some older ZWave 1 switches. They can be added only as a “Device” and are not controllable. Changing the device type in the Hubitat to a generic dimmer or switch does show the rest of the controls but they cannot be successfully controlled.
 +  * As of this moment only click and double click and click and hold appear to be able to captured to the central scene handler. Many switches support more than that. This appears to be a limitation in the MakerAPI as of this writing.
 +  * The enumerations for things like Thermostat Modes are different than the Vera. To avoid confusion you should script them via the newer [[dictionary:​unitinformation:​enumeratedvalue|Enumerated Value]] capabilities of XTension so that you can do things like:
 +<code AppleScript>​
 +set value of “Thermostat Mode Unit” to “cool”
 +</​code>​
 +
 +
 +====Gathering Data For Unsupported Devices:​====
 +If you have a device that is either not showing up at all or it showing no updates or the wrong updates please do the following to capture info about it. First I need a full database dump from your hubitat and the name of the device or it’s address so I can find the pertinent data in the potentially large database info. Please visit this link on your Hubitat, filling in your Access Token as described above in the initial setup:
 +
 +<​code>​
 +http://​hubitat.local/​apps/​api/<​replace with your APP ID Number as above>/​devices/​*?​access_token=<​replace with your access token as above>
 +</​code>​
 +
 +That will download some pages of JSON data into your browser, you can cut and paste it into an email to me or save it to a file and email me that if the data is too large.
 +
 +Second I will need some of the push data that the hubitat sends when values change or are updated. In the Interface List window in XTension control click, or perform a contextual click on the hubitat interface you created there and select “Turn Debug Mode On” Now all the push information that is received will be written to the XTension log. Do whatever you need to in order to create some push updates from the Hubitat and then copy and paste those lines into an email to me as well. I’ll do whatever possible to support any devices that aren’t already handled properly.
  
 ====History:​==== ====History:​====
   * The Hubitat plugin was first added as a beta version in XTension v9.4.35 in January of 2021   * The Hubitat plugin was first added as a beta version in XTension v9.4.35 in January of 2021
-  * Thermostats are working as of version 9.4.36+  * Thermostats are working as of XTension ​version 9.4.36 ​plugin version 1.1 
 +  * Ceiling Fan control is working as of XTension version 9.4.37 plugin version 1.2 
 +  * Scene Controllers are working as of XTension 9.4.41
supported_hardware/hubitat.1612278249.txt.gz · Last modified: 2021/02/02 15:04 by James Sentman