Google is committed to advancing racial equity for Black communities. See how.
Se usó la API de Cloud Translation para traducir esta página.
Switch to English

Notario

Este módulo incluye funciones para el rol de Comisionado de hilos.

Resumen

Enumeraciones

otCommissionerJoinerEvent enumeración
Esta enumeración define un evento Joiner 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 Typer de información de unión.

Typedefs

otCommissionerEnergyReportCallback )(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext) typedef
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) typedef
void(*
Este puntero de función se llama cada vez que cambia el estado de unión.
otCommissionerJoinerEvent typedef
Esta enumeración define un evento Joiner en el Comisionado.
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
Esta enumeración define el Estado Comisionado.
otCommissionerStateCallback )(otCommissionerState aState, void *aContext) typedef
void(*
Este puntero de función se llama cada vez que cambia el estado del comisionado.
otCommissioningDataset typedef
Esta estructura representa un conjunto de datos de puesta en servicio.
otJoinerInfo typedef
struct otJoinerInfo
Esta estructura representa una información de unión.
otJoinerInfoType typedef
Esta enumeración define un Typer de información de unión.
otJoinerPskd typedef
struct otJoinerPskd
Esta estructura representa un Joiner PSKd.
otSteeringData typedef
Esta estructura representa los datos de dirección.

Las funciones

otCommissionerAddJoiner ( otInstance *aInstance, const otExtAddress *aEui64, const char *aPskd, uint32_t aTimeout)
Esta función agrega una entrada Joiner.
otCommissionerAddJoinerWithDiscerner ( otInstance *aInstance, const otJoinerDiscerner *aDiscerner, const char *aPskd, uint32_t aTimeout)
Esta función agrega una entrada 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 inicio de anuncio.
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 escaneo de energía.
otCommissionerGetNextJoinerInfo ( otInstance *aInstance, uint16_t *aIterator, otJoinerInfo *aJoiner)
Este método obtiene información de unión en una 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 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 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.
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 hilos.
otCommissionerStop ( otInstance *aInstance)
Esta función deshabilita 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 unión.

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 Joiner en el Comisionado.

otCommissionerState

 otCommissionerState

Esta enumeración define el Estado Comisionado.

Propiedades
OT_COMMISSIONER_STATE_ACTIVE

El rol del comisionado es activo.

OT_COMMISSIONER_STATE_DISABLED

El rol del comisionado está deshabilitado.

OT_COMMISSIONER_STATE_PETITION

Actualmente solicita ser Comisionado.

otJoinerInfoType

 otJoinerInfoType

Esta enumeración define un Typer Info Joiner.

Propiedades
OT_JOINER_INFO_TYPE_ANY

Acepte 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 ).

Typedefs

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

otCommissionerJoinerCallback

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 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 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 Joiner en el Comisionado.

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 de ID de PAN.
[in] aChannelMask
El valor de la máscara del 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] aChannelMask
El valor de la máscara del 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.

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 unión.

otJoinerInfoType

enum otJoinerInfoType otJoinerInfoType

Esta enumeración define un Typer Info Joiner.

otJoinerPskd

struct otJoinerPskd otJoinerPskd

Esta estructura representa un Joiner PSKd.

otSteeringData

struct otSteeringData otSteeringData

Esta estructura representa los datos de dirección.

Las funciones

otCommissionerAddJoiner

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

Esta función agrega una entrada Joiner.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aEui64
Un puntero al IEEE EUI-64 de Joiner o NULL para cualquier Joiner.
[in] aPskd
Un puntero a la PSKd.
[in] aTimeout
Un tiempo después del cual un Joiner se elimina automáticamente, en segundos.
Valores de retorno
OT_ERROR_NONE
Se agregó con éxito el Joiner.
OT_ERROR_NO_BUFS
No hay buffers disponibles para agregar el Joiner.
OT_ERROR_INVALID_ARGS
aEui64 o aPskd no es válido.
OT_ERROR_INVALID_STATE
El comisionado no está activo.

