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

Notario

Este módulo incluye funciones para el rol de comisionado de subprocesos.

Resumen

enumeraciones

otCommissionerJoinerEvent enumeración
Esta enumeración define un Evento de Incorporación en el Comisionado.
otCommissionerState {
OT_COMMISSIONER_STATE_DISABLED = 0,
OT_COMMISSIONER_STATE_PETITION = 1,
OT_COMMISSIONER_STATE_ACTIVE = 2
}
enumeración
Esta enumeración define el Estado Comisionado.
otJoinerInfoType {
OT_JOINER_INFO_TYPE_ANY = 0,
OT_JOINER_INFO_TYPE_EUI64 = 1,
OT_JOINER_INFO_TYPE_DISCERNER = 2
}
enumeración
Esta enumeración define un tipo de información de unión.

definiciones de tipo

otCommissionerEnergyReportCallback )(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext) definición de tipo
void(*
Este puntero de función se llama cuando el Comisionado recibe un Informe de energía.
otCommissionerJoinerCallback )(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext) definición de tipo
void(*
Este puntero de función se llama cada vez que cambia el estado del ensamblador.
otCommissionerJoinerEvent definición de tipo
Esta enumeración define un Evento de Incorporación en el Comisionado.
otCommissionerPanIdConflictCallback )(uint16_t aPanId, uint32_t aChannelMask, void *aContext) definición de tipo
void(*
Este puntero de función se llama cuando el Comisionado recibe un mensaje de Conflicto de ID de PAN.
otCommissionerState definición de tipo
Esta enumeración define el Estado Comisionado.
otCommissionerStateCallback )(otCommissionerState aState, void *aContext) definición de tipo
void(*
Este puntero de función se llama cada vez que cambia el estado del comisionado.
otCommissioningDataset definición de tipo
Esta estructura representa un conjunto de datos de puesta en marcha.
otJoinerInfo definición de tipo
struct otJoinerInfo
Esta estructura representa una información de carpintero.
otJoinerInfoType definición de tipo
Esta enumeración define un tipo de información de unión.
otJoinerPskd definición de tipo
struct otJoinerPskd
Esta estructura representa un Joiner PSKd.
otSteeringData definición de tipo
Esta estructura representa los datos de dirección.

Funciones

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 de Joiner Discerner dado.
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 consulta de análisis de energía.
otCommissionerGetId ( otInstance *aInstance)
const char *
Esta función devuelve la identificación del comisionado.
otCommissionerGetNextJoinerInfo ( otInstance *aInstance, uint16_t *aIterator, otJoinerInfo *aJoiner)
Este método obtiene información de unión en la posición de iterador.
otCommissionerGetProvisioningUrl ( otInstance *aInstance)
const char *
Esta función obtiene la URL de aprovisionamiento.
otCommissionerGetSessionId ( otInstance *aInstance)
uint16_t
Esta función devuelve el ID de sesión del comisionado.
otCommissionerGetState ( otInstance *aInstance)
Esta función devuelve el estado del comisario.
otCommissionerPanIdQuery ( otInstance *aInstance, uint16_t aPanId, uint32_t aChannelMask, const otIp6Address *aAddress, otCommissionerPanIdConflictCallback aCallback, void *aContext)
Esta función envía un mensaje de consulta de ID de PAN.
otCommissionerRemoveJoiner ( otInstance *aInstance, const otExtAddress *aEui64)
Esta función elimina una entrada de Joiner.
otCommissionerRemoveJoinerWithDiscerner ( otInstance *aInstance, const otJoinerDiscerner *aDiscerner)
Esta función elimina 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 la identificación del 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 el rol de comisionado de subprocesos.
otCommissionerStop ( otInstance *aInstance)
Esta función desactiva el rol de comisionado de subprocesos.

estructuras

otCommissioningDataset

Esta estructura representa un conjunto de datos de puesta en servicio.

otJoinerInfo

Esta estructura representa una información de carpintero.

otJoinerPskd

Esta estructura representa un Joiner PSKd.

otSteeringData

Esta estructura representa los datos de dirección.

enumeraciones

otCommissionerJoinerEvent

 otCommissionerJoinerEvent

Esta enumeración define un Evento de Incorporación en el Comisionado.

otCommissionerState

 otCommissionerState

Esta enumeración define el Estado Comisionado.

Propiedades
OT_COMMISSIONER_STATE_ACTIVE

El papel de comisionado está activo.

OT_COMMISSIONER_STATE_DISABLED

La función de comisario está desactivada.

OT_COMMISSIONER_STATE_PETITION

Actualmente está solicitando convertirse en un Comisionado.

otJoinerInfoType

 otJoinerInfoType

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

Propiedades
OT_JOINER_INFO_TYPE_ANY

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

OT_JOINER_INFO_TYPE_DISCERNER

Se especifica Joiner Discerner ( mSharedId.mDiscerner en otJoinerInfo ).

OT_JOINER_INFO_TYPE_EUI64

Se especifica Joiner EUI-64 ( mSharedId.mEui64 en otJoinerInfo ).

definiciones de tipo

otCommissionerEnergyReportCallback

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

Este puntero de función se llama 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 medidas de energía.
[in] aEnergyListLength
Número de entradas en aEnergyListLength .
[in] aContext
Un puntero al contexto específico de la aplicación.

otCommissionerJoinerDevolución de llamada

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

Este puntero de función se llama cada vez que cambia el estado del ensamblador.

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

otCommissionerJoinerEvent

enum otCommissionerJoinerEvent otCommissionerJoinerEvent

Esta enumeración define un Evento de Incorporación en el Comisionado.

otCommissionerPanIdConflictCallback

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

Este puntero de función se llama cuando el Comisionado recibe un mensaje de Conflicto de ID de PAN.

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

otCommissionerState

enum otCommissionerState otCommissionerState

Esta enumeración define el Estado Comisionado.

otCommissionerStateCallback

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

Este puntero de función se llama cada vez que cambia el estado del comisionado.

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

otCommissioningDataset

struct otCommissioningDataset otCommissioningDataset

Esta estructura representa un conjunto de datos de puesta en servicio.

otJoinerInfo

struct otJoinerInfo otJoinerInfo

Esta estructura representa una información de carpintero.

otJoinerInfoType

enum otJoinerInfoType otJoinerInfoType

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

otJoinerPskd

struct otJoinerPskd otJoinerPskd

Esta estructura representa un Joiner PSKd.

otSteeringData

struct otSteeringData otSteeringData

Esta estructura representa los datos de dirección.

Funciones

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 a una instancia de OpenThread.
[in] aEui64
Un puntero al IEEE EUI-64 o NULL del Joiner para cualquier Joiner.
[in] aPskd
Un puntero al PSKd.
[in] aTimeout
Un tiempo después del cual se elimina automáticamente un Joiner, en segundos.
Valores devueltos
OT_ERROR_NONE
Se agregó con éxito el carpintero.
OT_ERROR_NO_BUFS
No hay búferes disponibles para agregar el carpintero.
OT_ERROR_INVALID_ARGS
aEui64 o aPskd no es válido.
OT_ERROR_INVALID_STATE
El comisario no está activo.

otCommissionerAddJoinerWithDiscerner

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

Esta función agrega una entrada de Joiner con un valor de Joiner Discerner dado.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aDiscerner
Un puntero al Joiner Discerner.
[in] aPskd
Un puntero al PSKd.
[in] aTimeout
Un tiempo después del cual se elimina automáticamente un Joiner, en segundos.
Valores devueltos
OT_ERROR_NONE
Se agregó con éxito el carpintero.
OT_ERROR_NO_BUFS
No hay búferes disponibles para agregar el carpintero.
OT_ERROR_INVALID_ARGS
aDiscerner o aPskd no son válidos.
OT_ERROR_INVALID_STATE
El comisario no está activo.

otComisionadoAnunciarComenzar

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 a una instancia de OpenThread.
[in] aChannelMask
El valor de la máscara de canal.
[in] aCount
El número de mensajes de Anuncio por canal.
[in] aPeriod
El tiempo entre dos transmisiones MLE Announce sucesivas (en milisegundos).
[in] aAddress
Un puntero al destino IPv6.
Valores devueltos
OT_ERROR_NONE
Se puso en cola con éxito el mensaje de anuncio de inicio.
OT_ERROR_NO_BUFS
Búferes insuficientes para generar un mensaje de anuncio de inicio.
OT_ERROR_INVALID_STATE
El comisario 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 consulta de análisis de energía.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aChannelMask
El valor de la máscara de canal.
[in] aCount
El número de mediciones de energía por canal.
[in] aPeriod
El tiempo entre mediciones de energía (milisegundos).
[in] aScanDuration
La duración del escaneo para cada medición de energía (milisegundos).
[in] aAddress
Un puntero al destino IPv6.
[in] aCallback
Un puntero a una función llamada al recibir un mensaje de Informe de energía.
[in] aContext
Un puntero al contexto específico de la aplicación.
Valores devueltos
OT_ERROR_NONE
Se puso en cola con éxito el mensaje de consulta de análisis de energía.
OT_ERROR_NO_BUFS
Búferes insuficientes para generar un mensaje de consulta de análisis de energía.
OT_ERROR_INVALID_STATE
El comisario no está activo.

otComisionadoGetId

const char * otCommissionerGetId(
  otInstance *aInstance
)

Esta función devuelve la identificación del comisionado.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Devoluciones
El Comisionado Id.

otCommissionerGetNextJoinerInfo

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

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

Detalles
Parámetros
[in] aInstance
Un puntero a la instancia.
[in,out] aIterator
Un puntero al contexto del iterador de información de unión.
[out] aJoiner
Una referencia a la información de Joiner.
Valores devueltos
OT_ERROR_NONE
Obtenga con éxito la información de Joiner.
OT_ERROR_NOT_FOUND
No se encuentra el siguiente carpintero.

otCommissionerGetProvisioningUrl

const char * otCommissionerGetProvisioningUrl(
  otInstance *aInstance
)

Esta función obtiene la URL de aprovisionamiento.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Devoluciones
Un puntero a la cadena de URL.

otCommissionerGetSessionId

uint16_t otCommissionerGetSessionId(
  otInstance *aInstance
)

Esta función devuelve el ID de sesión del comisionado.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Devoluciones
El ID de sesión del comisionado actual.

otCommissionerGetState

otCommissionerState otCommissionerGetState(
  otInstance *aInstance
)

Esta función devuelve el estado del comisario.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Valores devueltos
OT_COMMISSIONER_STATE_DISABLED
Comisionado discapacitado.
OT_COMMISSIONER_STATE_PETITION
Convertirse en el comisario.
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 consulta de ID de PAN.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aPanId
El ID de PAN a 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 llamada al recibir un mensaje de Conflicto de ID de PAN.
[in] aContext
Un puntero al contexto específico de la aplicación.
Valores devueltos
OT_ERROR_NONE
Se puso en cola con éxito el mensaje de consulta de ID de PAN.
OT_ERROR_NO_BUFS
Búferes insuficientes para generar un mensaje de consulta de ID de PAN.
OT_ERROR_INVALID_STATE
El comisario no está activo.

otCommissionerRemoveJoiner

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

Esta función elimina una entrada de Joiner.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aEui64
Un puntero al IEEE EUI-64 o NULL del Joiner para cualquier Joiner.
Valores devueltos
OT_ERROR_NONE
Eliminado con éxito el carpintero.
OT_ERROR_NOT_FOUND
No se encontró el Joiner especificado por aEui64 .
OT_ERROR_INVALID_ARGS
aEui64 no es válido.
OT_ERROR_INVALID_STATE
El comisario no está activo.

otCommissionerRemoveJoinerWithDiscerner

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

Esta función elimina una entrada de Joiner.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aDiscerner
Un puntero al Joiner Discerner.
Valores devueltos
OT_ERROR_NONE
Eliminado con éxito el carpintero.
OT_ERROR_NOT_FOUND
No se encontró el Joiner especificado por aEui64 .
OT_ERROR_INVALID_ARGS
aDiscerner no es válido.
OT_ERROR_INVALID_STATE
El comisario 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 a una instancia de OpenThread.
[in] aTlvs
Un puntero a los TLV.
[in] aLength
La longitud de los TLV.
Valores devueltos
OT_ERROR_NONE
Envíe con éxito el comando del conjunto de datos meshcop.
OT_ERROR_NO_BUFS
Espacio de búfer insuficiente para enviar.
OT_ERROR_INVALID_STATE
El comisario 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 a una instancia de OpenThread.
[in] aDataset
Un puntero al conjunto de datos de puesta en marcha.
[in] aTlvs
Un puntero a los TLV.
[in] aLength
La longitud de los TLV.
Valores devueltos
OT_ERROR_NONE
Envíe con éxito el comando del conjunto de datos meshcop.
OT_ERROR_NO_BUFS
Espacio de búfer insuficiente para enviar.
OT_ERROR_INVALID_STATE
El comisario no está activo.

otCommissionerSetId

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

Esta función establece la identificación del comisionado.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aId
Un puntero a una matriz de caracteres de cadena. Debe ser nulo terminado.
Valores devueltos
OT_ERROR_NONE
Establecer con éxito la identificación del comisionado.
OT_ERROR_INVALID_ARGS
El nombre de pila es demasiado largo.
OT_ERROR_INVALID_STATE
El comisionado está activo y la identificación no se puede cambiar.

otCommissionerSetProvisioningUrl

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

Esta función establece la URL de aprovisionamiento.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aProvisioningUrl
Un puntero a la URL de aprovisionamiento (puede ser NULL para establecer una cadena vacía).
Valores devueltos
OT_ERROR_NONE
Establecer correctamente la URL de aprovisionamiento.
OT_ERROR_INVALID_ARGS
aProvisioningUrl no es válido (demasiado largo).

otCommissionerStart

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

Esta función habilita el rol de comisionado de subprocesos.

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

otCommissionerStop

otError otCommissionerStop(
  otInstance *aInstance
)

Esta función desactiva el rol de comisionado de subprocesos.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Valores devueltos
OT_ERROR_NONE
Detuvo con éxito el servicio del Comisionado.
OT_ERROR_ALREADY
El comisario ya está detenido.

macros

OT_COMMISSIONING_PASSPHRASE_MAX_SIZE

 OT_COMMISSIONING_PASSPHRASE_MAX_SIZE 255

Tamaño máximo de la frase de contraseña de puesta en servicio.

OT_COMMISSIONING_PASSPHRASE_MIN_SIZE

 OT_COMMISSIONING_PASSPHRASE_MIN_SIZE 6

Tamaño mínimo de la frase de contraseña de puesta en servicio.

OT_JOINER_MAX_PSKD_LENGTH

 OT_JOINER_MAX_PSKD_LENGTH 32

Longitud máxima de cadena de un Joiner PSKd (no incluye caracteres nulos).

OT_PROVISIONING_URL_MAX_SIZE

 OT_PROVISIONING_URL_MAX_SIZE 64

Tamaño máximo (número de caracteres) en la cadena de URL de aprovisionamiento (excluye caracteres nulos).

OT_STEERING_DATA_MAX_LENGTH

 OT_STEERING_DATA_MAX_LENGTH 16

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

Recursos

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