Grizzly.ZWave.SmartStart.MetaExtension.SmartStartInclusionSetting (grizzly v0.15.6) View Source

This extension is used to advertise the SmartStart inclusion setting of the provisioning list entry

Link to this section Summary

Types

The setting for SmartStart inclusion. This tells the controller if it must listen and/or include a node in the network when receiving SmartStart inclusion requests.

t()

Functions

Make a binary from a SmartStartInclusionSetting.t()

Make a SmartStartInclusionSetting.t() from a binary

Link to this section Types

Specs

setting() :: :pending | :passive | :ignored

The setting for SmartStart inclusion. This tells the controller if it must listen and/or include a node in the network when receiving SmartStart inclusion requests.

  • :pending - the node will be added to the network when it issues SmartStart inclusion requests.
  • :passive - this node is unlikely to issues a SmartStart inclusion request and SmartStart inclusion requests will be ignored from this node by the Z/IP Gateway. All nodes in the list with this setting must be updated to :pending when Provisioning List Iteration Get command is issued.
  • :ignored - All SmartStart inclusion request are ignored from this node until updated via Z/IP Client (Grizzly) or a controlling node.

Specs

t() :: %Grizzly.ZWave.SmartStart.MetaExtension.SmartStartInclusionSetting{
  setting: setting()
}

Link to this section Functions

Specs

from_binary(binary()) ::
  {:ok, t()}
  | {:error, :invalid_setting | :critical_bit_not_set | :invalid_binary}

Make a binary from a SmartStartInclusionSetting.t()

If the setting is invalid this function will return {:error, :invalid_setting}

If the binary does not have the critical bit set then this function will return {:error, :critical_bit_not_set}

Specs

new(setting()) :: {:ok, t()} | {:error, :invalid_setting}
Link to this function

to_binary(smart_start_inclusion_setting)

View Source

Specs

to_binary(t()) :: {:ok, binary()}

Make a SmartStartInclusionSetting.t() from a binary

If the setting is invalid this function will return {:error, :invalid_setting}