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

The Confirmed Private Transfer Error is returned when a Confirmed Private Transfer service request fails.

In addition to the standard error class and code, it may carry a vendor- specific error code and parameters that the vendor has defined for their proprietary service. This allows vendors to return rich diagnostic information for private transfer operations.

Summary

Types

t()

Error response for a failed Confirmed Private Transfer.

Functions

from_apdu(error)

Converts a received Error APDU into a ConfirmedPrivateTransferError struct.

to_apdu(error, invoke_id \\ 0)

Constructs an Error APDU from a ConfirmedPrivateTransferError struct.

Types

t()

@type t() :: %BACnet.Protocol.Services.Error.ConfirmedPrivateTransferError{
  error_class: BACnet.Protocol.Constants.error_class(),
  error_code: BACnet.Protocol.Constants.error_code() | non_neg_integer(),
  invoke_id: term(),
  parameters: BACnet.Protocol.ApplicationTags.encoding_list() | nil,
  service_number: non_neg_integer(),
  vendor_id: BACnet.Protocol.ApplicationTags.unsigned16()
}

Error response for a failed Confirmed Private Transfer.

Besides the standard error, includes the vendor_id, service_number, and any vendor-defined parameters returned by the proprietary service implementation on the remote device.

Functions

from_apdu(error)

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

Converts a received Error APDU into a ConfirmedPrivateTransferError struct.

to_apdu(error, invoke_id \\ 0)

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

Constructs an Error APDU from a ConfirmedPrivateTransferError struct.