View Source Grizzly.ZWave.CommandClasses.BarrierOperator (grizzly v8.6.6)

"BarrierOperator" Command Class

The Barrier Operator Command Class is used to control and query the status of motorized barriers.

Summary

Types

state()

@type state() :: :closed | 1..99 | :closing | :stopped | :opening | :open

subsystem_state()

@type subsystem_state() :: :on | :off

subsystem_type()

@type subsystem_type() :: :audible_notification | :visual_notification

target_value()

@type target_value() :: :open | :close

Functions

bitmask_to_subsystem_types(byte)

state_from_byte(byte)

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

state_to_byte(stopped_position)

@spec state_to_byte(state()) :: byte()

subsystem_state_from_byte(byte)

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

subsystem_state_to_byte(atom)

@spec subsystem_state_to_byte(:off | :on) :: 0 | 255

subsystem_type_from_byte(byte)

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

subsystem_type_to_byte(atom)

@spec subsystem_type_to_byte(:audible_notification | :visual_notification) :: 1 | 2

subsystem_types_to_bitmask(subsystem_types)

@spec subsystem_types_to_bitmask([subsystem_type()]) :: byte()

Converts subsystems into a bytes

target_value_from_byte(byte)

@spec target_value_from_byte(byte()) ::
  {:error, Grizzly.ZWave.DecodeError.t()} | {:ok, :close | :open}

target_value_to_byte(atom)

@spec target_value_to_byte(:close | :open) :: 0 | 255