View Source Grizzly (grizzly v6.7.0)

Send commands to Z-Wave devices

Grizzly provides the send_command function as the way to send a command to Z-Wave devices.

The send_command function takes the node id that you are trying to send a command to, the command name, and optionally command arguments and command options.

A basic command that has no options or arguments looks like this:

Grizzly.send_command(node_id, :switch_binary_get)

A command with command arguments:

Grizzly.send_command(node_id, :switch_binary_set, value: :off)

Also, a command can have options.

Grizzly.send_command(node_id, :switch_binary_get, [], timeout: 10_000, retries: 5)

Some possible return values from send_command are:

{:ok, Grizzly.Report.t()} - the command was sent and the Z-Wave device responded with a report. See Grizzly.Report for more information.
{:error, :including} - current the Z-Wave controller is adding or removing a device and commands cannot be processed right now
{:error, :firmware_updating} - current the Z-Wave controller is updating firmware and commands cannot be processed right now
{:error, reason} - there was some other reason for an error, two common ones are: :nack_response

For a more detailed explanation of the responses from a send_command call see the typedoc for Grizzly.send_command_response().

Events from Z-Wave

Events generating from a Z-Wave device, for example a motion detected event, can be handled via the Grizzly.subscribe_command/1 and Grizzly.subscribe_commands/1 functions. This will allow you to subscribe to specific commands. When the command is received from the Z-Wave network it will placed in a Grizzly.Report and set to the subscribing process. The node that generated the report can be accessed with the :node_id field in the report.

iex> Grizzly.subscribe_command(:battery_report)

# sometime latter

iex> flush
{:grizzly, :event, %Grizzly.Report{command: %Grizzly.ZWave.Command{name: :battery_report}}}

Link to this section Summary

Types

command()

command_opt()

Options for Grizzly.send_command/4.

handler()

handler_spec()

A custom handler for the command.

node_id()

send_command_response()

The response from sending a Z-Wave command

seq_number()

Functions

background_rssi()

Reports the gateway's current background RSSI (noise).

can_supervise_command?(command_name)

Whether Grizzly supports sending the given command with supervision.

commands_for_command_class(command_class_name)

List the command for a particular command class

home_id()

Returns the network's home id. Returns nil if Grizzly is started with run_zipgateway: false or if Z/IP Gateway has not yet logged the home id.

inclusion_status()

Get the current inclusion status.

is_virtual_device(device_id)

Guard for checking if device is a virtual device or not

list_commands()

List the support commands

network_keys()

Returns the network encryption keys. Returns nil if Grizzly is started with run_zipgateway: false or if Z/IP Gateway has not yet logged the network keys.

ping(node_id, opts \\ [])

Sends a no-op command to the given node to check its reachability. Transmission stats are enabled by default.

restart_zipgateway()

Restarts the Z/IP Gateway process if it is running.

send_binary(node_id, binary)

Send a raw binary to the Z-Wave node

send_command(node_id, command_name, args \\ [], opts \\ [])

Send a command to the node via the node id or to Z/IP Gateway

subscribe_command(command_name)

Subscribe to a command event from a Z-Wave device.

subscribe_commands(command_names)

Subscribe to many events from a Z-Wave device.

subscribe_node(node_id)

Subscribe to all events from a particular Z-Wave device.

subscribe_nodes(node_ids)

Subscribe to all events from a group of Z-Wave devices.

unsubscribe_command(command_name)

Unsubscribe from an event.

unsubscribe_node(node_id)

Delete a subscription created with subscribe_node/1.

virtual_device?(device_id)

Check to if the device id is a virtual device or a regular Z-Wave devices

zniffer_network_keys()

Returns the network encryption keys formatted for use with the Zniffer application. See Grizzly.ZIPGateway.LogMonitor.zniffer_network_keys/1 for more information.

Link to this section Types

command()

@type command() :: atom()

command_opt()

@type command_opt() ::
  {:timeout, non_neg_integer()}
  | {:retries, non_neg_integer()}
  | {:handler, module() | handler_spec()}
  | {:transmission_stats, boolean()}
  | {:supervision?, boolean()}
  | {:status_updates?, boolean()}

Options for Grizzly.send_command/4.

