View Source Grizzly.ZWave.Commands.NodeAdd (grizzly v4.0.0)

Command for NODE_ADD

Params:

  • :seq_number - the sequence number for the network command (required)
  • :mode - the inclusion mode (optional default :node_add_any_s2)
  • :tx_opts - the transmission options (optional default :explore)

If your controller does not support the NETWORK_MANAGEMENT_INCLUSION version 2, you will ned to pass :node_add_any as the :mode parameter.

This command should return the NodeAddStatus report after inclusion is complete.

Link to this section Summary

Link to this section Types

@type mode() :: :node_add_any | :node_add_stop | :node_add_any_s2
@type param() ::
  {:mode, mode()} | {:tx_opt, tx_opt()} | {:seq_number, Grizzly.seq_number()}
@type tx_opt() :: :null | :low_power | :explore

Link to this section Functions

@spec decode_mode(byte()) :: {:ok, mode()} | {:error, Grizzly.ZWave.DecodeError.t()}
@spec decode_tx_opt(byte()) ::
  {:ok, tx_opt()} | {:error, Grizzly.ZWave.DecodeError.t()}
@spec encode_mode(mode()) :: byte()
@spec encode_tx_opt(tx_opt()) :: byte()