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 tipovoid(* Este puntero de función se llama para notificar la finalización de una operación de unión. |
otJoinerDiscerner | definición de tipostruct otJoinerDiscerner Esta estructura representa un Joiner Discerner. |
otJoinerState | definición de tipoenum otJoinerState Esta enumeración define el estado de unión. |
Funciones | |
---|---|
otJoinerGetDiscerner ( otInstance *aInstance) | const otJoinerDiscerner * 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 |
|
otJoinerDiscerner
struct otJoinerDiscerner otJoinerDiscerner
Esta estructura representa un Joiner Discerner.
Funciones
otJoinerGetDiscerner
const otJoinerDiscerner * otJoinerGetDiscerner( otInstance *aInstance )
Esta función obtiene el Joiner Discerner.
Detalles | |||
---|---|---|---|
Parámetros |
| ||
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 |
| ||
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 |
| ||||||||||||
Valores devueltos |
|
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 |
| ||||||
Valores devueltos |
|
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 |
| ||||||||||||||||||
Valores devueltos |
|
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 |
| ||
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 |
|
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 .