建具屋
このモジュールには、Thread Joiner のロールに対応する関数が含まれています。
概要
列挙型 |
|
---|---|
otJoinerState
|
列挙型 この列挙型は、Joiner 状態を定義します。 |
Typedef |
|
---|---|
otJoinerCallback)(otError aError, void *aContext)
|
typedefvoid(*
この関数ポインタは、結合オペレーションの完了を通知するために呼び出されます。 |
otJoinerDiscerner
|
typedefstruct otJoinerDiscerner
この構造は Joiner Discerner を表します。 |
otJoinerState
|
typedefenum otJoinerState
この列挙型は、Joiner 状態を定義します。 |
関数 |
|
---|---|
otJoinerGetDiscerner(otInstance *aInstance)
|
const otJoinerDiscerner *
この関数は Joiner Discerner を取得します。
|
otJoinerGetId(otInstance *aInstance)
|
const otExtAddress *
この関数は Joiner ID を取得します。
|
otJoinerGetState(otInstance *aInstance)
|
この関数は Joiner State を返します。
|
otJoinerSetDiscerner(otInstance *aInstance, otJoinerDiscerner *aDiscerner)
|
この関数は 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)
|
この関数は、スレッド結合者ロールを有効にします。
|
otJoinerStateToString(otJoinerState aState)
|
const char *
この関数は、与えられた結合子の状態の列挙値を人が読める文字列に変換します。
|
otJoinerStop(otInstance *aInstance)
|
void
この関数は、Thread Joiner のロールを無効にします。
|
構造体 |
|
---|---|
otJoinerDiscerner |
この構造は Joiner Discerner を表します。 |
列挙型
otJoinerState
otJoinerState
この列挙型は、Joiner 状態を定義します。
Typedef
otJoinerCallback
void(* otJoinerCallback)(otError aError, void *aContext)
この関数ポインタは、結合オペレーションの完了を通知するために呼び出されます。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
関数
otJoinerGetDiscerner(英語)
const otJoinerDiscerner * otJoinerGetDiscerner( otInstance *aInstance )
この関数は Joiner Discerner を取得します。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
Joiner Discerner へのポインタ。何も設定されていない場合は NULL。
|
otJoinerGetId
const otExtAddress * otJoinerGetId( otInstance *aInstance )
この関数は Joiner ID を取得します。
Joiner Discerner が設定されていない場合、工場割り当ての IEEE EUI-64 で SHA-256 を計算した結果の最初の 64 ビットが、結合元 ID です。それ以外の場合、Joiner ID は Joiner Discerner の値から計算されます。
Joiner ID は、試運転時にデバイスの IEEE 802.15.4 の Extended Address としても使用されます。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
Joiner ID へのポインタ。
|
otJoinerGetState(英語)
otJoinerState otJoinerGetState( otInstance *aInstance )
この関数は Joiner State を返します。
詳細 | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
パラメータ |
|
||||||||||||
戻り値 |
|
otJoinerSetDiscerner(英語)
otError otJoinerSetDiscerner( otInstance *aInstance, otJoinerDiscerner *aDiscerner )
この関数は Joiner Discerner を設定します。
Joiner Discerner を使用して、試運転や参加のプロセスで使用する Joiner ID を計算します。
デフォルト(ディストリビュータが提供されない場合や NULL に設定されている場合)では、ジョイナ ID は、工場に割り当てられた IEEE EUI-64 で SHA-256 を計算した結果の最初の 64 ビットとして導出されます。これは、スレッド仕様で想定される主な動作です。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメータ |
|
||||||
戻り値 |
|
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 )
この関数は、スレッド結合者ロールを有効にします。
詳細 | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
パラメータ |
|
||||||||||||||||||
戻り値 |
|
otJoinerStateToString(結合状態)
const char * otJoinerStateToString( otJoinerState aState )
この関数は、与えられた結合子の状態の列挙値を人が読める文字列に変換します。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
人が読める形式の
aState の文字列表現。 |
otJoinerStop
void otJoinerStop( otInstance *aInstance )
この関数は、Thread Joiner のロールを無効にします。
詳細 | |||
---|---|---|---|
パラメータ |
|
マクロ
OT_JOINER_MAX_DISCERNER_LENGTH(OT_JOINER_MAX_DISCERNER_LENGTH)
OT_JOINER_MAX_DISCERNER_LENGTH 64
Joiner Discerner の最大長(ビット単位)。
リソース
OpenThread API リファレンスのトピックは、GitHub で入手可能なソースコードに基づいています。 詳細またはドキュメントへの投稿については、リソースをご覧ください。