supported_hardware:hubitat
Differences
This shows you the differences between two versions of the page.
Next revision | Previous revision | ||
supported_hardware:hubitat [2021/01/02 14:39] – created James Sentman | supported_hardware:hubitat [2023/11/04 13:49] (current) – [XTension Settings:] added more info about the static IP issue James Sentman | ||
---|---|---|---|
Line 1: | Line 1: | ||
=====Hubitat===== | =====Hubitat===== | ||
{{: | {{: | ||
- | The [[https:// | + | (v1.4.9) |
====Hubitat Setup:==== | ====Hubitat Setup:==== | ||
- | Follow the standard initial Hubitat setup. A cloud connection is not required for XTension to talk to the Hubitat, all communications are done over the local network and so it is necessary that the Hubitat and the XTension be on the same local network subnet. | + | Follow the standard initial Hubitat setup. A cloud connection is not required for XTension to talk to the Hubitat, all communications are done over the local network and so it is necessary that the Hubitat and the XTension be on the same local network subnet. |
+ | |||
+ | |||
+ | > | ||
===Install the MakerAPI Plugin on the Hubitat:=== | ===Install the MakerAPI Plugin on the Hubitat:=== | ||
Line 24: | Line 27: | ||
in this case the API ID is the " | in this case the API ID is the " | ||
+ | ---- | ||
====XTension Settings: | ====XTension Settings: | ||
{{: | {{: | ||
Line 30: | Line 34: | ||
If you have only a single Hubitat on your network you can leave the defaults for **Address** as " | If you have only a single Hubitat on your network you can leave the defaults for **Address** as " | ||
- | If you are running multiple Hubitat' | + | If you are running multiple Hubitat' |
- | If you have setup local access security on the Hubitat check the "Send Authentication" | + | **NOTE: there is a problem that causes very slow performance when using the hubitat.local address. Later version of the Hubitat firmware have implemented the ability to set a static IP address and I recommend that you do this rather than rely on the local mDNS address. Then place the IP address into the Address field rather than the “hubitat.local” default. If you can’t set this through the hubitat interface a DHCP reservation in your router will work as well.** |
+ | |||
+ | If you have setup local access security on the Hubitat check the "Send Authentication" | ||
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 83: | ||
- | **Note:** as of this beta version there is not yet an " | + | **NOTE:** The default drivers in the hubitat may not support multi-clicks more than a double click. If you find a community driver that supports more that are not passed properly through to XTension please let me know and we can collect |
- | **NOTE:** Unlike | + | **Device Notifications:** If the device |
- | ====Things That Are Not Implemented Yet:==== | + | ===Scene Controllers:=== |
- | Multiple taps on a central | + | As of XTension 9.4.41 |
- | Devices with more than the 2 buttons on a regular paddle switch do appear to be working. The third " | + | ----- |
+ | ====Controlling Status LEDs:==== | ||
+ | As of XTension 9.4.41 you can now control | ||
+ | ----- | ||
- | Virtual units may not be controllable from XTension yet but they will send their value and state changes to XTension. I'm not sure yet why some appear to work normally and others do not but will get this sorted out for the release. | + | ====Sending Device Specific commands: |
- | Sensor type devices that should be controllable, for example door locks or garage door controllers may not be controllable | + | Many devices |
- | As of this moment it does not appear | + | Specific examples below but the general syntax for use requires |
- | The support for location events, control of modes and control of the " | + | Since the Hubitat |
- | Since this is a new Hub and a new plugin and I have not built a large system with it yet there will almost certainly be other issues and limitations with specific devices and I cannot yet speak about those. Overall it appears | + | < |
+ | tell xUnit “the name of the Unit” | ||
+ | </ | ||
- | The Hubitat and it's MakerAPI protocol are moving targets as of this moment, new firmware updates may break things, | + | If you are running the command inside the Unit’s on or off script then you can leave off the tell xUnit portion |
+ | Here are a couple of examples of using the command for real world devices. If you find a command for a device not listed here please let me know and I’ll add it as an example. | ||
+ | |||
+ | ===HomeSeer Flex Sensor=== | ||
+ | This device has the capability of producing a beep or alert sound. There is no standard Unit command to beep but you can use the sendDeviceCommand like this: | ||
+ | |||
+ | < | ||
+ | tell xUnit “name of HomeSeer Flex Sensor” to sendDeviceCommand( “beep”) | ||
+ | </ | ||
+ | |||
+ | ===Aeotec Home Energy Sensor=== | ||
+ | This device has a command to reset the energy usage numbers which can be sent with the command: | ||
+ | |||
+ | < | ||
+ | tell xUnit “name of Home Energy Monitor unit” to sendDeviceCommand( “resetMeterAccumulation”) | ||
+ | </ | ||
+ | |||
+ | |||
+ | ----- | ||
====Converting from the Vera:==== | ====Converting from the Vera:==== | ||
- | I know there is great interest among some folks to have an alternative to the Vera for ZWave control. As of this moment I do not recommend just transferring your entire network | + | You cannot simply transfer your network from the Vera, or any other ZWave controller, and the Hubitat. They do not even attempt |
- | Indeed, even if you wanted to you cannot simply transfer the network from another controller to the Hubitat. This feature seems to be missing from their feature list and instead they recommend removing | + | I would recommend removing devices from the Vera a few at a time, then re-linking them with the hubitat. In the MakerAPI app settings you’ll need to then select them for sharing. After that they will show up in XTension |
- | Please make your desire for this to them via feature requests or posts on their community support boards! | + | If you have the Units setup in any Views, events or web interfaces you will need to re-select |
+ | There is no reason to do an entire update at one time, except that you’ll be reducing the mesh qualities of the old network as you build up the new one. So I would do them in physical portions that might be routing through each other. This way the old device and the new devices will continue to be reachable on whichever interface they are connected to. XTension will happily control some through the vera and some through the Hubitat as you are converting. | ||
+ | You’ll find that it’s worth the effort as the Hubitat support, especially for things that were notoriously unreliable on the Vera such as door locks, work much better on the hubitat. They are sill in business as well and so their support continues to add new devices and improve the support of older devices. The way the interface to the hubitat allows you to write your own plugins, or cut and paste code fomr the community message boards on their site means that there is always going to be code available to support new devices, or less used features of special devices that aren’t supported by the built in drivers. | ||
+ | |||
+ | ----- | ||
+ | ====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. | ||
+ | * Some older switches do not keep their state updated in the Hubitat and will report an incorrect value some time after you control them. I have written code into the plugin to get around this which fixes most but not all of the problems. If you find you have Units that continue to show that they are still on or still off after some time after they were controlled you can create a script that just sends a query to that unit. That will update it to the proper value. And use the on and off script of the Unit to execute that script a few minutes after the Unit has changed state or value. This will result in it being correct, but only some time after it was wrong for a bit. This is good enough for me in every circumstance I’ve found so far. I am able to look through my inside lights list and find any that were actually left on as opposed to having several units always report that they are on when they were turned off and are actually off. | ||
+ | * The enumerations for things like Thermostat Modes are different than the Vera. To avoid confusion you should script them via the newer [[dictionary: | ||
+ | <code AppleScript> | ||
+ | set value of “Thermostat Mode Unit” to “cool” | ||
+ | </ | ||
+ | |||
+ | |||
+ | ----- | ||
+ | ====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: | ||
+ | |||
+ | < | ||
+ | http:// | ||
+ | </ | ||
+ | |||
+ | 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 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 | ||
+ | * Valve devices, and other more unusual enumerated devices, are working as of XTension 9.5.2 |
supported_hardware/hubitat.txt · Last modified: 2023/11/04 13:49 by James Sentman