Homy has been supporting the Open Source Home Automation Server since version 0.2.6 (March 2019). Homy uses a Websocket connection to communicate with the Home Assistant server. The Websocket connection is a very fast bi-directional connection. The Websocket API makes it possible to update in real time the Homy interface as soon as a change (state, value …) occurs on a component.
Current version: 0.1 (March 2019)
- 1 Configure Home Assistant
- 2 Open the Websocket API
- 3 Set up your router or Internet box to give access to the Home Assistant server from the internet
- 4 Create a free domain name with Duck DNS
- 5 Configure the Home Assistant connector on Homy
- 6 Limitations
- 7 Frequent problems
- 8 Compatible equipment with HASS
- 9 Other tutorials on the same theme
Configure Home Assistant
For the moment, Homy supports only long-live-token authentication.
Create a long-live access token for Homy
Open the page of your user profile.
At the bottom of the page, in the “Long-Lived Access Tokens” block, click Create Token.
Name the token
A dialog box opens and displays the token. Copy it before closing the box. The token is displayed only once. Send the token by SMS, iMessage or email … to the device on which Homy is installed.
Open the Websocket API
Open the configuration.yaml file with a text editor (Sublime Text, Notepad++, Visual Studio Code) and add the following line to the end of the file. Password authentication is not supported at the moment.
Restart HASS from the WEB for example. Configuration -> General -> Restart at the bottom of the page.
Set up your router or Internet box to give access to the Home Assistant server from the internet
If your ISP assigns you a fixed IP (which is almost always the case), just do a port forwarding to the computer or NAS which hosts Jeedom on your local network. The configuration is similar from one box to another. At SFR, go to the Network v4 menu and then NAT.
Create a new redirection by entering the following parameters:
- Protocol: TCP
- Port: 8123 by default
- IP: the IP address of the HASS server
- Check Activate
- Add the redirection by clicking on the More
Get the IP address of your internet box. It is usually in the state of the box, otherwise do a search “my ip” on your favorite search engine.
Create a free domain name with Duck DNS
DuckDNS is a totally free service that allows you to create up to 5 domain names. The extension of your domain will have the extension duckdns.org. This extension can not be customized but we will not be choosy.
To use Duck DNS, you will need a Persona account, Twitter, github or reddit.
Once logged in, simply enter the desired domain name in the creation field.DuckDNS automatically detects the IP address of your internet box. It is however possible to modify it and even to indicate an IP address of type IP v6 if your box supports it.
The domain name created with DuckDNS service is compatible with a secure HTTPS connection with a Let’s Encrypt certificate.
Configure the Home Assistant connector on Homy
Open the Settings
Open the Connector List.
Click the Plus.
Choose Home Assistant in the list
Complete the following parameters:
- Name the connector. Optional
- Check Active to enable the connector. By unchecking this option, you can suspend communication with the HASS server temporarily.
- API Token: paste the previously created
- Local IP. Enter the IP address of the HASS server on your local.
- External IP. If you have a previously created DynDNS domain name, enter it in the field. You can also directly enter the IP address of your internet box
- Port. By default, HASS uses port 8123.
- Protocol. WS or WSS protocol (secure). By default, the communication is not encrypted. The WSS protocol requires the installation of a certificate (Let’Encrypt for example) on the HASS server
- Test the connection. Click on “Test Connection”. If Homy could log in and authenticate with Home Assistant, the cross will be green. An exclamation point will be displayed if this is not the case. To test the external IP, check the Test connector with external IP option.
Check the option Add new accessories automatically to let Homy integrate all the home automation modules added to Home Assistant.
- Currently, Homy can only manage one Home Assistant server
- The home automation accessories removed on the HASS server must be manually deleted (or forgotten) on Homy
- API does not allow (for now) to recover the zones (rooms). You will have to manually assign each home automation accessory to rooms if you want to take advantage of this feature.
- Authentication fails even though all the parameters seem correct (IP address, port, protocol …). The token was probably badly copied. Create a new token and use the right mouse button to copy it from the dialog box.
- Localhost does not work on the local network. You must specify the local IP address of the HASS server in the local IP field.
Compatible equipment with HASS
Shutter, blinds, garage, door
The component Cover is compatible with the main manufacturers on the market: deConz, Fibaro, Homematic, Insteon, KNC Cover, Lutron, Lutron Caseta, MQTT for DIYers, RFLink (Somfy compatible), RFXtrx, SmartThings, Somfy Tahoma, Tuya, Telldus, TellStitck, Velux, Xiaomi (motorized curtains).
The Climate component of Home Assistant can control the connected thermostats, air conditioning or heat pump (PAC) from many manufacturers including Dyson Pure Hot+Cool, Ecobee, Hive, KNC Climate, Nest, Netatmo Thermostat, SmartThings, Vera, Z-Wave thermostats.
|Set value||Fan||Modes (including on/off)||Away mode||Doc.|
|Dyson Pure Hot+Cool||X||X||X||Read|
|Ecobee*||min, max, set||on/off||auto, auxHeatOnly, cool, heat, off||X||Read|
|Hive||X||X + auxillary||Read|
|Nest||min, max, set||X||X||X||Read|
(*) requires to create a developer account to recover an access token to the API
Vacuum robot cleaner
The HASS Vacuum component is used to manage several connected vacuum cleaner robots of the Dyson, Ecovacs (all Deebot models), iRobot Roomba 980, Neato Robotics (Botvac) and Xiaomi Mi Robot Vacuum brands. The complete list is here.
ou start / pause
|Dyson 360 eye||X||X||X||X||X||Quiet, max||Read|
|Ecovacs Deebot||X||X||X||X||X||X||Normal, high||X||Read|
|iRobot Roomba 980*||X||X||X||X||X||X||Automatic, eco, performance||X||Read|
|MQTT||X||X||X||X||X||X||X||Min, medium, high, max||X||Read|
|Xiaomi Mi Robot||X||X||X||X||X||Quiet, balance, turbo, max||X||Read|
(*) Component only tested by the developers with the 980 model but it should also work with the 690, 890 and 960 models.
(**) Allows you to locate the robot vacuum cleaner using a sound.
Other tutorials on the same theme
- Control Home Assistant from Homy, configure the connector
- Control HASS shutters, blinds and garage door (cover component) from Homy
- Control Home Assistant HVAC, Heat Pump and Thermostats (climate component)
- Control Home Assistant Vacuum component (robot vacuum cleaner) from Homy
- Control Domoticz from Homy, configure the HTTP / HTTPS connector
- Control your Tasmota home automation accessories, configure the Homy MQTT connector
- Control Domoticz via the JSON API, configure the Homy MQTT connector