Border Agent#

This module includes functions for the Thread Border Agent role.

Enumerations#

enum

otBorderAgentState {

OT_BORDER_AGENT_STATE_STOPPED = 0

OT_BORDER_AGENT_STATE_STARTED = 1

OT_BORDER_AGENT_STATE_ACTIVE = 2

}

This enumeration defines the Border Agent state.

Typedefs#

typedef enum otBorderAgentState

otBorderAgentState

This enumeration defines the Border Agent state.

Functions#

otBorderAgentState

otBorderAgentGetState(otInstance *aInstance)

Gets the otBorderAgentState of the Thread Border Agent role.

uint16_t

otBorderAgentGetUdpPort(otInstance *aInstance)

Gets the UDP port of the Thread Border Agent service.

otError

otBorderAgentGetId(otInstance *aInstance, uint8_t *aId, uint16_t *aLength)

Gets the randomly generated Border Agent ID.

Macros#

#define

OT_BORDER_AGENT_ID_LENGTH (16)

The length of Border Agent/Router ID in bytes.

Enumeration Documentation#

otBorderAgentState#

otBorderAgentState

This enumeration defines the Border Agent state.

Enumerator
OT_BORDER_AGENT_STATE_STOPPED	Border agent role is disabled.
OT_BORDER_AGENT_STATE_STARTED	Border agent is started.
OT_BORDER_AGENT_STATE_ACTIVE	Border agent is connected with external commissioner.

Typedef Documentation#

otBorderAgentState#

typedef enum otBorderAgentState otBorderAgentState

This enumeration defines the Border Agent state.

Function Documentation#

otBorderAgentGetState#

otBorderAgentState otBorderAgentGetState (otInstance * aInstance)

Gets the otBorderAgentState of the Thread Border Agent role.

Parameters

Type	Direction	Argument Name	Description
otInstance *	[in]	aInstance	A pointer to an OpenThread instance.

Returns

The current otBorderAgentState of the Border Agent.

otBorderAgentGetUdpPort#

uint16_t otBorderAgentGetUdpPort (otInstance * aInstance)

Gets the UDP port of the Thread Border Agent service.

Parameters

Type	Direction	Argument Name	Description
otInstance *	[in]	aInstance	A pointer to an OpenThread instance.

Returns

UDP port of the Border Agent.

otBorderAgentGetId#

otError otBorderAgentGetId (otInstance * aInstance, uint8_t * aId, uint16_t * aLength)

Gets the randomly generated Border Agent ID.

Parameters

Type	Direction	Argument Name	Description
otInstance *	[in]	aInstance	A pointer to an OpenThread instance.
uint8_t *	[out]	aId	A pointer to buffer to receive the ID.
uint16_t *	[inout]	aLength	Specifies the length of `aId` when used as input and receives the length actual ID data copied to `aId` when used as output.

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.