Agente de borde

Este módulo incluye funciones para la función de agente de borde de Thread.

Resumen

Enumeraciones
otBorderAgentState{
  OT_BORDER_AGENT_STATE_STOPPED = 0,
  OT_BORDER_AGENT_STATE_STARTED = 1,
  OT_BORDER_AGENT_STATE_ACTIVE = 2
} 		Enum
Define el estado del agente de borde.

Typedefs
otBorderAgentId typedef
Representa un ID del agente de borde.
otBorderAgentState typedef
Define el estado del agente de borde.

Variables
OT_TOOL_PACKED_END

Funciones
otBorderAgentGetId(otInstance *aInstance, otBorderAgentId *aId)
Obtiene el ID del agente de borde generado de forma aleatoria.
otBorderAgentGetState(otInstance *aInstance)
Obtiene el otBorderAgentState de la función de agente de borde de Thread.
otBorderAgentGetUdpPort(otInstance *aInstance)
uint16_t
Obtiene el puerto UDP del servicio del Agente de borde de Thread.
otBorderAgentSetId(otInstance *aInstance, const otBorderAgentId *aId)
Establece el ID del agente de borde.

Structs
otBorderAgentId;

Representa un ID del agente de borde.

Enumeraciones

otBorderAgentState

 otBorderAgentState

Define el estado del agente de borde.

Propiedades
OT_BORDER_AGENT_STATE_ACTIVE

El agente de borde se conecta con el comisionado externo.

OT_BORDER_AGENT_STATE_STARTED

Se inició el agente de borde.

OT_BORDER_AGENT_STATE_STOPPED

La función de agente de borde está inhabilitada.

Typedefs

ID de agente de borde

struct otBorderAgentId otBorderAgentId

Representa un ID del agente de borde.

otBorderAgentState

enum otBorderAgentState otBorderAgentState

Define el estado del agente de borde.

Variables

PO_TOOL_PACKED_END

OT_TOOL_PACKED_BEGIN struct otBorderAgentId OT_TOOL_PACKED_END

Funciones

otBorderAgentGetId

otError otBorderAgentGetId(
  otInstance *aInstance,
  otBorderAgentId *aId
)

Obtiene el ID del agente de borde generado de forma aleatoria.

El ID se guarda en el almacenamiento persistente y se mantiene después de los reinicios. El caso de uso típico del ID es que se publique en el servicio mDNS de MeshCoP como el valor id TXT para que el cliente identifique este dispositivo Border Router/Agent.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[out] aId
Un puntero para almacenar en búfer y recibir el ID.
Valores que se muestran
OT_ERROR_NONE
Si se recuperó correctamente el ID del agente de borde
...
Si no se pudo recuperar el ID del agente de borde.
Consulta también:
otBorderAgentSetId

otBorderAgentGetState

otBorderAgentState otBorderAgentGetState(
  otInstance *aInstance
)

Obtiene el otBorderAgentState de la función de agente de borde de Thread.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
El otBorderAgentState actual del agente de borde.

otBorderAgentGetUdpPort

uint16_t otBorderAgentGetUdpPort(
  otInstance *aInstance
)

Obtiene el puerto UDP del servicio del Agente de borde de Thread.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
Puerto UDP del agente de borde.

otBorderAgentSetId

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

Establece el ID del agente de borde.

El ID del agente de borde se guardará en el almacenamiento persistente y sobrevivirá a los reinicios. Es necesario que configures el ID solo una vez después de restablecer la configuración de fábrica. Si nunca se estableció el ID con una llamada a esta función, se generará un ID aleatorio que se mostrará cuando se llame a otBorderAgentGetId.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[out] aId
Un puntero para el ID del agente de borde.
Valores que se muestran
OT_ERROR_NONE
Si se configuró correctamente el ID del agente de borde
...
Si no se pudo configurar el ID del agente de borde.
Consulta también:
otBorderAgentGetId

Macros

PO_BORDER_AGENT_ID_LENGTH

 OT_BORDER_AGENT_ID_LENGTH (16)

Es la longitud del ID del router o del agente de borde en bytes.

Recursos

Los temas de referencia de la API de OpenThread se originan a partir del código fuente, disponible en GitHub. Para obtener más información o colaborar con nuestra documentación, consulta la sección Recursos.