Jeedom bridge smart home integration, free and open source
The equipment of your Jeedom box in Gladys: lights, plugs, shutters, thermostats, sensors…
Published by LM1LC3N7
- Devices
- Version 0.1.2
- Requires Gladys >=5.1.0
- ★ 0
This integration connects Gladys to your Jeedom box and offers every Jeedom equipment in the Discovery tab of Gladys: lights, plugs, shutters, thermostats, locks, sensors. Once an equipment is added, its states follow Jeedom within seconds, and Gladys controls it through Jeedom, which keeps running. Move to Gladys at your own pace, room after room, or use both side by side. Unofficial, not affiliated with Jeedom.
Development version (0.1). Tested against the official Jeedom Docker image (Jeedom 4.6) with test equipment, not yet on many real boxes. Your feedback (and the generic types of your equipment) are welcome on the GitHub repository.
What you get
Gladys reads the generic type of each Jeedom command (the "Generic type" column of the advanced configuration of a command, set automatically by most plugins):
| Jeedom generic types | In Gladys |
|---|---|
| Light state / on / off / toggle, slider, brightness, color, color temperature | a light: on/off, brightness, color, color temperature |
| Plug, switch, pilot wire, fan, valve, irrigation state / on / off (+ slider) | a switch (and a dimmer) |
| Shutter state / up / down / stop / slider (and motorized windows) | a shutter: open, close, stop, position |
| Gate or garage open / close / toggle, gate or garage state | open / close buttons, an opening sensor |
| Lock state / open / close | a lock |
| Siren state / on / off | a siren |
| Thermostat setpoint, temperatures, humidity, state, mode list, lock | a thermostat: setpoint, temperature, heating state, mode list |
| Mode plugin, alarm mode | a list to pick the mode |
| Temperature, humidity, pressure, brightness, UV, CO₂, CO, noise, air quality, rain, wind, distance | the sensor of the right category |
| Presence, door, window, smoke, flood, water leak, sabotage, shock | motion, opening, smoke, leak, tamper, vibration sensors |
| Power, consumption, voltage, production | measurements of the plug, or of an energy meter |
| Battery, battery charging | the battery level |
Visible info commands without a generic type are offered too: a numeric one as a value (with its unit when Gladys knows it), a text one as a text. Hidden commands without a generic type, the "Do not take into account" commands and the action commands without a generic type are left out.
Each enabled and visible Jeedom equipment makes one Gladys device, named after the equipment and its room ("Lamp (Living room)"); the Jeedom room and plugin are kept in its parameters. Disabled or hidden equipment is left out.
Requirements
- Jeedom 4.x (Jeedom 3 names its rooms API differently and is not supported).
- The Gladys machine reaches the Jeedom box on the local network.
- The API access enabled in Jeedom: Settings → System → Configuration, API tab: the "API access" must not be disabled, and if it is limited to "white IP addresses", the address of the Gladys machine must be one of them.
Installation
- In Jeedom, Settings → System → Configuration, API tab: copy the API key (the core one, at the top). The API key of a Jeedom user works too: the rights of that user then apply.
- In Gladys, open the integration, Configuration:
- Address of Jeedom: the address you open Jeedom with, as seen from the
Gladys machine:
http://192.168.1.20,https://jeedom.lan, orhttp://host/jeedomwhen Jeedom lives in a sub-folder. Notlocalhost: the integration runs in its own container. - API key of Jeedom: paste it.
- Address of Jeedom: the address you open Jeedom with, as seen from the
Gladys machine:
- Click Test the connection: the Jeedom version, the number of equipments and commands, and the number of devices offered are shown.
- Open the Discovery tab and add the devices you want. Their values are sent as soon as they are added.
Options
- Verify the TLS certificate (https): on by default. Turn it off only for a box with a self-signed certificate on your local network.
- Interval between two reads of the Jeedom changes: 2 seconds by default (1 to 60). Gladys asks Jeedom what changed at this pace.
- Minimum interval between two readings of a sensor: 10 seconds by default (0 to 300). A power meter reporting every second is sent to Gladys at this pace. Switches, lights, motion and opening sensors are never delayed.
Good to know
- Jeedom stays in charge of the devices: Gladys sends its commands to the Jeedom commands, which drive the Z-Wave, Zigbee, EnOcean… devices. Keep Jeedom running.
- New equipment shows up in Discovery within 10 minutes, at once with the Scan button of the Discovery tab. Enabling, disabling, showing or hiding an equipment in Jeedom is followed within seconds.
- Transport badge: a device turns "unreachable" when Jeedom is unreachable, or when its "Online" command (generic type) says it is offline.
- Commands that ask for a confirmation or an access code in Jeedom are refused when sent from Gladys: the error is shown.
- A door sensor: Jeedom says 1 for open, Gladys 1 for closed; the integration converts. The "Invert" option of a binary command in Jeedom is honored.
- A command whose generic type is wrong or missing in Jeedom shows up as a plain value: fix its generic type in Jeedom (advanced configuration of the command, or Tools → Equipment types), then click Scan in Discovery.
Troubleshooting
| Status message | What to do |
|---|---|
| Jeedom refused the API key | Copy the key again (Settings → System → Configuration → API) and paste it in the configuration. |
| Jeedom refused the access | In Jeedom, check that the API access is enabled, and allows the address of the Gladys machine. |
| Jeedom is unreachable: connection refused / host unreachable | Check the address: the LAN IP address of the box, not localhost. Is the box on? |
| Jeedom is unreachable: HTTP 404 | Check the address. After several failed logins, Jeedom also bans the caller for a while (Settings → System → Configuration → Security, banned IPs). |
| certificate refused | A self-signed certificate: turn off "Verify the TLS certificate", or use http://. |
| redirected to … | Type the address Jeedom redirects to. |
The integration logs (Gladys, the integration page) give the details.
Privacy
Everything stays on your local network: the integration talks to your Jeedom box only. The API key is stored as a secret by Gladys and never written in the logs.
Configuration settings
These are the settings Jeedom bridge asks for in its configuration screen in Gladys.
| Setting | Type | Required | Description |
|---|---|---|---|
| Your Jeedom equipment in Gladys | section | No | Every enabled and visible equipment of your Jeedom box is offered in the Discovery tab: lights, plugs, shutters, thermostats, locks, sensors, read from the generic types of its commands. The states follow Jeedom within seconds and Gladys controls the equipment through Jeedom, which keeps running: migrate at your pace, or use both side by side. Type the address of the box as seen from the Gladys machine (its LAN IP address, not localhost) and the API key of Jeedom: Settings → System → Configuration, API tab, "API key", with the API access enabled. Unofficial, not affiliated with Jeedom. |
| Address of Jeedom | string | Yes | The address you open Jeedom with: http://192.168.1.20, https://jeedom.lan or http://host/jeedom. A bare IP address means http://. |
| API key of Jeedom | secret | Yes | Settings → System → Configuration, API tab: the "API key" (or the API key of a Jeedom user, whose rights then apply). |
| Verify the TLS certificate (https) | boolean | No | Turn off only for a box with a self-signed certificate on your local network. |
| Interval between two reads of the Jeedom changes (s) | number | No | Gladys asks Jeedom what changed at this pace: 2 seconds keeps the states close to real time. |
| Minimum interval between two readings of a sensor (s) | number | No | Some equipment reports every second: Gladys keeps the last reading at this pace. Switches, lights, motion and opening sensors are never delayed. |
How to install Jeedom bridge in Gladys
- In Gladys, open Integrations: Jeedom 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-jeedom:0.1.2), 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-jeedom.
Jeedom 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
Jeedom 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