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

Copy Markdown View Source

The Get Alarm Summary Acknowledgment is the response to a Get Alarm Summary service request. It returns a list of Alarm Summary records, one for each object in the device that is currently in an alarm or fault state and that the requesting client is authorized to observe.

Each entry in the list contains the object identifier, its current event state, and the acknowledged transitions bit string. This service is primarily intended for operator workstations that need to build or refresh a list of active alarms without having to poll every object individually.

Although newer installations often prefer the more capable Get Event Information service, Get Alarm Summary remains widely supported for compatibility with older clients and devices.

Summary

Types

t()

Response for Get Alarm Summary containing the list of active alarm summaries from the device.

Types

t()

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

Response for Get Alarm Summary containing the list of active alarm summaries from the device.

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.GetAlarmSummaryAck struct.

Used by a server when responding to a Get Alarm Summary request.