Border Agent

This module includes functions for the Thread Border Agent role.

Summary

Enumerations
otBorderAgentEphemeralKeyState{   OT_BORDER_AGENT_STATE_DISABLED = 0,   OT_BORDER_AGENT_STATE_STOPPED = 1,   OT_BORDER_AGENT_STATE_STARTED = 2,   OT_BORDER_AGENT_STATE_CONNECTED = 3,   OT_BORDER_AGENT_STATE_ACCEPTED = 4 }	enum Represents Border Agent's Ephemeral Key Manager state.

Typedefs
otBorderAgentCounters	typedef struct otBorderAgentCounters Defines Border Agent counters.
otBorderAgentEphemeralKeyCallback)(void *aContext)	typedef void(* Callback function pointer to signal state changes to the Border Agent's Ephemeral Key Manager.
otBorderAgentEphemeralKeyState	typedef enum otBorderAgentEphemeralKeyState Represents Border Agent's Ephemeral Key Manager state.
otBorderAgentId	typedef struct otBorderAgentId Represents a Border Agent Identifier.
otBorderAgentMeshCoPServiceChangedCallback)(void *aContext)	typedef void(* This callback informs the application of the changes in the state of the MeshCoP service.
otBorderAgentMeshCoPServiceTxtData	typedef struct otBorderAgentMeshCoPServiceTxtData Represents the Border Agent MeshCoP Service TXT data.
otBorderAgentSessionInfo	typedef struct otBorderAgentSessionInfo Represents information about a Border Agent session.
otBorderAgentSessionIterator	typedef struct otBorderAgentSessionIterator Represents an iterator for Border Agent sessions.

Functions
otBorderAgentEphemeralKeyGetState(otInstance *aInstance)	otBorderAgentEphemeralKeyState Gets the state of Border Agent's Ephemeral Key Manager.
otBorderAgentEphemeralKeyGetUdpPort(otInstance *aInstance)	uint16_t Gets the UDP port used by Border Agent's Ephemeral Key Manager.
otBorderAgentEphemeralKeySetCallback(otInstance *aInstance, otBorderAgentEphemeralKeyCallback aCallback, void *aContext)	void Sets the callback function to notify state changes of Border Agent's Ephemeral Key Manager.
otBorderAgentEphemeralKeySetEnabled(otInstance *aInstance, bool aEnabled)	void Enables/disables the Border Agent's Ephemeral Key Manager.
otBorderAgentEphemeralKeyStart(otInstance *aInstance, const char *aKeyString, uint32_t aTimeout, uint16_t aUdpPort)	otError Starts using an ephemeral key for a given timeout duration.
otBorderAgentEphemeralKeyStateToString(otBorderAgentEphemeralKeyState aState)	const char * Converts a given otBorderAgentEphemeralKeyState to a human-readable string.
otBorderAgentEphemeralKeyStop(otInstance *aInstance)	void Stops the ephemeral key use and disconnects any session using it.
otBorderAgentGetCounters(otInstance *aInstance)	const otBorderAgentCounters * Gets the counters of the Thread Border Agent.
otBorderAgentGetId(otInstance *aInstance, otBorderAgentId *aId)	otError Gets the randomly generated Border Agent ID.
otBorderAgentGetMeshCoPServiceTxtData(otInstance *aInstance, otBorderAgentMeshCoPServiceTxtData *aTxtData)	otError Gets the MeshCoP service TXT data.
otBorderAgentGetNextSessionInfo(otBorderAgentSessionIterator *aIterator, otBorderAgentSessionInfo *aSessionInfo)	otError Retrieves the next Border Agent session information.
otBorderAgentGetUdpPort(otInstance *aInstance)	uint16_t Gets the UDP port of the Thread Border Agent service.
otBorderAgentInitSessionIterator(otInstance *aInstance, otBorderAgentSessionIterator *aIterator)	void Initializes a session iterator.
otBorderAgentIsActive(otInstance *aInstance)	bool Indicates whether or not the Border Agent service is enabled and also active.
otBorderAgentIsEnabled(otInstance *aInstance)	bool Indicates whether or not the Border Agent service is enabled.
otBorderAgentSetEnabled(otInstance *aInstance, bool aEnabled)	void Enables or disables the Border Agent service on the device.
otBorderAgentSetId(otInstance *aInstance, const otBorderAgentId *aId)	otError Sets the Border Agent ID.
otBorderAgentSetMeshCoPServiceBaseName(otInstance *aInstance, const char *aBaseName)	otError Sets the base name to construct the service instance name used when advertising the mDNS _meshcop._udp service by the Border Agent.
otBorderAgentSetMeshCoPServiceChangedCallback(otInstance *aInstance, otBorderAgentMeshCoPServiceChangedCallback aCallback, void *aContext)	void Sets the callback function used by the Border Agent to notify of any changes to the state of the MeshCoP service.
otBorderAgentSetVendorTxtData(otInstance *aInstance, const uint8_t *aVendorData, uint16_t aVendorDataLength)	void Sets the vendor extra TXT data to be included when the Border Agent advertises the mDNS _meshcop._udp service.

Macros
OT_BORDER_AGENT_DEFAULT_EPHEMERAL_KEY_TIMEOUT (2 * 60 * 1000u)	Default ephemeral key timeout interval in milliseconds.
OT_BORDER_AGENT_ID_LENGTH (16)	The length of Border Agent/Router ID in bytes.
OT_BORDER_AGENT_MAX_EPHEMERAL_KEY_LENGTH (32)	Maximum length of the ephemeral key string.
OT_BORDER_AGENT_MAX_EPHEMERAL_KEY_TIMEOUT (10 * 60 * 1000u)	Maximum ephemeral key timeout interval in milliseconds.
OT_BORDER_AGENT_MESHCOP_SERVICE_BASE_NAME_MAX_LENGTH (OT_DNS_MAX_LABEL_SIZE - 17)	Maximum string length of base name used in otBorderAgentSetMeshCoPServiceBaseName().
OT_BORDER_AGENT_MESHCOP_SERVICE_TXT_DATA_MAX_LENGTH 256	Maximum length of the OT core generated MeshCoP Service TXT data.
OT_BORDER_AGENT_MIN_EPHEMERAL_KEY_LENGTH (6)	Minimum length of the ephemeral key string.

Structs
otBorderAgentCounters	Defines Border Agent counters.
otBorderAgentId	Represents a Border Agent Identifier.
otBorderAgentMeshCoPServiceTxtData	Represents the Border Agent MeshCoP Service TXT data.
otBorderAgentSessionInfo	Represents information about a Border Agent session.
otBorderAgentSessionIterator	Represents an iterator for Border Agent sessions.

Enumerations

otBorderAgentEphemeralKeyState

 otBorderAgentEphemeralKeyState

Represents Border Agent's Ephemeral Key Manager state.

Properties
OT_BORDER_AGENT_STATE_ACCEPTED	Session is established and candidate is accepted as full commissioner.
OT_BORDER_AGENT_STATE_CONNECTED	Session is established with an external commissioner candidate.
OT_BORDER_AGENT_STATE_DISABLED	Ephemeral Key Manager is disabled.
OT_BORDER_AGENT_STATE_STARTED	Ephemeral key is set. Listening to accept secure connections.
OT_BORDER_AGENT_STATE_STOPPED	Enabled, but no ephemeral key is in use (not set or started).

Typedefs

otBorderAgentCounters

struct otBorderAgentCounters otBorderAgentCounters

Defines Border Agent counters.

The mEpskc related counters require OPENTHREAD_CONFIG_BORDER_AGENT_EPHEMERAL_KEY_ENABLE.

otBorderAgentEphemeralKeyCallback

void(* otBorderAgentEphemeralKeyCallback)(void *aContext)

Callback function pointer to signal state changes to the Border Agent's Ephemeral Key Manager.

This callback is invoked whenever the otBorderAgentEphemeralKeyGetState() gets changed.

Any OpenThread API, including otBorderAgent APIs, can be safely called from this callback.

Details
Parameters	[in] aContext A pointer to an arbitrary context (provided when callback is set).

otBorderAgentEphemeralKeyState

enum otBorderAgentEphemeralKeyState otBorderAgentEphemeralKeyState

Represents Border Agent's Ephemeral Key Manager state.

otBorderAgentId

struct otBorderAgentId otBorderAgentId

Represents a Border Agent Identifier.

otBorderAgentMeshCoPServiceChangedCallback

void(* otBorderAgentMeshCoPServiceChangedCallback)(void *aContext)

This callback informs the application of the changes in the state of the MeshCoP service.

In specific, the 'state' includes the MeshCoP TXT data originated from the Thread network and whether the Border Agent is Active (which can be obtained by otBorderAgentIsActive).

Details
Parameters	[in] aContext A pointer to application-specific context.

otBorderAgentMeshCoPServiceTxtData

struct otBorderAgentMeshCoPServiceTxtData otBorderAgentMeshCoPServiceTxtData

Represents the Border Agent MeshCoP Service TXT data.

otBorderAgentSessionInfo

struct otBorderAgentSessionInfo otBorderAgentSessionInfo

Represents information about a Border Agent session.

This structure is populated by otBorderAgentGetNextSessionInfo() during iteration over the list of sessions using an otBorderAgentSessionIterator.

To ensure consistent mLifetime calculations, the iterator's initialization time is stored within the iterator, and each session's mLifetime is calculated relative to this time.

otBorderAgentSessionIterator

struct otBorderAgentSessionIterator otBorderAgentSessionIterator

Represents an iterator for Border Agent sessions.

The caller MUST NOT access or update the fields in this struct. It is intended for OpenThread internal use only.

Functions

otBorderAgentEphemeralKeyGetState

otBorderAgentEphemeralKeyState otBorderAgentEphemeralKeyGetState(
  otInstance *aInstance
)

Gets the state of Border Agent's Ephemeral Key Manager.

Requires OPENTHREAD_CONFIG_BORDER_AGENT_EPHEMERAL_KEY_ENABLE.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance.
Returns	The current state of Ephemeral Key Manager.

otBorderAgentEphemeralKeyGetUdpPort

uint16_t otBorderAgentEphemeralKeyGetUdpPort(
  otInstance *aInstance
)

Gets the UDP port used by Border Agent's Ephemeral Key Manager.

Requires OPENTHREAD_CONFIG_BORDER_AGENT_EPHEMERAL_KEY_ENABLE.

The port is applicable if an ephemeral key is in use, i.e., the state is not OT_BORDER_AGENT_STATE_DISABLED or OT_BORDER_AGENT_STATE_STOPPED.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance.
Returns	The UDP port being used by Border Agent's Ephemeral Key Manager (when active).

otBorderAgentEphemeralKeySetCallback

void otBorderAgentEphemeralKeySetCallback(
  otInstance *aInstance,
  otBorderAgentEphemeralKeyCallback aCallback,
  void *aContext
)

Sets the callback function to notify state changes of Border Agent's Ephemeral Key Manager.

Requires OPENTHREAD_CONFIG_BORDER_AGENT_EPHEMERAL_KEY_ENABLE.

A subsequent call to this function will replace any previously set callback.

Details
Parameters	[in] aInstance The OpenThread instance. [in] aCallback The callback function pointer. [in] aContext The arbitrary context to use with callback.

otBorderAgentEphemeralKeySetEnabled

void otBorderAgentEphemeralKeySetEnabled(
  otInstance *aInstance,
  bool aEnabled
)

Enables/disables the Border Agent's Ephemeral Key Manager.

Requires OPENTHREAD_CONFIG_BORDER_AGENT_EPHEMERAL_KEY_ENABLE.

If this function is called to disable, while an an ephemeral key is in use, the ephemeral key use will be stopped (as if otBorderAgentEphemeralKeyStop() is called).

Details
Parameters	[in] aInstance The OpenThread instance. [in] aEnabled Whether to enable or disable the Ephemeral Key Manager.

otBorderAgentEphemeralKeyStart

otError otBorderAgentEphemeralKeyStart(
  otInstance *aInstance,
  const char *aKeyString,
  uint32_t aTimeout,
  uint16_t aUdpPort
)

Starts using an ephemeral key for a given timeout duration.

Requires OPENTHREAD_CONFIG_BORDER_AGENT_EPHEMERAL_KEY_ENABLE.

An ephemeral key can only be set when otBorderAgentEphemeralKeyGetState() is OT_BORDER_AGENT_STATE_STOPPED, i.e., enabled but not yet started. Otherwise, OT_ERROR_INVALID_STATE is returned. This means that setting the ephemeral key again while a previously set key is still in use will fail. Callers can stop the previous key by calling otBorderAgentEphemeralKeyStop() before starting with a new key.

The Ephemeral Key Manager and the Border Agent service (which uses PSKc) can be enabled and used in parallel, as they use independent and separate DTLS transport and sessions.

The given aKeyString is used directly as the ephemeral PSK (excluding the trailing null \0 character). Its length must be between OT_BORDER_AGENT_MIN_EPHEMERAL_KEY_LENGTH and OT_BORDER_AGENT_MAX_EPHEMERAL_KEY_LENGTH, inclusive. Otherwise OT_ERROR_INVALID_ARGS is returned.

When successfully set, the ephemeral key can be used only once by an external commissioner candidate to establish a secure session. After the commissioner candidate disconnects, the use of the ephemeral key is stopped. If the timeout expires, the use of the ephemeral key is stopped, and any connected session using the key is immediately disconnected.

The Ephemeral Key Manager limits the number of failed DTLS connections to 10 attempts. After the 10th failed attempt, the use of the ephemeral key is automatically stopped (even if the timeout has not yet expired).

Details
Parameters	[in] aInstance The OpenThread instance. [in] aKeyString The ephemeral key. [in] aTimeout The timeout duration, in milliseconds, to use the ephemeral key. If zero, the default OT_BORDER_AGENT_DEFAULT_EPHEMERAL_KEY_TIMEOUT value is used. If the timeout value is larger than OT_BORDER_AGENT_MAX_EPHEMERAL_KEY_TIMEOUT, the maximum value is used instead. [in] aUdpPort The UDP port to use with the ephemeral key. If the UDP port is zero, an ephemeral port will be used. otBorderAgentEphemeralKeyGetUdpPort() returns the current UDP port being used.
Return Values	OT_ERROR_NONE Successfully started using the ephemeral key. OT_ERROR_INVALID_STATE A previously set ephemeral key is still in use or the feature is disabled. OT_ERROR_INVALID_ARGS The given aKeyString is not valid. OT_ERROR_FAILED Failed to start (e.g., it could not bind to the given UDP port).

otBorderAgentEphemeralKeyStateToString

const char * otBorderAgentEphemeralKeyStateToString(
  otBorderAgentEphemeralKeyState aState
)

Converts a given otBorderAgentEphemeralKeyState to a human-readable string.

Details
Parameters	[in] aState The state to convert.
Returns	Human-readable string corresponding to aState.

otBorderAgentEphemeralKeyStop

void otBorderAgentEphemeralKeyStop(
  otInstance *aInstance
)

Stops the ephemeral key use and disconnects any session using it.

Requires OPENTHREAD_CONFIG_BORDER_AGENT_EPHEMERAL_KEY_ENABLE.

If there is no ephemeral key in use, calling this function has no effect.

Details
Parameters	[in] aInstance The OpenThread instance.

otBorderAgentGetCounters

const otBorderAgentCounters * otBorderAgentGetCounters(
  otInstance *aInstance
)

Gets the counters of the Thread Border Agent.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance.
Returns	A pointer to the Border Agent counters.

otBorderAgentGetId

otError otBorderAgentGetId(
  otInstance *aInstance,
  otBorderAgentId *aId
)

Gets the randomly generated Border Agent ID.

Requires OPENTHREAD_CONFIG_BORDER_AGENT_ID_ENABLE.

The ID is saved in persistent storage and survives reboots. The typical use case of the ID is to be published in the MeshCoP mDNS service as the id TXT value for the client to identify this Border Router/Agent device.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance. [out] aId A pointer to buffer to receive the ID.
Return Values	OT_ERROR_NONE If successfully retrieved the Border Agent ID. ... If failed to retrieve the Border Agent ID.

See also:
otBorderAgentSetId

otBorderAgentGetMeshCoPServiceTxtData

otError otBorderAgentGetMeshCoPServiceTxtData(
  otInstance *aInstance,
  otBorderAgentMeshCoPServiceTxtData *aTxtData
)

Gets the MeshCoP service TXT data.

The generated TXT data includes a subset of keys (depending on the device's current state and whether features are enabled) as specified in the documentation of the OT_BORDER_AGENT_MESHCOP_SERVICE_TXT_DATA_MAX_LENGTH constant. Notably, if OPENTHREAD_CONFIG_BORDER_AGENT_MESHCOP_SERVICE_ENABLE is enabled and otBorderAgentSetVendorTxtData() was used to set extra vendor-specific TXT data bytes, those vendor-specified TXT data bytes are NOT included in the TXT data returned by this function.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance. [out] aTxtData A pointer to a MeshCoP Service TXT data struct to get the data.
Return Values	OT_ERROR_NONE If successfully retrieved the Border Agent MeshCoP Service TXT data. OT_ERROR_NO_BUFS If the buffer in aTxtData doesn't have enough size.

otBorderAgentGetNextSessionInfo

otError otBorderAgentGetNextSessionInfo(
  otBorderAgentSessionIterator *aIterator,
  otBorderAgentSessionInfo *aSessionInfo
)

Retrieves the next Border Agent session information.

Details
Parameters	[in] aIterator The iterator to use. [out] aSessionInfo A pointer to an otBorderAgentSessionInfo to populate.
Return Values	OT_ERROR_NONE Successfully retrieved the next session info. OT_ERROR_NOT_FOUND No more sessions are available. The end of the list has been reached.

otBorderAgentGetUdpPort

uint16_t otBorderAgentGetUdpPort(
  otInstance *aInstance
)

Gets the UDP port of the Thread Border Agent service.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance.
Returns	UDP port of the Border Agent.

otBorderAgentInitSessionIterator

void otBorderAgentInitSessionIterator(
  otInstance *aInstance,
  otBorderAgentSessionIterator *aIterator
)

Initializes a session iterator.

An iterator MUST be initialized before being used in otBorderAgentGetNextSessionInfo(). A previously initialized iterator can be re-initialized to start from the beginning of the session list.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance. [in] aIterator The iterator to initialize.

otBorderAgentIsActive

bool otBorderAgentIsActive(
  otInstance *aInstance
)

Indicates whether or not the Border Agent service is enabled and also active.

While the Border Agent is active, external commissioner candidates can try to connect to and establish secure DTLS sessions with the Border Agent using PSKc. A connected commissioner can then petition to become a full commissioner.

If OPENTHREAD_CONFIG_BORDER_AGENT_EPHEMERAL_KEY_ENABLE is enabled, independent and separate DTLS transport and sessions are used for the ephemeral key. Therefore, the ephemeral key and Border Agent service can be enabled and used in parallel.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance.
Return Values	TRUE The Border Agent is active. FALSE The Border Agent is not active.

otBorderAgentIsEnabled

bool otBorderAgentIsEnabled(
  otInstance *aInstance
)

Indicates whether or not the Border Agent service is enabled.

Details
Parameters	[in] aInstance The OpenThread instance.
Return Values	TRUE The Border Agent service is enabled. FALSE The Border Agent service is disabled.

otBorderAgentSetEnabled

void otBorderAgentSetEnabled(
  otInstance *aInstance,
  bool aEnabled
)

Enables or disables the Border Agent service on the device.

By default, the Border Agent service is enabled when the OPENTHREAD_CONFIG_BORDER_AGENT_ENABLE feature is used. This function allows higher-layer code to explicitly control its state. This can be useful in scenarios such as:

• The higher-layer code wishes to delay the start of the Border Agent service (and its mDNS advertisement of the _meshcop._udp service on the infrastructure link). This allows time to prepare or determine vendor-specific TXT data entries for inclusion.
• Unit tests or test scripts might disable the Border Agent service to prevent it from interfering with specific test steps. For example, tests validating mDNS or DNS-SD functionality may disable the Border Agent to prevent its registration of the MeshCoP service.

Details
Parameters	[in] aInstance The OpenThread instance. [in] aEnabled A boolean to indicate whether to to enable (TRUE), or disable (FALSE).

otBorderAgentSetId

otError otBorderAgentSetId(
  otInstance *aInstance,
  const otBorderAgentId *aId
)

Sets the Border Agent ID.

Requires OPENTHREAD_CONFIG_BORDER_AGENT_ID_ENABLE.

The Border Agent ID will be saved in persistent storage and survive reboots. It's required to set the ID only once after factory reset. If the ID has never been set by calling this function, a random ID will be generated and returned when otBorderAgentGetId is called.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance. [out] aId A pointer to the Border Agent ID.
Return Values	OT_ERROR_NONE If successfully set the Border Agent ID. ... If failed to set the Border Agent ID.

See also:
otBorderAgentGetId

otBorderAgentSetMeshCoPServiceBaseName

otError otBorderAgentSetMeshCoPServiceBaseName(
  otInstance *aInstance,
  const char *aBaseName
)

Sets the base name to construct the service instance name used when advertising the mDNS _meshcop._udp service by the Border Agent.

Requires the OPENTHREAD_CONFIG_BORDER_AGENT_MESHCOP_SERVICE_ENABLE feature.

The name can also be configured using the OPENTHREAD_CONFIG_BORDER_AGENT_MESHCOP_SERVICE_BASE_NAME configuration option (which is the recommended way to specify this name). This API is provided for projects where the name needs to be set after device initialization and at run-time.

Per the Thread specification, the service instance should be a user-friendly name identifying the device model or product. A recommended format is "VendorName ProductName".

To construct the full name and ensure name uniqueness, the OpenThread Border Agent module will append the Extended Address of the device (as 16-character hex digits) to the given base name.

Note that the same name will be used for the ephemeral key service _meshcop-e._udp when the ephemeral key feature is enabled and used.

Details
Parameters	[in] aInstance The OpenThread instance. [in] aBaseName The base name to use (MUST not be NULL).
Return Values	OT_ERROR_NONE The name was set successfully. OT_ERROR_INVALID_ARGS The name is too long or invalid.

otBorderAgentSetMeshCoPServiceChangedCallback

void otBorderAgentSetMeshCoPServiceChangedCallback(
  otInstance *aInstance,
  otBorderAgentMeshCoPServiceChangedCallback aCallback,
  void *aContext
)

Sets the callback function used by the Border Agent to notify of any changes to the state of the MeshCoP service.

The callback is invoked when the 'Is Active' state of the Border Agent or the MeshCoP service TXT data values change. For example, it is invoked when the network name or the extended PAN ID changes and passes the updated encoded TXT data to the application layer.

This callback is invoked once right after this API is called to provide initial states of the MeshCoP service.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance. [in] aCallback The callback to be invoked when there are any changes of the MeshCoP service. [in] aContext A pointer to application-specific context.

otBorderAgentSetVendorTxtData

void otBorderAgentSetVendorTxtData(
  otInstance *aInstance,
  const uint8_t *aVendorData,
  uint16_t aVendorDataLength
)

Sets the vendor extra TXT data to be included when the Border Agent advertises the mDNS _meshcop._udp service.

Requires the OPENTHREAD_CONFIG_BORDER_AGENT_MESHCOP_SERVICE_ENABLE feature.

The provided aVendorData bytes are appended as they appear in the buffer to the end of the TXT data generated by the Border Agent itself, and are then included in the advertised mDNS _meshcop._udp service.

This function itself does not perform any validation of the format of the provided aVendorData. Therefore, the caller MUST ensure it is formatted properly. Per the Thread specification, vendor-specific Key-Value TXT data pairs use TXT keys starting with 'v'. For example, vn for vendor name and generally v*.

The OpenThread stack will create and retain its own copy of the bytes in aVendorData. So, the buffer passed to this function does not need to persist beyond the scope of the call.

The vendor TXT data can be set at any time while the Border Agent is in any state. If there is a change from the previously set value, it will trigger an update of the registered mDNS service to advertise the new TXT data.

Details
Parameters	[in] aInstance The OpenThread instance. [in] aVendorData A pointer to the buffer containing the vendor TXT data. [in] aVendorDataLength The length of aVendorData in bytes.

Macros

OT_BORDER_AGENT_DEFAULT_EPHEMERAL_KEY_TIMEOUT

 OT_BORDER_AGENT_DEFAULT_EPHEMERAL_KEY_TIMEOUT (2 * 60 * 1000u)

Default ephemeral key timeout interval in milliseconds.

OT_BORDER_AGENT_ID_LENGTH

 OT_BORDER_AGENT_ID_LENGTH (16)

The length of Border Agent/Router ID in bytes.

OT_BORDER_AGENT_MAX_EPHEMERAL_KEY_LENGTH

 OT_BORDER_AGENT_MAX_EPHEMERAL_KEY_LENGTH (32)

Maximum length of the ephemeral key string.

OT_BORDER_AGENT_MAX_EPHEMERAL_KEY_TIMEOUT

 OT_BORDER_AGENT_MAX_EPHEMERAL_KEY_TIMEOUT (10 * 60 * 1000u)

Maximum ephemeral key timeout interval in milliseconds.

OT_BORDER_AGENT_MESHCOP_SERVICE_BASE_NAME_MAX_LENGTH

 OT_BORDER_AGENT_MESHCOP_SERVICE_BASE_NAME_MAX_LENGTH (OT_DNS_MAX_LABEL_SIZE - 17)

Maximum string length of base name used in otBorderAgentSetMeshCoPServiceBaseName().

The full DNS label is constructed by appending the Extended Address of the device (as 16-character hex digits) to the given base name.

OT_BORDER_AGENT_MESHCOP_SERVICE_TXT_DATA_MAX_LENGTH

 OT_BORDER_AGENT_MESHCOP_SERVICE_TXT_DATA_MAX_LENGTH 256

Maximum length of the OT core generated MeshCoP Service TXT data.

Each field has the format: | Length (1 byte) | "Keyname=" | Data |

Fields: Border Agent Id (id) - 4 + 16 = 20 bytes Version of TXT record format (rv) - 4 + 1 = 5 bytes Network Name (nn) - 4 + 16 = 20 bytes ExtendedPanId (xp) - 4 + 8 = 12 bytes Thread Version (tv) - 4 + 5 = 9 bytes Extended Address (xa) - 4 + 8 = 12 bytes State Bitmap (sb) - 4 + 4 = 8 bytes Partition Id (pt) - 4 + 4 = 8 bytes Active Timestamp (at) - 4 + 8 = 12 bytes Backbone Router Sequence Number (sq) - 4 + 1 = 5 bytes Backbone Router Udp Port (bb) - 4 + 2 = 6 bytes Backbone Router Domain Name (dn) - 4 + 16 = 20 bytes On-Mesh Routable Prefix (omr) - 5 + 9 = 14 bytes

Maximum possible data length: 151 bytes

OT_BORDER_AGENT_MIN_EPHEMERAL_KEY_LENGTH

 OT_BORDER_AGENT_MIN_EPHEMERAL_KEY_LENGTH (6)

Minimum length of the ephemeral key string.

Resources

OpenThread API Reference topics originate from the source code, available on GitHub. For more information, or to contribute to our documentation, refer to Resources.