BACnet/SC
BACnet Secure Connect: the hub connector, hub function, direct connections and certificates.
Your application owns the WebSocket and TLS connections; the stack drives them through the callbacks in this group. Requires a build with BACnet/SC. See BACnet/SC.
Functions
Section titled “Functions”| Function | Summary |
|---|---|
BACnetStack_SetBACnetSCUuid() |
Sets the device’s BACnet/SC device UUID (135-2024 AB.1.5.3), which identifies this device across VMAC and device-instance changes. |
BACnetStack_SetBACnetSCHubConnector() |
Configures this device as a BACnet/SC hub connector (initiator), specifying its VMAC and the primary/failover hub URIs to connect to. |
BACnetStack_SetBACnetSCHubConnectorForNetworkPort() |
Configures the BACnet/SC hub connector of one named BACnet/SC Network Port object. |
BACnetStack_SetBACnetSCSettings() |
Sets the BACnet/SC transport-level timing and size settings shared by every SC connection this device makes. |
BACnetStack_SetBACnetSCHelloCapabilities() |
Sets the Capabilities octet this device advertises in the BACnet/SC Hello destination option of Connect-Request and Connect-Accept (135-2024 Annex AB). |
BACnetStack_SetBACnetSCCompatibilityFlags() |
Sets BACnet/SC compatibility flags, which RELAX spec-conformant behaviour so this device can interoperate with non-conformant peers. |
BACnetStack_SetBACnetSCHubFunctionConfig() |
Configures this device’s BACnet/SC hub function (the hub role itself, if this device is acting as a BACnet/SC hub rather than only a node). |
BACnetStack_SetBACnetSCDirectConnectConfig() |
Configures this device’s BACnet/SC direct-connect capability (peer-to-peer SC connections that bypass the hub). |
BACnetStack_AddBACnetSCAcceptUri() |
Adds one accept URI to a Secure Connect Network Port’s hub function or direct connect role. |
BACnetStack_ClearBACnetSCAcceptUris() |
Removes every accept URI from a Secure Connect Network Port’s hub function or direct connect role and stops every listener that role currently has running. |
BACnetStack_SetBACnetSCCertificateFileObjects() |
Associates this device’s BACnet/SC Network Port with the File objects that hold its operational certificate, certificate-signing-request, and issuer certificate chain. |
BACnetStack_SetBACnetSCWebSocketStatus() |
Reports the status of a BACnet/SC WebSocket connection to the stack. |
BACnetStack_RegisterCallbackInitiateWebsocket() |
Registers the callback the stack calls to ask the host to OPEN a WebSocket/TLS connection to a URI. |
BACnetStack_RegisterCallbackDisconnectWebsocket() |
Registers a callback the stack calls to ask the host application to close a previously opened WebSocket connection to the given URI. |
BACnetStack_RegisterCallbackSCStartListening() |
Registers the callback the stack calls to ask the host to start ACCEPTING inbound WebSocket connections on a URI - the hub-function and direct-connect accept roles. |
BACnetStack_RegisterCallbackSCStopListening() |
Registers a callback the stack calls to ask the host application to stop listening for incoming WebSocket connections on the given URI. |
BACnetStack_RegisterCallbackBACnetSCStateChange() |
Registers a purely observational callback the stack invokes whenever a BACnet/SC connection state machine changes state. |
BACnetStack_SCCertificateAddIssuer() |
Adds a new issuer certificate to a BACnet/SC node, as the certificate-management procedure of 135-2024 clause 19.8.3.1 describes. |
BACnetStack_SCCertificateReplaceOperational() |
Replaces a BACnet/SC node’s operational certificate, as the certificate-management procedure of 135-2024 clause 19.8.3.2 describes. |
BACnetStack_SCCertificateRemoveIssuer() |
Removes an outdated issuer certificate from a BACnet/SC node, as the certificate-management procedure of 135-2024 clause 19.8.3.3 describes. |
BACnetStack_SCCertificateProvideSignedCertificate() |
Resumes a ReplaceOperational procedure that is waiting for its signed certificate (the SignCertificate step). |
BACnetStack_SCCertificateCancel() |
Stops a procedure without a report (reports already due in the same BACnetStack_Tick() are dropped too). |
BACnetStack_RegisterCallbackSCCertificateSignRequest() |
Registers the host’s CA hand-off for ReplaceOperational: called with the CSR the procedure read from the target. |
BACnetStack_RegisterHookSCCertificateProcedure() |
Registers the hook that reports the progress of a BACnet/SC certificate procedure. |