API Reference grizzly v0.21.1

Send commands to Z-Wave devices

Behaviour for how commands should handle incoming Z-Wave messages

This handler is useful for most set commands that only needs to be acknowledged

Handler for working with reports that could take many report frames to complete

This handle is useful for when you want to wait for a particular report from the Z-Wave network. Most GET commands can use this handler.

Behaviour for handling incoming commands during the firmware update process

Module for upgrading firmware on target devices.

Behaviour for handling incoming commands during the inclusion process

Module for adding and removing Z-Wave nodes

Indicator handling for Grizzly when an indicator event is triggered

Module for working with the Z-Wave network

Functions for working directly with a Z-Wave node

Reports from Z-Wave commands

Supervisor for running the Grizzly runtime.

Commands for working with devices that support the Switch Binary command class

Module that tracks the commands that are sent and received by Grizzly

Data structure for a single item in the trace log

Behaviour and functions for communicating to zipgateway

The response from parse response

DTLS implementation of the Grizzly.Transport behaviour

Grizzly transport implementation for UDP

Module for Z-Wave protocol specific functionality and information

CRC for Z-Wave commands

Data struct and behaviour for working with Z-Wave commands

Behaviour for a command class implementation

Alarm Command Class

"Antitheft" Command Class

"AntitheftUnlock" Command Class

"ApplicationStatus" Command Class

Association Command Class

"AssociationGroupInfo" Command Class

"Basic" Command Class

"Battery" Command Class

"Crc16Encap" Command Class

"CentralScene" Command Class

"Clock" Command Class

Configuration command class

"DeviceResetLocally" Command Class

DoorLock Command Class

The Firmware Update Meta Data Command Class may be used to transfer a firmware image to a Z-Wave device.

Hail Command Class

"Indicator" Command Class

ManufacturerSpecific Command Class

"Meter" Command Class

"MultiChannel" Command Class

"MultiChannelAssociation" Command Class

"MultiCommand" Command Class

Command class for working with Z-Wave network updates and resetting the controller back to the factor defaults

Network Management Inclusion Command Class

"NetworkManagementInstallationMaintenance" Command Class

Network Management Proxy Command Class

"NoOperation" Command Class

"NodeNaming" Command Class

NodeProvisioning Command Class

"Powerlevel" Command Class

"SceneActivation" Command Class

"SceneActuatorConf" Command Class

"ScheduleEntryLock" Command Class

Deprecated command class for triggered/not triggered sensors.

"SensorMultilevel" Command Class

The Supervision Command Class allows a sending node to request application-level delivery confirmation from a receiving node.

Switch Binary Command Class

Multilevel Switch Command Class

"ThermostatFanMode" Command Class

"ThermostatFanState" Command Class

"ThermostatMode" Command Class

"ThermostatOperatingState" Command Class

"ThermostatSetback" Command Class

"ThermostatSetpoint" Command Class

"Time" Command Class

"TimeParameters" Command Class

Command Class for working with user codes

Version Command Class

"WakeUp" Command Class

ZIP Command Class

ZIPGateway Command Class

"ZwaveplusInfo" Command Class

This command is used to request the supported Notifications for a specified Notification Type.

This command is used to advertise supported events/states for a specified Notification Type.

This command is used to get the value of an alarm.

This command notifies the application of the alarm state (v1, v2) or the notification state (v8).

This command is used to enable or disable the unsolicited transmission of a specific Notification/Alarm Type.

This command is used to request supported Alarm/Notification Types.

This command is used to advertise supported Alarm/Notification Types. Versions 2+ are supported.

This command is used to request the locked/unlocked state of a supporting node.

This command is used to advertise the lock/unlock state of a supporting node.

This command is used to lock or unlock a node.

This command is used to request the locked/unlocked state of the node.

This command is used to advertise the current locked/unlocked state of the node with some additional information.

This command is used to unlock a node that is currently locked.

The Application Busy Command used to instruct a node that the node that it is trying to communicate with is busy and is unable to service the request right now.

Get the node information frame of for the Z/IP Gateway controller

Reports the Application Node Info with regards to the command classes that are supported

This command is used to instruct a node that the command was rejected by the application in the receiving node.

Get the current destinations for the association group

This command is used to request the commands that are sent via a given association group.

This command is used to advertise the commands that are sent via an actual association group.

This command is used to request the properties of one or more association group.

