BACnetStack_SetBACnetSCHelloCapabilities

bool BACnetStack_SetBACnetSCHelloCapabilities(const uint8_t helloCapabilities);

Sets the Capabilities octet this device advertises in the BACnet/SC Hello destination option of Connect-Request and Connect-Accept (135-2024 Annex AB).

CHANGING THIS DROPS CONNECTIONS. If the new value differs from the current one, every accepted hub-function peer and the direct-connect peer are disconnected through CallbackDisconnectWebsocket so the new Hello is exchanged on reconnect. Setting the value it already has is a no-op and disconnects nothing.

DEVICE-WIDE: applied to EVERY BACnet/SC data link instance, not only the port you may have in mind. There is no per-Network-Port variant and no read-back.

Note

Requires the STACK_OPTION_DATA_LINK_LAYER_SC (with STACK_OPTION_DATA_LINK_LAYER_IPV4) build option.

Parameters

Parameter	Direction	Description
helloCapabilities	in	The Capabilities octet. Per 135-2024, bit 0 (0x01) is “identity relay” and bits 1-7 are reserved, shall be 0, and are ignored by the receiver. The stack advertises this byte verbatim without validating it, and does not itself act on the identity-relay bit - nor on a peer’s. Pass 0 unless a hub or peer requires otherwise.

Returns

True if the value was applied to every BACnet/SC data link instance. False if any instance rejected it, if no BACnet/SC data link exists, or if the stack was built without STACK_OPTION_DATA_LINK_LAYER_SC.

Topic: BACnet/SC. Declared in CASBACnetStackDLL.h.