:timeout - Time (in milliseconds) to wait for an ACK or report before timing out. Maximum 140 seconds. Default 5_000.
:retries - Number of retries in case the node responds with a NACK. Default 0.
:handler - A custom response handler (see Grizzly.CommandHandler).
:transmission_stats - If true, transmission stats will be included with the returned report (if available). Default false.
:supervision? - Whether to use Supervision CC encapsulation. Default false.
:status_updates? - If true, the calling process will receive messages when a supervision status update is received from the destination node. Default false.

handler()

@type handler() :: module() | handler_spec()

handler_spec()

@type handler_spec() :: {module(), args :: any()}

A custom handler for the command.

See Grizzly.CommandHandler behaviour for more documentation.

node_id()

@type node_id() :: non_neg_integer()

send_command_response()

@type send_command_response() ::
  {:ok, Grizzly.Report.t()}
  | {:error,
     :including | :updating_firmware | :nack_response | :queue_full | any()}

The response from sending a Z-Wave command

When everything is okay the response will be {:ok, Grizzly.Report{}}. For documentation about a report see Grizzly.Report module.

When there are errors the response will be in the pattern of {:error, reason}.

Three reasons that Grizzly supports for all commands are :nack_response, :update_firmware, and :including.

In you receive the reason for the error to be :including that means the controller is in an inclusion state and your command will be dropped if we tried to send it. So we won't allow sending a Z-Wave command during an inclusion. It's best to wait and try again once your application is done trying to include.

nack-response
Nack response

A :nack_response normally means that the Z-Wave node that you were trying to send a command to is unreachable and did not receive your command at all. This could mean that the Z-Wave network is overloaded and you should reissue the command, the device is too far from the controller, or the device is no longer part of the Z-Wave network.

Grizzly by default will try a command 3 times before sending returning a :nack_response. This is configurable via the :retries command option in the Grizzly.send_command/4 function. This is useful if you are going to have a known spike in Z-Wave traffic.

queue-full
Queue full

When send commands to a device that sleeps (normally these are sensor type of devices) and the sleeping device is not awake these commands get queued up to be sent once the device wakes up and tells the Z-Wave network that it is awake. However, there is only a limited amount of commands that can be queued at once. When sending a command to a device when the queue is full you will receive the {:error, :queue_full} return from Grizzly.send_command/4. The reason this is an error is because the device will never receive the command that you tried to send.

seq_number()

@type seq_number() :: non_neg_integer()

Link to this section Functions

background_rssi()

@spec background_rssi() ::
  {:ok, [Grizzly.ZWave.Commands.RssiReport.param()]} | {:error, any()}

Reports the gateway's current background RSSI (noise).

can_supervise_command?(command_name)

@spec can_supervise_command?(command()) :: boolean()

Whether Grizzly supports sending the given command with supervision.

commands_for_command_class(command_class_name)

@spec commands_for_command_class(atom()) :: [atom()]

List the command for a particular command class

home_id()

@spec home_id() :: binary() | nil

Returns the network's home id. Returns nil if Grizzly is started with run_zipgateway: false or if Z/IP Gateway has not yet logged the home id.

inclusion_status()

@spec inclusion_status() :: Grizzly.Inclusions.status()

Get the current inclusion status.

is_virtual_device(device_id)

(macro)

Guard for checking if device is a virtual device or not

list_commands()

@spec list_commands() :: [atom()]

List the support commands

network_keys()

@spec network_keys() ::
  [{Grizzly.ZIPGateway.LogMonitor.network_key_type(), binary()}] | nil

Returns the network encryption keys. Returns nil if Grizzly is started with run_zipgateway: false or if Z/IP Gateway has not yet logged the network keys.

ping(node_id, opts \\ [])

@spec ping(Grizzly.ZWave.node_id(), [command_opt()]) :: send_command_response()

Sends a no-op command to the given node to check its reachability. Transmission stats are enabled by default.

restart_zipgateway()

@spec restart_zipgateway() :: :ok

Restarts the Z/IP Gateway process if it is running.

send_binary(node_id, binary)

@spec send_binary(Grizzly.ZWave.node_id(), binary()) ::
  :ok | {:error, :including | :firmware_updating}

Send a raw binary to the Z-Wave node