otCommissionerAddJoinerWithDiscerner

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

Esta función agrega una entrada 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 a la PSKd.
[in] aTimeout
Un tiempo después del cual un Joiner se elimina automáticamente, en segundos.
Valores de retorno
OT_ERROR_NONE
Se agregó con éxito el Joiner.
OT_ERROR_NO_BUFS
No hay buffers disponibles para agregar el Joiner.
OT_ERROR_INVALID_ARGS
aDiscerner o aPskd no es válido.
OT_ERROR_INVALID_STATE
El comisionado no está activo.

otCommissionerAnnounceBegin

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

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

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aChannelMask
El valor de la máscara del canal.
[in] aCount
El número de mensajes de anuncio por canal.
[in] aPeriod
El tiempo entre dos transmisiones de anuncios MLE sucesivos (en milisegundos).
[in] aAddress
Un puntero al destino IPv6.
Valores de retorno
OT_ERROR_NONE
Con éxito puso en cola el mensaje Anunciar inicio.
OT_ERROR_NO_BUFS
Buffers insuficientes para generar un mensaje de inicio de anuncio.
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 consulta de escaneo de energía.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aChannelMask
El valor de la máscara del 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 de retorno
OT_ERROR_NONE
Con éxito puso en cola el mensaje Energy Scan Query.
OT_ERROR_NO_BUFS
Buffers insuficientes para generar un mensaje de Energy Scan Query.
OT_ERROR_INVALID_STATE
El comisionado no está activo.

otCommissionerGetNextJoinerInfo

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

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

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

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 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 actual del comisionado.

otCommissionerGetState

 otCommissionerState otCommissionerGetState(
  otInstance *aInstance
)

Esta función devuelve el estado del comisionado.

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

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aPanId
La ID de PAN para consultar.
[in] aChannelMask
El valor de la máscara del 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 de retorno
OT_ERROR_NONE
Se colocó correctamente el mensaje de consulta de ID de PAN.
OT_ERROR_NO_BUFS
Buffers insuficientes para generar un mensaje de consulta de ID PAN.
OT_ERROR_INVALID_STATE
El comisionado 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 de Joiner o NULL para cualquier Joiner.
Valores de retorno
OT_ERROR_NONE
Se eliminó con éxito el Joiner.
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 comisionado 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] aEui64
Un puntero al Joiner Discerner.
Valores de retorno
OT_ERROR_NONE
Se eliminó con éxito el Joiner.
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 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 a una instancia de OpenThread.
[in] aTlvs
Un puntero a los TLV.
[in] aLength
La longitud de los TLV.
Valores de retorno
OT_ERROR_NONE
Enviar 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 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 a una instancia de OpenThread.
[in] aDataset
Un puntero a la puesta en marcha del conjunto de datos.
[in] aTlvs
Un puntero a los TLV.
[in] aLength
La longitud de los TLV.
Valores de retorno
OT_ERROR_NONE
Enviar 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 comisionado no está activo.

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 como cadena vacía).
Valores de retorno
OT_ERROR_NONE
Establezca correctamente la URL de aprovisionamiento.
OT_ERROR_INVALID_ARGS
aProvisioningUrl no es válido (demasiado tiempo).

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 de retorno
OT_ERROR_NONE
Comenzó con éxito el servicio del Comisionado.
OT_ERROR_ALREADY
El comisionado ya ha comenzado.
OT_ERROR_INVALID_STATE
El dispositivo no está conectado actualmente a una red.

otCommissionerStop

 otError otCommissionerStop(
  otInstance *aInstance
)

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

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Valores de retorno
OT_ERROR_NONE
Se detuvo con éxito el servicio del Comisionado.
OT_ERROR_ALREADY
El comisionado 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 la cadena de un PSKd Joiner (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 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)