BACnet.Protocol.EnrollmentSummary (bacstack v0.1.0-dev.1)

Copy Markdown View Source

An Enrollment Summary entry is produced by the Get Enrollment Summary service. It lists the objects inside a device that have been configured to generate event notifications (intrinsic or algorithmic) to a particular notification class or recipient, filtered by the parameters supplied in the request.

Each entry carries the object identifier, the event type that the object is configured to generate, the current event state, the priority that will be used in notifications, and optionally the notification class. This information is primarily useful for management stations that need to discover which objects will send alarms to a given operator or system, or to audit the event subscription configuration of a large site.

The service supports several different "acknowledgment filter" modes so that a client can ask for only unacknowledged alarms, only acknowledged alarms, or all enrollments regardless of acknowledgment state.

Summary

Types

t()

Represents a single entry returned by the Get Enrollment Summary service.

Functions

encode(summary, opts \\ [])

Encodes a BACnet enrollment summary into BACnet application tags encoding.

parse(tags)

Parses a BACnet enrollment summary from BACnet application tags encoding.

valid?(t)

Validates whether the given enrollment summary is in form valid.

Types

t()

@type t() :: %BACnet.Protocol.EnrollmentSummary{
  event_state: BACnet.Protocol.Constants.event_state(),
  event_type: BACnet.Protocol.Constants.event_type(),
  notification_class: non_neg_integer() | nil,
  object_identifier: BACnet.Protocol.ObjectIdentifier.t(),
  priority: byte()
}

Represents a single entry returned by the Get Enrollment Summary service.

Functions

encode(summary, opts \\ [])

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

Encodes a BACnet enrollment summary 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 enrollment summary from BACnet application tags encoding.

valid?(t)

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

Validates whether the given enrollment summary is in form valid.

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