Event Message Texts is a simple triple of character strings that a device can use to supply human-readable messages for each of the three possible event state transitions. The three fields correspond to the messages that should be sent when the object transitions to-Offnormal, to-Fault, and to-Normal.
These texts are optional in most object types. When present, they are usually copied into the Event Message Text parameter of ConfirmedEventNotification and UnconfirmedEventNotification messages. This gives receiving systems (workstations, pagers, logging systems, etc.) a pre-formatted description of what the alarm means without requiring them to perform a separate Read Property to obtain the description.
Because the strings travel with the notification itself, they are especially useful in environments where the notification recipient does not have full read access to the alarming device or where low-bandwidth transports make additional round-trips expensive.
Summary
Types
Represents the three optional text messages associated with an event (to-offnormal, to-fault, to-normal).
Functions
Encodes a BACnet event message texts (BACnetArray[3] of CharacterString) into BACnet application tags encoding.
Parses a BACnet event message texts (BACnetArray[3] of CharacterString) from BACnet application tags encoding.
Validates whether the given event message texts is in form valid.
Types
Functions
@spec encode(t(), Keyword.t()) :: {:ok, BACnet.Protocol.ApplicationTags.encoding_list()} | {:error, term()}
Encodes a BACnet event message texts (BACnetArray[3] of CharacterString) into BACnet application tags encoding.
@spec parse(BACnet.Protocol.ApplicationTags.encoding_list()) :: {:ok, {t(), rest :: BACnet.Protocol.ApplicationTags.encoding_list()}} | {:error, term()}
Parses a BACnet event message texts (BACnetArray[3] of CharacterString) from BACnet application tags encoding.
Validates whether the given event message texts is in form valid.
It only validates the struct is valid as per type specification.