@spec encode(t()) :: iodata()

Encodes the struct into a BACnet APDU binary packet.

Any information that is additionally required by the transport layer, must be added by the transport layer.

Any segmentation that needs to be applied, can not and will not be respected by this function.

@spec encode_segmented(t(), integer()) :: [iodata()]

Same as encode/1, but respects the APDU maximum size.

The APDU struct must have a valid window size set.

It will output a list of segmented binaries, that can be sent ordered to the transport layer. Rules around segmentation (such as Segment ACK) still apply for the transport layer.

Conventionally, this function simply takes the encoded body and splits it apart into individual segments and adds the correct header.

@spec encode_to_segmented(t(), iodata(), integer()) :: [iodata()]

Turns the outpot of encode/1 in respect to the APDU maximum size into segmented binaries with the correct header applied to them.

The APDU struct must have a valid window size set.

This is useful if you have already encoded the APDU, but it turns out the APDU length is too large for the target device to be transmitted unsegmented. This is a more efficient method than doing a double encode.

Be aware that the given iodata will first be converted to a binary, if you didn't already give it a binary.

It will output a list of segmented binaries, that can be sent ordered to the transport layer. Rules around segmentation (such as Segment ACK) still apply for the transport layer.

@spec expects_reply(t()) :: boolean()

Whether the struct expects a reply (i.e. Confirmed Service Request).

This is useful for NPCI calculation.

@spec request?(t()) :: boolean()

Whether the struct is a request.

@spec response?(t()) :: boolean()

Whether the struct is a response.

@spec supports_segmentation(t()) :: boolean()

Whether the struct can be segmented (supported by the BACnet protocol).