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

Copy Markdown View Source

This module represents the BACnet Get Enrollment Summary service.

The Get Enrollment Summary service is used to get a list of event-initiating objects. Several different filters may be applied.

Service Description (ASHRAE 135)

The GetEnrollmentSummary service is used by a client BACnet-user to obtain a summary of event-initiating objects. Several different filters may be applied to define the search criteria. This service may be used to obtain summaries of objects with any event type and is thus a superset of the functionality provided by the GetAlarmSummary Service.

Service Procedure (ASHRAE 135)

After verifying the validity of the request, the responding BACnet-user shall search for all event-initiating objects that meet the search criteria specified in the request primitive. The search criteria are the logical conjunctions of all of the explicitly stated filters and the default values for any filters that were omitted in the request primitive. Any object that has an Event_Detection_Enable property with a value of FALSE shall be ignored. A positive response containing the enrollment summaries for objects found in this search shall be constructed. If no objects are found that meet these criteria, then a list of length zero shall be returned.

Result(+) Response (ASHRAE 135)

On success, the responding BACnet-user returns a 'Result(+)' primitive containing a list of enrollment summaries. Each summary includes the object identifier, event type, and notification class of qualifying event-initiating objects. If no objects meet the search criteria, an empty list is returned.

Result(-) Errors (ASHRAE 135)

The 'Result(-)' parameter shall indicate that the service request has failed. The reason for failure shall be specified by the 'Error Type' parameter.

The 'Error Class' and 'Error Code' are per Clause 18 (no service-specific situations are defined beyond the general cases).

Summary

Types

t()

Parameters (filters) for the Get Enrollment Summary service.

Functions

confirmed?()

Whether the service is of type confirmed or unconfirmed.

from_apdu(request)

Converts the given Confirmed Service Request into a Get Enrollment Summary Service.

get_name()

Get the service name atom.

to_apdu(service, request_data)

Get the Confirmed Service request for the given Get Enrollment Summary Service.

Types

t()

@type t() :: %BACnet.Protocol.Services.GetEnrollmentSummary{
  acknowledgment_filter: :all | :acked | :not_acked,
  enrollment_filter:
    {process_identifier :: BACnet.Protocol.ApplicationTags.unsigned32(),
     BACnet.Protocol.Recipient.t()}
    | nil,
  event_state_filter: BACnet.Protocol.Constants.event_state() | nil,
  event_type_filter: BACnet.Protocol.Constants.event_type() | nil,
  notification_class_filter: non_neg_integer() | nil,
  priority_filter:
    {min :: BACnet.Protocol.ApplicationTags.unsigned8(),
     max :: BACnet.Protocol.ApplicationTags.unsigned8()}
    | nil
}

Parameters (filters) for the Get Enrollment Summary service.

Allows a client to retrieve a filtered list of event enrollments from a device. Filters include acknowledgment state, recipient, event state, event type, priority range, and notification class.

All fields except acknowledgment_filter are optional.

Functions

confirmed?()

@spec confirmed?() :: true

Whether the service is of type confirmed or unconfirmed.

from_apdu(request)

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

Converts the given Confirmed Service Request into a Get Enrollment Summary Service.

get_name()

@spec get_name() :: atom()

Get the service name atom.

to_apdu(service, request_data)

@spec to_apdu(t(), Keyword.t()) ::
  {:ok, BACnet.Protocol.APDU.ConfirmedServiceRequest.t()} | {:error, term()}

Get the Confirmed Service request for the given Get Enrollment Summary Service.

See the BACnet.Protocol.Services.Protocol function documentation for more information.