This command is used to advertise the properties of one or more association groups.

This command is used to query the name of an association group.

This command is used to advertise the assigned name of an association group.

This command is used to request the number of association groups that this node supports.

This command is used to advertise the maximum number of association groups implemented by this node.

This command is used to remove destinations from a given association group.

Report the destinations for the given association group

Module for the ASSOCIATION_SET command

This command allows a portable controller to interactively create associations from a multi-button device to a destination that is out of direct range.

This command is used to advertise the association group that represents the most recently detected button.

This module implements the BASIC_GET command form the COMMAND_CLASS_BASIC command class

This module implements the BASIC_REPORT command of the COMMAND_CLASS_BASIC command class

This module implements the BASIC_SET command of the COMMAND_CLASS_BASIC command class

This module implements the BATTERY_GET command in the COMMAND_CLASS_BATTERY command class.

This module implements the BATTERY_REPORT command of the COMMAND_CLASS_BATTERY command class.

The CRC-16 Encapsulation Command is used to encapsulate a command with an additional checksum to ensure integrity of the payload.

This command is used to query the configuration of optional node capabilities for scene notifications

This command is used to advertise the configuration of optional node capabilities for scene notifications.

This command is used to configure the use of optional node capabilities for scene notifications.

This command is used to advertise a scene key event.

This command is used to request the maximum number of scenes that this device supports.

This command is used to report the maximum number of supported scenes and the Key Attributes supported for each scene.

This command is used to request the current time set at a supporting node.

This command reports on the current time in a supporting node

This command is used to set the current time in a supporting node

This command is used to query the value of one or more configuration parameters.

This command is used to advertise the actual value of one or more advertised parameters.

This command is used to set the value of one or more configuration parameters.

This command is used to query the value of a configuration parameter.

This command is used to request the properties of a configuration parameter.

This command is used to advertise the properties of a configuration parameter.

Reports on a configuration parameter

Set the configuration parameter

Request the S2 DSK of a Node

Report the DSK for the Z-Wave Node

This command is used to request the current date adjusted according to the local time zone and Daylight Saving Time from a supporting node.

This command is used to advertise the current date adjusted according to the local time zone and Daylight Saving Time.

Reset a Node Z-Wave node back to factory default state

Command to indicate the result of a Grizzly.ZWave.Commands.DefaultSet operation

The Device Reset Locally Notification Command is used to advertise that the device will be reset to default.

This command is used to request the Door Lock capabilities of a supporting node.

This command is used to advertise the Door Lock capabilities supported by the sending node.

This command is used to request the configuration parameters of a door lock device.

This command is used to advertise the configuration parameters of a door lock device.

This command is used to set the configuration parameters of a door lock device.

OperationGet request the door lock operating mode

OperationReport is used to advertise the status of a door lock

OperationSet command allows you to lock or unlock lock devices

This command is used to advertise the current list of failing nodes in the network.

This command is used to remove a non-responding node. It will only succeed if the controller has already put the node on the failed nodes list.

This command reports on the attempted removal of a presumed failed node.

This module implements command FIRMWARE_MD_GET of command class COMMAND_CLASS_FIRMWARE_UPDATE_MD The command requests a FIRMWARE_MD_REPORT

The Firmware Meta Data Report Command is used to advertise the status of the current firmware in the device.

This command is used to advertise the result of a firmware update operation initiated by the Firmware Update Activation Set Command.

This command is used to initiate the programming of a previously transferred firmware image.

The Firmware Update Meta Data Get Command is used to request one or more Firmware Update Meta Data Report Commands.

The Firmware Update Meta Data Report Command is used to transfer a firmware image fragment.

The Firmware Update Meta Data Request Get Command is used to request that a firmware update be initiated.

This command is used to advertise if the firmware update will be initiated.

This command is used to advertise the firmware update status.

Send an unsolicited Hail command to other devices on the network

This command is used to request a detailed description of the appearance and use of an Indicator ID

This command is used to advertise appearance and use of an indicator ID resource.

This command is used to request the state of an indicator.

This command is used to advertise the state of an indicator resource.

This command is used to manipulate one or more indicator resources at a supporting node.

This command is used to request the supported properties of an indicator.

This command is used to advertise the supported properties for a given indicator.

This command is used to allow a node to be added to (or removed from) the network. When a node is added to the network, the node is assigned a valid Home ID and NodeID.

