Grizzly.ZWave.CommandClasses.NetworkManagementInstallationMaintenance (grizzly v8.11.0)

View Source

"NetworkManagementInstallationMaintenance" Command Class

The Network Management Installation and Maintenance Command Class is used to access statistical data.

Summary

Types

neighbor()
neighbor_param()
route_type()
rssi()
speed()
speeds()
statistic()
statistics()

Functions

neighbor_speeds_from_byte(byte)
neighbor_speeds_to_byte(speeds)
repeaters_from_bytes(bytes)
repeaters_to_bytes(repeaters)
route_type_from_byte(byte)
route_type_to_byte(type)
rssi_from_byte(byte)

Decodes the given byte to an 8-bit signed integer (or one of the special values defined in the spec).

rssi_to_byte(rssi)

Encodes the given RSSI value to an 8-bit signed integer.

speed_from_byte(byte)
speed_to_byte(speed)
statistics_from_binary(arg)
statistics_to_binary(statistics)

Types

neighbor()

@type neighbor() :: [neighbor_param()]

neighbor_param()

@type neighbor_param() ::
  {:node_id, byte()} | {:repeater?, boolean()} | {:speed, speeds()}

route_type()

@type route_type() ::
  :no_route
  | :last_working_route
  | :next_to_last_working_route
  | :set_by_application

rssi()

@type rssi() ::
  :rssi_not_available
  | :rssi_max_power_saturated
  | :rssi_below_sensitivity
  | -124..127

speed()

@type speed() :: :"9.6kbit/s" | :"40kbit/s" | :"100kbit/s" | :reserved

speeds()

@type speeds() :: [speed()]

statistic()

@type statistic() ::
  {:route_changes, byte()}
  | {:transmission_count, byte()}
  | {:neighbors, [neighbor()]}
  | {:packet_error_count, byte()}
  | {:sum_of_transmission_times, non_neg_integer()}
  | {:sum_of_transmission_times_squared, non_neg_integer()}

statistics()

@type statistics() :: [statistic()]

Functions

neighbor_speeds_from_byte(byte)

@spec neighbor_speeds_from_byte(byte()) :: {:ok, speeds()}

neighbor_speeds_to_byte(speeds)

@spec neighbor_speeds_to_byte(speeds()) :: byte()

repeaters_from_bytes(bytes)

repeaters_to_bytes(repeaters)

route_type_from_byte(byte)

@spec route_type_from_byte(any()) ::
  {:error, Grizzly.ZWave.DecodeError.t()} | {:ok, route_type()}

route_type_to_byte(type)

@spec route_type_to_byte(route_type()) :: byte()

rssi_from_byte(byte)

@spec rssi_from_byte(byte()) :: rssi()

Decodes the given byte to an 8-bit signed integer (or one of the special values defined in the spec).

NOTE: In order to support Z/IP Gateway quirks, this function accepts values outside of the range specified in the spec (-32..-128). This function may return any value in the range -128..124.

rssi_to_byte(rssi)

@spec rssi_to_byte(rssi()) :: byte()

Encodes the given RSSI value to an 8-bit signed integer.

NOTE: In order to support Z/IP Gateway quirks, this function accepts values outside of the range specified in the spec (-32..-128). Values out of range for an 8-bit signed integer will overflow.

speed_from_byte(byte)

@spec speed_from_byte(byte()) ::
  {:ok, speed()} | {:error, Grizzly.ZWave.DecodeError.t()}

speed_to_byte(speed)

@spec speed_to_byte(speed()) :: byte()

statistics_from_binary(arg)

statistics_to_binary(statistics)