MIG API

HomeAutomation.ZWave Domain


HomeAutomation.ZWave

Z-Wave USB/Serial interface for home automation.

Controller.Discovery

Query the node list from controller.

Syntax

/api/HomeAutomation.ZWave/1/Controller.Discovery

Response Events

Controller.Status

Controller.NodeAdd

Put the controller in node adding mode.

Syntax

/api/HomeAutomation.ZWave/1/Controller.NodeAdd

Response Events

Controller.Status

Controller.NodeRemove

Put the controller in node removal mode.

Syntax

/api/HomeAutomation.ZWave/1/Controller.NodeRemove

Response Events

Controller.Status

Controller.SoftReset

Soft reset the controller.

Syntax

/api/HomeAutomation.ZWave/1/Controller.SoftReset

Controller.HardReset

Hard reset the controller removing all node associations.

Syntax

/api/HomeAutomation.ZWave/1/Controller.HardReset

NodeInfo.Get

Query the Node Information Frame (supported command classes) from the node with address <node_address>.

Syntax

/api/HomeAutomation.ZWave/<node_address>/NodeInfo.Get
GET /api/HomeAutomation.ZWave/10/NodeInfo.Get

Response Events

ZWaveNode.NodeInfo

ManufacturerSpecific.Get

Query the Manufacturer Specific from the node with address <node_address>.

Syntax

/api/HomeAutomation.ZWave/<node_address>/ManufacturerSpecific.Get
GET /api/HomeAutomation.ZWave/12/ManufacturerSpecific.Get

Response Events

ZWaveNode.ManufacturerSpecific

Basic.Get

Perform a Basic Get command on the node with address <node_address>.

Syntax

/api/HomeAutomation.ZWave/<node_address>/Basic.Get
GET /api/HomeAutomation.ZWave/12/Basic.Get

Response Events

ZWaveNode.Basic, Status.Level

Basic.Set

Perform a Basic Set command with the specified <value> value on the node with address <node_address>.

Syntax

/api/HomeAutomation.ZWave/<node_address>/Basic.Set/<value>
GET /api/HomeAutomation.ZWave/10/Basic.Set/30

Response Events

Status.Level

Control.On

Turn on the node with address <node_address>.

Syntax

/api/HomeAutomation.ZWave/<node_address>/Control.On
GET /api/HomeAutomation.ZWave/16/Control.On

Response Events

Status.Level

Control.Off

Turn off the node with address <node_address>.

Syntax

/api/HomeAutomation.ZWave/<node_address>/Control.Off
GET /api/HomeAutomation.ZWave/18/Control.Off

Response Events

Status.Level

Control.Level

Set the level of the node with address <node_address> to <level>% (0-100).

Syntax

/api/HomeAutomation.ZWave/<node_address>/Control.Level/<level>
GET /api/HomeAutomation.ZWave/14/Control.Level/35

Response Events

Status.Level

Control.Toggle

Toggle on/off the node with address <node_address>.

Syntax

/api/HomeAutomation.ZWave/<node_address>/Control.Toggle
GET /api/HomeAutomation.ZWave/14/Control.Toggle

Response Events

Status.Level

Association.Get

Query the associations present in the group <group_id> from the node with address <node_address>.

Syntax

/api/HomeAutomation.ZWave/<node_address>/Association.Get/<group_id>
GET /api/HomeAutomation.ZWave/8/Association.Get/1

Response Events

ZWaveNode.Associations.<group_id>

Association.Set

Add node <assoc_node> to the associations present in the group <group_id> for the node with address <node_address>.

Syntax

/api/HomeAutomation.ZWave/<node_address>/Association.Set/<group_id>/<assoc_node>
GET /api/HomeAutomation.ZWave/8/Association.Set/1/1

Config.ParameterGet

Query the Configuration parameter with id <parameter_id> from the node with address <node_address>.

Syntax

/api/HomeAutomation.ZWave/<node_address>/Config.ParameterGet/<parameter_id>
GET /api/HomeAutomation.ZWave/8/Config.ParameterGet/101

Response Events

ZWaveNode.Variables.<parameter_id>

Config.ParameterSet

Set to <value> the Configuration parameter with id <parameter_id> of the node with address <node_address>.

