Comisionado

En este módulo, se incluyen funciones para el rol de Thread Commissioner.

Resumen

Enumeraciones

otCommissionerJoinerEvent enum
Define un evento Joiner en el Commissioner.
otCommissionerState{
  OT_COMMISSIONER_STATE_DISABLED = 0,
  OT_COMMISSIONER_STATE_PETITION = 1,
  OT_COMMISSIONER_STATE_ACTIVE = 2
}
enum
Define el estado de comisionado.
otJoinerInfoType{
  OT_JOINER_INFO_TYPE_ANY = 0,
  OT_JOINER_INFO_TYPE_EUI64 = 1,
  OT_JOINER_INFO_TYPE_DISCERNER = 2
}
enum
Define un tipo de información de unión.

Typedefs

otCommissionerEnergyReportCallback)(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext) typedef
void(*
Se llama al puntero cuando el comisionado recibe un Informe de energía.
otCommissionerJoinerCallback)(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext) typedef
void(*
Se llama al puntero cada vez que cambia el estado de la unión.
otCommissionerJoinerEvent typedef
Define un evento Joiner en el Commissioner.
otCommissionerPanIdConflictCallback)(uint16_t aPanId, uint32_t aChannelMask, void *aContext) typedef
void(*
Se llama al puntero cuando el comisionado recibe un mensaje de conflicto de ID del PAN.
otCommissionerState typedef
Define el estado de comisionado.
otCommissionerStateCallback)(otCommissionerState aState, void *aContext) typedef
void(*
Se llama al puntero cada vez que cambia el estado del comisionado.
otCommissioningDataset typedef
Representa un conjunto de datos de comisión.
otJoinerInfo typedef
struct otJoinerInfo
Representa una información de unión.
otJoinerInfoType typedef
Define un tipo de información de unión.
otJoinerPskd typedef
struct otJoinerPskd
Representa una PSKd de unión.
otSteeringData typedef
Representa los datos del volante.

remotas

otCommissionerAddJoiner(otInstance *aInstance, const otExtAddress *aEui64, const char *aPskd, uint32_t aTimeout)
Agrega una entrada de Joiner.
otCommissionerAddJoinerWithDiscerner(otInstance *aInstance, const otJoinerDiscerner *aDiscerner, const char *aPskd, uint32_t aTimeout)
Agrega una entrada de Joiner con un valor determinado de Joiner Discerner.
otCommissionerAnnounceBegin(otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, const otIp6Address *aAddress)
Envía un mensaje de inicio del anuncio.
otCommissionerEnergyScan(otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, uint16_t aScanDuration, const otIp6Address *aAddress, otCommissionerEnergyReportCallback aCallback, void *aContext)
Envía un mensaje de consulta de análisis de energía.
otCommissionerGetId(otInstance *aInstance)
const char *
Muestra el ID de Commissioner.
otCommissionerGetNextJoinerInfo(otInstance *aInstance, uint16_t *aIterator, otJoinerInfo *aJoiner)
Obtén información de la unión en la posición aIterator.
otCommissionerGetProvisioningUrl(otInstance *aInstance)
const char *
Obtiene la URL de aprovisionamiento.
otCommissionerGetSessionId(otInstance *aInstance)
uint16_t
Muestra el ID de sesión del comisionado.
otCommissionerGetState(otInstance *aInstance)
Muestra el estado de comisionado.
otCommissionerPanIdQuery(otInstance *aInstance, uint16_t aPanId, uint32_t aChannelMask, const otIp6Address *aAddress, otCommissionerPanIdConflictCallback aCallback, void *aContext)
Envía un mensaje de consulta del ID del PAN.
otCommissionerRemoveJoiner(otInstance *aInstance, const otExtAddress *aEui64)
Quita una entrada de Joiner.
otCommissionerRemoveJoinerWithDiscerner(otInstance *aInstance, const otJoinerDiscerner *aDiscerner)
Quita una entrada de Joiner.
otCommissionerSendMgmtGet(otInstance *aInstance, const uint8_t *aTlvs, uint8_t aLength)
Envía MGMT_COMMISSIONER_GET.
otCommissionerSendMgmtSet(otInstance *aInstance, const otCommissioningDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength)
Envía MGMT_COMMISSIONER_SET.
otCommissionerSetId(otInstance *aInstance, const char *aId)
Establece el ID de comisionado.
otCommissionerSetProvisioningUrl(otInstance *aInstance, const char *aProvisioningUrl)
Configura la URL de aprovisionamiento.
otCommissionerStart(otInstance *aInstance, otCommissionerStateCallback aStateCallback, otCommissionerJoinerCallback aJoinerCallback, void *aCallbackContext)
Habilita el rol Thread Commissioner.
otCommissionerStop(otInstance *aInstance)
Inhabilita el rol Thread Commissioner.

Structs

otCommissioningDataset

Representa un conjunto de datos de comisión.

otJoinerInfo

Representa una información de unión.

otJoinerPskd

Representa una PSKd de unión.

otSteeringData

Representa los datos del volante.

Enumeraciones

otCommissionerJoinerEvent

 otCommissionerJoinerEvent

Define un evento Joiner en el Commissioner.

otCommissionerState

 otCommissionerState

Define el estado de comisionado.

Propiedades
OT_COMMISSIONER_STATE_ACTIVE

El rol de comisionado está activo.

OT_COMMISSIONER_STATE_DISABLED

El rol de comisionado está inhabilitado.

OT_COMMISSIONER_STATE_PETITION

Actualmente solicita convertirse en Comisionado.

otJoinerInfoType

 otJoinerInfoType

Define un tipo de información de unión.

Propiedades
OT_JOINER_INFO_TYPE_ANY

Aceptar cualquier Joiner (no se especifica EUI64 ni Discerner).

OT_JOINER_INFO_TYPE_DISCERNER

Se especificó el algoritmo de unión (mSharedId.mDiscerner en otJoinerInfo).

OT_JOINER_INFO_TYPE_EUI64

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

Typedefs

otCommissionerEnergyReportCallback

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

Se llama al puntero cuando el comisionado recibe un Informe de energía.

Detalles
Parámetros
[in] aChannelMask
El valor de la máscara de canal.
[in] aEnergyList
Un puntero a 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 al puntero cada vez que cambia el estado de la unión.

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

otCommissionerJoinerEvent

enum otCommissionerJoinerEvent otCommissionerJoinerEvent

Define un evento Joiner en el Commissioner.

otCommissionerPanIdConflictCallback

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

Se llama al puntero cuando el comisionado recibe un mensaje de conflicto de ID del PAN.

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

otCommissionerState

enum otCommissionerState otCommissionerState

Define el estado de comisionado.

otCommissionerStateCallback

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

Se llama al puntero cada vez que cambia el estado del comisionado.

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

otCommissioningDataset

struct otCommissioningDataset otCommissioningDataset

Representa un conjunto de datos de comisión.

otJoinerInfo

struct otJoinerInfo otJoinerInfo

Representa una información de unión.

otJoinerInfoType

enum otJoinerInfoType otJoinerInfoType

Define un tipo de información de unión.

otJoinerPskd

struct otJoinerPskd otJoinerPskd

Representa una PSKd de unión.

otSteeringData

struct otSteeringData otSteeringData

Representa los datos del volante.

remotas

otCommissionerAddJoiner

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

Agrega una entrada de Joiner.

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

otCommissionerAddJoinerWithDiscerner

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

Agrega una entrada de Joiner con un valor determinado de Joiner Discerner.

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

otCommissionerAnnounceBegin

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

Envía un mensaje de inicio del anuncio.

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

otCommissionerEnergyScan

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

Envía un mensaje de consulta de análisis de energía.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aChannelMask
El valor de la máscara de canal.
[in] aCount
Es la cantidad de mediciones de energía por canal.
[in] aPeriod
El tiempo entre 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 a una función a la que se llama cuando recibe 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 del análisis de energía se puso en cola correctamente.
OT_ERROR_NO_BUFS
Búferes insuficientes para generar un mensaje de consulta del análisis de energía.
OT_ERROR_INVALID_STATE
La comisión no está activa.

otCommissionerGetId

const char * otCommissionerGetId(
  otInstance *aInstance
)

Muestra el ID de Commissioner.

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
)

