Published July 25, 2019 © GPL3+

Home Automation Using Z-Wave

Automate your home rapidly with Raspberry Pi, Z-Wave devices and WolkAbout IoT Platform.

IntermediateFull instructions provided1 hour3,506

Things used in this project

Hardware components

Raspberry Pi 3 Model B+

Aeotec Z-Stick Gen5

Aeotec LED Bulb 6

Aeotec MultiSensor 6

Software apps and online services

WolkAbout IoT Platform

Story

Introduction

In this project, we have used a Raspberry Pi 3+ and Aeotec Z-Stick Gen5 to create a Z-Wave gateway used to report data from Aeotec MultiSensor6 and control the state of Aeotec LED Bulb6 with WolkAbout IoT Platform. Other Z-Wave devices can be used instead. To check if there is support for your device, please refer to PyZwaver that was used as a dependency for this project.

Hardware Setup

Add all Z-Wave devices to your Z-Wave network by following the inclusion guide listed in the device manuals. After successfully adding all nodes to the network, go ahead and plug in the controller into the USB port of the Raspberry Pi.

Software Setup

This project uses two repositories: WolkGateway and WolkGatewayModule-Z-Wave.

WolkGateway bridges the communication between WolkAbout IoT Platform and multiple non-IP-enabled devices connected to it through modules. The modules enable communication with subordinate devices by implementing the devices’ network communication protocol on one end (Z-Wave in this project) and parsing data between the Mosquitto MQTT broker on the other end.

Start with connecting to the Raspberry Pi and cloning the WolkGateway repository:

git clone --recurse-submodules https://github.com/Wolkabout/WolkGateway.git

After that, install WolkGateway’s dependencies.

Now that the dependencies are installed change the directory into WolkGateway and run the configure.sh script. This script will prepare the build system and compile OpenSSL. Because of the limited hardware capabilities, this step will take some time (up to 10 minutes), so while waiting for this step to finish, create a gateway on WolkAbout IoT Platform.

Head over to demo.wolkabout.com and register/log in with your account. Next, switch to the Device Management tool from the application menu.

Press + and from the dropdown menu select Create device without device type.

Enter the name for the gateway and the optionally a device key.

Set the Protocol to WolkAbout MQTT Gateway, Connectivity Type to MQTT and Sub device Management to GATEWAY.

Tick the checkbox for Create Default Semantic and click Save.

A pop-up will appear with the gateway name and the key, as well as its password.

Save this information by using one of the options from the bottom on the left as you will need to enter it into WolkGateway/out/gatewayConfiguration.json.

After the configure.sh script finishes, change the directory to WolkGateway/out/ and run make. To run the application correctly, you need to enter the device credentials into gatewayConfiguration.json:

