ルーター/リーダー
このモジュールには、Thread Router と Thread リーダーの関数が含まれています。
概要
列挙型 |
|
---|---|
otCacheEntryState
|
enum EID キャッシュ エントリの状態を定義します。 |
otNeighborTableEvent{
|
enum 隣接テーブルの変更を示すために otNeighborTableCallback で使用される定数を定義します。 |
otPowerSupply{
|
enum デバイスの電源プロパティを表します。 |
Typedef |
|
---|---|
otCacheEntryInfo
|
typedefstruct otCacheEntryInfo
EID キャッシュ エントリを表します。 |
otCacheEntryIterator
|
typedefstruct otCacheEntryIterator
EID キャッシュ テーブルのエントリを反復処理するために使用されるイテレータを表します。 |
otCacheEntryState
|
typedefenum otCacheEntryState
EID キャッシュ エントリの状態を定義します。 |
otChildIp6AddressIterator
|
typedefuint16_t
Thread の子エントリの IPv6 アドレスを反復処理するために使用されます。 |
otDeviceProperties
|
typedefstruct otDeviceProperties
デバイスのローカル リーダー ウェイトを計算するために使用されるデバイス プロパティを表します。 |
otNeighborTableCallback)(otNeighborTableEvent aEvent, const otNeighborTableEntryInfo *aEntryInfo)
|
typedefvoid(*
隣接テーブルに変更があったことを通知するためにポインタが呼び出されます。 |
関数 |
|
---|---|
otThreadBecomeLeader(otInstance *aInstance)
|
リーダーになって新しいパーティションを開始します。
|
otThreadBecomeRouter(otInstance *aInstance)
|
ルーターに設定してみます。
|
otThreadGetAdvertisementTrickleIntervalMax(otInstance *aInstance)
|
uint32_t
アドバタイズメント トリクル タイマーで使用される現在の間隔最大値を取得します。
|
otThreadGetChildInfoById(otInstance *aInstance, uint16_t aChildId, otChildInfo *aChildInfo)
|
子 ID または RLOC16 で、添付された子の診断情報を取得します。
|
otThreadGetChildInfoByIndex(otInstance *aInstance, uint16_t aChildIndex, otChildInfo *aChildInfo)
|
この関数は、アタッチされた子の診断情報を内部テーブル インデックスによって保持します。
|
otThreadGetChildNextIp6Address(otInstance *aInstance, uint16_t aChildIndex, otChildIp6AddressIterator *aIterator, otIp6Address *aAddress)
|
指定された子の次の IPv6 アドレスを(イテレータを使用して)取得します。
|
otThreadGetChildRouterLinks(otInstance *aInstance)
|
uint8_t
REED ロールで使用される MLE_CHILD_ROUTER_LINKS パラメータを取得します。
|
otThreadGetContextIdReuseDelay(otInstance *aInstance)
|
uint32_t
リーダーのロールで使用される CONTEXT_ID_REUSE_DELAY パラメータを取得します。
|
otThreadGetDeviceProperties(otInstance *aInstance)
|
const otDeviceProperties *
現在のデバイスのプロパティを取得します。
|
otThreadGetJoinerUdpPort(otInstance *aInstance)
|
uint16_t
Joiner UDP ポートを取得します。
|
otThreadGetLocalLeaderWeight(otInstance *aInstance)
|
uint8_t
リーダー ロールで操作しているときに使用される Thread リーダーの重みを取得します。
|
otThreadGetMaxAllowedChildren(otInstance *aInstance)
|
uint16_t
現在許可されている子の最大数を取得します。
|
otThreadGetMaxChildIpAddresses(otInstance *aInstance)
|
uint8_t
それぞれの MTD の子がこのデバイスに親として登録できる IP アドレスの最大数を取得します。
|
otThreadGetMaxRouterId(otInstance *aInstance)
|
uint8_t
この関数は、使用可能な最大ルーター ID を返します。
|
otThreadGetNetworkIdTimeout(otInstance *aInstance)
|
uint8_t
NETWORK_ID_TIMEOUT パラメータを取得します。 |
otThreadGetNextCacheEntry(otInstance *aInstance, otCacheEntryInfo *aEntryInfo, otCacheEntryIterator *aIterator)
|
次の EID キャッシュ エントリを(イテレータを使用して)取得します。
|
otThreadGetNextHopAndPathCost(otInstance *aInstance, uint16_t aDestRloc16, uint16_t *aNextHopRloc16, uint8_t *aPathCost)
|
void
指定された RLOC16 宛先へのネクストホップとパスのコストを取得します。
|
otThreadGetParentPriority(otInstance *aInstance)
|
int8_t
割り当てられた親の優先度を取得します。
|
otThreadGetPreferredLeaderPartitionId(otInstance *aInstance)
|
uint32_t
リーダーのロールで操作する際に使用される、優先される Thread リーダー パーティション ID を取得します。
|
otThreadGetPskc(otInstance *aInstance, otPskc *aPskc)
|
void
Thread PSKc を取得します。
|
otThreadGetPskcRef(otInstance *aInstance)
|
保存されたスレッド PSKc へのキー参照を取得。
|
otThreadGetRouterDowngradeThreshold(otInstance *aInstance)
|
uint8_t
Router ロールで使用される ROUTER_DOWNGRADE_THRESHOLD パラメータを取得します。
|
otThreadGetRouterIdRange(otInstance *aInstance, uint8_t *aMinRouterId, uint8_t *aMaxRouterId)
|
void
スレッド ネットワーク内のノードに割り当てることができるルーター ID の範囲を取得します。
|
otThreadGetRouterIdSequence(otInstance *aInstance)
|
uint8_t
現在の Router ID シーケンスを取得します。
|
otThreadGetRouterInfo(otInstance *aInstance, uint16_t aRouterId, otRouterInfo *aRouterInfo)
|
この関数は、特定の Thread Router の診断情報を保持します。
|
otThreadGetRouterSelectionJitter(otInstance *aInstance)
|
uint8_t
REED/ルーターのロールで使用される ROUTER_SELECTION_JITTER パラメータを取得します。
|
otThreadGetRouterUpgradeThreshold(otInstance *aInstance)
|
uint8_t
REED ロールで使用される ROUTER_UPGRADE_THRESHOLD パラメータを取得します。
|
otThreadIsRouterEligible(otInstance *aInstance)
|
bool
デバイスがルーターに対応しているかどうかを示します。
|
otThreadIsRouterIdAllocated(otInstance *aInstance, uint8_t aRouterId)
|
bool
Router ID が現在割り当てられているかどうかを示します。
|
otThreadRegisterNeighborTableCallback(otInstance *aInstance, otNeighborTableCallback aCallback)
|
void
近傍テーブルのコールバック関数を登録します。
|
otThreadReleaseRouterId(otInstance *aInstance, uint8_t aRouterId)
|
リーダーロールのデバイスによって割り当てられたルーター ID を解放します。
|
otThreadSetCcmEnabled(otInstance *aInstance, bool aEnabled)
|
void
デバイスが CCM を使用してコミッショニングされたかどうかを設定します。
|
otThreadSetChildRouterLinks(otInstance *aInstance, uint8_t aChildRouterLinks)
|
REED ロールで使用される MLE_CHILD_ROUTER_LINKS パラメータを設定します。
|
otThreadSetContextIdReuseDelay(otInstance *aInstance, uint32_t aDelay)
|
void
リーダーのロールで使用される CONTEXT_ID_REUSE_DELAY パラメータを設定します。
|
otThreadSetDeviceProperties(otInstance *aInstance, const otDeviceProperties *aDeviceProperties)
|
void
リーダー ウェイトの特定と設定に使用されるデバイスのプロパティを設定します。
|
otThreadSetJoinerUdpPort(otInstance *aInstance, uint16_t aJoinerUdpPort)
|
Joiner UDP ポートを設定します。
|
otThreadSetLocalLeaderWeight(otInstance *aInstance, uint8_t aWeight)
|
void
リーダー ロールで操作しているときに使用される Thread リーダーの重みを設定します。
|
otThreadSetMaxAllowedChildren(otInstance *aInstance, uint16_t aMaxChildren)
|
現在許可されている子の最大数を設定します。
|
otThreadSetMaxChildIpAddresses(otInstance *aInstance, uint8_t aMaxIpAddresses)
|
それぞれの MTD の子が親としてこのデバイスに登録できる IP アドレスの最大数を設定または復元します。
|
otThreadSetNetworkIdTimeout(otInstance *aInstance, uint8_t aTimeout)
|
void
NETWORK_ID_TIMEOUT パラメータを設定します。 |
otThreadSetParentPriority(otInstance *aInstance, int8_t aParentPriority)
|
親の優先度を設定します。
|
otThreadSetPreferredLeaderPartitionId(otInstance *aInstance, uint32_t aPartitionId)
|
void
リーダーロールで操作するときに使用する優先 Thread リーダー パーティション ID を設定します。
|
otThreadSetPreferredRouterId(otInstance *aInstance, uint8_t aRouterId)
|
優先ルーター ID を設定します。
|
otThreadSetPskc(otInstance *aInstance, const otPskc *aPskc)
|
スレッド PSKc を設定します。
|
otThreadSetPskcRef(otInstance *aInstance, otPskcRef aKeyRef)
|
Key Reference を Thread PSKc に設定します。
|
otThreadSetRouterDowngradeThreshold(otInstance *aInstance, uint8_t aThreshold)
|
void
リーダー ロールで使用される ROUTER_DOWNGRADE_THRESHOLD パラメータを設定します。
|
otThreadSetRouterEligible(otInstance *aInstance, bool aEligible)
|
デバイスがルーター対応かどうかを設定します。
|
otThreadSetRouterIdRange(otInstance *aInstance, uint8_t aMinRouterId, uint8_t aMaxRouterId)
|
スレッド ネットワーク内のノードに割り当てることができるルーター ID の範囲を設定します。
|
otThreadSetRouterSelectionJitter(otInstance *aInstance, uint8_t aRouterJitter)
|
void
REED/ルーターのロールで使用される ROUTER_SELECTION_JITTER パラメータを設定します。
|
otThreadSetRouterUpgradeThreshold(otInstance *aInstance, uint8_t aThreshold)
|
void
リーダーのロールで使用される ROUTER_UPGRADE_THRESHOLD パラメータを設定します。
|
otThreadSetSteeringData(otInstance *aInstance, const otExtAddress *aExtAddress)
|
void
ステアリング データを帯域外に設定する。
|
otThreadSetThreadVersionCheckEnabled(otInstance *aInstance, bool aEnabled)
|
void
ルーティング(VR フィールド)のセキュリティ ポリシー TLV バージョンしきい値を有効にするかどうかを設定します。
|
構造体 |
|
---|---|
otCacheEntryInfo |
EID キャッシュ エントリを表します。 |
otCacheEntryIterator |
EID キャッシュ テーブルのエントリを反復処理するために使用されるイテレータを表します。 |
otChildInfo |
Thread 子の診断情報を保持します。 |
otDeviceProperties |
デバイスのローカル リーダー ウェイトを計算するために使用されるデバイス プロパティを表します。 |
otNeighborTableEntryInfo |
近傍テーブルのエントリ情報(子またはルーター)を表し、近傍テーブルのコールバック |
列挙型
otCacheEntryState
otCacheEntryState
EID キャッシュ エントリの状態を定義します。
otNeighborTableEvent
otNeighborTableEvent
隣接テーブルの変更を示すために otNeighborTableCallback
で使用される定数を定義します。
プロパティ | |
---|---|
OT_NEIGHBOR_TABLE_EVENT_CHILD_ADDED
|
お子様を追加しています。 |
OT_NEIGHBOR_TABLE_EVENT_CHILD_MODE_CHANGED
|
既存のお子様のモードが変更された。 |
OT_NEIGHBOR_TABLE_EVENT_CHILD_REMOVED
|
お子様を削除しています。 |
OT_NEIGHBOR_TABLE_EVENT_ROUTER_ADDED
|
ルーターを追加しています。 |
OT_NEIGHBOR_TABLE_EVENT_ROUTER_REMOVED
|
ルーターを削除しています。 |
otPowerSupply
otPowerSupply
デバイスの電源プロパティを表します。
これは、リーダーのウェイトを計算するために otDeviceProperties
のプロパティとして使用されます。
プロパティ | |
---|---|
OT_POWER_SUPPLY_BATTERY
|
バッテリー給電。 |
OT_POWER_SUPPLY_EXTERNAL
|
外部電源(電源から供給)。 |
OT_POWER_SUPPLY_EXTERNAL_STABLE
|
バッテリー バックアップまたは UPS で安定した外部電源。 |
OT_POWER_SUPPLY_EXTERNAL_UNSTABLE
|
外部電源が不安定である可能性がある(スイッチで給電される電球など)。 |
Typedef
otCacheEntryIterator
struct otCacheEntryIterator otCacheEntryIterator
EID キャッシュ テーブルのエントリを反復処理するために使用されるイテレータを表します。
このイテレータを初期化し、キャッシュ テーブルの最初のエントリから開始するには、構造体内のすべてのフィールドをゼロに設定します(例:memset
でイテレータをゼロにする)。
otChildIp6AddressIterator
uint16_t otChildIp6AddressIterator
Thread の子エントリの IPv6 アドレスを反復処理するために使用されます。
otDeviceProperties
struct otDeviceProperties otDeviceProperties
デバイスのローカル リーダー ウェイトを計算するために使用されるデバイス プロパティを表します。
パラメータは、デバイスの機能(ボーダー ルーターとして機能するかどうか、電源構成など)に基づいて設定されます。
mIsUnstable
はデバイスの動作の安定性を示します。ベンダー固有のメカニズムによって決定されます。これには、次のようなケースが該当します。
- 外部電源が通常より頻繁に失われていることをデバイスが内部で検出しています。通常の処理はベンダーが決定します。
- デバイスが通常よりも頻繁に再起動していることを内部で検出しました。通常の処理はベンダーが決定します。
otNeighborTableCallback
void(* otNeighborTableCallback)(otNeighborTableEvent aEvent, const otNeighborTableEntryInfo *aEntryInfo)
隣接テーブルに変更があったことを通知するためにポインタが呼び出されます。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
関数
otThreadBecomeLeader
otError otThreadBecomeLeader(
otInstance *aInstance
)
リーダーになって新しいパーティションを開始します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
otThreadBecomeRouter
otError otThreadBecomeRouter(
otInstance *aInstance
)
ルーターに設定してみます。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
otThreadGetAdvertisementTrickleIntervalMax
uint32_t otThreadGetAdvertisementTrickleIntervalMax(
otInstance *aInstance
)
アドバタイズメント トリクル タイマーで使用される現在の間隔最大値を取得します。
この API には OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE
が必要です。これはテスト専用です。
詳細 | |
---|---|
戻り値 |
アドバタイズメント トリクル タイマーのインターバルの最大値(ミリ秒単位)。
|
otThreadGetChildInfoById
otError otThreadGetChildInfoById(
otInstance *aInstance,
uint16_t aChildId,
otChildInfo *aChildInfo
)
子 ID または RLOC16 で、添付された子の診断情報を取得します。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメータ |
|
||||||
戻り値 |
|
otThreadGetChildInfoByIndex
otError otThreadGetChildInfoByIndex(
otInstance *aInstance,
uint16_t aChildIndex,
otChildInfo *aChildInfo
)
この関数は、アタッチされた子の診断情報を内部テーブル インデックスによって保持します。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメータ |
|
||||||
戻り値 |
|
otGetMaxAllowedChildren
otThreadGetChildNextIp6Address
otError otThreadGetChildNextIp6Address(
otInstance *aInstance,
uint16_t aChildIndex,
otChildIp6AddressIterator *aIterator,
otIp6Address *aAddress
)
指定された子の次の IPv6 アドレスを(イテレータを使用して)取得します。
詳細 | |||||||||
---|---|---|---|---|---|---|---|---|---|
パラメータ |
|
||||||||
戻り値 |
|
otThreadGetChildInfoByIndex
otThreadGetChildRouterLinks
uint8_t otThreadGetChildRouterLinks(
otInstance *aInstance
)
REED ロールで使用される MLE_CHILD_ROUTER_LINKS パラメータを取得します。
このパラメータでは、デバイス(FED として)がリンクの確立を試みる近隣ルーターの最大数を指定します。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
MLE_CHILD_ROUTER_LINKS 値。
|
otThreadSetChildRouterLinks
otThreadGetContextIdReuseDelay
uint32_t otThreadGetContextIdReuseDelay(
otInstance *aInstance
)
リーダーのロールで使用される CONTEXT_ID_REUSE_DELAY パラメータを取得します。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
CONTEXT_ID_REUSE_DELAY 値。
|
otThreadSetContextIdReuseDelay
otThreadGetDeviceProperties
const otDeviceProperties * otThreadGetDeviceProperties(
otInstance *aInstance
)
現在のデバイスのプロパティを取得します。
OPENTHREAD_CONFIG_MLE_DEVICE_PROPERTY_LEADER_WEIGHT_ENABLE
が必要です。
詳細 | |
---|---|
戻り値 |
デバイスのプロパティ
otDeviceProperties 。 |
otThreadGetJoinerUdpPort
uint16_t otThreadGetJoinerUdpPort(
otInstance *aInstance
)
Joiner UDP ポートを取得します。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
Joiner UDP ポート番号。
|
otThreadSetJoinerUdpPort
otThreadGetLocalLeaderWeight
uint8_t otThreadGetLocalLeaderWeight(
otInstance *aInstance
)
リーダー ロールで操作しているときに使用される Thread リーダーの重みを取得します。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
スレッド リーダーの重量の値。
|
otThreadSetLeaderWeight
otThreadSetDeviceProperties
otThreadGetMaxAllowedChildren
uint16_t otThreadGetMaxAllowedChildren(
otInstance *aInstance
)
現在許可されている子の最大数を取得します。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
現在許可されている子の最大数。
|
otThreadSetMaxAllowedChildren
otThreadGetMaxChildIpAddresses
uint8_t otThreadGetMaxChildIpAddresses(
otInstance *aInstance
)
それぞれの MTD の子がこのデバイスに親として登録できる IP アドレスの最大数を取得します。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
各 MTD の子がこのデバイスに親として登録できる IP アドレスの最大数。
|
otThreadSetMaxChildIpAddresses
otThreadGetMaxRouterId
uint8_t otThreadGetMaxRouterId(
otInstance *aInstance
)
この関数は、使用可能な最大ルーター ID を返します。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
最大許容ルーター ID。
|
otThreadGetNetworkIdTimeout
uint8_t otThreadGetNetworkIdTimeout(
otInstance *aInstance
)
NETWORK_ID_TIMEOUT
パラメータを取得します。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
NETWORK_ID_TIMEOUT 値。 |
otThreadSetNetworkIdTimeout
otThreadGetNextCacheEntry
otError otThreadGetNextCacheEntry(
otInstance *aInstance,
otCacheEntryInfo *aEntryInfo,
otCacheEntryIterator *aIterator
)
次の EID キャッシュ エントリを(イテレータを使用して)取得します。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメータ |
|
||||||
戻り値 |
|
otThreadGetNextHopAndPathCost
void otThreadGetNextHopAndPathCost(
otInstance *aInstance,
uint16_t aDestRloc16,
uint16_t *aNextHopRloc16,
uint8_t *aPathCost
)
指定された RLOC16 宛先へのネクストホップとパスのコストを取得します。
aNextHopRloc16
または aPathCost
が NULL の場合に使用でき、呼び出し元が値の取得を望まないことを示します。
詳細 | |||||||||
---|---|---|---|---|---|---|---|---|---|
パラメータ |
|
otThreadGetParentPriority
int8_t otThreadGetParentPriority(
otInstance *aInstance
)
割り当てられた親の優先度を取得します。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
割り当てられた親優先度の値。-2 は割り当てられていないことを意味します。
|
otThreadSetParentPriority
otThreadGetPreferredLeaderPartitionId
uint32_t otThreadGetPreferredLeaderPartitionId(
otInstance *aInstance
)
リーダーのロールで操作する際に使用される、優先される Thread リーダー パーティション ID を取得します。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
スレッド リーダー パーティション ID の値。
|
otThreadGetPskc
void otThreadGetPskc(
otInstance *aInstance,
otPskc *aPskc
)
Thread PSKc を取得します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
otThreadSetPskc
otThreadGetPskcRef
otPskcRef otThreadGetPskcRef(
otInstance *aInstance
)
保存されたスレッド PSKc へのキー参照を取得。
ビルド時の機能 OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE
を有効にする必要があります。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
PSKc への主な参照先
|
otThreadSetPskcRef
otThreadGetRouterDowngradeThreshold
uint8_t otThreadGetRouterDowngradeThreshold(
otInstance *aInstance
)
Router ロールで使用される ROUTER_DOWNGRADE_THRESHOLD パラメータを取得します。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
ROUTER_DOWNGRADE_THRESHOLD 値。
|
otThreadSetRouterDowngradeThreshold
otThreadGetRouterIdRange
void otThreadGetRouterIdRange(
otInstance *aInstance,
uint8_t *aMinRouterId,
uint8_t *aMaxRouterId
)
スレッド ネットワーク内のノードに割り当てることができるルーター ID の範囲を取得します。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメータ |
|
otThreadSetRouterIdRange
otThreadGetRouterIdSequence
uint8_t otThreadGetRouterIdSequence(
otInstance *aInstance
)
現在の Router ID シーケンスを取得します。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
ルーター ID シーケンス。
|
otThreadGetRouterInfo
otError otThreadGetRouterInfo(
otInstance *aInstance,
uint16_t aRouterId,
otRouterInfo *aRouterInfo
)
この関数は、特定の Thread Router の診断情報を保持します。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメータ |
|
||||||
戻り値 |
|
otThreadGetRouterSelectionJitter
uint8_t otThreadGetRouterSelectionJitter(
otInstance *aInstance
)
REED/ルーターのロールで使用される ROUTER_SELECTION_JITTER パラメータを取得します。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
ROUTER_SELECTION_JITTER 値。
|
otThreadSetRouterSelectionJitter
otThreadGetRouterUpgradeThreshold
uint8_t otThreadGetRouterUpgradeThreshold(
otInstance *aInstance
)
REED ロールで使用される ROUTER_UPGRADE_THRESHOLD パラメータを取得します。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
ROUTER_UPGRADE_THRESHOLD 値。
|
otThreadSetRouterUpgradeThreshold
otThreadIsRouterEligible
bool otThreadIsRouterEligible(
otInstance *aInstance
)
デバイスがルーターに対応しているかどうかを示します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
otThreadIsRouterIdAllocated
bool otThreadIsRouterIdAllocated(
otInstance *aInstance,
uint8_t aRouterId
)
Router ID が現在割り当てられているかどうかを示します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
otThreadRegisterNeighborTableCallback
void otThreadRegisterNeighborTableCallback(
otInstance *aInstance,
otNeighborTableCallback aCallback
)
近傍テーブルのコールバック関数を登録します。
指定されたコールバック(NULL でない場合)は、ネイバー テーブルが変更された場合(たとえば、子またはルーター ネイバーのエントリが追加または削除されたとき、または既存の子のモードが変更されたとき)に呼び出されます。
その後このメソッドを呼び出すと、以前のコールバックが上書きされます。このコールバックは、近傍/子テーブルの更新中に、常に otStateChangedCallback
の前に呼び出されます。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
otThreadReleaseRouterId
otError otThreadReleaseRouterId(
otInstance *aInstance,
uint8_t aRouterId
)
リーダーロールのデバイスによって割り当てられたルーター ID を解放します。
詳細 | |||||||||
---|---|---|---|---|---|---|---|---|---|
パラメータ |
|
||||||||
戻り値 |
|
otThreadSetCcmEnabled
void otThreadSetCcmEnabled(
otInstance *aInstance,
bool aEnabled
)
デバイスが CCM を使用してコミッショニングされたかどうかを設定します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
otThreadSetChildRouterLinks
otError otThreadSetChildRouterLinks(
otInstance *aInstance,
uint8_t aChildRouterLinks
)
REED ロールで使用される MLE_CHILD_ROUTER_LINKS パラメータを設定します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
otThreadGetChildRouterLinks
otThreadSetContextIdReuseDelay
void otThreadSetContextIdReuseDelay(
otInstance *aInstance,
uint32_t aDelay
)
リーダーのロールで使用される CONTEXT_ID_REUSE_DELAY パラメータを設定します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
otThreadGetContextIdReuseDelay
otThreadSetDeviceProperties
void otThreadSetDeviceProperties(
otInstance *aInstance,
const otDeviceProperties *aDeviceProperties
)
リーダー ウェイトの特定と設定に使用されるデバイスのプロパティを設定します。
OPENTHREAD_CONFIG_MLE_DEVICE_PROPERTY_LEADER_WEIGHT_ENABLE
が必要です。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
otThreadSetJoinerUdpPort
otError otThreadSetJoinerUdpPort(
otInstance *aInstance,
uint16_t aJoinerUdpPort
)
Joiner UDP ポートを設定します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
otThreadGetJoinerUdpPort
otThreadSetLocalLeaderWeight
void otThreadSetLocalLeaderWeight(
otInstance *aInstance,
uint8_t aWeight
)
リーダー ロールで操作しているときに使用される Thread リーダーの重みを設定します。
リーダー ウェイトを新しい値に直接設定し、以前の値(現在の otDeviceProperties
から決定されている場合があります)と置き換えます。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
otThreadGetLeaderWeight
otThreadSetMaxAllowedChildren
otError otThreadSetMaxAllowedChildren(
otInstance *aInstance,
uint16_t aMaxChildren
)
現在許可されている子の最大数を設定します。
このパラメータは、スレッド プロトコル オペレーションが停止している場合にのみ設定できます。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメータ |
|
||||||
戻り値 |
|
otThreadGetMaxAllowedChildren
otThreadSetMaxChildIpAddresses
otError otThreadSetMaxChildIpAddresses(
otInstance *aInstance,
uint8_t aMaxIpAddresses
)
それぞれの MTD の子が親としてこのデバイスに登録できる IP アドレスの最大数を設定または復元します。
0
を渡して、設定を消去してデフォルトに戻します。
OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE
が有効な場合に利用可能です。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
otThreadGetMaxChildIpAddresses
otThreadSetNetworkIdTimeout
void otThreadSetNetworkIdTimeout(
otInstance *aInstance,
uint8_t aTimeout
)
NETWORK_ID_TIMEOUT
パラメータを設定します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
otThreadGetNetworkIdTimeout
otThreadSetParentPriority
otError otThreadSetParentPriority(
otInstance *aInstance,
int8_t aParentPriority
)
親の優先度を設定します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
otThreadGetParentPriority
otThreadSetPreferredLeaderPartitionId
void otThreadSetPreferredLeaderPartitionId(
otInstance *aInstance,
uint32_t aPartitionId
)
リーダーロールで操作するときに使用する優先 Thread リーダー パーティション ID を設定します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
otThreadSetPreferredRouterId
otError otThreadSetPreferredRouterId(
otInstance *aInstance,
uint8_t aRouterId
)
優先ルーター ID を設定します。
ルーター/リーダーになると、ノードはこのルーター ID を使用しようとします。優先ルーター ID が設定されていない場合、または使用できない場合は、ランダムに生成されたルーター ID が選択されます。このプロパティは、デバイスの役割が関連付けられていないか無効になっている場合にのみ設定できます。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
otThreadSetPskc
otError otThreadSetPskc(
otInstance *aInstance,
const otPskc *aPskc
)
スレッド PSKc を設定します。
Thread プロトコルが無効になっている場合にのみ成功します。この関数の呼び出しが成功すると、不揮発性メモリ内のアクティブ データセットと保留中のオペレーション データセットも無効になります。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
otThreadGetPskc
otThreadSetPskcRef
otError otThreadSetPskcRef(
otInstance *aInstance,
otPskcRef aKeyRef
)
Key Reference を Thread PSKc に設定します。
ビルド時の機能 OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE
を有効にする必要があります。
Thread プロトコルが無効になっている場合にのみ成功します。成功すると、不揮発性メモリ内のアクティブな運用データセットと保留中の運用データセットも無効になります。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
otThreadGetPskcRef
otThreadSetRouterDowngradeThreshold
void otThreadSetRouterDowngradeThreshold(
otInstance *aInstance,
uint8_t aThreshold
)
リーダー ロールで使用される ROUTER_DOWNGRADE_THRESHOLD パラメータを設定します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
otThreadGetRouterDowngradeThreshold
otThreadSetRouterEligible
otError otThreadSetRouterEligible(
otInstance *aInstance,
bool aEligible
)
デバイスがルーター対応かどうかを設定します。
aEligible
が false で、デバイスが現在ルーターとして動作している場合、この呼び出しによりデバイスが接続解除され、子供として再アタッチが試行されます。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
otThreadSetRouterIdRange
otError otThreadSetRouterIdRange(
otInstance *aInstance,
uint8_t aMinRouterId,
uint8_t aMaxRouterId
)
スレッド ネットワーク内のノードに割り当てることができるルーター ID の範囲を設定します。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメータ |
|
||||||
戻り値 |
|
otThreadGetRouterIdRange
otThreadSetRouterSelectionJitter
void otThreadSetRouterSelectionJitter(
otInstance *aInstance,
uint8_t aRouterJitter
)
REED/ルーターのロールで使用される ROUTER_SELECTION_JITTER パラメータを設定します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
otThreadGetRouterSelectionJitter
otThreadSetRouterUpgradeThreshold
void otThreadSetRouterUpgradeThreshold(
otInstance *aInstance,
uint8_t aThreshold
)
リーダーのロールで使用される ROUTER_UPGRADE_THRESHOLD パラメータを設定します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
otThreadGetRouterUpgradeThreshold
otThreadSetSteeringData
void otThreadSetSteeringData(
otInstance *aInstance,
const otExtAddress *aExtAddress
)
ステアリング データを帯域外に設定する。
構成オプション OPENTHREAD_CONFIG_MLE_STEERING_DATA_SET_OOB_ENABLE
を設定して、データを帯域外でステアリングする設定を有効にする必要があります。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
otThreadSetThreadVersionCheckEnabled
void otThreadSetThreadVersionCheckEnabled(
otInstance *aInstance,
bool aEnabled
)
ルーティング(VR フィールド)のセキュリティ ポリシー TLV バージョンしきい値を有効にするかどうかを設定します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
マクロ
OT_CHILD_IP6_ADDRESS_ITERATOR_INIT
OT_CHILD_IP6_ADDRESS_ITERATOR_INIT 0
otChildIP6AddressIterator の初期化子。
関連情報
OpenThread API リファレンスのトピックは、GitHub で入手できるソースコードに由来しています。 詳細について、またはドキュメントへの投稿については、リソースをご覧ください。