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

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

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

Whether Grizzly supports sending the given command with supervision.

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

List the supported Z-Wave commands for a particular command class.

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

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

Get the current inclusion status.

Guard for checking if device is a virtual device or not

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

List all supported Z-Wave commands.

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

@spec options() :: Grizzly.Options.t() | nil

Return the options Grizzly.Supervisor was started with. Returns nil if supervisor is not started.

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

@spec restart_zipgateway() :: :ok

Restarts the Z/IP Gateway process. An error will be raised if Grizzly.ZIPGateway.Supervisor is not running.

@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 a binary command to a Z-Wave node, the binary must be encapsulated in a Z/IP Packet (see 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 can be useful when you need very fine-grained control of the outgoing Z/IP Packet, if you need to send a command that has not been implemented in Grizzly yet (contributions are welcome!), or for debugging purposes.

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

{:grizzly, :binary_response, <<...>>}

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

Arguments

• node_id - The node id to send the command to. If :gateway is passed, the command will be sent to the locally running Z/IP Gateway -- this is useful if this controller has a node id other than 1.

• command - The command to send. See Grizzly.Commands.Table for a list of available commands and their associated modules.

• args - A list of arguments to pass to the command. See the associated command module for details.

• opts - A keyword list of options to control how the command is sent and processed. See Grizzly.command_opt/0 for details.

Usage

# A command with no arguments or options:
Grizzly.send_command(node_id, :switch_binary_get)

# ... with arguments:
Grizzly.send_command(node_id, :switch_binary_set, value: :off)

# ... with arguments and options:
Grizzly.send_command(node_id, :switch_binary_get, [], timeout: 10_000, retries: 5)

Return values and errors

Following are the most common return values and errors that you will see. For a complete list, see Grizzly.send_command_response/0.

• {:ok, Grizzly.Report.t()} - the command was sent and the Z-Wave device responded with an ACK or a report. See Grizzly.Report for more information.
• {:error, :including} - the Z-Wave controller is currently in inclusion or exclusion mode
• {:error, :firmware_updating} - the Z-Wave controller is undergoing a firmware update
• {:error, reason} - see Grizzly.send_command_response/0

@spec stop_zipgateway() :: :ok

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

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

Subscribe to unsolicited events for the given command.

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

Subscribe to unsolicited events for multiple commands.

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

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

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

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

Unsubscribe from an unsolicited event.

Delete a subscription created with subscribe_node/1.

@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

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