Joiner
This module includes functions for the Thread Joiner role.
Summary
Enumerations |
|
---|---|
otJoinerState
|
enum This enumeration defines the Joiner State. |
Typedefs |
|
---|---|
otJoinerCallback)(otError aError, void *aContext)
|
typedefvoid(*
This function pointer is called to notify the completion of a join operation. |
otJoinerState
|
typedefenum otJoinerState
This enumeration defines the Joiner State. |
Functions |
|
---|---|
otJoinerGetId(otInstance *aInstance, otExtAddress *aJoinerId)
|
void
Get the Joiner ID.
|
otJoinerGetState(otInstance *aInstance)
|
This function returns the Joiner State.
|
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)
|
This function enables the Thread Joiner role.
|
otJoinerStop(otInstance *aInstance)
|
void
This function disables the Thread Joiner role.
|
Enumerations
otJoinerState
otJoinerState
This enumeration defines the Joiner State.
Typedefs
otJoinerCallback
void(* otJoinerCallback)(otError aError, void *aContext)
This function pointer is called to notify the completion of a join operation.
Details | |||||
---|---|---|---|---|---|
Parameters |
|
Functions
otJoinerGetId
void otJoinerGetId( otInstance *aInstance, otExtAddress *aJoinerId )
Get the Joiner ID.
Joiner ID is the first 64 bits of the result of computing SHA-256 over factory-assigned IEEE EUI-64, which is used as IEEE 802.15.4 Extended Address during commissioning process.
Details | |||||
---|---|---|---|---|---|
Parameters |
|
otJoinerGetState
otJoinerState otJoinerGetState( otInstance *aInstance )
This function returns the Joiner State.
Details | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parameters |
|
||||||||||||
Return Values |
|
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 )
This function enables the Thread Joiner role.
Details | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parameters |
|
||||||||||||||||||
Return Values |
|
otJoinerStop
void otJoinerStop( otInstance *aInstance )
This function disables the Thread Joiner role.
Details | |||
---|---|---|---|
Parameters |
|