Syntax

/api/HomeAutomation.ZWave/<node_address>/Config.ParameterSet/<parameter_id>/<value>
GET /api/HomeAutomation.ZWave/8/Config.ParameterSet/101/1

Battery.Get

Query the Battery level from the node with address <node_address>.

Syntax

/api/HomeAutomation.ZWave/<node_address>/Battery.Get
GET /api/HomeAutomation.ZWave/31/Battery.Get

Response Events

ZWaveNode.Battery, Status.Battery

WakeUp.Get

Query the Wake Up interval from the node with address <node_address>.

Syntax

/api/HomeAutomation.ZWave/<node_address>/WakeUp.Get
GET /api/HomeAutomation.ZWave/8/WakeUp.Get

Response Events

ZWaveNode.WakeUpInterval

WakeUp.Set

Set to <interval> the Wake Up interval of the node with address <node_address>.

Syntax

/api/HomeAutomation.ZWave/<node_address>/WakeUp.Set/<interval>
GET /api/HomeAutomation.ZWave/23/WakeUp.Set/360

MultiInstance.Get

Query the Multi-Instance parameter of type <type> and with id <parameter_id> from the node with address <node_address>.

The option <type> can be: Switch.Binary, Switch.MultiLevel, Sensor.Binary, Sensor.MultiLevel.

Syntax

/api/HomeAutomation.ZWave/<node_address>/MultiInstance.Get/<type>/<parameter_id>
GET /api/HomeAutomation.ZWave/13/MultiInstance.Get/Switch.MultiLevel/1

Response Events

ZWaveNode.MultiInstance.SwitchBinary.<parameter_id>, ZWaveNode.MultiInstance.SwitchMultiLevel.<parameter_id>, ZWaveNode.MultiInstance.SensorBinary.<parameter_id>, ZWaveNode.MultiInstance.SensorMultiLevel.<parameter_id>

MultiInstance.Set

Set to <value> the Multi-Instance parameter of type <type> and with id <parameter_id> from the node with address <node_address>.

The option <type> can be: Switch.Binary, Switch.MultiLevel.

Syntax

/api/HomeAutomation.ZWave/<node_address>/MultiInstance.Set/<type>/<parameter_id>/<value>
GET /api/HomeAutomation.ZWave/13/MultiInstance.Set/Switch.MultiLevel/2/60

MultiInstance.GetCount

Query the Multi-Instance parameters count of type <type> from the node with address <node_address>.

The option <type> can be: Switch.Binary, Switch.MultiLevel, Sensor.Binary, Sensor.MultiLevel.

Syntax

/api/HomeAutomation.ZWave/<node_address>/MultiInstance.GetCount
GET /api/HomeAutomation.ZWave/15/MultiInstance.GetCount/Sensor.MultiLevel

Response Events

ZWaveNode.MultiInstance.SwitchBinary.Count, ZWaveNode.MultiInstance.SwitchMultiLevel.Count, ZWaveNode.MultiInstance.SensorBinary.Count, ZWaveNode.MultiInstance.SensorMultiLevel.Count

SensorBinary.Get

Perform a Sensor Binary Get command on the node with address <node_address>.

Syntax

/api/HomeAutomation.ZWave/<node_address>/SensorBinary.Get
GET /api/HomeAutomation.ZWave/11/SensorBinary.Get

Response Events

Sensor.Generic, Sensor.Alarm, Sensor.MotionDetect, Sensor.Tamper, Sensor.DoorWindow, Sensor.CarbonMonoxide, Sensor.CarbonDioxide, Sensor.Smoke, Sensor.Heat, Sensor.Flood

SensorMultiLevel.Get

Perform a Sensor Multilevel Get command on the node with address <node_address>.

Syntax

/api/HomeAutomation.ZWave/<node_address>/SensorMultiLevel.Get
GET /api/HomeAutomation.ZWave/28/SensorMultiLevel.Get

Response Events

Sensor.Generic, Sensor.Alarm, Sensor.Temperature, Sensor.Luminance, Sensor.Humidity Sensor.Power

Meter.Get

Perform a Meter Get command of type <scale_type> on the node with address <node_address>.

