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

Carpintero

Este módulo incluye funciones para el rol Thread Joiner.

Resumen

enumeraciones

otJoinerState enumeración
Esta enumeración define el estado de unión.

definiciones de tipo

otJoinerCallback )(otError aError, void *aContext) definición de tipo
void(*
Este puntero de función se llama para notificar la finalización de una operación de unión.
otJoinerDiscerner definición de tipo
Esta estructura representa un Joiner Discerner.
otJoinerState definición de tipo
Esta enumeración define el estado de unión.

Funciones

otJoinerGetDiscerner ( otInstance *aInstance)
Esta función obtiene el Joiner Discerner.
otJoinerGetId ( otInstance *aInstance)
const otExtAddress *
Esta función obtiene el ID de carpintero.
otJoinerGetState ( otInstance *aInstance)
Esta función devuelve el estado de unión.
otJoinerSetDiscerner ( otInstance *aInstance, otJoinerDiscerner *aDiscerner)
Esta función configura el Joiner Discerner.
otJoinerStart ( otInstance *aInstance, const char *aPskd, const char *aProvisioningUrl, const char *aVendorName, const char *aVendorModel, const char *aVendorSwVersion, const char *aVendorData, otJoinerCallback aCallback, void *aContext)
Esta función habilita el rol Thread Joiner.
otJoinerStateToString ( otJoinerState aState)
const char *
Esta función convierte un valor de enumeración de estado de unión dado en una cadena legible por humanos.
otJoinerStop ( otInstance *aInstance)
void
Esta función deshabilita la función Thread Joiner.

estructuras

otJoinerDiscerner

Esta estructura representa un Joiner Discerner.

enumeraciones

otJoinerState

 otJoinerState

Esta enumeración define el estado de unión.

definiciones de tipo

otJoinerCallback

void(* otJoinerCallback)(otError aError, void *aContext)

Este puntero de función se llama para notificar la finalización de una operación de unión.

Detalles
Parámetros
[in] aError
OT_ERROR_NONE si el proceso de unión tuvo éxito. OT_ERROR_SECURITY si el proceso de unión falló debido a las credenciales de seguridad. OT_ERROR_NOT_FOUND si no se descubrió ninguna red a la que se pueda unir. OT_ERROR_RESPONSE_TIMEOUT si se agotó el tiempo de espera de una respuesta.
[in] aContext
Un puntero al contexto específico de la aplicación.

otJoinerDiscerner

struct otJoinerDiscerner otJoinerDiscerner

Esta estructura representa un Joiner Discerner.

otJoinerState

enum otJoinerState otJoinerState

Esta enumeración define el estado de unión.

Funciones

otJoinerGetDiscerner

const otJoinerDiscerner * otJoinerGetDiscerner(
  otInstance *aInstance
)

Esta función obtiene el Joiner Discerner.

Detalles
Parámetros
[in] aInstance
Un puntero a la instancia de OpenThread.
Devoluciones
Un puntero a Joiner Discerner o NULL si no se establece ninguno.

otJoinerGetId

const otExtAddress * otJoinerGetId(
  otInstance *aInstance
)

Esta función obtiene el ID de carpintero.

Si no se establece un Joiner Discerner, Joiner ID son los primeros 64 bits del resultado de calcular SHA-256 sobre IEEE EUI-64 asignado de fábrica. De lo contrario, el ID de Joiner se calcula a partir del valor de Joiner Discerner.

El Joiner ID también se usa como la dirección extendida IEEE 802.15.4 del dispositivo durante el proceso de puesta en marcha.

Detalles
Parámetros
[in] aInstance
Un puntero a la instancia de OpenThread.
Devoluciones
Un puntero a la ID de carpintero.

otJoinerGetState

otJoinerState otJoinerGetState(
  otInstance *aInstance
)

Esta función devuelve el estado de unión.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Valores devueltos
OT_JOINER_STATE_IDLE
OT_JOINER_STATE_DISCOVER
OT_JOINER_STATE_CONNECT
OT_JOINER_STATE_CONNECTED
OT_JOINER_STATE_ENTRUST
OT_JOINER_STATE_JOINED

otJoinerSetDiscerner

otError otJoinerSetDiscerner(
  otInstance *aInstance,
  otJoinerDiscerner *aDiscerner
)

Esta función configura el Joiner Discerner.

Joiner Discerner se utiliza para calcular el ID de Joiner utilizado durante el proceso de puesta en servicio/unión.

De forma predeterminada (cuando no se proporciona un discernidor o se establece en NULL), el ID de unión se deriva como los primeros 64 bits del resultado de calcular SHA-256 sobre IEEE EUI-64 asignado de fábrica. Tenga en cuenta que este es el comportamiento principal esperado por la especificación Thread.

Detalles
Parámetros
[in] aInstance
Un puntero a la instancia de OpenThread.
[in] aDiscerner
Un puntero a un Joiner Discerner. Si NULL borra cualquier discernidor establecido previamente.
Valores devueltos
OT_ERROR_NONE
El Joiner Discerner se actualizó con éxito.
OT_ERROR_INVALID_ARGS
aDiscerner no es válido (la longitud especificada no está dentro del rango válido).
OT_ERROR_INVALID_STATE
Hay un proceso de unión en curso, por lo que Joiner Discerner no se pudo cambiar.

otJoinerStart

otError otJoinerStart(
  otInstance *aInstance,
  const char *aPskd,
  const char *aProvisioningUrl,
  const char *aVendorName,
  const char *aVendorModel,
  const char *aVendorSwVersion,
  const char *aVendorData,
  otJoinerCallback aCallback,
  void *aContext
)

Esta función habilita el rol Thread Joiner.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aPskd
Un puntero al PSKd.
[in] aProvisioningUrl
Un puntero a la URL de aprovisionamiento (puede ser NULL).
[in] aVendorName
Un puntero al nombre del proveedor (puede ser NULL).
[in] aVendorModel
Un puntero al modelo de proveedor (puede ser NULL).
[in] aVendorSwVersion
Un puntero a la versión de software del proveedor (puede ser NULL).
[in] aVendorData
Un puntero a los datos del proveedor (puede ser NULL).
[in] aCallback
Un puntero a una función que se llama cuando se completa la operación de combinación.
[in] aContext
Un puntero al contexto específico de la aplicación.
Valores devueltos
OT_ERROR_NONE
Comenzó con éxito el rol de carpintero.
OT_ERROR_BUSY
El intento anterior todavía está en curso.
OT_ERROR_INVALID_ARGS
aPskd o aProvisioningUrl no son válidos.
OT_ERROR_INVALID_STATE
La pila de IPv6 no está habilitada o la pila de subprocesos está totalmente habilitada.

otJoinerStateToString

const char * otJoinerStateToString(
  otJoinerState aState
)

Esta función convierte un valor de enumeración de estado de unión dado en una cadena legible por humanos.

Detalles
Parámetros
[in] aState
El estado carpintero.
Devoluciones
Una representación de cadena legible por humanos de aState .

otJoinerStop

void otJoinerStop(
  otInstance *aInstance
)

Esta función deshabilita la función Thread Joiner.

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

macros

OT_JOINER_MAX_DISCERNER_LENGTH

 OT_JOINER_MAX_DISCERNER_LENGTH 64

Longitud máxima de un Joiner Discerner en bits.

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 .