This command is used to indicate the progress of the Learn Mode Set command.

Module for the DEVICE_SPECIFIC_GET command of command class COMMAND_CLASS_MANUFACTURER_SPECIFIC

Module for the DEVICE_SPECIFIC_REPORT command of command class COMMAND_CLASS_MANUFACTURER_SPECIFIC Report the manufacturer specific device specific information

Module for the MANUFACTURER_SPECIFIC_GET command of command class COMMAND_CLASS_MANUFACTURER_SPECIFIC

Module for the MANUFACTURER_SPECIFIC_REPORT command of command class COMMAND_CLASS_MANUFACTURER_SPECIFIC Report the manufacturer specific information

This module implements the METER_GET command of the COMMAND_CLASS_METER command class.

This module implements the command METER_REPORT of the COMMAND_CLASS_METER command class.

This command is used to query the members of an Aggregated End Point.

This command is used to advertise the members of an Aggregated End Point.

This command is used to request the current destinations of a given association group.

This command is used to request the number of association groups that this node supports.

This command is used to advertise the maximum number of association groups implemented by this node.

This command is used to remove NodeID and End Point destinations from a given association group. The destinations MAY be a mix of NodeID destinations and End Point destinations.

This command is used to advertise the current destinations for a given association group.

This command is used to request that one or more destinations are added to a given association group. The destinations MAY be a mix of NodeID destinations and End Point destinations.

This command is used to query the non-secure Command Class capabilities of an End Point.

This command is used to advertise the Generic and Specific Device Class and the supported command classes of an End Point.

This command is used to encapsulate commands to or from a Multi Channel End Point.

This command is used to request End Points having a specific Generic or Specific Device Class in End Points.

This command is used to advertise End Points that implement a given combination of Generic and Specific Device Classes.

This command is used to query the number of End Points implemented by the receiving node.

This command is used to advertise the number of End Points implemented by the sending node.

The Multi Command Encapsulated Command used to contain multiple Commands.

This command is used to request network topology updates from the SUC/SIS node.

This command is used to indicate if the Network Update Request command execution has completed successfully or not.

This commands does nothing other than test if the node is responding

Command for NODE_ADD

The Z-Wave Command NODE_ADD_DSK_REPORT

Command to set the DSK for a including node

Command to report the security keys requested by an including node if that node is participating in S2 bootstrapping.

Command used to grant the security keys to the including node if the including node requested keys.

Command for NODE_ADD_STATUS

Report the cached node information

Get the node information that is cached on another device

Module for the NODE_LIST_GET command

The NODE_LIST_REPORT command

This command is used to request the stored location from a node.

This command is used to advertize the location of the receiving node.

This command is used to set the location of the receiving node.

This command is used to request the stored name from a node.

This command is used to advertize the name of the receiving node.

This command is used to set the name of the receiving node.

Node Provisioning Delete Command

This module implements command COMMAND_NODE_PROVISIONING_GET of the COMMAND_CLASS_NODE_PROVISIONING command class

Module for working with the NODE_PROVISIONING_LIST_ITERATION_GET command

Module for working with the NODE_PROVISIONING_LIST_ITERATION_REPORT command

Module for working with the NODE_PROVISIONING_REPORT command

Module for working with the NODE_PROVISIONING_SET command

Z-Wave command NODE_REMOVE

Z-Wave command for NODE_REMOVE_STATUS

This command is used to request the current power level value.

This command is used to advertise the current power level.

This command is used to set the power level indicator value, which should be used by the node when transmitting RF, and the timeout for this power level indicator value before returning the power level defined by the application.

This command is used to request the result of the latest Powerlevel Test.

This command is used to report the latest result of a test frame transmission started by the Powerlevel Test Node Set Command.

This command is used to instruct the destination node to transmit a number of test frames to the specified NodeID with the RF power level specified. After the test frame transmissions the RF power level is reset to normal and the result (number of acknowledged test frames) is saved for subsequent read-back. The result of the test may be requested with a Powerlevel Test Node Get Command.

This command is used to query the current network route from a node for a given destination.

This command is used to advertise the current network route in use for an actual destination NodeID.

This command is used to query the measured RSSI on the Z-Wave network from a node.

This command is used to advertise the measured RSSI on the Z-Wave network for each used channel.

S2 Resynchronization Event

What does this command do??

This command is used to request the settings for a given scene identifier or for the scene currently active.