Obtén 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
Es 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 miembro de unión.

otCommissionerGetProvisioningUrl

const char * otCommissionerGetProvisioningUrl(
  otInstance *aInstance
)

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

otCommissionerGetSessionId

uint16_t otCommissionerGetSessionId(
  otInstance *aInstance
)

Muestra el ID de sesión del comisionado.

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

otCommissionerGetState

otCommissionerState otCommissionerGetState(
  otInstance *aInstance
)

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
Se habilitó la función de Comisionado.

otCommissionerPanIdQuery

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

Envía un mensaje de consulta del ID del PAN.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aPanId
El ID del PAN que se consultará.
[in] aChannelMask
El valor de la máscara de canal.
[in] aAddress
Un puntero al destino IPv6.
[in] aCallback
Un puntero a una función a la que se llama cuando recibes un mensaje de conflicto de ID del 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 del ID del PAN se puso en cola correctamente.
OT_ERROR_NO_BUFS
Búferes insuficientes para generar un mensaje de consulta de ID del PAN.
OT_ERROR_INVALID_STATE
La comisión no está activa.

otCommissionerRemoveJoiner

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

Quita una entrada de Joiner.

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

otCommissionerRemoveJoinerWithDiscerner

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

Quita una entrada de Joiner.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aDiscerner
Un puntero para el Discerner de Joiner.
Valores que se muestran
OT_ERROR_NONE
Se quitó correctamente la unión.
OT_ERROR_NOT_FOUND
No se encontró el conector especificado por aEui64.
OT_ERROR_INVALID_ARGS
aDiscerner no es válido.
OT_ERROR_INVALID_STATE
La comisión no está activa.

