API Reference grizzly v#9.1.0

Send commands, subscribe to unsolicited events, and other helpers.

Storage for Z-Wave association groups. Supports both standard and multi channel associations.

A representation of a Z-Wave association group with associated nodes.

Pubsub registry for Grizzly events other than Z-Wave commands from devices.

Behaviour for handling incoming commands during the firmware update process

Module for upgrading firmware on target devices.

A Circuits.UART.Framing implementation for handling framing of data exchanged with the Gecko bootloader during over-the-wire firmware updates.

A firmware upgrade specification used to determine if a firmware image can be applied given the running firmware version.

State machine for managing an OTW update for a Z-Wave controller module.

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

Grizzly config options.

Reports from Z-Wave commands

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 handler is used for non-get commands sent with Supervision.

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.

Persistent storage for device information and other Grizzly internals.

Behaviour for Grizzly storage adapters.

A storage adapter for PropertyTable.

Supervisor for running the Grizzly runtime.

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

DTLS implementation of the Grizzly.Transport behaviour

Virtual devices

Behaviour for implementing virtual device specifics

Builds valid zipgateway.cfg based on Grizzly options.

Functions for inspecting and debugging Z/IP Gateway's SQLite database.

Does some sanity checking on the Z/IP Gateway SQLite database during its init, then exits normally.

Monitors the Z/IP Gateway logs to extract and process certain data.

Supervisor for the Z/IP Gateway process.

Module for Z-Wave protocol specific functionality and information

Data struct and behaviour for working with Z-Wave commands

Utilities for encoding and decoding command classes and command class lists.

"BarrierOperator" Command Class

"CentralScene" Command Class

DoorLock Command Class

Types and functions for the Humidity Control Mode, Operating State, and Setpoint command classes.

"Indicator" Command Class

"Meter" Command Class

"MultiChannelAssociation" Command Class

Network Management Inclusion Command Class

"NetworkManagementInstallationMaintenance" Command Class

NodeProvisioning Command Class

S0 (Security) Command Class

"SceneActuatorConf" Command Class

Security 2 (S2) Command Class

S2 AAD (Additional Authenticated Data) structure

"SensorMultilevel" Command Class

"ThermostatMode" Command Class

"ThermostatSetback" Command Class

"ThermostatSetpoint" Command Class

Command Class for working with user codes

User Credential command class

Window Covering Command Class

"ZwaveplusInfo" Command Class

Data structure describing a Z-Wave command, including how to create, encode, and decode it.

Lookup table for sendable Z-Wave commands.

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 advertise supported Alarm/Notification Types. Versions 2+ are supported.

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

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

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

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

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 returns a bit mask of signaling subsystem(s) supported by the sending node.

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_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 advertise a scene key event.

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 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 advertise the properties of a configuration parameter.

Set the configuration parameter

CredentialCapabilitiesReport is used to report the capabilities related to credentials at the sending node.

CredentialReport is used to report the status of a credential at the sending node.

CredentialSet is used to set a specific credential at the receiving node.

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

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

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

OperationReport is used to advertise the status of a door lock

ExtendedNodeAddStatus

This command is used to report the user code of a specific user identifier.

This command is used to request the user code of a specific user identifier.

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.

Command for FAILED_NODE_REPLACE

Command for FAILED_NODE_REPLACE_STATUS

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

Generic encoder and decoder for Z-Wave commands.

HumidityControlSetpointCapabilitiesReport

HumidityControlSetpointSet

This command is sent by Z/IP Gateway to the unsolicited destination(s) when a SmartStart Included Node Information Frame (NIF) is received and both of the following conditions are fulfilled

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

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 , which is used to advertise the current meter reading at the sending node.

This module implements the command METER_RESET of the METER command class.

This module implement command METER_SUPPORTED_REPORT of command class METER.

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

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

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 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 advertise the number of End Points implemented by the sending node.

The Multi Command Encapsulated Command used to contain multiple Commands.

Command to query the capabilities of one individual endpoint or aggregated end point

Command to query the capabilities of one individual endpoint or aggregated end point

Command is used to query the number of Multi Channel End Points and other relevant Multi Channel attributes

Command use to advertise the number of Multi Channel End Points

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

Get the node information that is cached on another device

Report the cached node information

Instruct a node to send its Node Information Frame to another node (typically a controller).

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_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 advertise the current network route in use for an actual destination NodeID.

This command is used to set the network route to use when sending commands to the specified NodeID. This route will override the normal routing table.

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

Lists commands supported by a node when using S0.

This command is used to request an external nonce from the receiving node.

Lists commands supported by a node when using S2.

This command is used by a joining node to advertise the network keys which it intends to request from the including node. The including node subsequently grants keys which may be exchanged once a temporary secure channel has been established.

During initial key exchange this command is used by an including node to grant network keys to a joining node. The joining node subsequently requests the granted keys once a temporary secure channel has been established.

Encapsulates a message for transmission using S2.

Functions for working with S2 Message Encapsulation extensions.

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.

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_SCALE_REPORT of the COMMAND_CLASS_SENSOR_MULTILEVEL command class. This command is used to advertise the supported scales of a specified multilevel sensor type.

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 advertise the information associated with a tone at a supporting 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).

Module for the SWITCH_BINARY_REPORT command

Module for the SWITCH_BINARY_SET command

Module for the SWITCH_MULTILEVEL_REPORT

Module for the SWITCH_MULTILEVEL_SET

Module for the SWITCH_MULTILEVEL_START_LEVEL_CHANGE

This module implements command THERMOSTAT_MODE_SET of the COMMAND_CLASS_THERMOSTAT_MODE command class.

This command is used to report the thermostat's supported modes.

This command is used request the supported setpoint value range for a setpoint type.

This command is used advertise the supported setpoint value range for a given setpoint type.

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 report the thermostat's supported setpoint types.

UserCapabilitiesReport

This command is used to advertise User Code capabilities.

UserCodeReport reports on a user code

UserCodeSet sets the user code

UserReport is used to report the status of a user ID at the sending node.

UserSet

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_REPORT of command class COMMAND_CLASS_VERSION

This module implements command VERSION_ZWAVE_SOFTWARE_REPORT of command class COMMAND_CLASS_VERSION

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

The WindowCoveringGet command is used to request the status of a specified Windows Covering Parameter.

his command is used to request the status of a specified Covering Parameter.

This command is used to control one or more parameters in a window covering device.

This command is used to initiate a transition of one parameter to a new level.

This command is used to stop an ongoing transition.

This command is used to advertise the supported properties of a windows covering device.

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

The installation and maintenance report for a Z/IP Packet

Command to advertise the configured Z-Wave Long Range Channel

Command to configure which channel to use for Z-Wave Long Range

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

Z-Wave device classes

Utility functions for encoding/decoding common data types.

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

Encoding and decoding functions for notification events and types from the Notification command class.

Data structure describing a parameter for a Z-Wave command.

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

Helpers for security

This module is used to generate and store S0 nonces in response to incoming Security Nonce Get commands.

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.

A bidirectional map for Z-Wave enumerations.

Exception for when receiving unsupported Z-Wave binary