This command is used to advertise the settings associated to a scene identifier.

This command is used to associate the specified scene ID to the defined actuator settings.

ScheduleEntryLockDailyRepeatingGet command is used to request a daily repeating schedule slot for a identified user and specified schedule slot ID.

ScheduleEntryLockDailyRepeatingReport command is used to return the requested schedule slot ID for identified user

This command is used to set or erase a daily repeating schedule for an identified user who already has valid user access code.

This command enables or disables all schedules for type Entry Lock.

This command enables or disables schedules for a specified user code ID.

This command is used to request time zone offset and daylight savings parameters.

This command is used to advertise the time zone offset and daylight savings parameters.

This command is used to set the current local tzo and dst offsets into an Entry Lock Device. A

The ScheduleEntryLockWeekDayGet command gets a week day schedule slot for a identified user and specified schedule slot ID.

This command returns week day schedule report for the requested schedule slot ID for identified user.

This command set or erase a weekday schedule for a identified user who already has valid user access code.

The ScheduleEntryLockYearDayGet command gets a year/day schedule slot for an identified user and specified schedule slot ID.

The ScheduleEntryLockYearDayReport command returns year/day schedule report for the requested schedule slot ID for the identified user.

This command sets or erases a schedule slot for a identified user who already has valid user access code

This command is used to request the number of schedule slots each type of schedule the device supports for every user.

This command is used to report the number of supported schedule slots an Entry Lock schedule device supports for each user in the system.

What does this command do??

This command is used to advertise whether a binary sensor was triggered.

This module implements command SENSOR_MULTILEVEL_GET of command class COMMAND_CLASS_SENSOR_MULTILEVEL. The command is used to request the current reading from a multilevel sensor.

This module implements command COMMAND_CLASS_SENSOR_MULTILEVEL implements the SENSOR_MULTILEVEL_REPORT command class.

This module implements command SENSOR_MULTILEVEL_SUPPORTED_GET_SENSOR of command class COMMAND_CLASS_SENSOR_MULTILEVEL The command requests the list of supported sensor types.

This module implements command SENSOR_MULTILEVEL_SUPPORTED_SENSOR_REPORT of the COMMAND_CLASS_SENSOR_MULTILEVEL command class. This command is used to advertise the supported Sensor Types by a supporting node.

This command is sent to the unsolicited destinations when a Smart Start inclusion starts.

This command is used to clear all statistic registers maintained by the node.

This command is used to query Installation and Maintenance statistics from a node.

This command is used to query Installation and Maintenance statistics from a node.

This command is used to initiate the execution of a command and to request the immediate and future status of the process being initiated.

This command is used to advertise the status of one or more command process(es).

Get the command value of a binary switch

Module for the SWITCH_BINARY_REPORT command

Module for the SWITCH_BINARY_SET command

Module for the SWITCH_MULTILEVEL_GET

Module for the SWITCH_MULTILEVEL_REPORT

Module for the SWITCH_MULTILEVEL_SET

Module for the SWITCH_MULTILEVEL_START_LEVEL_CHANGE

Module for the SWITCH_MULTILEVEL_STOP_LEVEL_CHANGE

This module implements command THERMOSTAT_FAN_MODE_GET of the COMMAND_CLASS_THERMOSTAT_FAN_MODE command class

This module implement command THERMOSTAT_FAN_MODE_REPORT of the COMMAND_CLASS_THERMOSTAT_FAN_MODE command class

This module implement command THERMOSTAT_FAN_MODE_SET of the COMMAND_CLASS_THERMOSTAT_FAN_MODE command class

This module implement command THERMOSTAT_FAN_STATE_GET of the COMMAND_CLASS_THERMOSTAT_FAN_STATE command class

This module implements command THERMOSTAT_FAN_STATE_REPORT of the COMMAND_CLASS_THERMOSTAT_FAN_STATE command class.

This module implements command THERMOSTAT_MODE_GET of the command class COMMAND_CLASS_THERMOSTAT_MODE.

This module implements command THERMOSTAT_MODE_REPORT of the COMMAND_CLASS_THERMOSTAT_MODE command class.

This module implements command THERMOSTAT_MODE_SET of the COMMAND_CLASS_THERMOSTAT_MODE command class.

This module implement command THERMOSTAT_OPERATING_STATE_GET of the COMMAND_CLASS_THERMOSTAT_OPERATING_STATE command class

