Howto use zigbee2mqtt with openHAB, removing proprietary bridges / gateways

Tags: #<Tag:0x00007f51ef9e7120> #<Tag:0x00007f51ef9e6fe0> #<Tag:0x00007f51ef9e6ea0>

(Fraser Howell) #82

I thought I would share this in case anybody else finds it useful.

I have managed to get zigbee2MQTT working with an Innr and Ikea Tradfri bulb using the latest MQTT binding without using a javescript transformation, just a JSON one for the incoming message.

Things file.

Bridge mqtt:broker:myUnsecureBroker [ host="", secure=false ]
    Thing topic zigbeeMQTT "Zigbee2mqtt" {
        Type switch : permitJoin         [ commandTopic="zigbee2mqtt/bridge/config/permit_join", on="true", off="false" ]
        Type dimmer : Test_Lamp "Test Lamp" [ stateTopic="zigbee2mqtt/Her_Lamp", commandTopic="zigbee2mqtt/Her_Lamp/set", min=1, max=254, step=1, transformationPattern="JSONPATH:$.brightness", formatBeforePublish="{   \"brightness\": %s }" ]
        //Main Study Lights
        Type dimmer : Main_Study_1 "Test Main Study 1" [ stateTopic="zigbee2mqtt/Main_Study_1", commandTopic="zigbee2mqtt/Main_Study_1/set", min=1, max=254, step=1, transformationPattern="JSONPATH:$.brightness", formatBeforePublish="{   \"brightness\": %s }" ]
        Type dimmer : Main_Study_2 "Test Main Study 2" [ stateTopic="zigbee2mqtt/Main_Study_2", commandTopic="zigbee2mqtt/Main_Study_2/set", min=1, max=254, step=1, transformationPattern="JSONPATH:$.brightness", formatBeforePublish="{   \"brightness\": %s }" ]
        Type dimmer : Main_Study_3 "Test Main Study 3" [ stateTopic="zigbee2mqtt/Main_Study_3", commandTopic="zigbee2mqtt/Main_Study_3/set", min=1, max=254, step=1, transformationPattern="JSONPATH:$.brightness", formatBeforePublish="{   \"brightness\": %s }" ]

The ‘Min’ value is set to 1 as that’s what my bulbs report as off, ‘Max’ is 254 so the value can be between 1-255.

The ‘transformationPattern’ selects just the ‘Brightness’ value from the incoming JSON message. The ‘formatBeforePublish’ works to format the outgoing message into JSON format.

I have tested it with a couple of my lights and I am able to control them fine using Basic UI, HabPanel and through my Alexa.

(Fraser Howell) #83

@DarkZark, I’m no expert but this is how I am doing similar with a Xiaomi Button


String CUBE_ACTION "Cube Action" {mqtt="<[broker:zigbee2mqtt/mqtt_aqara_cube:state:JSONPATH($.action)]"}

Then you can make a rule that will trigger when CUBE_ACTION is updated.

rule "Cube Action"
    Item CUBE_ACTION recieved update
    switch(CUBE_ACTION) {
        case "rotate_right":{
            //Do Something
        case "shake": {
            //Do Something Else

You can add more case entries for each of the different actions the cube reports.

In terms of the error you are seeing about a motion sensor, can you confirm you have a file called “” in you transform folder?

(Stefan Zieren) #84

I have recently installed zigbee2mqtt with the help of this thread and I’m quite pleased - thanks to all of you.
But now I’m facing a problem where I need help.
I added my Xiaomi Mijja smoke sensors to zigbee2mqtt and that works quite well.
I added these to oh2:

Contact XIAOMI_SMOKE_EG1_STATE “Smoke [%s]” {mqtt="<[broker:zigbee2mqtt/xyz:state:JSONPATH($.smoke)]"}
Contact XIAOMI_SMOKE_EG_STATE “Smoke [%s]” {mqtt="<[broker:zigbee2mqtt/xyz:state:JS(getZigbeeSmoke.js)]" }
Number XIAOMI_SMOKE_EG_VOLTAGE “Smoke Volt [%d mV]” {mqtt="<[broker:zigbee2mqtt/xyz:state:JSONPATH($.voltage)]"}
Number XIAOMI_SMOKE_EG_BATTERY “Smoke BAT [%.1f %%]” {mqtt="<[broker:zigbee2mqtt/xyz:state:JSONPATH($.battery)]"}
Number XIAOMI_SMOKE_EG_LINK “Smoke Link [%d]” {mqtt="<[broker:zigbee2mqtt/xyz:state:JSONPATH($.linkquality)]"}

Both of the smoke state items do not work.
When i press the button on the smoke sensor i receive the following warning in the log:

2019-02-24 11:09:34.890 [WARN ] [] - given new state is NULL, couldn’t post update for ‘XIAOMI_SMOKE_EG1_STATE’
2019-02-24 11:09:35.426 [WARN ] [] - given new state is NULL, couldn’t post update for ‘XIAOMI_SMOKE_EG_STATE’

I have other json transformations that work quite well - so i guess it is not the transformation setup anyway this is the getZigbeeSmoke.js

var result = “”;
var json = JSON.parse(x);
if (json.smoke)
return result;

I’m really stuck here - so any help is highly appreciated

(Joachim Boeddeker) #85

Not that I know of. But I also did not follow the development closely. I am currently at the limit, for each device I add, another one does not work anymore.

(Joachim Boeddeker) #86

Could you show the message sent? Without it is impossible to help. It looks like the message does not contain that smoke attribute.

(Stefan Zieren) #87

From the zigbee2mqtt log:

Feb 28 08:19:33 raspberrypi npm[400]: zigbee2mqtt:info 2019-2-28 08:19:33 MQTT publish: topic ‘zigbee2mqtt/0x…’, payload ‘{“battery”:100,“voltage”:3105,“linkquality”:35,“smoke”:false}’

(Joachim Boeddeker) #88

Ahhh… Now I see. If you use a Contact item you need to use OPEN and CLOSED as states. If you like to use ON/OFF the item must be defined as a Switch.

(Stefan Zieren) #89

Ahhh … perfect! Thank you very much !

(Fraser Howell) #90

Just thought I would post this from the Zigbee2MQTT FAQ regarding device limits as it seems to confuse quite a few people, including myself.

I read that zigbee2mqtt has a limit of 15 devices, is this true?

Definitely not! The default zigbee2mqtt firmware indeed supports 15 devices connected directly to the coordinator. However, by having routers in your network the network size can be extended. Probably all AC powered devices e.g. bulbs serve as a router, you can even use another CC2530/CC2531 as a router (which has a limit of 21 devices). Various zigbee2mqtt users have reported that networks of 40+ nodes work without problems. Don’t want to buy a router? No problem! In that case an alternative firmware can be used which supported 44 devices directly connected to the coordinator.


When using the default coordinator firmware + 2 CC2531 routers your device limit will be:

  • Coordinator: 15 - 2 routers = 13
  • Router 1: 21
  • Router 2: 21
  • Device limit of 55 devices

Also there has been mention about using instances of Zigbee2MQTT on several Raspberry Pi’s. The only way this would work would be to have each Pi running their own separate Zigbee network. I.e you would have an Upstairs network running from one Pi and a downstairs network running from the other Pi It’s not possible to have more than one coordinator(zigbee adaptor plugged into a Pi) per network .

As far as I can see there is no benefit of this whatsoever as all your Zigbee devices are designed to connect in a mesh network in increase single range. If you have too many end devices (Buttons, sensors) and not enough routers (Bulbs, sockets) it would be easier to follow the instructions in the Zigbee2MQTT documentation to make a router from a CC2530 or CC2531 than it would be to run multiple networks.

Hope this info can be of help.

(EdgarM) #91

Hi there,

I have successfully configured all my Aquara Temperature Sensors, but am not able to do the same for the door contacts.

Things File
Bridge mqtt:broker:myMQTTBroker [ host="pinky", secure=false]
    Thing topic zigbeeMQTT "Zigbee2mqtt" {
        Type switch : permitJoin         [ commandTopic="zigbee2mqtt/bridge/config/permit_join", on="true", off="false" ]
        Type string : state              [ stateTopic="zigbee2mqtt/bridge/state" ]
        //Type string : logType            [ stateTopic="zigbee2mqtt/bridge/log",  transformationPattern="JSONPATH:$.type" ]
        //Type string : logMessage         [ stateTopic="zigbee2mqtt/bridge/log",  transformationPattern="JSONPATH:$.message" ]

    Thing topic zigbeeSensorWZ "Wohnzimmer Sensor" {
        Type number : temperature        [ stateTopic="zigbee2mqtt/Temperatur_WZ",  transformationPattern="JSONPATH:$.temperature" ]
        Type number : humidity           [ stateTopic="zigbee2mqtt/Temperatur_WZ",  transformationPattern="JSONPATH:$.humidity" ]
        Type number : pressure           [ stateTopic="zigbee2mqtt/Temperatur_WZ",  transformationPattern="JSONPATH:$.pressure" ]
        Type number : voltage            [ stateTopic="zigbee2mqtt/Temperatur_WZ",  transformationPattern="JSONPATH:$.voltage" ]
        Type number : battery            [ stateTopic="zigbee2mqtt/Temperatur_WZ",  transformationPattern="JSONPATH:$.battery" ]
        Type number : linkquality        [ stateTopic="zigbee2mqtt/Temperatur_WZ",  transformationPattern="JSONPATH:$.linkquality" ]

    Thing topic zigbeeBK "Balkontuer" {
            Type string : status  
                [ commandTopic="zigbee2mqtt/Fenstersensor_BK", transformationPattern="JSONPATH:$.contact" ]
            Type number : voltage 
                [ commandTopic="zigbee2mqtt/Fenstersensor_BK", transformationPattern="JSONPATH:$.voltage" ]
            Type number : battery 
                [ commandTopic="zigbee2mqtt/Fenstersensor_BK", transformationPattern="JSONPATH:$.battery" ]
            Type number : linkquality 
                [ commandTopic="zigbee2mqtt/Fenstersensor_BK", transformationPattern="JSONPATH:$.linkquality" ]


Items file

Number ZigbeeSensorWZTemperature  "Sensor WZ Temperature [%.1f °C]"  <temperature>  (gZigbeeSensor) { channel="mqtt:topic:myMQTTBroker:zigbeeSensorWZ:temperature" }
Number ZigbeeSensorWZHumidity     "Sensor WZ Humidity [%.1f %%]"     <humidity>     (gZigbeeSensor) { channel="mqtt:topic:myMQTTBroker:zigbeeSensorWZ:humidity" }
Number ZigbeeSensorWZPressure     "Sensor WZ Pressure  [%d hPa]"     <pressure>     (gZigbeeSensor) { channel="mqtt:topic:myMQTTBroker:zigbeeSensorWZ:pressure" }
Number ZigbeeSensorWZLinkQuality  "Sensor WZ Link Quality [%d]"      <network>      (gZigbeeSensor) { channel="mqtt:topic:myMQTTBroker:zigbeeSensorWZ:linkquality" }
Number ZigbeeSensorWZVoltage      "Sensor WZ Voltage [%d mV]"        <energy>       (gZigbeeSensor) { channel="mqtt:topic:myMQTTBroker:zigbeeSensorWZ:voltage" }
Number ZigbeeSensorWZBattery      "Sensor WZ Battery [%.1f %%]"      <battery>      (gZigbeeSensor) { channel="mqtt:topic:myMQTTBroker:zigbeeSensorWZ:battery" }

String ZigbeeBKContact      "Balkontür Status [%s]"      <switch>      (gZigbeeSensor) 
    { channel="mqtt:topic:myMQTTBroker:zigbeeBK:status" }
Number ZigbeeBKLinkQuality  "Balkontür Link Quality [%d]"      <network>      (gZigbeeSensor) 
    { channel="mqtt:topic:myMQTTBroker:zigbeeBK:linkquality" }
Number ZigbeeBKVoltage      "Balkontür Voltage [%d mV]"        <energy>       (gZigbeeSensor) 
    { channel="mqtt:topic:myMQTTBroker:zigbeeBK:voltage" }
Number ZigbeeBKBattery      "Balkontür Battery [%.1f %%]"      <battery>      (gZigbeeSensor) 
    { channel="mqtt:topic:myMQTTBroker:zigbeeBK:battery" }

Does anybody find my error maybe?


(EdgarM) #92

I found the Problem, I accidently wrote commandTopic instead of stateTopic.


(M) #93

Thank you gforce!

I will try that rule! Looks like what I was searching for.

The file HM… I do not have in my transformation folder. What should I do?

(Fraser Howell) #94

In your post above where you set up the item MD_MOTION you then set the following:

"MD Motion [MAP(]"

The section [MAP(] is telling OpenHAB you want to transform the value that is returned based on a file map transformation file.

If you haven’t setup that file I am guessing you have copied it from somebody else’s example?

You can find more details of the Map transformation service here

Because you are using the Javascript transformation I don’t believe there is any need for a Map transformation.

Set your item up like this.

 Switch MD_MOTION "MD Motion"  <motion> {mqtt="<[broker:zigbee/MD:state:JS(getZigbeeOccupancy2Switch.js)]" }

(Joachim Boeddeker) #95

Your assumption is wrong.
The two transformations are on purpose. The JS transformation transforms the values into standard openhab Switch/Contact logic. The map transformation transforms the given Switch or Contact to human readable value. I use the same map transformation for motion detectors of all kind.

(Fraser Howell) #96

I see. Not had a need to use a Map transformation myself yet.


(M) #97

And what do I need to do in order to fix that error? the map transformations are activated in paper ui…

(Joachim Boeddeker) #98

Just enter the file, here is my contents. It’s german “keine Bewegung”=“no motion detected”, “Bewegung”=“motion detected”, “unbekannt”=“unknown”

0=keine Bewegung
CLOSED=keine Bewegung
OFF=keine Bewegung

(Martin Köhler) #99

I have a problem with the min/max/step value (2.4)

For example, the light is set to 254 then the item shows correctly as 100%
If I change the item via the slider to 50 it sends 50 to the lamp (instead of 127) and as result change the item to 19,68…% (50 divided by 254). What I’m doing wrong?

(Fraser Howell) #100

Can you post the section from your thing file where you have configured it?

I must admit I have actually gone back to the V1 binding so I could use a slight different Javascript transformation that changes the ‘state’ to off if the brightness is set to 0.

It can also deal with On and Off commands so that my Amazon Alexa can fully control the light.

(Martin Köhler) #101

I found another solution, it was aboutt he min/max value using the dimmer item of the mqtt2 binding. I might try it again and will post a detailed information.