This function does not block and expects the sending process to handle the lifecycle of the command being sent. This maximizes control but minimizes safety and puts things such as timeouts, retries, and response handling in the hand of the calling process.

When sending the binary ensure the binary is the encoded Grizzly.ZWave.Commands.ZIPPacket.

seq_no = 0x01
{:ok, my_command} = Grizzly.ZWave.Commands.SwitchBinaryGet.new()
{:ok, packet} = Grizzly.ZWave.Commands.ZIPPacket.with_zwave_command(my_command, seq_no)
binary = Grizzly.ZWave.to_binary(packet)

Grizzly.send_binary(node_id, binary)

This is helpful when you need very fine grade control of the Z/IP Packet or if you not expecting a response from a Z-Wave network to handle the back and forth between your application and the Z-Wave network. Also, this can be useful for debugging purposes.

First check if send_command/4 will provide the functionality that is needed before using this function.

After sending a binary packet the calling process will receive messages in the form of:

{:grizzly, :binary_response, binary}

send_command(node_id, command_name, args \\ [], opts \\ [])

@spec send_command(
  Grizzly.ZWave.node_id() | :gateway | Grizzly.VirtualDevices.id(),
  command(),
  args :: list(),
  [command_opt()]
) :: send_command_response()

Send a command to the node via the node id or to Z/IP Gateway

To talk to your controller directly you can pass :gateway as the node id. This is helpful because your controller might not always be the same node id on any given network. This ensures that not matter node id your controller is you will still be able to query it and make it perform Z-Wave functions. There are many Z-Wave functions a controller do. There are helper functions for these functions in Grizzly.Network and Grizzly.Node.

NOTE: The :handler and :supervision? options are not compatible. If :supervision? is true, any custom handler will be ignored.

subscribe_command(command_name)

@spec subscribe_command(command()) :: :ok

Subscribe to a command event from a Z-Wave device.

subscribe_commands(command_names)

@spec subscribe_commands([command()]) :: :ok

Subscribe to many events from a Z-Wave device.

subscribe_node(node_id)

Subscribe to all events from a particular Z-Wave device.

NOTE: Subscribers using both subscribe_node and subscribe_command will receive duplicate messages.

subscribe_nodes(node_ids)

@spec subscribe_nodes([node_id() | Grizzly.VirtualDevices.id()]) :: :ok

Subscribe to all events from a group of Z-Wave devices.

NOTE: Subscribers using both subscribe_node and subscribe_command will receive duplicate messages.

unsubscribe_command(command_name)

@spec unsubscribe_command(command()) :: :ok

Unsubscribe from an event.

unsubscribe_node(node_id)

Delete a subscription created with subscribe_node/1.

virtual_device?(device_id)

@spec virtual_device?(
  :gateway
  | Grizzly.ZWave.node_id()
  | Grizzly.VirtualDevices.id()
) :: boolean()

Check to if the device id is a virtual device or a regular Z-Wave devices

zniffer_network_keys()

@spec zniffer_network_keys() :: binary() | nil

Returns the network encryption keys formatted for use with the Zniffer application. See Grizzly.ZIPGateway.LogMonitor.zniffer_network_keys/1 for more information.

Settings View Source Grizzly (grizzly v6.7.0)

Events from Z-Wave

Link to this section Summary

Types

Functions

Link to this section Types

command()

command_opt()

handler()

handler_spec()

node_id()

send_command_response()

nack-response Nack response

queue-full Queue full

seq_number()

Link to this section Functions

background_rssi()

can_supervise_command?(command_name)

commands_for_command_class(command_class_name)

home_id()

inclusion_status()

is_virtual_device(device_id)

list_commands()

network_keys()

ping(node_id, opts \\ [])

restart_zipgateway()

send_binary(node_id, binary)

send_command(node_id, command_name, args \\ [], opts \\ [])

subscribe_command(command_name)

subscribe_commands(command_names)

subscribe_node(node_id)

subscribe_nodes(node_ids)

unsubscribe_command(command_name)

unsubscribe_node(node_id)

virtual_device?(device_id)

zniffer_network_keys()

View Source Grizzly (grizzly v6.7.0)

nack-response
Nack response

queue-full
Queue full