The option <scale_type> can be: 0 (kWh), 1 (kVAh), 2 (Watt), 3 (Pulses), 4 (AC Volt), 5 (AC Current), 6 (Power Factor).

Syntax

/api/HomeAutomation.ZWave/<node_address>/Meter.Get/<scale_type>
GET /api/HomeAutomation.ZWave/19/Meter.Get/2

Response Events

Meter.KilowattHour, Meter.KilovoltAmpereHour, Meter.Watts, Meter.Pulses, Meter.AcVoltage Meter.AcCurrent

Meter.Reset

Perform a Meter Reset command on the node with address <node_address>.

Syntax

/api/HomeAutomation.ZWave/<node_address>/Meter.Reset
GET /api/HomeAutomation.ZWave/19/Meter.Reset

Meter.SupportedGet

Query supported metering scale types from the node with address <node_address>.

Syntax

/api/HomeAutomation.ZWave/<node_address>/Meter.SupportedGet
GET /api/HomeAutomation.ZWave/19/Meter.SupportedGet

Thermostat.ModeGet

Query the thermostat mode from the node with address <node_address>.

Syntax

/api/HomeAutomation.ZWave/<node_address>/Thermostat.ModeGet
GET /api/HomeAutomation.ZWave/26/Thermostat.ModeGet

Response Events

Thermostat.Mode

Thermostat.ModeSet

Change the mode to <mode> for the thermostat node with address <node_address>.

The option <mode> can be: Off, Heat, Cool, Auto, AuxHeat, Resume, FanOnly, Furnace, DryAir, MoistAir, AutoChangeover, HeatEconomy, CoolEconomy, Away

Syntax

/api/HomeAutomation.ZWave/<node_address>/Thermostat.ModeSet/<mode>
GET /api/HomeAutomation.ZWave/26/Thermostat.ModeSet/Heat

Thermostat.SetPointGet

Query the thermostat set point for the <mode> mode from the node with address <node_address>.

The option <mode> can be: Heating, Cooling, Furnace, DryAir, MoistAir, AutoChangeover, HeatingEconomy, CoolingEconomy, HeatingAway

Syntax

/api/HomeAutomation.ZWave/<node_address>/Thermostat.SetPointGet/<mode>
GET /api/HomeAutomation.ZWave/26/Thermostat.SetPointGet/Heating

Response Events

Thermostat.SetPoint.<mode>

Thermostat.SetPointSet

Change the set point of the thermostat node with address <node_address>, to <value> for the <mode> mode.

The option <mode> can be: Heating, Cooling, Furnace, DryAir, MoistAir, AutoChangeover, HeatingEconomy, CoolingEconomy, HeatingAway

Syntax

/api/HomeAutomation.ZWave/<node_address>/Thermostat.SetPointSet/<mode>/<value>
GET /api/HomeAutomation.ZWave/26/Thermostat.SetPointSet/Heating/19.5

Thermostat.FanModeGet

Query the fan mode from the thermostat node with address <node_address>.

Syntax

/api/HomeAutomation.ZWave/<node_address>/Thermostat.FanModeGet
GET /api/HomeAutomation.ZWave/26/Thermostat.FanModeGet

Response Events

Thermostat.FanMode

Thermostat.FanModeSet

Set the fan mode to <mode> for the thermostat node with address <node_address>.

The option <mode> can be: AutoLow, OnLow, AutoHigh, OnHigh, Circulate

Syntax

/api/HomeAutomation.ZWave/<node_address>/Thermostat.FanModeSet/<mode>
GET /api/HomeAutomation.ZWave/26/Thermostat.FanModeSet/Circulate

Thermostat.FanStateGet

Query the currently operating state of the fan from the thermostat node with address <node_address>.

Syntax

/api/HomeAutomation.ZWave/<node_address>/Thermostat.FanStateGet
GET /api/HomeAutomation.ZWave/26/Thermostat.FanModeGet

Response Events

Thermostat.FanState

Thermostat.OperatingStateGet

Query the current operating state from the thermostat node with address <node_address>.

Syntax

/api/HomeAutomation.ZWave/<node_address>/Thermostat.OperatingStateGet
GET /api/HomeAutomation.ZWave/26/Thermostat.OperatingStateGet

Response Events

Thermostat.OperatingState