{
"name": "",
"key": "",
"password": "",

Before running the gateway application, make sure that Mosquitto is running by invoking

sudo systemctl start mosquitto

Then start the application with

./WolkGatewayApp gatewayConfiguration.json

After a couple of seconds, the gateway will connect to the Platform and perform its initial configuration, after which you can register the devices through the gateway.

For easier use, create a service that will run the gateway by creating a new file wolk_gateway.service and copy the content from the project’s attachments. Make changes to the username and the path if necessary. Then move the service file and enable it with the following commands:

sudo mv wolk_gateway.service /lib/systemd/system/wolk_gateway.service
sudo chmod 644 /lib/systemd/system/wolk_gateway.service
sudo systemctl daemon-reload
sudo systemctl enable wolk_gateway.service
sudo systemctl start wolk_gateway.service

To check the state of the service use

sudo systemctl status wolk_gateway.service

and also use restart, stop, disable if needed.

This completes the setup for WolkGateway repository resulting in a service that will forward the data from the Z-Wave module to WolkAbout IoT Platform.

Next, clone the WolkGatewayModule-Z-Wave repository:

git clone https://github.com/Wolkabout/WolkGatewayModule-Z-Wave.git

This module requires Python 3.7. Also, installing it on Raspberry Pi unfortunately still isn’t as easy as running sudo apt-get install, but it is achievable if you follow this guide.

After installing Python3.7, run the setup.sh as sudo that is located inside WolkGatewayModule-Z-Wave folder. It will download the necessary dependencies for this project.

Within the same folder, there is a configuration.json file that should be edited to match the address of your Z-Wave controller. You can check the port assigned to the Z-Wave controller with dmesg | grep tty.

{
 "serial_port": "/dev/ttyACM0", // Z-Wave controller port
 "host": "localhost", // Host address of WolkGateway
 "port": 1883, // WolkGateway's MQTT broker address
 "module_name": "Z-Wave Module" // Unique module identifier
}

The application is split into several files to make it easier to manage:

demo.py - This is the main part of the application that will include the other files contained in this list.
devices.py - This file contains device templates that describe the type and the format of the data that will be sent from devices. It includes a ready-to-use device template for Aeotec MultiSensor 6, LED Bulb 6 and Smart Dimmer 6. If you want to connect other Z-Wave devices, this documentation should help.
handlers.py - This file is responsible for getting the current connection status of Z-Wave devices and controlling the value of switches, sliders, etc.
zwave.py - This file is responsible for setting up the Z-Wave controller and translating command messages.

In the project’s attachments, you will find demo.py and handlers.py that have been modified to work with Aeotec MultiSensor 6 and LED Bulb 6. Go ahead and copy their contents over the cloned files.

According to these files, the MultiSensor’s node address is 3 and the LED bulb’s node address is 4. If your setup is different than this, make changes to the loop in demo.py and to the functions in handlers.py.

Now, if you run the application with

python3.7 demo.py

it will start to poll data from your Z-Wave devices and send a registration request to the gateway.

By following the same steps as for wolk_gateway.service, create a service for the Z-Wave module using the z_wave_module.service file from the project’s attachments.

Now that the devices have been registered and have started to send the data to WolkAbout IoT Platform, create a dashboard and add some widgets.

Choose Reading widget and make one for Illuminance, Humidity, Temperature and Ultraviolet from the MultiSensor6 device.

Next, create an actuator widget for the LED Bulb dimmer.

And now you have a dashboard displaying the data from your Z-Wave devices!

Conclusion

We have created this project to showcase the WolkGatewayModule-Z-Wave and provide you with an insight into how to use this library to enable Z-Wave devices to communicate with WolkAbout IoT Platform. This allows you to build your home automation projects and create a unique digital experience with WolkAbout IoT Platform.

This project can be further expanded through the use of WolkAbout IoT Platform’s rule engine. Compare the value of the MultiSensor’s illuminance sensor against a fixed value, and if it’s above or below that value, then change the value of LED Bulb dimmer. Another way to add more value to the project is by creating reports that allow you to see how the temperature or humidity have changed over time.

WolkAbout IoT Platform offers a range of features that help you build killer apps for intelligent home products in a few days instead of weeks. By design and through different libraries, it is compatible with virtually any modern consumer product or microchip.

Stay tuned for more amazing projects!

In the meantime, find out more about our platform and its features by visiting our website.

import time

import pyzwaver
import wolk_gateway_module as wolk

import zwave


def node_status_provider(device_key):
    """Ping network node to get current state."""
    nodes = zwave.controller.nodes.copy()
    nodes.remove(zwave.controller.GetNodeId())
    if device_key == "multi_sensor6":
        node_number = 3
    elif device_key == "LED_Bulb6":
        node_number = 4
    else:
        return wolk.DeviceStatus.OFFLINE

    zwave.translator.Ping(node_number, 5, False, "status_request")
    time.sleep(1.5)
    node = zwave.nodeset.GetNode(node_number)
    if node.IsInterviewed():
        if node in zwave.controller.failed_nodes:
            return wolk.DeviceStatus.OFFLINE
        return wolk.DeviceStatus.CONNECTED
    else:
        return wolk.DeviceStatus.OFFLINE


def handle_actuation(device_key, reference, value):
    """
    Set device actuator identified by reference to value.
    """
    if device_key == "LED_Bulb6":
        if reference == "D":
            node_number = 4
            node = zwave.nodeset.GetNode(node_number)
            node.BatchCommandSubmitFilteredFast(
                pyzwaver.command_helper.MultilevelSwitchSet(int(value))
            )


def get_actuator_status(device_key, reference):
    """
    Get current actuator status identified by device key and reference.
    """
    if device_key == "LED_Bulb6":
        if reference == "D":
            node_number = 4
            node = zwave.nodeset.GetNode(node_number)
            if (
                not node.IsInterviewed()
                or node in zwave.controller.failed_nodes
            ):
                return wolk.ActuatorState.ERROR, None
            node.RefreshDynamicValues()
            time.sleep(1)
            return wolk.ActuatorState.READY, node.values.GetMultilevelSwitchLevel()
    return wolk.ActuatorState.ERROR, None

import json
import time

import wolk_gateway_module as wolk

import zwave
import devices
import handlers

# # uncomment to enable debug
wolk.logging_config("debug")


try:
    with open("configuration.json", encoding="utf-8") as file:
        configuration = json.load(file)
except Exception as e:
    print(f"Failed to open configuration file: {e}")
    quit()

wolk_module = wolk.Wolk(
    configuration["host"],
    configuration["port"],
    configuration["module_name"],
    handlers.node_status_provider,
    actuation_handler=handlers.handle_actuation,
    actuator_status_provider=handlers.get_actuator_status,
)
wolk_module.add_device(devices.LED_bulb_device)
wolk_module.add_device(devices.multi_sensor_device)

wolk_module.connect()
wolk_module.publish()

time.sleep(5)  # Allow connect method to ping nodes for their status

wolk_module.publish_actuator_status("LED_Bulb6", "D")

try:
    while True:
        for n in zwave.controller.nodes:
            node = zwave.nodeset.GetNode(n)
            if node.IsInterviewed():
                if node not in zwave.controller.failed_nodes:
                    node.RefreshDynamicValues()
            time.sleep(5)

        wolk_module.publish_actuator_status("LED_Bulb6", "D")

        node_number = 3
        node = zwave.nodeset.GetNode(node_number)

        if not node.IsInterviewed():
            wolk_module.publish_device_status(
                "multi_sensor6", wolk.DeviceStatus.OFFLINE
            )
            continue

        for value in node.values.Sensors():

            if value[2] == "%":
                wolk_module.add_sensor_reading(
                    "multi_sensor6",
                    "H",
                    value[3],
                    int(round(time.time() * 1000)),
                )
            elif value[2] == "C":
                wolk_module.add_sensor_reading(
                    "multi_sensor6",
                    "T",
                    value[3],
                    int(round(time.time() * 1000)),
                )
            elif value[2] == "lux":
                wolk_module.add_sensor_reading(
                    "multi_sensor6",
                    "IL",
                    value[3],
                    int(round(time.time() * 1000)),
                )
            elif value[2] == "":
                wolk_module.add_sensor_reading(
                    "multi_sensor6",
                    "UV",
                    value[3],
                    int(round(time.time() * 1000)),
                )

        wolk_module.publish()
        time.sleep(5)

except Exception as e:
    print(f"Exception occurred: {e}")
    zwave.driver.Terminate()
    wolk_module.disconnect()
    quit()

import wolk_gateway_module as wolk


# Aeotec Smart Dimmer 6

power_sensor = wolk.SensorTemplate(
    name="Power",
    reference="P",
    reading_type_name=wolk.ReadingTypeName.POWER,
    unit=wolk.ReadingTypeMeasurementUnit.WATT,
)

voltage_sensor = wolk.SensorTemplate(
    name="Voltage",
    reference="V",
    reading_type_name=wolk.ReadingTypeName.BATTERY_VOLTAGE,
    unit=wolk.ReadingTypeMeasurementUnit.VOLT,
)

current_sensor = wolk.SensorTemplate(
    name="Electric Current",
    reference="I",
    reading_type_name=wolk.ReadingTypeName.ELECTRIC_CURRENT,
    unit=wolk.ReadingTypeMeasurementUnit.AMPERE,
    minimum=0,
    maximum=100,
)

power_consumption_sensor = wolk.SensorTemplate(
    name="Energy consumption",
    reference="EC",
    reading_type_name=wolk.ReadingTypeName.BATTERY_POWER,
    unit=wolk.ReadingTypeMeasurementUnit.BATTERY_X1000,
    minimum=0,
    maximum=100,
)

dimmer_actuator = wolk.ActuatorTemplate(
    name="Dimmer",
    reference="D",
    data_type=wolk.DataType.NUMERIC,
    minimum=0,
    maximum=100,
)

smart_dimmer_template = wolk.DeviceTemplate(
    sensors=[
        power_sensor,
        voltage_sensor,
        current_sensor,
        power_consumption_sensor,
    ],
    actuators=[dimmer_actuator],
)

smart_dimmer_device = wolk.Device(
    "Smart Dimmer", "smart_dimmer6", smart_dimmer_template
)

# Aeotec LED Bulb 6

LED_dimmer_template = wolk.ActuatorTemplate(
    name="Dimmer",
    reference="D",
    data_type=wolk.DataType.NUMERIC,
    minimum=0,
    maximum=100,
)

LED_bulb_template = wolk.DeviceTemplate(actuators=[LED_dimmer_template])

LED_bulb_device = wolk.Device("LED Bulb", "LED_Bulb6", LED_bulb_template)


# Aeotec Multi Sensor 6

illuminance_sensor = wolk.SensorTemplate(
    name="Illuminance",
    reference="IL",
    reading_type_name=wolk.ReadingTypeName.ILLUMINANCE,
    unit=wolk.ReadingTypeMeasurementUnit.LUX,
    minimum=0,
    maximum=30000,
)

humidity_sensor = wolk.SensorTemplate(
    name="Humidity",
    reference="H",
    reading_type_name=wolk.ReadingTypeName.HUMIDITY,
    unit=wolk.ReadingTypeMeasurementUnit.PERCENT,
    minimum=0,
    maximum=100,
)

temperature_sensor = wolk.SensorTemplate(
    name="Temperature",
    reference="T",
    reading_type_name=wolk.ReadingTypeName.TEMPERATURE,
    unit=wolk.ReadingTypeMeasurementUnit.CELSIUS,
    minimum=-10,
    maximum=50,
)

ultraviolet_sensor = wolk.SensorTemplate(
    name="Ultraviolet",
    reference="UV",
    data_type=wolk.DataType.NUMERIC,
    minimum=0,
    maximum=10,
)


multi_sensor_template = wolk.DeviceTemplate(
    sensors=[
        illuminance_sensor,
        humidity_sensor,
        temperature_sensor,
        ultraviolet_sensor,
    ]
)

multi_sensor_device = wolk.Device(
    "MultiSensor 6", "multi_sensor6", multi_sensor_template
)

Credits

WolkWriter

17 projects • 33 followers

With WolkAbout IoT Platform, we give you proven technology to develop powerful IoT applications and control your business ecosystem.

Home Automation Using Z-Wave

Things used in this project

Hardware components

Software apps and online services

Story

Introduction

Hardware Setup

Software Setup

Conclusion

Code

handlers.py

z_wave_module.service

wolk_gateway.service

demo.py

devices.py

WolkGatewayModule-Z-Wave

WolkGateway

Credits

WolkWriter

Comments

Embed the widget on your own site

Home Automation Using Z-Wave

Home Automation Using Z-Wave

Things used in this project

Hardware components

Software apps and online services

Story

Introduction

Hardware Setup

Software Setup

Conclusion

Code

handlers.py

z_wave_module.service

wolk_gateway.service

demo.py

devices.py

WolkGatewayModule-Z-Wave

WolkGateway

Credits

WolkWriter

Comments

Related channels and tags