The HAGateway driver integrates your Home Assistant automation controller's Devices and Entities into myServer 6.
In order for the HAGateway driver to communicate with Home Assistant you will have to first generate a Long-lived access token. Go to the Home Assistant's web page and from your Profile page select the CREATE TOKEN option in the Long-lived access tokens pane. Save the access token you create in a text file as you will need it in the next steps.
Install the HAGateway driver and then navigate to the HAGateway drivers page.
The first thing you need to do is add the Home Assistant controller as a local myServer device. You can either click on the Discover button at the bottom of the page and let the driver find it. Or...
...Or click on the Driver Command testing button and select the Host:AddHost option
Once the Home Assistant host has been added click on the pencil icon to edit the device properties.
Now open your text file where you saved your long-lived access token and copy and paste it into the Serial number field and click save.
After a few seconds the display should refresh with all the Home Assistant devices the driver has discovered.
The driver will make an attempt to translate the Home Assistant device into a compatible myServer device.
Two important notes.
All the discovered devices will be imported in a disabled state. This is done so that we do not overwhelm the system with a lot of devices that may not be needed that would otherwise adversly affect your device license count.
Also, all the devices will be placed in the Unknown room. This is done so that we do not automatically create a lot of rooms that might not be relavant.
If you scroll the page to the left you will see that the Notes column has been populated with the area id as it was defined in Home Assistant. You can use that as a reference when naming your rooms.
If your Home Assistant Rooms are all accurate to can save time and simply re-import your rooms. On the bottom of the page there is a checkbox labeled "Add Rooms On Import"
Activate this checkbox and then from the Driver command testing execute the RemoveDevices command.
This will flush all the old devices out of the system and re-import then. This time you will see that they have been placed into their proper rooms.
In our test system we have a large number of Lutron devices that need to be controlled by myServer. You can either eable each device one by one but if you want to save some time you can bulk enable a range of devices all at once. There's a command for that.
Select the EnabledDevices command from the list of commands and then from the Family to Enable dropdown select the name of the family of devices you want to enable.
In our example we are going to group enable all the lighting devices. Click Execute to perform the enabling.
All the lighting devices are now enabled.
The process can be reversed by running the DisableDevices command. Here we disable the lighting devices.
and now they are will go back to their disabled state.
myServer variables versus Home Assistant entities.
If you click on the right arrow button next to any device in the driver you will see all the server variables that have been associated with that device. Here we show the variables for the Great Room Lights. Notice the we track both the myServer and Home Assistant sets of variables. The variables that start with the family name and an underscrore are the set of myServer variables. The other variables are equivalent to the Home Assistant entity values. You can use any of these variables in myServer. Both sets will be updated in realtime as soon as they change in Home Assistant.
You will want to get familiar with myServer command syntax. You can do that from within the driver. Under Driver Command Testing you will see that we provide samples for all the available HAGateway commands. You can exercise any of them from this page and then use the generated command in your Designer pages. Here we test the command for turning off a light.
On going development.
During the development of the HAGateway driver we were only able to test on an handful of systems with a limited amount of devices. The driver works well on the systems we tested it on but you might find on your system we may not have found all your devices or we might have incorrectly identified some of them.
This is where you can help. You will see a command option called SendDevices. When you execute that command the driver will create a copy of your Home Assistant Devices and Entities databases and send them to our development team for testing. We will be able to load those registeries in our lab and make the adjustments to the driver.
Please keep in mind that Allonis will try to fit in the support for new devices on an as available basis. If there is a more critical need, Allonis can be retained for prioritized service.
If you want to submit your devices for review execute the SendDevices command. Which will display the following pop-up.
You will have to answer yes to send the data. But first feel free to change the message displayed in the text box. The data is submitted anonymously but if you want to hear back from us on what we found type in the email address where we you can be reached.
If you click yes it will be followed by a toast message when the data has been sent.
Please check our Home Assistant Forum for up to date status on the continuing HAGateway driver development.