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

Copy Markdown View Source

The Create Object Acknowledgment is returned by a server after successfully creating a new object in response to a Create Object service request.

The acknowledgment contains only the Object Identifier of the newly created object. This identifier may have been chosen by the server (when the client requested a specific object type without specifying an instance) or it may match the identifier the client requested.

This is one of the simpler acknowledgments because the only useful information returned is the identity of the object that was just brought into existence.

Summary

Types

t()

The response to a successful Create Object request, containing the identifier of the new object.

Types

t()

@type t() :: %BACnet.Protocol.Services.Ack.CreateObjectAck{
  object_identifier: BACnet.Protocol.ObjectIdentifier.t()
}

The response to a successful Create Object request, containing the identifier of the new object.

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

Used by a server to confirm successful creation of a new object.