Grizzly.Network (grizzly v0.22.2) View Source

Module for working with the Z-Wave network

Link to this section Summary

Types

Options for when you want to reset the device

Functions

Add a long range device to the provisioning list

Delete a node from the network's provisioning list via the node's DSK

Get a list of node ids from the network

Get the nodes provisioning list information via the node's DSK

List all the nodes on the provisioning list

Remove a (presumably) failed node

Request a network update (network healing)

Reset the Z-Wave controller

A node to the network provisioning list

Link to this section Types

Specs

opt() :: {:node_id, Grizzly.ZWave.node_id()}

Specs

reset_opt() :: {:notify, boolean()}

Options for when you want to reset the device

  • :notify - if the flag is set to true this will try to notify any node that is part of the lifeline association group (default true)

Link to this section Functions

Link to this function

add_long_range_device(dsk, opts \\ [])

View Source

Specs

add_long_range_device(Grizzly.ZWave.DSK.t(), [opt()]) ::
  Grizzly.send_command_response()

Add a long range device to the provisioning list

Link to this function

delete_node_provisioning(dsk, opts \\ [])

View Source

Specs

delete_node_provisioning(Grizzly.ZWave.DSK.t(), [opt()]) ::
  Grizzly.send_command_response()

Delete a node from the network's provisioning list via the node's DSK

Options

  • :node_id - If your controller is part of another controller's network you might want to issue network commands to that controller. By default this option will chose your controller.
Link to this function

get_node_ids(opts \\ [])

View Source

Specs

get_node_ids([opt()]) :: Grizzly.send_command_response()

Get a list of node ids from the network

Just because a node id might be in the list does not mean the node is on the network. A device might have been reset or unpaired from the controller with out the controller knowing. However, in most use cases this shouldn't be an issue.

Options

  • :node_id - If your controller is part of another controller's network you might want to issue network commands to that controller. By default this option will chose your controller.
Link to this function

get_node_provisioning(dsk, opts \\ [])

View Source

Specs

get_node_provisioning(Grizzly.ZWave.DSK.t(), [opt()]) ::
  Grizzly.send_command_response()

Get the nodes provisioning list information via the node's DSK

Options

  • :node_id - If your controller is part of another controller's network you might want to issue network commands to that controller. By default this option will chose your controller.
Link to this function

list_node_provisionings(remaining_counter, opts \\ [])

View Source

Specs

list_node_provisionings(integer(), [opt()]) :: Grizzly.send_command_response()

List all the nodes on the provisioning list

Options

  • :node_id - If your controller is part of another controller's network you might want to issue network commands to that controller. By default this option will chose your controller.
Link to this function

remove_failed_node(opts \\ [])

View Source

Specs

remove_failed_node([opt()]) :: Grizzly.send_command_response()

Remove a (presumably) failed node

Options

  • :node_id - If your controller is part of another controller's network you might want to issue network commands to that controller. By default this option will chose your controller.
Link to this function

request_network_update(opts \\ [])

View Source

Specs

request_network_update([opt()]) :: Grizzly.send_command_response()

Request a network update (network healing)

Options

  • :node_id - If your controller is part of another controller's network you might want to issue network commands to that controller. By default this option will chose your controller.
Link to this function

reset_controller(opts \\ [])

View Source

Specs

reset_controller([reset_opt() | opt()]) :: Grizzly.send_command_response()

Reset the Z-Wave controller

This command takes a few seconds to run.

Options

  • :node_id - If your controller is part of another controller's network you might want to issue network commands to that controller. By default this option will chose your controller.
Link to this function

set_node_provisioning(dsk, meta_extensions, opts \\ [])

View Source

Specs

A node to the network provisioning list

Options

  • :node_id - If your controller is part of another controller's network you might want to issue network commands to that controller. By default this option will chose your controller.