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

The Write Property Multiple Error is returned when a Write Property Multiple service request fails.

It identifies the first object and property that could not be written (via an Object Property Reference) along with the reason for the failure. This allows the client to know exactly where in a large bulk write operation the failure occurred without having to guess.

Summary

Types

t()

Error response for a failed Write Property Multiple service.

Functions

from_apdu(error)

Converts a received Error APDU into a WritePropertyMultipleError struct.

to_apdu(error, invoke_id \\ 0)

Constructs an Error APDU from a WritePropertyMultipleError struct.

Types

t()

@type t() :: %BACnet.Protocol.Services.Error.WritePropertyMultipleError{
  error_class: BACnet.Protocol.Constants.error_class() | non_neg_integer(),
  error_code: BACnet.Protocol.Constants.error_code() | non_neg_integer(),
  first_failed_write_attempt: BACnet.Protocol.ObjectPropertyRef.t()
}

Error response for a failed Write Property Multiple service.

Identifies the exact object/property reference (first failure) and the error class/code so the client can pinpoint which write in a bulk operation failed.

Functions

from_apdu(error)

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

Converts a received Error APDU into a WritePropertyMultipleError 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 WritePropertyMultipleError struct.