Search documentation of grizzly

# View Source Grizzly.ZWave.CommandClasses.BarrierOperator (grizzly v7.4.2)

"BarrierOperator" Command Class

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

# Summary

## Types

state()
subsystem_state()
subsystem_type()
target_value()

## Functions

bitmask_to_subsystem_types(byte)
state_from_byte(byte)
state_to_byte(stopped_position)
subsystem_state_from_byte(byte)
subsystem_state_to_byte(atom)
subsystem_type_from_byte(byte)
subsystem_type_to_byte(atom)
subsystem_types_to_bitmask(subsystem_types)

Converts subsystems into a bytes

target_value_from_byte(byte)
target_value_to_byte(atom)

# Types

Link to this type

# state()

View Source

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

Link to this type

# subsystem_state()

View Source

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

Link to this type

# subsystem_type()

View Source

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

Link to this type

# target_value()

View Source

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

# Functions

Link to this function

# bitmask_to_subsystem_types(byte)

View Source
Link to this function

# state_from_byte(byte)

View Source

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

Link to this function

# state_to_byte(stopped_position)

View Source

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

Link to this function

# subsystem_state_from_byte(byte)

View Source

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

Link to this function

# subsystem_state_to_byte(atom)

View Source

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

Link to this function

# subsystem_type_from_byte(byte)

View Source

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

Link to this function

# subsystem_type_to_byte(atom)

View Source

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

Link to this function

# subsystem_types_to_bitmask(subsystem_types)

View Source

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

Converts subsystems into a bytes

Link to this function

# target_value_from_byte(byte)

View Source

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

Link to this function

# target_value_to_byte(atom)

View Source

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