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

Joiner

Este módulo incluye funciones para la unión de subprocesos.

Resumen

Enumeraciones

otJoinerState enum
Esta enumeración define el estado de Joiner.

Typedefs

otJoinerCallback)(otError aError, void *aContext) typedef
void(*
Se llama a este puntero de función para notificar que se completó una operación de unión.
otJoinerDiscerner typedef
Esta estructura representa un separador de carpintero.
otJoinerState typedef
Esta enumeración define el estado de Joiner.

Funciones

otJoinerGetDiscerner(otInstance *aInstance)
Obtiene el discernista de la unión.
otJoinerGetId(otInstance *aInstance)
const otExtAddress *
Obtiene el ID de unión.
otJoinerGetState(otInstance *aInstance)
Obtiene el estado de Joiner.
otJoinerSetDiscerner(otInstance *aInstance, otJoinerDiscerner *aDiscerner)
Establece el activador de Joiner.
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)
Habilita la función de unión de subprocesos.
otJoinerStateToString(otJoinerState aState)
const char *
Esta función convierte un valor de enumeración de estado de unión determinado en una string legible.
otJoinerStop(otInstance *aInstance)
void
Inhabilita la función de unión de subprocesos.

Structs

otJoinerDiscerner.

Esta estructura representa un separador de carpintero.

Enumeraciones

Estado de unión de ot

 otJoinerState

Esta enumeración define el estado de Joiner.

Typedefs

otJoinerCallback.

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

Se llama a este puntero de función para notificar que se completó una operación de unión.

Detalles
Parámetros
[in] aError
OT_ERROR_NONE si el proceso para unirse fue exitoso. OT_ERROR_SECURITY si el proceso para unirse falló debido a credenciales de seguridad. OT_ERROR_NOT_FOUND si no se descubrió una red para unirse. OT_ERROR_RESPONSE_TIMEOUT si se agotó el tiempo de espera de la respuesta
[in] aContext
Un puntero para el contexto específico de la aplicación.

otJoinerDiscerner

struct otJoinerDiscerner otJoinerDiscerner

Esta estructura representa un separador de carpintero.

Estado de unión de ot

enum otJoinerState otJoinerState

Esta enumeración define el estado de Joiner.

Funciones

oJoinJoinerGetDiscerner

const otJoinerDiscerner * otJoinerGetDiscerner(
  otInstance *aInstance
)

Obtiene el discernista de la unión.

Para obtener más información, consulta otJoinerSetDiscerner.

Detalles
Parámetros
[in] aInstance
Un puntero para la instancia de OpenThread.
Qué muestra
Un puntero para Discerner de Joiner o NULL si no se configuró ninguno

ID de OtJoinerGet

const otExtAddress * otJoinerGetId(
  otInstance *aInstance
)

Obtiene el ID de unión.

Si no se establece un activador de unión, el ID de unión es el primero de los 64 bits del resultado de calcular SHA-256 sobre IEEE EUI-64 asignado por la fábrica. De lo contrario, el ID de unión se calcula a partir del valor del separador de unión.

El ID de unión también se utiliza como la dirección extendida IEEE 802.15.4 del dispositivo durante el proceso de asignación.

Detalles
Parámetros
[in] aInstance
Un puntero para la instancia de OpenThread.
Qué muestra
Un puntero al ID de unión.

OtJoinerGetState

otJoinerState otJoinerGetState(
  otInstance *aInstance
)

Obtiene el estado de Joiner.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Valores que se muestran
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
)

Establece el activador de Joiner.

El discernible de Joiner se usa para calcular el ID de Joiner durante el proceso de comisión de Thread. Para obtener más información, consulta otJoinerGetId.

Detalles
Parámetros
[in] aInstance
Un puntero para la instancia de OpenThread.
[in] aDiscerner
Un puntero para un Discerner de carpintero. Si el valor NULL borra cualquier discernible configurado previamente.
Valores que se muestran
OT_ERROR_NONE
El identificador de Joiner se actualizó correctamente.
OT_ERROR_INVALID_ARGS
aDiscerner no es válido (la longitud especificada no se encuentra dentro del rango válido).
OT_ERROR_INVALID_STATE
Hay un proceso de unión en curso, por lo que no se pudo cambiar el identificador de Joiner.

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
)

Habilita la función de unión de subprocesos.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aPskd
Un puntero para la PSKd
[in] aProvisioningUrl
Un puntero para la URL de aprovisionamiento (puede ser NULO).
[in] aVendorName
Un puntero al nombre del proveedor (puede ser NULO).
[in] aVendorModel
Un puntero al modelo de proveedor (puede ser NULO).
[in] aVendorSwVersion
Un puntero para la versión de SW del proveedor (puede ser NULO).
[in] aVendorData
Un puntero para los datos del proveedor (puede ser NULO).
[in] aCallback
Un puntero para una función que se llama cuando se completa la operación de unión.
[in] aContext
Un puntero para el contexto específico de la aplicación.
Valores que se muestran
OT_ERROR_NONE
Se inició la función de unión con éxito.
OT_ERROR_BUSY
El intento anterior todavía está en curso.
OT_ERROR_INVALID_ARGS
aPskd o aProvisioningUrl no es válido.
OT_ERROR_INVALID_STATE
La pila IPv6 no está habilitada o la pila de Thread está completamente habilitada.

oJoinerStateToString

const char * otJoinerStateToString(
  otJoinerState aState
)

Esta función convierte un valor de enumeración de estado de unión determinado en una string legible.

Detalles
Parámetros
[in] aState
El estado de la unión.
Qué muestra
Una representación de string legible de aState

OtJoinerStop

void otJoinerStop(
  otInstance *aInstance
)

Inhabilita la función de unión de subprocesos.

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

Macros

OT_JOINER_MAX_DISCERNER_LENGTH

 OT_JOINER_MAX_DISCERNER_LENGTH 64

Longitud máxima de un discernible de Joiner en bits.

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.