Border Agent

This module includes functions for the Thread Border Agent role.

Summary

Enumerations
`otBorderAgentState{ OT_BORDER_AGENT_STATE_STOPPED = 0, OT_BORDER_AGENT_STATE_STARTED = 1, OT_BORDER_AGENT_STATE_ACTIVE = 2 }`	enum This enumeration defines the Border Agent state.

Typedefs
`otBorderAgentState`	typedef `enum otBorderAgentState` This enumeration defines the Border Agent state.

Functions
`otBorderAgentGetId(otInstance aInstance, uint8_t aId, uint16_t *aLength)`	`otError` Gets the randomly generated Border Agent ID.
`otBorderAgentGetState(otInstance *aInstance)`	`otBorderAgentState` Gets the otBorderAgentState of the Thread Border Agent role.
`otBorderAgentGetUdpPort(otInstance *aInstance)`	`uint16_t` Gets the UDP port of the Thread Border Agent service.

Enumerations

otBorderAgentState

 otBorderAgentState

This enumeration defines the Border Agent state.

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

Typedefs

otBorderAgentState

enum otBorderAgentState otBorderAgentState

This enumeration defines the Border Agent state.

Functions

otBorderAgentGetId

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

Gets the randomly generated Border Agent ID.

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.
`[in,out] aLength`	Specifies the length of `aId` when used as input and receives the length actual ID data copied to `aId` when used as output.

Return Values

`OT_ERROR_INVALID_ARGS`	If value of `aLength` if smaller than `OT_BORDER_AGENT_ID_LENGTH`.
`OT_ERROR_NONE`	If successfully retrieved the Border Agent ID.

otBorderAgentGetState

otBorderAgentState otBorderAgentGetState(
  otInstance *aInstance
)

Gets the otBorderAgentState of the Thread Border Agent role.

Details

Parameters

[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.

Details

Parameters

[in] aInstance

A pointer to an OpenThread instance.

Returns

UDP port of the Border Agent.

Macros

OT_BORDER_AGENT_ID_LENGTH

 OT_BORDER_AGENT_ID_LENGTH (16)

The length of Border Agent/Router ID in bytes.

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.