BACnet.Protocol.TimeValue (bacstack v0.0.1)

View Source

Summary

Types

t()

Represents a BACnet Time Value (used in Daily Schedule and Special Event).

Functions

encode(time_value, opts \\ [])

Encodes a BACnet time value into BACnet application tags encoding.

parse(tags)

Parses a BACnet time value from BACnet application tags encoding.

valid?(t)

Validates whether the given time value is in form valid.

Types

t()

@type t() :: %BACnet.Protocol.TimeValue{
  time: BACnet.Protocol.BACnetTime.t(),
  value: BACnet.Protocol.ApplicationTags.Encoding.t()
}

Represents a BACnet Time Value (used in Daily Schedule and Special Event).

Functions

encode(time_value, opts \\ [])

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

Encodes a BACnet time value into BACnet 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 time value from BACnet application tags encoding.

valid?(t)

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

Validates whether the given time value is in form valid.

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