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

This extension is used to advertise if the node is in the network and its assigned node id

Link to this section Summary

Types

The different network statuses are

t()

Functions

Make a NetworkStatus.t() from a binary string

Create a NetworkStatus.t()

Make a binary string from a NetworkStatus.t()

Link to this section Types

Specs

network_status() :: :not_in_network | :included | :failing

The different network statuses are:

  • :not_in_network - the node in the provisioning list is not included in the network
  • :included - the node in the provisioning list is included in the network and is functional
  • :failing - the node in the provisioning list is included in the network but is now marked as failing

Specs

t() :: %Grizzly.ZWave.SmartStart.MetaExtension.NetworkStatus{
  network_status: network_status(),
  node_id: Grizzly.ZWave.node_id()
}

Link to this section Functions

Specs

from_binary(binary()) ::
  {:ok, t()}
  | {:error, :invalid_network_status | :critical_bit_set | :invalid_binary}

Make a NetworkStatus.t() from a binary string

The binary string's critical bit MUST not be set. If it is this function will return {:error, :critical_bit_set}

Link to this function

new(node_id, network_status)

View Source

Specs

new(Grizzly.ZWave.node_id(), network_status()) ::
  {:ok, t()} | {:error, :invalid_network_status | :invalid_node_id}

Create a NetworkStatus.t()

If the node is not included into the network the node_id has to be equal to 0. If the node has been included into the network and is either functional or failing then it has to have a node_id greater than 0.

Link to this function

to_binary(network_status)

View Source

Specs

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

Make a binary string from a NetworkStatus.t()