otCommissionerSendMgmtGet

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

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
Es la longitud de los TLV.
Valores que se muestran
OT_ERROR_NONE
Se envió correctamente el comando del conjunto de datos de Meshcop.
OT_ERROR_NO_BUFS
No hay suficiente espacio de búfer para enviar.
OT_ERROR_INVALID_STATE
La comisión no está activa.

otCommissionerSendMgmtSet

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

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 comisión.
[in] aTlvs
Un puntero para los TLV.
[in] aLength
Es la longitud de los TLV.
Valores que se muestran
OT_ERROR_NONE
Se envió correctamente el comando del conjunto de datos de Meshcop.
OT_ERROR_NO_BUFS
No hay suficiente espacio de búfer para enviar.
OT_ERROR_INVALID_STATE
La comisión no está activa.

otCommissionerSetId

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

Establece el ID de comisionado.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aId
Un puntero para un array de caracteres de string. Debe ser 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 miembro de la comisión está activo y no se puede cambiar el ID.

otCommissionerSetProvisioningUrl

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

Configura la URL de aprovisionamiento.

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

otCommissionerStart

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

Habilita el rol Thread Commissioner.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aStateCallback
Un puntero para una función a la que se llama cuando cambia el estado de comisionado.
[in] aJoinerCallback
Ocurre un puntero a una función a la 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
Se inició correctamente el servicio de Commissioner.
OT_ERROR_ALREADY
Commissioner ya comenzó.
OT_ERROR_INVALID_STATE
El dispositivo no está conectado a una red.

otCommissionerStop

otError otCommissionerStop(
  otInstance *aInstance
)

Inhabilita el rol Thread Commissioner.

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

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 un PSKd de Joiner (no incluye los caracteres nulos).

OT_PROVISIONING_URL_MAX_SIZE

 OT_PROVISIONING_URL_MAX_SIZE 64

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

OT_STEERING_DATA_MAX_LENGTH

 OT_STEERING_DATA_MAX_LENGTH 16

Longitud máxima de los datos de direccionamiento (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 contribuir a nuestra documentación, consulta Recursos.