eedomus bridge smart home integration, free and open source
The peripherals of your eedomus box in Gladys: lights, shutters, heating, sensors, meters…
Published by LM1LC3N7
- Devices
- Version 0.1.1
- Requires Gladys >=5.1.0
- ★ 0
This integration connects Gladys to your eedomus box and offers every eedomus peripheral in the Discovery tab of Gladys: lamps, plugs, shutters, pilot wire heaters, setpoints, sensors, meters, remotes. Once a device is added, its values follow the box every few seconds, and Gladys controls it through the box, which keeps running with its Z-Wave, Zigbee, RF modules and its plugins. Move to Gladys at your own pace, room after room, or use both side by side. Unofficial, not affiliated with Connected Object (the maker of eedomus).
Development version (0.1). Built from the eedomus API documentation and tested on a simulated box, not yet on a real eedomus. Your feedback is welcome on the GitHub repository: it is what makes the next version.
What you get
| eedomus peripherals (usage) | In Gladys |
|---|---|
| Lamp (on/off or dimmer) | a light: on/off, brightness |
| Electrical appliance, heating relay | a switch (and its level when it has some) |
| Pilot wire heating (Arrêt, Hors gel, Eco, Confort -2, Confort -1, Confort) | a pilot wire heater, every order |
| Temperature setpoint, thermostat whose values are temperatures | a thermostat setpoint |
| Shutter, shutters, opening centralisation | a shutter: open, close, stop (when the box has one), position |
| Alarm arming, other actuator, thermostat mode | a list of its values |
| Remote, wall switch (Interrupteur/Télécommande) | a button: every press is an event for your scenes |
| Motion, presence, opening, smoke, flood detectors | motion, opening, smoke and leak sensors |
| Temperature, humidity, luminosity, pressure, CO₂, noise, rain, wind, UV | the sensor of the right category |
| Power, energy (Linky, plugs), voltage, current, water and gas meters | power, energy index, voltage, current, volume |
| Other indicators (day phase, messages…) | a text, or a value with its unit |
| Battery level of battery modules | the battery level |
Each eedomus peripheral makes one Gladys device, named after the peripheral and its room ("Lamp (Living room)"); its id, usage and parent module are kept in its parameters. A module with several channels (a motion sensor with its temperature and luminosity) makes one device per channel, so that each channel keeps its room.
The integration reads the unit of each value first: a peripheral left with the "Temperature" usage but measuring watts is offered as a power meter.
Requirements
- An eedomus box (eedomus+ or eedomus) and its API credentials.
- For the local connection: the Gladys machine reaches the box on the local network (port 80). Otherwise, the eedomus cloud is used (internet access).
Installation
- Get your API credentials: on secure.eedomus.com, Configuration → Mon compte → Identifiants API. eedomus sends the API user and the API secret by email. They are not the ones of your eedomus account.
- Find the IP address of the box on your network (your internet router
lists the devices of your network), like
192.168.1.30. - In Gladys, open the integration, Configuration:
- IP address of the eedomus box:
192.168.1.30. Leave it empty to go through the eedomus cloud only. - API user and API secret: paste them.
- IP address of the eedomus box:
- Click Test the connection: the local API and the eedomus cloud are tried one after the other, then the number of peripherals, rooms and devices offered shows up.
- Open the Discovery tab and add the devices you want. Their values are sent as soon as they are added.
Options
- Prefer the local connection (a Gladys toggle): on by default. The integration talks to the box on your network, and goes through the eedomus cloud only when the box does not answer (the box is then tried again every 5 minutes). Turn it off to go through the cloud first, the box being the fallback.
- Interval between two reads of the values: 15 seconds by default (5 to 300). The values of all the devices you added are read in one request to the box. Through the eedomus cloud, at most once a minute, to stay within the cloud quotas.
Good to know
- The box stays in charge of the modules: Gladys sends its commands to the box, which drives the Z-Wave, Zigbee, RF modules. Keep it running, with its rules if you wish.
- The box is slow: the integration sends one request at a time, never closer than 0.6 s apart. A command shows up in Gladys within 2 seconds.
- Values, not events: the values are read at the chosen interval, so a motion lasting less than the interval may be missed. Lower the interval for your motion sensors' sake, not below 5 seconds.
- Remotes and wall switches: every new value is a press for your scenes ("Simple appui" a click, "Double appui" a double click, "Appui long" a long press…), even the same button twice in a row, as long as the presses are a read apart.
- Lists of values: a command always sends one of the values eedomus allows for the peripheral: a dimmer whose list has 10 % steps goes to the nearest step, a setpoint to the nearest temperature of its list.
- A new or renamed peripheral shows up within 15 minutes, at once with the Scan button of the Discovery tab.
- Transport badge: "local" through the box, "cloud" through eedomus, with an orange dot on the fallback way; "unreachable" when nothing answers, or when the box itself has lost the module ("Non joignable" in eedomus).
- Door sensors: eedomus says Fermé / Ouvert, Gladys 1 for closed and 0 for open; the integration converts.
Troubleshooting
| Status message | What to do |
|---|---|
| eedomus refused the API credentials | Check the API user and secret (Configuration → Mon compte → Identifiants API), not the account. |
| The eedomus box (…) is unreachable | Check its IP address, seen from the Gladys machine (not localhost). Is the box on? |
| Connected through the eedomus cloud: the box … | The box does not answer on the network: check its address; the cloud keeps things working. |
| The eedomus cloud is unreachable | Check the internet access of the Gladys machine, or set the box address. |
| eedomus answered with an error | The message of the box says why (an unknown peripheral, a value it does not allow…). |
The logs of the integration (Gladys, integration page) give the details. They never contain the API secret.
Privacy
With the local connection, everything stays on your network: the integration only talks to your box. The eedomus cloud (api.eedomus.com) is used only when the box does not answer, or when you chose it. The API secret is stored as a secret by Gladys and never written to the logs.
Configuration settings
These are the settings eedomus bridge asks for in its configuration screen in Gladys.
| Setting | Type | Required | Description |
|---|---|---|---|
| Your eedomus peripherals in Gladys | section | No | Every peripheral of your eedomus box is offered in the Discovery tab: lamps and dimmers, plugs, shutters, pilot wire heating, setpoints, motion, door, smoke and flood sensors, temperature, humidity, luminosity, power and energy, remotes. The values follow the box every few seconds and Gladys controls the peripherals through the box, which keeps running: migrate at your pace, or use both side by side. The integration talks to the box on your network (its local API), and through the eedomus cloud when the box does not answer. Unofficial, not affiliated with Connected Object. |
| IP address of the eedomus box | string | No | Its address on your network, seen from the Gladys machine (your internet router lists the devices of your network). Leave empty to go through the eedomus cloud only. |
| API user | string | Yes | On secure.eedomus.com: Configuration → Mon compte → Identifiants API. eedomus sends them by email. They are not the ones of your eedomus account. |
| API secret | secret | Yes | |
| Interval between two reads of the values (s) | number | No | Gladys reads the values of the devices you added at this pace, in one request to the box. Through the eedomus cloud, at most once a minute. |
How to install eedomus bridge in Gladys
- In Gladys, open Integrations: eedomus bridge appears in the catalog, next to the native integrations, with a community badge.
- Click Install. Gladys pulls the Docker image (
ghcr.io/lm1lc3n7/gladys-eedomus:0.1.1), starts it in a sandbox isolated from the core, and generates the integration's interface (devices, discovery and configuration). - Open the Configuration screen of the integration, fill in the settings, and save.
- You can also install it directly from its repository URL: https://github.com/LM1LC3N7/gladys-eedomus.
eedomus bridge requires Gladys >=5.1.0. The catalog inside Gladys refreshes every hour, so a new version becomes available at most one hour after its release.
Not running Gladys yet? It is free and open source: follow the installation guide to get started.
About external integrations
eedomus bridge is an external integration: a community integration packaged as a Docker container and published on GitHub, that Gladys installs in one click and runs in a sandbox isolated from its core. It is published and maintained by LM1LC3N7, not by the Gladys core team.
- Browse all integrations, native and community
- Build and publish your own external integration
- Source code on GitHub — source of this documentation