zwayToMqtt.py

zwayToMqtt.py is intended to run as a service, it connects to [z-way-server] and pushes the defined devices to MQTT

A running z-way-server and a mqtt-broker (e.g: mosquitto) are required to use this deamon.

Usage

• install a broker like mosquitto

apt-get install mosquitto mosquitto-clients

• install software

apt-get install python-requests python-pip python-enum
pip install paho-mqtt

cd /usr/local/src

git clone https://github.com/dawys/zway-to-mqtt zwayToMqtt

cd zwayToMqtt

cp config.xml.sample config.xml

cp zway-to-mqtt.service /etc/systemd/system/

systemctl enable zway-to-mqtt.service

vi config.xml

systemctl start zway-to-mqtt.service

• edit config to your needs

<mqtt>
  <hostname>localhost</hostname>
  <port>1883</port>
  <username>username</username>
  <password>password</password>
</mqtt>

<zway>
  <hostname>localhost</hostname>
  <port>8083</port>
  <username>username</username>
  <password>password</password>
</zway>

• map your zway devices to topics

<mqtt>
  <topics>
    <topic id="2-1-38" property="switch" type="ON_OFF">diningRoom/light1Switch</topic>
    <topic id="2-1-38" property="dimmer" type="INTEGER">diningRoom/light1Dimmer</topic>
    <topic id="2-1-49-4" type="FLOAT">diningRoom/light1ElectricMeterWatt</topic>
    <topic id="12-0-128" type="INTEGER">basement/smokeDetectorBatteryLevel</topic>
  </topics>
</mqtt>

• edit cron jobs for your devices

<zway>
  <cron>
    <job id="2-*">*/5 * * * *</job>
    <job id="3-*">*/5 * * * *</job>
    <job id="5-*">*/5 * * * *</job>
    <job id="6-*">*/5 * * * *</job>
    <job id="12-*">0 12 * * *</job>
  </cron>
</zway>

Example

check if it is working

mosquitto_sub -h localhost -u username -P password -v -t '#'

zway/get/diningRoom/light1Switch ON
zway/get/diningRoom/light1Dimmer 46
zway/get/diningRoom/light1ElectricMeterWatt 22.1

if you want to set values

mosquitto_pub -h localhost -u username -P password -t zway/set/diningRoom/light1Switch -m OFF
mosquitto_pub -h localhost -u username -P password -t zway/get/diningRoom/light1Dimmer -m 10

if you want to init all devices

mosquitto_pub -h localhost -u username -P password -t zway/set/init -m true

if you are using openHAB2

Version 1.11.0

• install binding mqtt and edit services/mqtt.cfg
• define items

Item itemDiningRoomLight1Switch {mqtt=">[broker:zway/set/diningRoom/light1Switch:*:default], <[broker:zway/get/diningRoom/light1Switch:*:default], autoupdate="true"}
Item itemDiningRoomLight1Dimmer {mqtt=">[broker:zway/set/diningRoom/light1Dimmer:*:default], <[broker:zway/get/diningRoom/light1Dimmer:*:default], autoupdate="true"}
Item itemDiningRoomLight1ElectricMeterWatt {mqtt="<[broker:zway/get/diningRoom/light1ElectricMeterWatt:*:default]"}

Version 2.4.0

• install binding mqtt and edit things/mqtt.things

Bridge mqtt:broker:broker "Mosquitto MQTT Broker" @ "MQTT" [ 
  host = "localhost",
  secure = false,
  port = 1883,
  qos = 0,
  retain = false,
  clientid = "openhab2",
  keep_alive_time = 30000,
  reconnect_time = 60000,
  username = "",
  password = ""
]

{
  Thing mqtt:topic:thingDiningRoomLight1 "Diningroom Light 1" @ "MQTT" {
    Channels:
      Type switch:switch "Switch" [ 
        stateTopic = "zway/get/diningRoom/light1Switch", 
        commandTopic = "zway/set/diningRoom/light1Switch",
        on="ON",
        off="OFF"
      ]
      Type dimmer:dimmer "Dimmer" [ 
        stateTopic = "zway/get/diningRoom/light1Dimmer", 
        commandTopic = "zway/set/diningRoom/light1Dimmer"
      ]			
      Type number:electricMeterWatt "Electricmeter in watt" [ 
        stateTopic = "zway/get/diningRoom/light1ElectricMeterWatt"
      ]			
      Type number:electricMeterKwh "Electricmeter in kwh" [ 
        stateTopic = "zway/get/diningRoom/light1ElectricMeterKwh"
      ]
  }
}

Configuration file

a self explaining sample configuration file is included copy config.xml.sample to config.xml

Libs required

the following libraries are required by zwayToMqtt.py

• python-requests
• python-croniter
• python-pip
• python-enum
• paho-mqtt

install with

apt-get install python-requests python-croniter python-pip python-enum
pip install paho-mqtt