Actions and triggers
Indigo’s usual controls
Lights, plugs, blinds, locks and radiator valves answer Indigo’s standard controls wherever you use them — the device list, a control page, a schedule, a trigger or an action group:
- Lights — Turn On, Turn Off, Toggle, Set Brightness, Brighten By and Dim By, and on bulbs that have them, colour and white temperature.
- Plugs and switches — Turn On, Turn Off and Toggle.
- Groups — the same as a light or a switch, for every member at once.
- Blinds — Turn On opens, Turn Off closes, and Set Brightness sets how far open, from 0 (closed) to 100 (open).
- Locks — lock and unlock.
- Radiator valves — set the heat setpoint, raise or lower it, and change the mode to heat, automatic or off.
Send Status Request asks zigbee2mqtt to send the device’s latest state again. A repeater takes no commands other than this one.
The plugin’s own actions
These are under Device Actions when you add an action.
| Action | What it does |
|---|---|
| Set Color Temperature | For a light that can change its shade of white. Set Color Temperature (Kelvin) — about 2700 for a warm white, 4000 for a neutral white, 6500 for a cold daylight white. It switches the light on if it is off. |
| Set Brightness / Position | For a light, sets its brightness from 0 to 100%, where 0 switches it off. For a blind, sets how far open it is. |
| Set Cover Position | For a blind, sets how far open it is, from 0 (fully closed) to 100 (fully open). |
| Refresh Device State | Asks zigbee2mqtt to fetch the device’s latest state. |
| Publish Custom Payload | Sends a device a setting, or anything else, in the form zigbee2mqtt understands, for anything the other actions do not cover — see below. |
| Update Device Firmware | Starts a firmware update on the device you choose, if one is waiting — now, or the next time the device asks for one, which suits a battery device. It does nothing on a device with no update waiting — see Firmware updates. |
| Cancel Device Firmware Update | Cancels a scheduled update, or stops one that is installing. |
| Stop Blind | Stops a blind where it is, part way up or down. |
| Store Zigbee Scene | For a group or a light. Saves what the lights are doing right now — on or off, brightness and colour — as a scene, in each light’s own memory. Choose A new scene and give it a name, or choose an existing scene to replace it. |
| Recall Zigbee Scene | Puts every light in the group back as the scene stored it, all at the same moment. |
| Remove Zigbee Scene | Deletes a stored scene from the lights. |
| Fade Light to Brightness | Changes a light to the brightness you set, gradually, over the number of seconds you set. 0% fades it off. The bulb does the fading itself; one that cannot fade simply changes at once. |
| Set Up Zigbee Device Again | Asks zigbee2mqtt to run the device’s setup again, as it does when a device first pairs. It is the usual cure for a device that has stopped reporting. A battery device must be awake: press its button or set off its sensor first. |
These are under the plugin’s own name, not Device Actions, because they act on zigbee2mqtt itself:
| Action | What it does |
|---|---|
| Back Up zigbee2mqtt | Saves zigbee2mqtt’s settings and list of devices to the backup folder set in the plugin’s Configure window, for one zigbee2mqtt or all of them. Run it from a schedule once a week, say. See Settings. |
| Report Zigbee Network Map | Writes the network map report to the log — see The plugin menu. |
| Check zigbee2mqtt for Missing Routers | Asks zigbee2mqtt whether any router it knows about has stopped answering, and writes the answer to the log and the coordinator device. |
| Restart zigbee2mqtt | Restarts the zigbee2mqtt you choose. Every device on it stops answering for about half a minute. With the Zigbee2MQTT Bridge Needs a Restart trigger, it can restart zigbee2mqtt in the night after you change one of its settings. |
Zigbee scenes
A Zigbee scene is kept in the lights themselves, so recalling one is a single message and every light changes at once, however many are in the group. To make one, set the lights how you want them, then run Store Zigbee Scene once — from an action group, say. After that, Recall Zigbee Scene brings it back from a schedule, a trigger or a control page.
The scenes listed are the ones zigbee2mqtt says are stored, so a new one appears a moment after you store it. A group device’s Scenes state lists them too.
Publish Custom Payload
Every Zigbee device has settings zigbee2mqtt can change — a sensor’s sensitivity, the brightness of a plug’s indicator light, a child lock. zigbee2mqtt’s web page shows them under each device, with their names. This action sends one or more of them.
Type the settings into JSON payload, written the way zigbee2mqtt names them, in curly brackets, such as:
{"motion_sensitivity": "high"}
The action window checks the text is in the right form when you click Save, so a mistake shows there rather than when the action runs.
A battery device only listens while it is awake, so a setting sent to a sleeping sensor may not arrive. Pressing its button, or setting off its motion sensor, usually wakes it. For a setting you want kept, the Device Settings section of the device’s own settings window is the better choice, because it puts the setting back whenever the device forgets it — see Settings.
Running something on a button press
- Create a new trigger and set its type to Zigbee2MQTT Bridge Event, then Zigbee Button Pressed.
- Choose the device, and the press — single, double, hold and so on, or Any press. The presses listed are the ones zigbee2mqtt says that device can send.
It runs on every press, even the same press twice in a row. It works for wireless buttons and for wall switches that send presses as well as switching a light.
Before version 2.13.0 the way to do this was a Device State Changed trigger on the button’s Button Action or Press Count. Those triggers still work, but a trigger on Button Action runs only when the kind of press changes, so pressing the same way twice runs it once.
The plugin’s triggers
These are under Zigbee2MQTT Bridge when you create a new trigger. Apart from Zigbee Button Pressed, none of them needs setting up — each runs for any device on any zigbee2mqtt you connect.
| Trigger | When it runs |
|---|---|
| Zigbee Device Joined the Network | A new device joins. |
| Zigbee Device Left the Network | A device leaves the network. |
| Zigbee Device Announced Itself | A device says hello after a battery change, a power cut or a restart. This happens now and then without anything being wrong. |
| Zigbee Device Interview Failed | zigbee2mqtt could not finish setting up a newly paired device. |
| Zigbee Device Interview Succeeded | zigbee2mqtt finished setting up a newly paired device. |
| Zigbee Device Rejoined (leave count rose) | zigbee2mqtt’s health report shows a device dropped off the network and joined again. |
| Zigbee Device Changed Network Address | zigbee2mqtt’s health report shows a device took a new place in the network. |
| Zigbee Device Firmware Update Available | A device has a firmware update waiting. It runs once when the update appears, not again while it waits. |
| Zigbee Device Firmware Update Finished | A firmware update has finished and the device is running the new version. |
| Zigbee Device Firmware Update Failed | A firmware update ended with the device still on the old version. |
| Zigbee2MQTT Bridge Went Offline | zigbee2mqtt itself stops. |
| Zigbee2MQTT Bridge Came Online | zigbee2mqtt comes back after going offline. |
| Zigbee2MQTT Bridge Needs a Restart | zigbee2mqtt says it needs restarting for a setting to take effect. |
| Number of Offline Zigbee Devices Changed | A device has gone offline, or come back. The coordinator device’s Offline Devices says how many are offline now, and Offline Device Names which ones. |
| Zigbee Button Pressed | A button press — see above. Unlike the others, this one asks which device and which press. |
The two health-report triggers can run up to ten minutes after the event, because zigbee2mqtt sends its health report every ten minutes.
Knowing which device it was
A trigger does not carry the device’s name itself, so the plugin writes it onto the Z2M Coordinator device first: Last Event says what happened, Last Event Device names the device, and Last Event Time says when. If you have made the coordinator device with Plugins → Zigbee2MQTT Bridge → Create Coordinator Devices, your trigger’s actions can read the device name from there — to put it in a notification, for example.