This module implement command THERMOSTAT_OPERATING_STATE_REPORT (v1) of the COMMAND_CLASS_THERMOSTAT_OPERATING_STATE command class

This module implements command THERMOSTAT_SETBACK_GET of the command class COMMAND_CLASS_THERMOSTAT_SETBACK.

This module implements command THERMOSTAT_SETBACK_REPORT of the COMMAND_CLASS_THERMOSTAT_SETBACK command class. This command is used to report the setback state of the thermostat.

This module implements command THERMOSTAT_SETBACK_SET of the COMMAND_CLASS_THERMOSTAT_SETBACK command class.

This module implements command THERMOSTAT_SETPOINT_GET of the COMMAND_CLASS_THERMOSTAT_SETPOINT command class.

This module implements command THERMOSTAT_SETPOINT_REPORT of the COMMAND_CLASS_THERMOSTAT_SETPOINT command class.

This module implements command THERMOSTAT_SETPOINT_SET of the COMMAND_CLASS_THERMOSTAT_SETPOINT command class.

This command is used to request the current time from a supporting node.

This command is used to request the Time Zone Offset (TZO) and Daylight Savings Time (DST) parameters from a supporting node.

This command is used to advertise the Time Zone Offset (TZO) and Daylight Savings Time (DST) parameters.

This command is used to set Time Zone Offset (TZO) and Daylight Savings Time (DST) at the supporting node.

This command is used to request date and time parameters.

This command is used to advertise date and time.

This command is used to set current date and time in Universal Time (UTC).

This command is used to report the current time.

This module implements command USER_CODE_GET of the COMMAND_CLASS_USER_CODE command class.

UserCodeReport reports on a user code

UserCodeSet sets the user code

This module implements the command USERS_NUMBER_GET from the COMMAND_CLASS_USER_CODE command class.

Gets the number of supported user codes

This module implements command VERSION_COMMAND_CLASS_GET of command class COMMAND_CLASS_VERSION

Reports the command class version for a device

This module implements command VERSION_GET of command class COMMAND_CLASS_VERSION

This module implements command VERSION_REPORT of command class COMMAND_CLASS_VERSION

This module implements the WAKE_UP_INTERVAL_CAPABILITIES_GET command of the COMMAND_CLASS_WAKE_UP command class.

This module implements the WAKE_UP_INTERVAL_CAPABILITIES_REPORT command of the COMMAND_CLASS_WAKE_UP command class.

This module implements the WAKE_UP_INTERVAL_GET command of the COMMAND_CLASS_WAKE_UP command class

This module implements the WAKE_UP_INTERVAL_REPORT command of the COMMAND_CLASS_WAKE_UP command class.

This module implements the WAKE_UP_INTERVAL_SET command of the COMMAND_CLASS_WAKE_UP command class.

This module implements the WAKE_UP_NO_MORE_INFORMATION command of the COMMAND_CLASS_WAKE_UP command class

This module implements the WAKE_UP_NOTIFICATION command of the COMMAND_CLASS_WAKE_UP command class

The Z/IP Packet keep alive command

Command for sending Z-Wave commands via Z/IP

Functions for working with the header extension in a Z/IP Packet.

Encapsulation format info for a Z/IP Packet

Expected Delay is the header extension that is found in a Z/IP Command to indicate how many seconds until the command will be received by a node and processed.

The installation and maintenance report for a Z/IP Packet

Used to get additional information of a Z-Wave Plus device.

This command reports the version of the Z-Wave Plus framework used and provides additional information of the Z-Wave Plus device.

Module for working with the SmartStart and S2 DSKs

Exception for when decoding a Z-Wave Command goes wrong

Z-Wave device classes

The installer icon type is used in Z-Wave Plus devices to allow interoperability with generic Z-Wave graphical user interfaces.

Z-Wave QR code This module handles Z-Wave QR codes that follow Silicon Labs Software Design Specification SDS13937 and SDS13944.

Helpers for security

Meta Extensions for SmartStart devices for QR codes and node provisioning list

This is used to advertise 16 bytes of manufactured-defined information that is unique for a given product. Z-Wave UUIDs are not limited to the format outlined in RFC 4122 but can also be ASCII characters and a relevant prefix.

Prints the generated zipgateway config to the console

Generates the scaffolding for a new Z-Wave Command

Generates the scaffolding for a new Z-Wave Command