BACnet.Protocol.SpecialEvent (bacstack v0.0.1)

View Source

Summary

Types

t()

Represents a BACnet Special Event.

Functions

encode(event, opts \\ [])

Encode a BACnet special event into application tag-encoded.

parse(tags)

Parse a BACnet special event from application tags encoding.

valid?(t)

Validates whether the given special event is in form valid.

Types

t()

@type t() :: %BACnet.Protocol.SpecialEvent{
  list: [BACnet.Protocol.TimeValue.t()],
  period:
    BACnet.Protocol.CalendarEntry.t() | BACnet.Protocol.ObjectIdentifier.t(),
  priority: 1..16
}

Represents a BACnet Special Event.

Functions

encode(event, opts \\ [])

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

Encode a BACnet special event into application tag-encoded.

parse(tags)

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

Parse a BACnet special event from application tags encoding.

valid?(t)

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

Validates whether the given special event is in form valid.

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