結合

このモジュールには、Thread Joiner ロール用の関数が含まれています。

概要

列挙型
otJoinerState enum
Joiner 状態を定義します。

Typedef
otJoinerCallback)(otError aError, void *aContext) typedef
void(*
結合オペレーションの完了を通知するポインタが呼び出されます。
otJoinerDiscerner typedef
ジョイナー判別者を表します。
otJoinerState typedef
Joiner 状態を定義します。

関数
otJoinerGetDiscerner(otInstance *aInstance)
Joiner Discerner を取得します。
otJoinerGetId(otInstance *aInstance)
const otExtAddress *
Joiner ID を取得します。
otJoinerGetState(otInstance *aInstance)
Joiner の状態を取得します。
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)
Thread Joiner のロールを有効にします。
otJoinerStateToString(otJoinerState aState)
const char *
指定された結合状態の列挙値を、人が読める文字列に変換します。
otJoinerStop(otInstance *aInstance)
void
Thread Joiner のロールを無効にします。

構造体
otJoinerDiscerner

ジョイナー判別者を表します。

列挙型

otJoinerState

 otJoinerState

Joiner 状態を定義します。

Typedef

otJoinerCallback

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

結合オペレーションの完了を通知するポインタが呼び出されます。

詳細
パラメータ
[in] aError
結合プロセスが成功した場合は OT_ERROR_NONE。OT_ERROR_SECURITY: セキュリティ認証情報が原因で結合プロセスが失敗した場合。接続可能なネットワークが検出されなかった場合は、OT_ERROR_NOT_FOUND。OT_ERROR_RESPONSE_TIMEOUT（レスポンスがタイムアウトした場合）。
[in] aContext
アプリケーション固有のコンテキストへのポインタ。

otJoinerDiscerner

struct otJoinerDiscerner otJoinerDiscerner

ジョイナー判別者を表します。

otJoinerState

enum otJoinerState otJoinerState

Joiner 状態を定義します。

関数

otJoinerGetDiscerner

const otJoinerDiscerner * otJoinerGetDiscerner(
  otInstance *aInstance
)

Joiner Discerner を取得します。

詳細については、otJoinerSetDiscerner をご覧ください。

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
戻り値
Joiner Discerner へのポインタ。設定されていない場合は NULL。

otJoinerGetId

const otExtAddress * otJoinerGetId(
  otInstance *aInstance
)

Joiner ID を取得します。

Joiner ID が設定されていない場合、Joiner ID は、工場出荷時に割り当てられた IEEE EUI-64 に基づいて SHA-256 を計算した結果の最初の 64 ビットになります。それ以外の場合、Joiner ID は Joiner Discerner 値から計算されます。

Joiner ID は、コミッショニング プロセス中にデバイスの IEEE 802.15.4 拡張アドレスとしても使用されます。

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
戻り値
Joiner ID へのポインタ。

otJoinerGetState

otJoinerState otJoinerGetState(
  otInstance *aInstance
)

Joiner の状態を取得します。

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
戻り値
結合の状態。

otJoinerSetDiscerner

otError otJoinerSetDiscerner(
  otInstance *aInstance,
  otJoinerDiscerner *aDiscerner
)

Joiner Discerner を設定します。

Joiner Discerner は、Thread のコミッショニング プロセス中に Joiner ID を計算するために使用されます。詳しくは、otJoinerGetId をご覧ください。

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
[in] aDiscerner
Joiner Discerner へのポインタ。NULL の場合、以前に設定された識別はすべてクリアされます。
戻り値
OT_ERROR_NONE
Joiner Discerner が正常に更新されました。
OT_ERROR_INVALID_ARGS
aDiscerner は無効です（指定された長さが有効な範囲内にありません）。
OT_ERROR_INVALID_STATE
進行中の参加プロセスがあるため、Joiner Discerner を変更できませんでした。

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
)

Thread Joiner のロールを有効にします。

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
[in] aPskd
PSKd へのポインタ。
[in] aProvisioningUrl
プロビジョニング URL へのポインタ（NULL でもかまいません）。
[in] aVendorName
ベンダー名へのポインタ（NULL でもかまいません）。
[in] aVendorModel
ベンダーモデルへのポインタ（NULL でもかまいません）。
[in] aVendorSwVersion
ベンダー ソフトウェア バージョンへのポインタ（NULL でもかまいません）。
[in] aVendorData
ベンダーデータへのポインタ（NULL でもかまいません）。
[in] aCallback
結合オペレーションの完了時に呼び出される関数へのポインタ。
[in] aContext
アプリケーション固有のコンテキストへのポインタ。
戻り値
OT_ERROR_NONE
結合者ロールを開始しました。
OT_ERROR_BUSY
前回の試行はまだ進行中です。
OT_ERROR_INVALID_ARGS
aPskd または aProvisioningUrl が無効です。
OT_ERROR_INVALID_STATE
IPv6 スタックが有効になっていないか、スレッド スタックが完全に有効になっています。

otJoinerStateToString

const char * otJoinerStateToString(
  otJoinerState aState
)

指定された結合状態の列挙値を、人が読める文字列に変換します。

詳細
パラメータ
[in] aState
結合の状態。
戻り値
人が読める形式の aState の文字列表現。

otJoinerStop

void otJoinerStop(
  otInstance *aInstance
)

Thread Joiner のロールを無効にします。

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。

マクロ

OT_JOINER_MAX_DISCERNER_LENGTH

 OT_JOINER_MAX_DISCERNER_LENGTH 64

Joiner Discerner の最大長（ビット単位）。

関連情報

OpenThread API リファレンスのトピックは、GitHub で入手できるソースコードに由来しています。 詳細について、またはドキュメントへの投稿については、リソースをご覧ください。