grizzly v0.9.0-rc.3 API Reference

Modules

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 inclusion process

Module for adding and removing Z-Wave nodes

Module for working with the Z-Wave network

Functions for working directly with a Z-Wave node

Cofiguration params

Module for Z-Wave protocol specific functionality and information

Data struct and behaviour for working with Z-Wave commands

Behaviour for a command class implementation

Association Command Class

"Basic" Command Class

"Battery" Command Class

Configuration 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.

ManufacturerSpecific Command Class

"Meter" 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

Network Management Proxy Command Class

"NoOperation" Command Class

NodeProvisioning 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

Command Class for working with user codes

Version Command Class

"WakeUp" Command Class

This command notifies the application of the alarm state

Get the current destinations for the association group

Report the destinations for the given association group

Module for the ASSOCIATION_SET command

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.

This module implements command VERSION_COMMAND_CLASS_GET of command class COMMAND_CLASS_VERSION

Reports the command class version for a device

Set the configuration parameter

Request the S2 DSK of a Node

Report the DSK for the Z-Wave Node

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

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

What does this command do??

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

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 commands does nothing other than test if the node is responding

Command for NODE_ADD

The Z-Wave Command NODE_ADD_DSK_REPORT

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

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

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 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).

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 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_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

Command for sending Z-Wave commands via Z/IP

Functions for working with the header extension in 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.

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.

Helpers for security

This extension is used to advertise the Security keys to grant during S2 bootstrapping to a SmartStart node in the provisioning list For more information about S2 security see the Grizzly.Security module

This extension is used to advertise the bootstrapping mode to use when including the node advertised in the provisioning list

This extension is used to advertise the location assigned to the supporting node

This is used to advertise if a power constrained Smart Start node will issue inclusion request at a higher interval value than the default 512 seconds.

This extension is used to advertise the name assigned to the supporting node

This extension is used to advertise if the node is in the network and its assigned node id

This Information Type is used to advertise the product identifying data of a supporting node.

This Information Type is used to advertise the product type data of a supporting node

This extension is used to advertise the SmartStart inclusion setting of the provisioning list entry

This is used to advertise 16 bytes of manufactured-defined information that is unique for a given product.

Mix Tasks

Generates the scaffolding for a new Z-Wave Command

Generates the scaffolding for a new Z-Wave Command