View Source Grizzly.Node (grizzly v8.6.6)

Functions for working directly with a Z-Wave node

Summary

Types

id()

info_opt()

Options to use when getting device info.

lifeline_opts()

opt()

Functions

get_dsk(node_id, add_mode, opts \\ [])

Get a node's dsk.

get_info(node_id, opts \\ [])

Get the information for a node by its id

get_lifeline_association(node_id)

Get the lifeline association group for a node.

get_statistics(node_id)

Gets a node's statistics from Z/IP Gateway.

set_lifeline_association(node_id, opts \\ [])

Set lifeline association for the node

Types

id()

@type id() :: non_neg_integer()

info_opt()

@type info_opt() :: {:force_update, boolean()} | info_opt()

Options to use when getting device info.

:force_update - By default there is a cache managed by zipgateway that tracks the device information. Sometimes that can get out of date, so you can pass [force_update: true] to force the cache to update the device info. By default this is false

lifeline_opts()

@type lifeline_opts() ::
  {:controller_id, Grizzly.ZWave.node_id()}
  | {:extra_node_ids, [Grizzly.ZWave.node_id()]}

opt()

@type opt() :: {:seq_number, integer()} | {:timeout, non_neg_integer()}

Functions

get_dsk(node_id, add_mode, opts \\ [])

@spec get_dsk(Grizzly.ZWave.node_id() | :gateway, :add | :learn, [
  Grizzly.command_opt()
]) ::
  Grizzly.send_command_response()

Get a node's dsk.

The response to this command is the DSKReport command

Sending this command with :gateway will always go to your Z-Wave controller

get_info(node_id, opts \\ [])

@spec get_info(Grizzly.ZWave.node_id() | Grizzly.VirtualDevices.id(), [
  info_opt() | opt()
]) ::
  Grizzly.send_command_response()

Get the information for a node by its id

The response to this command is the NodeInfoCacheReport command

get_lifeline_association(node_id)

@spec get_lifeline_association(Grizzly.ZWave.node_id() | Grizzly.VirtualDevices.id()) ::
  Grizzly.send_command_response()

Get the lifeline association group for a node.

get_statistics(node_id)

@spec get_statistics(Grizzly.ZWave.node_id() | Grizzly.VirtualDevices.id()) ::
  {:ok,
   Grizzly.ZWave.CommandClasses.NetworkManagementInstallationMaintenance.statistics()}
  | {:error, any()}

Gets a node's statistics from Z/IP Gateway.

set_lifeline_association(node_id, opts \\ [])

@spec set_lifeline_association(
  Grizzly.ZWave.node_id() | Grizzly.VirtualDevices.id(),
  [lifeline_opts()]
) ::
  Grizzly.send_command_response()

Set lifeline association for the node

The lifeline associated is used to report events that happen at the Z-Wave device level back to the Z-Wave controller. For example, if you turn on a light and want to be notified, the device will need to have it's lifeline association set.

Opts:

:controller_id - the idea of the main controller to send lifeline reports to (defaults to 1)
:extra_node_ids - any extra nodes to set add to the association group