Skip to main content

Broadlink community integration, free and open source

Broadlink integration for Gladys Assistant

Local control of Broadlink devices: RM remotes (IR/RF), SP plugs, MP1 strips, A1 sensors.

Control your Broadlink devices locally from Gladys: no Broadlink account, no cloud. The integration talks directly to the devices on your network (UDP, port 80).

Supported devices​

FamilyModels (examples)In Gladys
Universal remotesRM mini 3, RM pro / pro+, RM4 mini, RM4C, RM4 proOne button per IR/RF code + temp. / humidity
Smart plugsSP1, SP2, SP mini, SP3, SP3S, SP4L, SP4M, MCB1…On/off (+ power on SP2S, SP3S, SP4B)
Power stripMP14 switchable outlets
Environment sensorA1Temperature, humidity
  • The temperature / humidity of an RM4 only shows up when its sensor cable (HTS2) is plugged in. The RM pro (RM2) has a built-in temperature sensor.
  • Radio (RF 433/315 MHz) learning is only available on the pro models (RM pro, RM4 pro).

Before you start​

Gladys 5.1.0 or newer is required.

  1. Set up your devices on your Wi-Fi with the Broadlink app.
  2. In the app, open the settings of each device and turn "Lock device" off. A locked device refuses every local command: the integration ignores it.
  3. Recommended: give each device a fixed IP (DHCP reservation on your router). Without one, when a device stops answering the integration scans the network again on its own (at most once every 10 minutes) to find its new address.

Add the devices​

  1. Open the Discover tab of the integration and press Scan.
  2. Gladys sends a discovery request (UDP broadcast, port 80) on your local network; the devices found show up.
  3. Click Add to Gladys on the ones you want.

Every device shows a local badge when it answers, or unreachable when it stops answering (unplugged, IP changed…).

A device does not show up? It is probably on another network / VLAN, or the broadcast is filtered. In the Configuration tab, type its IP address in Device IP addresses (several addresses separated by commas), save, then scan again.

Remote codes (IR / RF)​

Every code saved on an RM remote becomes a push button of the device in Gladys: each press sends the code once. Use it on the dashboard and in scenes ("Set device value" action).

Upgrading from 1.2.0 or earlier: codes used to be published as on/off switches, so Gladys' "Turn On the Switches" scene action and the voice assistants could send any code of the remote (Vol+, for instance). Open the Discover tab and click Update on each remote: its codes become push buttons. They keep their identity, so the dashboards and scenes using them keep working.

In scenes, the "Send a Broadlink code" action also sends a code by its name (remote + code name, with an optional repeat count), without going through a button.

The actions live in the Configuration tab:

  • Learn a remote code
    • Pick the remote, give a name (e.g. "TV on"), then choose Infrared or Radio.
    • Infrared: click the button, then within 30 seconds press the key of your original remote, pointed at the Broadlink.
    • Radio: hold the key until the frequency is found (up to 30 s), release it, then press it once briefly.
  • Import a code: paste an existing Broadlink code, in base64 (Home Assistant format, starts with JgB) or hexadecimal.
  • Send a code: test a code by its name.
  • List saved codes / Delete a code.
  • List found devices: name, model, IP and MAC of every device (handy for troubleshooting).

After learning, importing or deleting a code, open the Discover tab and click Update on the remote so the button appears (or disappears).

Codes are stored in the data volume of the integration (/data/codes.json): they survive updates.

Settings​

  • Device IP addresses: only when the scan does not find a device.
  • Refresh interval: how often plug states and sensors are read (60 s by default, 10 to 3600 s). Gladys keeps the polling rhythm a device was added with (every 10, 15, 30 or 60 s), and the integration cannot change it afterwards. Raising the interval always applies; lowering it below 60 s (or below the value in force when the device was added) only applies to devices added afterwards: delete the device in Gladys and add it again from the Discover tab to apply it.

Troubleshooting​

  • A device is not found: check it answers ping and sits on the same network as Gladys, or type its IP in the configuration.
  • "Authentication failed" / the device ignores commands: the device is locked in the Broadlink app, unlock it.
  • An IR code is not captured: bring the original remote closer (5–10 cm) and aim at the top of the Broadlink.
  • Logs: read the integration logs in its Logs tab in Gladys (or docker logs), with LOG_LEVEL=debug for details.

Configuration settings​

These are the settings Broadlink asks for in its configuration screen in Gladys.

SettingTypeRequiredDescription
Getting startedsectionNoSet up your devices on your Wi-Fi with the Broadlink app first, and make sure they are NOT locked (device settings > Lock device: off). Then run a scan from the Discover tab. Everything stays on your local network: no Broadlink account is needed here.
Device IP addresses (optional)stringNoOnly if the scan does not find a device (other VLAN, broadcast filtered...): its IP addresses, separated by commas. Give your devices a fixed IP (DHCP reservation).
Refresh interval (s)numberNoHow often plug states and sensors are read, in seconds.
  1. In Gladys, open Integrations: Broadlink appears in the catalog, next to the native integrations, with a community badge.
  2. Click Install. Gladys pulls the Docker image (ghcr.io/prohand/gladys-broadlink:1.4.1), starts it in a sandbox isolated from the core, and generates the integration's interface (devices, discovery and configuration).
  3. Open the Configuration screen of the integration, fill in the settings, and save.
  4. You can also install it directly from its repository URL: https://github.com/prohand/gladys-broadlink.

Broadlink 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​

Broadlink 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 prohand, not by the Gladys core team.

Subscribe to the Gladys Assistant newsletter

A few emails per month about new releases and project news. Sent by Pierre-Gilles Leymarie, founder of the project. Unsubscribe anytime 🙂