BACnet.Protocol.GroupChannelValue (bacstack v0.0.1)

View Source

Summary

Types

t()

Represents a BACnet Group Channel Value.

Functions

encode(value, opts \\ [])

Encodes a group channel value struct into application tags encoding.

parse(tags)

Parses a BACnet group channel value into a struct.

valid?(t)

Validates whether the given BACnet group channel value is in form valid.

Types

t()

@type t() :: %BACnet.Protocol.GroupChannelValue{
  channel: BACnet.Protocol.ApplicationTags.unsigned16(),
  overriding_priority: 1..16 | nil,
  value:
    BACnet.Protocol.ApplicationTags.Encoding.t()
    | (lightning_command :: [BACnet.Protocol.ApplicationTags.Encoding.t()])
}

Represents a BACnet Group Channel Value.

Functions

encode(value, opts \\ [])

@spec encode(t(), Keyword.t()) ::
  {:ok, BACnet.Protocol.ApplicationTags.encoding_list()} | {:error, term()}

Encodes a group channel value struct into application tags encoding.

parse(tags)

@spec parse(BACnet.Protocol.ApplicationTags.encoding_list()) ::
  {:ok, {t(), rest :: BACnet.Protocol.ApplicationTags.encoding_list()}}
  | {:error, term()}

Parses a BACnet group channel value into a struct.

valid?(t)

@spec valid?(t()) :: boolean()

Validates whether the given BACnet group channel value is in form valid.

It only validates the struct is valid as per type specification.