Google se compromete a impulsar la igualdad racial para las comunidades afrodescendientes. Obtén información al respecto.

Comisionado

En este módulo, se incluyen funciones para la función de Thread Commissioner.

Resumen

Enumeraciones
otCommissionerJoinerEvent enum
En esta enumeración se define un evento de Joiner sobre el encargado.
otCommissionerState{
  OT_COMMISSIONER_STATE_DISABLED = 0,
  OT_COMMISSIONER_STATE_PETITION = 1,
  OT_COMMISSIONER_STATE_ACTIVE = 2
} 		enum
En esta enumeración se define el estado como comisionado.
otJoinerInfoType{
  OT_JOINER_INFO_TYPE_ANY = 0,
  OT_JOINER_INFO_TYPE_EUI64 = 1,
  OT_JOINER_INFO_TYPE_DISCERNER = 2
} 		enum
Esta enumeración define un tipo de información de Joiner.

Typedefs
otCommissionerEnergyReportCallback)(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext) typedef
void(*
Se llama a este puntero de función cuando el comisionado recibe un informe de energía.
otCommissionerJoinerCallback)(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext) typedef
void(*
Se llama a este puntero de función cada vez que cambia el estado de unión.
otCommissionerJoinerEvent typedef
En esta enumeración se define un evento de Joiner sobre el encargado.
otCommissionerPanIdConflictCallback)(uint16_t aPanId, uint32_t aChannelMask, void *aContext) typedef
void(*
Se llama a este puntero de función cuando el comisionado recibe un mensaje de conflicto de ID de PAN.
otCommissionerState typedef
En esta enumeración se define el estado como comisionado.
otCommissionerStateCallback)(otCommissionerState aState, void *aContext) typedef
void(*
Se llama a este puntero de función cada vez que cambia el estado de comisión.
otCommissioningDataset typedef
Esta estructura representa un conjunto de datos Commissioning.
otJoinerInfo typedef
struct otJoinerInfo
Esta estructura representa la información de Joiner.
otJoinerInfoType typedef
Esta enumeración define un tipo de información de Joiner.
otJoinerPskd typedef
struct otJoinerPskd
Esta estructura representa una PSKd de Joiner.
otSteeringData typedef
Esta estructura representa los datos del volante.

Functions
otCommissionerAddJoiner(otInstance *aInstance, const otExtAddress *aEui64, const char *aPskd, uint32_t aTimeout)
Esta función agrega una entrada de Joiner.
otCommissionerAddJoinerWithDiscerner(otInstance *aInstance, const otJoinerDiscerner *aDiscerner, const char *aPskd, uint32_t aTimeout)
Esta función agrega una entrada de Joiner con un valor específico de Discerner de Joiner.
otCommissionerAnnounceBegin(otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, const otIp6Address *aAddress)
Esta función envía un mensaje de anuncio de inicio.
otCommissionerEnergyScan(otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, uint16_t aScanDuration, const otIp6Address *aAddress, otCommissionerEnergyReportCallback aCallback, void *aContext)
Esta función envía un mensaje de búsqueda de Energy Scan.
otCommissionerGetId(otInstance *aInstance)
const char *
Esta función muestra el ID de comisionado.
otCommissionerGetNextJoinerInfo(otInstance *aInstance, uint16_t *aIterator, otJoinerInfo *aJoiner)
Este método obtiene información de la unión en la posición aIterator.
otCommissionerGetProvisioningUrl(otInstance *aInstance)
const char *
Esta función obtiene la URL de aprovisionamiento.
otCommissionerGetSessionId(otInstance *aInstance)
uint16_t
Esta función muestra el ID de la sesión de Commissioner.
otCommissionerGetState(otInstance *aInstance)
Esta función muestra el estado de Comisionado.
otCommissionerPanIdQuery(otInstance *aInstance, uint16_t aPanId, uint32_t aChannelMask, const otIp6Address *aAddress, otCommissionerPanIdConflictCallback aCallback, void *aContext)
Esta función envía un mensaje de búsqueda de ID de PAN.
otCommissionerRemoveJoiner(otInstance *aInstance, const otExtAddress *aEui64)
Esta función quita una entrada de Joiner.
otCommissionerRemoveJoinerWithDiscerner(otInstance *aInstance, const otJoinerDiscerner *aDiscerner)
Esta función quita una entrada de Joiner.
otCommissionerSendMgmtGet(otInstance *aInstance, const uint8_t *aTlvs, uint8_t aLength)
Esta función envía MGMT_COMMISSIONER_GET.
otCommissionerSendMgmtSet(otInstance *aInstance, const otCommissioningDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength)
Esta función envía MGMT_COMMISSIONER_SET.
otCommissionerSetId(otInstance *aInstance, const char *aId)
Esta función establece el ID de comisionado.
otCommissionerSetProvisioningUrl(otInstance *aInstance, const char *aProvisioningUrl)
Esta función establece la URL de aprovisionamiento.
otCommissionerStart(otInstance *aInstance, otCommissionerStateCallback aStateCallback, otCommissionerJoinerCallback aJoinerCallback, void *aCallbackContext)
Esta función habilita la función de Thread Commissioner.
otCommissionerStop(otInstance *aInstance)
Esta función inhabilita la función de Comisionado de subprocesos.

Structs
otCommissioningDataset

Esta estructura representa un conjunto de datos Commissioning.

otJoinerInfo.

Esta estructura representa la información de Joiner.

otJoinerPskd

Esta estructura representa una PSKd de Joiner.

OtSteeringData

Esta estructura representa los datos del volante.

Enumeraciones

otCommissionerJoinerEvent

 otCommissionerJoinerEvent

En esta enumeración se define un evento de Joiner sobre el encargado.

Estado de la comisión

 otCommissionerState

En esta enumeración se define el estado como comisionado.

Properties
OT_COMMISSIONER_STATE_ACTIVE

La función de comisionado está activa.

OT_COMMISSIONER_STATE_DISABLED

La función de comisionado está inhabilitada.

OT_COMMISSIONER_STATE_PETITION

Solicitando convertirte en comisionado.

Tipo de información de unión de ot

 otJoinerInfoType

Esta enumeración define un tipo de información de Joiner.

Properties
OT_JOINER_INFO_TYPE_ANY

Acepte cualquier unión (no se especifica EUI64 ni Discerner).

OT_JOINER_INFO_TYPE_DISCERNER

Se especifica el identificador de la unión (mSharedId.mDiscerner en otJoinerInfo).

OT_JOINER_INFO_TYPE_EUI64

Se especificó la unión EUI-64 (mSharedId.mEui64 en otJoinerInfo).

Typedefs

otCommissionerEnergyReportCallback

void(* otCommissionerEnergyReportCallback)(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext)

Se llama a este puntero de función cuando el comisionado recibe un informe de energía.

Detalles
Parámetros
[in] aChannelMask
Es el valor de máscara del canal.
[in] aEnergyList
Un puntero para la lista de medición de energía.
[in] aEnergyListLength
Cantidad de entradas en aEnergyListLength.
[in] aContext
Un puntero para el contexto específico de la aplicación.

otCommissionerJoinerCallback

void(* otCommissionerJoinerCallback)(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext)

Se llama a este puntero de función cada vez que cambia el estado de unión.

Detalles
Parámetros
[in] aEvent
El tipo de evento de unión.
[in] aJoinerInfo
Un puntero a la información de Joiner.
[in] aJoinerId
Un puntero al ID de unión (si no se conoce, es nulo).
[in] aContext
Un puntero para el contexto específico de la aplicación.

otCommissionerJoinerEvent

enum otCommissionerJoinerEvent otCommissionerJoinerEvent

En esta enumeración se define un evento de Joiner sobre el encargado.

otCommissionerPanIdConflictCallback

void(* otCommissionerPanIdConflictCallback)(uint16_t aPanId, uint32_t aChannelMask, void *aContext)

Se llama a este puntero de función cuando el comisionado recibe un mensaje de conflicto de ID de PAN.

Detalles
Parámetros
[in] aPanId
El valor del PAN
[in] aChannelMask
Es el valor de máscara del canal.
[in] aContext
Un puntero para el contexto específico de la aplicación.

Estado de la comisión

enum otCommissionerState otCommissionerState

En esta enumeración se define el estado como comisionado.

otCommissionerStateCallback

void(* otCommissionerStateCallback)(otCommissionerState aState, void *aContext)

Se llama a este puntero de función cada vez que cambia el estado de comisión.

Detalles
Parámetros
[in] aState
El estado de Comisionado.
[in] aContext
Un puntero para el contexto específico de la aplicación.

otCommissioningDataset

struct otCommissioningDataset otCommissioningDataset

Esta estructura representa un conjunto de datos Commissioning.

OtJoinerInfo

struct otJoinerInfo otJoinerInfo

Esta estructura representa la información de Joiner.

Tipo de información de unión de ot

enum otJoinerInfoType otJoinerInfoType

Esta enumeración define un tipo de información de Joiner.

OtJoinerPskd

struct otJoinerPskd otJoinerPskd

Esta estructura representa una PSKd de Joiner.

otSteeringData

struct otSteeringData otSteeringData

Esta estructura representa los datos del volante.

Functions

otCommissionerAddJoiner

otError otCommissionerAddJoiner(
  otInstance *aInstance,
  const otExtAddress *aEui64,
  const char *aPskd,
  uint32_t aTimeout
)

Esta función agrega una entrada de Joiner.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aEui64
Un puntero a la unión IEEE EUI-64 o NULL para cualquier unión.
[in] aPskd
Un puntero para la PSKd
[in] aTimeout
Tiempo después del cual se quita automáticamente un objeto Joiner, en segundos.
Valores que se muestran
OT_ERROR_NONE
Se agregó correctamente el Joiner.
OT_ERROR_NO_BUFS
No hay búferes disponibles para agregar Joiner.
OT_ERROR_INVALID_ARGS
aEui64 o aPskd no es válido.
OT_ERROR_INVALID_STATE
El comisionado no está activo.

otCommissionerAddJoinerConDiscerner

otError otCommissionerAddJoinerWithDiscerner(
  otInstance *aInstance,
  const otJoinerDiscerner *aDiscerner,
  const char *aPskd,
  uint32_t aTimeout
)

Esta función agrega una entrada de Joiner con un valor específico de Discerner de Joiner.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aDiscerner
Un puntero del receptor de carpintero.
[in] aPskd
Un puntero para la PSKd
[in] aTimeout
Tiempo después del cual se quita automáticamente un objeto Joiner, en segundos.
Valores que se muestran
OT_ERROR_NONE
Se agregó correctamente el Joiner.
OT_ERROR_NO_BUFS
No hay búferes disponibles para agregar Joiner.
OT_ERROR_INVALID_ARGS
aDiscerner o aPskd no es válido.
OT_ERROR_INVALID_STATE
El comisionado no está activo.

Comienzo de la comisión

otError otCommissionerAnnounceBegin(
  otInstance *aInstance,
  uint32_t aChannelMask,
  uint8_t aCount,
  uint16_t aPeriod,
  const otIp6Address *aAddress
)

Esta función envía un mensaje de anuncio de inicio.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aChannelMask
Es el valor de máscara del canal.
[in] aCount
Es la cantidad de mensajes de anuncios por canal.
[in] aPeriod
El tiempo entre dos sucesivas transmisiones de MLE Announce (en milisegundos).
[in] aAddress
Un puntero al destino IPv6.
Valores que se muestran
OT_ERROR_NONE
El mensaje de Anuncio de inicio se puso en cola correctamente.
OT_ERROR_NO_BUFS
No hay suficientes búferes para generar un mensaje de anuncio de inicio.
OT_ERROR_INVALID_STATE
El comisionado no está activo.

otCommissionerEnergyScan

otError otCommissionerEnergyScan(
  otInstance *aInstance,
  uint32_t aChannelMask,
  uint8_t aCount,
  uint16_t aPeriod,
  uint16_t aScanDuration,
  const otIp6Address *aAddress,
  otCommissionerEnergyReportCallback aCallback,
  void *aContext
)

Esta función envía un mensaje de búsqueda de Energy Scan.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aChannelMask
Es el valor de máscara del canal.
[in] aCount
La cantidad de mediciones de energía por canal.
[in] aPeriod
Indica el tiempo que transcurre entre las mediciones de energía (milisegundos).
[in] aScanDuration
La duración del análisis para cada medición de energía (milisegundos).
[in] aAddress
Un puntero al destino IPv6.
[in] aCallback
Un puntero para una función llamada en la recepción de un mensaje de informe de energía.
[in] aContext
Un puntero para el contexto específico de la aplicación.
Valores que se muestran
OT_ERROR_NONE
El mensaje de consulta de análisis de energía se puso en cola correctamente.
OT_ERROR_NO_BUFS
Búferes insuficientes para generar un mensaje de búsqueda de Energy Scan.
OT_ERROR_INVALID_STATE
El comisionado no está activo.

ID de la organización otCommissionerGetId

const char * otCommissionerGetId(
  otInstance *aInstance
)

Esta función muestra el ID de comisionado.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
El ID de comisionado.

otCommissionerGetNextJoinerInfo

otError otCommissionerGetNextJoinerInfo(
  otInstance *aInstance,
  uint16_t *aIterator,
  otJoinerInfo *aJoiner
)

Este método obtiene información de la unión en la posición aIterator.

Detalles
Parámetros
[in] aInstance
Un puntero para la instancia.
[in,out] aIterator
Un puntero al contexto de iterador de información de Joiner.
[out] aJoiner
Una referencia a la información de Joiner.
Valores que se muestran
OT_ERROR_NONE
Se obtuvo correctamente la información de Joiner.
OT_ERROR_NOT_FOUND
No se encontró el siguiente Joiner.

otCommissionerGetProvisioningUrl

const char * otCommissionerGetProvisioningUrl(
  otInstance *aInstance
)

Esta función obtiene la URL de aprovisionamiento.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
Un puntero para la string de la URL.

ID de sesión de otCommissionerGetSessionId

uint16_t otCommissionerGetSessionId(
  otInstance *aInstance
)

Esta función muestra el ID de la sesión de Commissioner.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
El ID de la sesión de comisionado actual.

otCommissionerGetState

otCommissionerState otCommissionerGetState(
  otInstance *aInstance
)

Esta función muestra el estado de Comisionado.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Valores que se muestran
OT_COMMISSIONER_STATE_DISABLED
Se inhabilitó el comisionado.
OT_COMMISSIONER_STATE_PETITION
Convertirse en comisionado
OT_COMMISSIONER_STATE_ACTIVE
Comisionado habilitado

OtCommissionerPanIdQuery

otError otCommissionerPanIdQuery(
  otInstance *aInstance,
  uint16_t aPanId,
  uint32_t aChannelMask,
  const otIp6Address *aAddress,
  otCommissionerPanIdConflictCallback aCallback,
  void *aContext
)

Esta función envía un mensaje de búsqueda de ID de PAN.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aPanId
El ID de PAN que se debe consultar.
[in] aChannelMask
Es el valor de máscara del canal.
[in] aAddress
Un puntero al destino IPv6.
[in] aCallback
Un puntero para una función llamada en el envío de un mensaje de conflicto de ID de PAN.
[in] aContext
Un puntero para el contexto específico de la aplicación.
Valores que se muestran
OT_ERROR_NONE
El mensaje de consulta de ID de PAN se puso en cola correctamente.
OT_ERROR_NO_BUFS
Búferes insuficientes para generar un mensaje de consulta de ID de PAN.
OT_ERROR_INVALID_STATE
El comisionado no está activo.

otCommissionerRemoveJoiner

otError otCommissionerRemoveJoiner(
  otInstance *aInstance,
  const otExtAddress *aEui64
)

Esta función quita una entrada de Joiner.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aEui64
Un puntero a la unión IEEE EUI-64 o NULL para cualquier unión.
Valores que se muestran
OT_ERROR_NONE
Se quitó correctamente el Joiner.
OT_ERROR_NOT_FOUND
No se encontró el unión especificado por aEui64.
OT_ERROR_INVALID_ARGS
aEui64 no es válido.
OT_ERROR_INVALID_STATE
El comisionado no está activo.

otCommissionerRemoveJoinerWithDiscerner

otError otCommissionerRemoveJoinerWithDiscerner(
  otInstance *aInstance,
  const otJoinerDiscerner *aDiscerner
)

Esta función quita una entrada de Joiner.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aDiscerner
Un puntero del receptor de carpintero.
Valores que se muestran
OT_ERROR_NONE
Se quitó correctamente el Joiner.
OT_ERROR_NOT_FOUND
No se encontró el unión especificado por aEui64.
OT_ERROR_INVALID_ARGS
aDiscerner no es válido.
OT_ERROR_INVALID_STATE
El comisionado no está activo.

otCommissionerSendMgmtGet

otError otCommissionerSendMgmtGet(
  otInstance *aInstance,
  const uint8_t *aTlvs,
  uint8_t aLength
)

Esta función envía MGMT_COMMISSIONER_GET.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aTlvs
Un puntero para los TLV.
[in] aLength
La longitud de los TLV.
Valores que se muestran
OT_ERROR_NONE
El comando del conjunto de datos Meshcop se envió de forma correcta.
OT_ERROR_NO_BUFS
No hay suficiente espacio en el búfer para enviar.
OT_ERROR_INVALID_STATE
El comisionado no está activo.

otCommissionerSendMgmtSet

otError otCommissionerSendMgmtSet(
  otInstance *aInstance,
  const otCommissioningDataset *aDataset,
  const uint8_t *aTlvs,
  uint8_t aLength
)

Esta función envía MGMT_COMMISSIONER_SET.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aDataset
Un puntero para el conjunto de datos de asignación.
[in] aTlvs
Un puntero para los TLV.
[in] aLength
La longitud de los TLV.
Valores que se muestran
OT_ERROR_NONE
El comando del conjunto de datos Meshcop se envió de forma correcta.
OT_ERROR_NO_BUFS
No hay suficiente espacio en el búfer para enviar.
OT_ERROR_INVALID_STATE
El comisionado no está activo.

ID decomposición de ot

otError otCommissionerSetId(
  otInstance *aInstance,
  const char *aId
)

Esta función establece el ID de comisionado.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aId
Un puntero para un arreglo de caracteres de string. Debe tener un valor nulo.
Valores que se muestran
OT_ERROR_NONE
Se configuró correctamente el ID de comisionado.
OT_ERROR_INVALID_ARGS
El nombre es demasiado largo.
OT_ERROR_INVALID_STATE
El comisionado está activo y no se puede cambiar la ID.

otCommissionerSetProvisioningUrl

otError otCommissionerSetProvisioningUrl(
  otInstance *aInstance,
  const char *aProvisioningUrl
)

Esta función establece la URL de aprovisionamiento.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aProvisioningUrl
Un puntero para la URL de aprovisionamiento (puede ser NULL para establecer como string vacía).
Valores que se muestran
OT_ERROR_NONE
Se configuró correctamente la URL de aprovisionamiento.
OT_ERROR_INVALID_ARGS
aProvisioningUrl no es válido (demasiado largo).

Comité de inicio de ot

otError otCommissionerStart(
  otInstance *aInstance,
  otCommissionerStateCallback aStateCallback,
  otCommissionerJoinerCallback aJoinerCallback,
  void *aCallbackContext
)

Esta función habilita la función de Thread Commissioner.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aStateCallback
Un puntero para una función que se llama cuando cambia el estado de comisionado.
[in] aJoinerCallback
Se produce un puntero a una función que se llama con un evento de unión.
[in] aCallbackContext
Un puntero para el contexto específico de la aplicación.
Valores que se muestran
OT_ERROR_NONE
El servicio de comisionado se inició correctamente.
OT_ERROR_ALREADY
El comisionado ya se inició.
OT_ERROR_INVALID_STATE
El dispositivo no está conectado a una red.

OtCommissionerStop

otError otCommissionerStop(
  otInstance *aInstance
)

Esta función inhabilita la función de Comisionado de subprocesos.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Valores que se muestran
OT_ERROR_NONE
El servicio de comisionado se detuvo correctamente.
OT_ERROR_ALREADY
Ya se detuvo al comisionado.

Macros

OT_COMMISSIONING_PASSPHRASE_MAX_SIZE

 OT_COMMISSIONING_PASSPHRASE_MAX_SIZE 255

Tamaño máximo de la frase de contraseña de comisión.

OT_COMMISSIONING_PASSPHRASE_MIN_SIZE

 OT_COMMISSIONING_PASSPHRASE_MIN_SIZE 6

Tamaño mínimo de la frase de contraseña de comisión.

OT_JOINER_MAX_PSKD_LENGTH

 OT_JOINER_MAX_PSKD_LENGTH 32

Longitud máxima de la string de una PSKd de Joiner (no incluye el valor nulo).

OT_PROVISIONING_URL_MAX_SIZE

 OT_PROVISIONING_URL_MAX_SIZE 64

Tamaño máximo (cantidad de caracteres) en la string de la URL de aprovisionamiento (no incluye caracteres nulos).

TS_STEERING_DATA_MAX_LENGTH

 OT_STEERING_DATA_MAX_LENGTH 16

Longitud máxima de los datos de dirección (bytes)

Recursos

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