Fork me on GitHub

pimatic-z-way by Mathias Nestler (mathias.nestler) | github | npm

pimatic-z-way plugin

This is a pimatic plugin which allows you to control Z-Wave devices using Z-Way.

Configuration

You can load the plugin by editing your config.json to include:

{
   "plugin": "z-way",
   "hostname": "10.10.7.46" // set hostname if necessary (localhost by default)
   "username": "admin", // Username for your z-way webinterface (default admin)
   "password": "P4$$w0Rd" // Password for your z-way webinterface
}

Devices can be defined by adding them to the devices section in the config file. Set the class attribute to one of the following classes. For example:

{
  "class": "ZWaySwitch",
  "id": "fibaro_plug",
  "name": "Wall Plug",
  "virtualDeviceId": "ZWayVDev_zway_2-0-42",
  "interval": 0
},
{
  "class": "ZWayDimmer",
  "id": "fibaro_dimmer",
  "name": "Dimmer",
  "virtualDeviceId": "ZWayVDev_zway_2-0-44",
  "interval": 0
},
{
  "class": "ZWayThermostat",
  "id": "danfoss_321",
  "name": "Heater 1",
  "virtualDeviceId": "ZWayVDev_zway_19-0-17-1",
  "interval": 20,
  "comfyTemp": 20,
  "ecoTemp": 17
},
{
  "class": "ZWayPowerSensor",
  "id": "fibaro_power_sensor",
  "name": "Power Sensor",
  "virtualDeviceId": "ZWayVDev_zway_2-0-43"
},
{
  "class": "ZWayLuminescenceSensor",
  "id": "fibaro_luminescence_sensor",
  "name": "Luminescence Sensor",
  "virtualDeviceId": "ZWayVDev_zway_2-0-49"
},
{
  "class": "ZWayHumiditySensor",
  "id": "fibaro_Humidity_sensor",
  "name": "Humidity Sensor",
  "virtualDeviceId": "ZWayVDev_zway_2-0-51"
},
{
  "class": "ZWayDoorWindowSensor",
  "id": "fibaro_window_sensor",
  "name": "Window Sensor",
  "virtualDeviceId": "ZWayVDev_zway_2-0-45"
},
{
  "class": "ZWayTemperatureSensor",
  "id": "fibaro_temp_sensor",
  "name": "Window Sensor",
  "virtualDeviceId": "ZWayVDev_zway_2-0-46"
},
{
  "class": "ZWayMotionSensor",
  "id": "fibaro_motion_sensor",
  "name": "Motion Sensor",
  "virtualDeviceId": "ZWayVDev_zway_2-0-47"
},
{
  "class": "ZWayShutterController",
  "id": "fibaro_roller_shutter",
  "name": "Roller Shutter",
  "virtualDeviceId": "ZWayVDev_zway_2-0-48"
}

Figure the virtualDeviceId out by calling curl http://HOSTNAME:8083/ZAutomation/api/v1/devices. If the interval option is greater than 0 then the state of the device is updated automatically after the defined seconds. Sensors always should have a value greater than 0.

Authentication

Starting with Z-Way v2.0.1 authentication can become an issue for you. There must be a user that has access to your devices.

  1. Go to http://HOSTNAME:8083/smarthome/
  2. Assign your devices to room(s).
  3. In User management allow the 'Local User' to access your rooms.
  4. If you do not use the default 'localhost' as hostname, create a new anonymous user and allow him access to your rooms.

Plugin Config Options

pimatic-z-way config options
OptionDescriptionDefault
hostname
string
Hostname of the server that runs the z-way server (usually localhost)
"localhost"
username
string
Username for your z-way webinterface
"admin"
password
string
Password for your z-way webinterface
""

Device Config Options

pimatic-z-way device config options

ZWaySwitch

ZWaySwitch config options
OptionDescriptionDefault
virtualDeviceId
string
Virtual Device ID (call `curl http://HOSTNAME:8083/ZAutomation/api/v1/devices` for a list)
interval
number
Time interval (in s) after a state update is requested. If 0 then the state will not updated automatically.
0

ZWayDimmer

ZWayDimmer config options
OptionDescriptionDefault
virtualDeviceId
string
Virtual Device ID (call `curl http://HOSTNAME:8083/ZAutomation/api/v1/devices` for a list)
interval
number
Time interval (in s) after a state update is requested. If 0 then the state will not updated automatically.
0

ZWayThermostat

ZWayThermostat config options
OptionDescriptionDefault
virtualDeviceId
string
Virtual Device ID (call `curl http://HOSTNAME:8083/ZAutomation/api/v1/devices` for a list)
interval
number
Time interval (in s) after a state update is requested. If 0 then the state will not updated automatically.
60
comfyTemp
number
The defined comfy temperature
21
ecoTemp
number
The defined eco temperature
17
guiShowModeControl
boolean
Show the mode buttons in the gui
false
guiShowPresetControl
boolean
Show the preset temperatures in the gui
true
guiShowTemperatureInput
boolean
Show the temperature input spinbox in the gui
true
guiShowValvePosition
boolean
Show the valve position in the gui
true

ZWayPowerSensor

ZWayPowerSensor config options
OptionDescriptionDefault
virtualDeviceId
string
Virtual Device ID (call `curl http://HOSTNAME:8083/ZAutomation/api/v1/devices` for a list)
interval
number
Time interval (in s) after an update is requested.
60

ZWayDoorWindowSensor

ZWayDoorWindowSensor config options
OptionDescriptionDefault
virtualDeviceId
string
Virtual Device ID (call `curl http://HOSTNAME:8083/ZAutomation/api/v1/devices` for a list)
interval
number
Time interval (in s) after an update is requested.
2
inverted
boolean
Sets 1 to opend and 0 to closed
false

ZWayTemperatureSensor

ZWayTemperatureSensor config options
OptionDescriptionDefault
virtualDeviceId
string
Virtual Device ID (call `curl http://HOSTNAME:8083/ZAutomation/api/v1/devices` for a list)
interval
number
Time interval (in s) after an update is requested.
60

ZWayLuminescenceSensor

ZWayLuminescenceSensor config options
OptionDescriptionDefault
virtualDeviceId
string
Virtual Device ID (call `curl http://HOSTNAME:8083/ZAutomation/api/v1/devices` for a list)
interval
number
Time interval (in s) after an update is requested.
60

ZWayHumiditySensor

ZWayHumiditySensor config options
OptionDescriptionDefault
virtualDeviceId
string
Virtual Device ID (call `curl http://HOSTNAME:8083/ZAutomation/api/v1/devices` for a list)
interval
number
Time interval (in s) after an update is requested.
60

ZWayMotionSensor

ZWayMotionSensor config options
OptionDescriptionDefault
virtualDeviceId
string
Virtual Device ID (call `curl http://HOSTNAME:8083/ZAutomation/api/v1/devices` for a list)
interval
number
Time interval (in s) after an update is requested.
2
inverted
boolean
Sets 1 to motion and 0 to no motion
false

ZWayShutterController

ZWayShutterController config options
OptionDescriptionDefault
virtualDeviceId
string
Virtual Device ID (call `curl http://HOSTNAME:8083/ZAutomation/api/v1/devices` for a list)
interval
number
Time interval (in s) after an update is requested.
2
pimatic-z-way is written by Mathias Nestler (mathias.nestler)