Setting up Xiaomi Mi SmartPlug (Zigbee) with OpenHAB 3

Setup, Configuration and Use Beginners
, ,
3

I found a way to couple the socket to OpenHAB 3 via a ZigBee stick and the ZigBee2MQTT binding and to use all channels.
To achieve this, I did the following
(Note: These steps are working, but for steps 5 to 10 there is an easier way - look at the post from hafniumzinc or for an even more easier solution at the post from sihui):

  1. Installation of the MQTT broker Mosquitto. This is described in Install Mosquitto Broker Raspberry Pi | Random Nerd Tutorials.
  2. Installation of the ZigBee2MQTT service. This is very well described in | Zigbee2MQTT.
  3. Installation of the add-on “MQTT Binding”. To do this, click on the “Bindings” link in OH3 in the “Administration” area under “Settings”, “Add-ons”. Then click on the blue “+” button at the bottom right and install the “MQTT Binding” add-on.
4. Pairing of the socket and assigning of a 'friendly name'.
  • To pair the socket, you may have first to change the entry “permit_join:” in the file “/opt/zigbee2mqtt/data/configuration.yaml”. You must set its value from false to true. You must restart the service to reload the configuration!
  • Then plug in the socket and min. press the button for 5 seconds (until the LED flashes blue).
  • If the pairing was successful, an entry with the substring “Successfully interviewed” can be found in the log. In addition, the device is attached to the file /opt/zigbee2mqtt/data/configuration.yaml. For me it looked like this:

permit_join: true
:
devices:
‘0x04cf8cdf3c777242’:
friendly_name: ‘0x04cf8cdf3c777242’

  • Change the friendly name, add a retain statement and change the permit_join value to false. The file should now looks like the following:

permit_join: false
:
devices:
‘0x04cf8cdf3c777242’:
friendly_name: ‘MobileSocketMi1’
retain: false // I don’t see why we should save messages, so disable this

  • With that the topic for the device in the MQTT broker has now the name MobileSocketMi1. This will be needed for the configuration of the thing in OH.
5. Translation scripts are needed in OH3. For that two add-ons must be installed
  1. In the “Administration” area click on “Settings”.
  • Click on “Transformations” on the page under “Add-ons”.
  • Click on the blue “+” button at the bottom right.
  • Install the add-ons “Javascript Transformation” and "JSONPath Transformation.
  1. The translation scripts must be in the directory /etc/openhab/transform/js
    created (possibly create the subdirectory js beforehand).
  2. The first script is used for translation of the values true and false of the channel
    “consumer_connected” to the string values “ON” and “OFF”, used by OH. This
    happens with the help of the file “consumer_connected_Bool2Switch.js”:
8. Content of consumer_connected_Bool2Switch.js 
(function(x){

    var result = "";
 
    var json = JSON.parse(x);  
    if (json.consumer_connected) 
    {
        result="ON";
    } 
    else 
    {
        result="OFF";
    }
    return result;
    
})(input)
  1. The second script is required to be able to switch the socket. It
    transforms the OpenHAB values 0 and 1 into the strings “ON” and “OFF”. This
    happens with the help of the file “set_Number2Switch.js”.
10. Content of set_Number2Switch.js 
// Transforms an input value of 0 or 1 to "OFF" or "ON" respectively and formats as JSON
  (function(x) {
    var result = new Object();
    if (x == 1) {
        result.state = "ON"
    }
    else if (x == 0) {
        result.state = "OFF"
    }
    else {
        result.state = x
    }
    return JSON.stringify(result);
  })(input)
  1. Definition of the plug thing with all channels. For this a text file (eg zigbee2mqtt.things) must be created. In my installation this file must be created in /etc/openhab/things.
12. Content of zigbee2mqtt.things

Bridge mqtt:broker:mosquitto [host="zigbee2mqtt", port=1883, secure=false, clientID="openHAB3"] { Thing topic MobileSocketMi1 "MobileSocket, Mi, 1: ZigBee2MQTT" @ "Mobil at Home" { Channels: Type switch : consumer_connected "Connected" [ stateTopic="zigbee2mqtt/MobileSocketMi1", transformationPattern="JS:js/consumer_connected_Bool2Switch.js"] Type number : consumption "Energy" [ stateTopic="zigbee2mqtt/MobileSocketMi1", transformationPattern="JSONPATH:$.consumption"] Type number : current "Current" [ stateTopic="zigbee2mqtt/MobileSocketMi1", transformationPattern="JSONPATH:$.current"] Type number : link_quality "Link Quality" [ stateTopic="zigbee2mqtt/MobileSocketMi1", transformationPattern="JSONPATH:$.linkquality"] Type number : power "Power" [ stateTopic="zigbee2mqtt/MobileSocketMi1", transformationPattern="JSONPATH:$.power"] Type switch : state "Status" [ stateTopic="zigbee2mqtt/MobileSocketMi1", transformationPattern="JSONPATH:$.state", commandTopic="zigbee2mqtt/MobileSocketMi1/set", transformationPatternOut="JS:js/set_Number2Switch.js"] Type number : temperature "Temperature" [ stateTopic="zigbee2mqtt/MobileSocketMi1", transformationPattern="JSONPATH:$.temperature"] Type number : voltage "Voltage" [ stateTopic="zigbee2mqtt/MobileSocketMi1", transformationPattern="JSONPATH:$.voltage"] } }

  1. After restarting all services, the socket with all channels should be visible in OH3 and can be bound to items in the normal way.
2 Likes