nRF5 SDK for Thread and Zigbee v3.2.0
Typedefs | Enumerations | Functions
Border Agent

This module includes functions for the Thread Border Agent role. More...

Typedefs

typedef enum otBorderAgentState otBorderAgentState
 

Enumerations

enum  otBorderAgentState { OT_BORDER_AGENT_STATE_STOPPED = 0, OT_BORDER_AGENT_STATE_STARTED = 1, OT_BORDER_AGENT_STATE_ACTIVE = 2 }
 

Functions

otBorderAgentState otBorderAgentGetState (otInstance *aInstance)
 

Detailed Description

This module includes functions for the Thread Border Agent role.

Typedef Documentation

This enumeration defines the Border Agent state.

Enumeration Type Documentation

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.

Function Documentation

otBorderAgentState otBorderAgentGetState ( otInstance aInstance)

This function gets the state of Thread Border Agent role.

Parameters
[in]aInstanceA pointer to an OpenThread instance.
Returns
State of the Border Agent.

Documentation feedback | Developer Zone | Subscribe | Updated