BACnet.Protocol.EventLogRecord (bacstack v0.0.1)

View Source

Summary

Types

t()

Functions

encode(record, opts \\ [])

Encode a BACnet log record into application tag-encoded.

parse(tags)

Parse a BACnet event log record from application tags encoding.

valid?(t)

Validates whether the given event log record is in form valid.

Types

t()

@type t() :: %BACnet.Protocol.EventLogRecord{
  log_datum:
    BACnet.Protocol.LogStatus.t()
    | BACnet.Protocol.Services.ConfirmedEventNotification.t()
    | {:time_change, float()},
  timestamp: BACnet.Protocol.BACnetDateTime.t()
}

Functions

encode(record, opts \\ [])

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

Encode a BACnet log record 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 event log record from application tags encoding.

valid?(t)

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

Validates whether the given event log record is in form valid.

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