BACnet.Protocol.Services.Ack.GetEnrollmentSummaryAck (bacstack v0.1.0-dev.1)

Copy Markdown View Source

The Get Enrollment Summary Acknowledgment returns the list of objects that have been configured to generate event notifications to a particular recipient or notification class.

Each entry is an Enrollment Summary record containing the object identifier, the type of event it generates, its current state, the priority it will use, and the notification class. This service is useful for auditing and managing which objects are currently "subscribed" to send alarms to a given system or operator.

Summary

Types

t()

Response for Get Enrollment Summary. Contains the filtered list of enrollment summaries describing which objects are subscribed to generate event notifications for particular recipients.

Types

t()

@type t() :: %BACnet.Protocol.Services.Ack.GetEnrollmentSummaryAck{
  summaries: [BACnet.Protocol.EnrollmentSummary.t()]
}

Response for Get Enrollment Summary. Contains the filtered list of enrollment summaries describing which objects are subscribed to generate event notifications for particular recipients.

Functions

from_apdu(ack)

@spec from_apdu(BACnet.Protocol.APDU.ComplexACK.t()) :: {:ok, t()} | {:error, term()}

Converts a received BACnet.Protocol.APDU.ComplexACK APDU into a struct.

to_apdu(ack, invoke_id \\ 0)

@spec to_apdu(t(), 0..255) ::
  {:ok, BACnet.Protocol.APDU.ComplexACK.t()} | {:error, term()}

Constructs a BACnet.Protocol.APDU.ComplexACK APDU from a BACnet.Protocol.Services.Ack.GetEnrollmentSummaryAck struct.