เราเตอร์/ลีดเดอร์

โมดูลนี้ประกอบด้วยฟังก์ชันสำหรับเราเตอร์และตัวนำเทรด

สรุป

การแจกแจง
otCacheEntryState	enum กำหนดสถานะรายการแคช EID
otNeighborTableEvent{   OT_NEIGHBOR_TABLE_EVENT_CHILD_ADDED,   OT_NEIGHBOR_TABLE_EVENT_CHILD_REMOVED,   OT_NEIGHBOR_TABLE_EVENT_CHILD_MODE_CHANGED,   OT_NEIGHBOR_TABLE_EVENT_ROUTER_ADDED,   OT_NEIGHBOR_TABLE_EVENT_ROUTER_REMOVED }	enum กำหนดค่าคงที่ที่ใช้ใน otNeighborTableCallback เพื่อระบุการเปลี่ยนแปลงในตารางใกล้เคียง
otPowerSupply{   OT_POWER_SUPPLY_BATTERY = 0,   OT_POWER_SUPPLY_EXTERNAL = 1,   OT_POWER_SUPPLY_EXTERNAL_STABLE = 2,   OT_POWER_SUPPLY_EXTERNAL_UNSTABLE = 3 }	enum แสดงคุณสมบัติของแหล่งจ่ายไฟในอุปกรณ์

Typedef
otCacheEntryInfo	typedef struct otCacheEntryInfo แสดงรายการแคช EID
otCacheEntryIterator	typedef struct otCacheEntryIterator แสดงตัววนซ้ำที่ใช้สำหรับทำซ้ำผ่านรายการในตารางแคช EID
otCacheEntryState	typedef enum otCacheEntryState กำหนดสถานะรายการแคช EID
otChildIp6AddressIterator	typedef uint16_t ใช้ในการทำซ้ำผ่านที่อยู่ IPv6 ของรายการย่อยของ Thread
otDeviceProperties	typedef struct otDeviceProperties แสดงพร็อพเพอร์ตี้ของอุปกรณ์ซึ่งใช้ในการคำนวณน้ำหนักของผู้นำในพื้นที่บนอุปกรณ์
otNeighborTableCallback)(otNeighborTableEvent aEvent, const otNeighborTableEntryInfo *aEntryInfo)	typedef void(* ระบบจะเรียกใช้ตัวชี้เพื่อแจ้งว่ามีการเปลี่ยนแปลงในตารางใกล้เคียง

ฟังก์ชัน
otThreadBecomeLeader(otInstance *aInstance)	otError มาเป็นผู้นำและเริ่มแบ่งพาร์ติชันใหม่
otThreadBecomeRouter(otInstance *aInstance)	otError ลองพยายามเป็นเราเตอร์
otThreadGetAdvertisementTrickleIntervalMax(otInstance *aInstance)	uint32_t รับค่าสูงสุดของช่วงปัจจุบันที่ใช้โดยตัวจับเวลาถอยหลังของโฆษณา
otThreadGetChildInfoById(otInstance *aInstance, uint16_t aChildId, otChildInfo *aChildInfo)	otError รับข้อมูลการวินิจฉัย Child ID หรือ RLOC16 ที่แนบอยู่
otThreadGetChildInfoByIndex(otInstance *aInstance, uint16_t aChildIndex, otChildInfo *aChildInfo)	otError ฟังก์ชันนี้จะเก็บข้อมูลการวินิจฉัยสำหรับรายการย่อยที่แนบอยู่โดยดัชนีตารางภายใน
otThreadGetChildNextIp6Address(otInstance *aInstance, uint16_t aChildIndex, otChildIp6AddressIterator *aIterator, otIp6Address *aAddress)	otError รับที่อยู่ IPv6 ถัดไป (โดยใช้ตัวซ้ำ) สำหรับส่วนย่อยที่ระบุ
otThreadGetChildRouterLinks(otInstance *aInstance)	uint8_t รับพารามิเตอร์ MLE_CHILD_ROUTER_LINKS ที่ใช้ในบทบาท REED
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 รับน้ำหนักของตัวนำเทรดที่ใช้เมื่อทำงานในบทบาทผู้นำ
otThreadGetMaxAllowedChildren(otInstance *aInstance)	uint16_t ดึงจำนวนเด็กสูงสุดที่อนุญาตในปัจจุบัน
otThreadGetMaxChildIpAddresses(otInstance *aInstance)	uint8_t รับจำนวนที่อยู่ IP สูงสุดที่ผู้เผยแพร่โฆษณาย่อย MTD แต่ละรายอาจลงทะเบียนกับอุปกรณ์นี้ในฐานะระดับบนสุด
otThreadGetMaxRouterId(otInstance *aInstance)	uint8_t ฟังก์ชันนี้จะแสดงรหัสเราเตอร์สูงสุดที่อนุญาต
otThreadGetNetworkIdTimeout(otInstance *aInstance)	uint8_t รับพารามิเตอร์ NETWORK_ID_TIMEOUT
otThreadGetNextCacheEntry(otInstance *aInstance, otCacheEntryInfo *aEntryInfo, otCacheEntryIterator *aIterator)	otError รับรายการแคช 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 รับรหัสพาร์ติชันของผู้นำเทรดที่ต้องการเมื่อดําเนินการในบทบาทผู้นำ
otThreadGetPskc(otInstance *aInstance, otPskc *aPskc)	void รับ Thread PSKc
otThreadGetPskcRef(otInstance *aInstance)	otPskcRef รับการอ้างอิงคีย์ไปยัง Thread PSKc ที่จัดเก็บไว้
otThreadGetRouterDowngradeThreshold(otInstance *aInstance)	uint8_t รับพารามิเตอร์ ROUTER_DOWNGRADE_THRESHOLD ที่ใช้ในบทบาทเราเตอร์
otThreadGetRouterIdRange(otInstance *aInstance, uint8_t *aMinRouterId, uint8_t *aMaxRouterId)	void รับช่วงของรหัสเราเตอร์ที่ได้รับอนุญาตให้กำหนดให้กับโหนดภายในเครือข่ายเทรด
otThreadGetRouterIdSequence(otInstance *aInstance)	uint8_t รับลำดับรหัสเราเตอร์ปัจจุบัน
otThreadGetRouterInfo(otInstance *aInstance, uint16_t aRouterId, otRouterInfo *aRouterInfo)	otError ฟังก์ชันนี้จะเก็บข้อมูลการวินิจฉัยสำหรับเราเตอร์เทรดที่ระบุ
otThreadGetRouterSelectionJitter(otInstance *aInstance)	uint8_t รับพารามิเตอร์ ROUTER_SELECTION_JITTER ที่ใช้ในบทบาท REED/เราเตอร์
otThreadGetRouterUpgradeThreshold(otInstance *aInstance)	uint8_t รับพารามิเตอร์ ROUTER_UPGRADE_THRESHOLD ที่ใช้ในบทบาท REED
otThreadIsRouterEligible(otInstance *aInstance)	bool ระบุว่าอุปกรณ์มีสิทธิ์ใช้เราเตอร์หรือไม่
otThreadIsRouterIdAllocated(otInstance *aInstance, uint8_t aRouterId)	bool ระบุว่ามีการจัดสรรรหัสเราเตอร์ในปัจจุบันหรือไม่
otThreadRegisterNeighborTableCallback(otInstance *aInstance, otNeighborTableCallback aCallback)	void ลงทะเบียนฟังก์ชันเรียกกลับของตารางใกล้เคียง
otThreadReleaseRouterId(otInstance *aInstance, uint8_t aRouterId)	otError ปล่อยรหัสเราเตอร์ที่อุปกรณ์ได้รับการจัดสรรในบทบาทผู้นำ
otThreadSetCcmEnabled(otInstance *aInstance, bool aEnabled)	void ตั้งค่าว่าอุปกรณ์ได้รับการว่าจ้างให้ใช้ CCM หรือไม่
otThreadSetChildRouterLinks(otInstance *aInstance, uint8_t aChildRouterLinks)	otError ตั้งค่าพารามิเตอร์ MLE_CHILD_ROUTER_LINKS ที่ใช้ในบทบาท REED
otThreadSetContextIdReuseDelay(otInstance *aInstance, uint32_t aDelay)	void ตั้งค่าพารามิเตอร์ CONTEXT_ID_REUSE_DELAY ที่ใช้ในบทบาทผู้นำ
otThreadSetDeviceProperties(otInstance *aInstance, const otDeviceProperties *aDeviceProperties)	void ตั้งค่าคุณสมบัติของอุปกรณ์ที่จะใช้กำหนดและกำหนดน้ำหนักตัวนำ
otThreadSetJoinerUdpPort(otInstance *aInstance, uint16_t aJoinerUdpPort)	otError ตั้งค่าพอร์ต Joiner UDP
otThreadSetLocalLeaderWeight(otInstance *aInstance, uint8_t aWeight)	void ตั้งค่าน้ำหนักของตัวนำเทรดที่ใช้เมื่อทำงานในบทบาทผู้นำ
otThreadSetMaxAllowedChildren(otInstance *aInstance, uint16_t aMaxChildren)	otError ตั้งค่าจำนวนสูงสุดของเด็กที่อนุญาตในปัจจุบัน
otThreadSetMaxChildIpAddresses(otInstance *aInstance, uint8_t aMaxIpAddresses)	otError ตั้งค่าหรือกู้คืนจำนวนที่อยู่ IP สูงสุดที่ผู้เผยแพร่โฆษณาย่อย MTD แต่ละรายอาจลงทะเบียนกับอุปกรณ์นี้ในฐานะระดับบนสุด
otThreadSetNetworkIdTimeout(otInstance *aInstance, uint8_t aTimeout)	void ตั้งค่าพารามิเตอร์ NETWORK_ID_TIMEOUT
otThreadSetParentPriority(otInstance *aInstance, int8_t aParentPriority)	otError กำหนดลำดับความสำคัญของผู้ปกครอง
otThreadSetPreferredLeaderPartitionId(otInstance *aInstance, uint32_t aPartitionId)	void ตั้งค่ารหัสพาร์ติชันของผู้นำเทรดที่ต้องการเมื่อใช้ในบทบาทผู้นำ
otThreadSetPreferredRouterId(otInstance *aInstance, uint8_t aRouterId)	otError ตั้งค่ารหัสเราเตอร์ที่ต้องการ
otThreadSetPskc(otInstance *aInstance, const otPskc *aPskc)	otError ตั้งค่าเทรด PSKc
otThreadSetPskcRef(otInstance *aInstance, otPskcRef aKeyRef)	otError ตั้งค่าการอ้างอิงคีย์เป็นเทรด PSKc
otThreadSetRouterDowngradeThreshold(otInstance *aInstance, uint8_t aThreshold)	void ตั้งค่าพารามิเตอร์ ROUTER_DOWNGRADE_THRESHOLD ที่ใช้ในบทบาทผู้นำ
otThreadSetRouterEligible(otInstance *aInstance, bool aEligible)	otError ตั้งค่าว่าอุปกรณ์มีสิทธิ์ใช้เราเตอร์หรือไม่
otThreadSetRouterIdRange(otInstance *aInstance, uint8_t aMinRouterId, uint8_t aMaxRouterId)	otError ตั้งค่าช่วงของรหัสเราเตอร์ที่ได้รับอนุญาตให้กำหนดให้กับโหนดภายในเครือข่ายเทรด
otThreadSetRouterSelectionJitter(otInstance *aInstance, uint8_t aRouterJitter)	void ตั้งค่าพารามิเตอร์ ROUTER_SELECTION_JITTER ที่ใช้ในบทบาท REED/เราเตอร์
otThreadSetRouterUpgradeThreshold(otInstance *aInstance, uint8_t aThreshold)	void ตั้งค่าพารามิเตอร์ ROUTER_UPGRADE_THRESHOLD ที่ใช้ในบทบาทผู้นำ
otThreadSetSteeringData(otInstance *aInstance, const otExtAddress *aExtAddress)	void ตั้งค่าข้อมูลพวงมาลัยอยู่นอกย่านความถี่
otThreadSetThreadVersionCheckEnabled(otInstance *aInstance, bool aEnabled)	void กำหนดว่าจะเปิดใช้เกณฑ์เวอร์ชัน TLV ของนโยบายความปลอดภัยสำหรับการกำหนดเส้นทาง (ฟิลด์ VR) หรือไม่

โครงสร้าง
otCacheEntryInfo	แสดงรายการแคช EID
otCacheEntryIterator	แสดงตัววนซ้ำที่ใช้สำหรับทำซ้ำผ่านรายการในตารางแคช EID
otChildInfo	เก็บข้อมูลการวินิจฉัยสำหรับผู้เผยแพร่โฆษณาย่อยในเทรด
otDeviceProperties	แสดงพร็อพเพอร์ตี้ของอุปกรณ์ซึ่งใช้ในการคำนวณน้ำหนักของผู้นำในพื้นที่บนอุปกรณ์
otNeighborTableEntryInfo	แสดงข้อมูลรายการในตารางใกล้เคียง (ย่อยหรือเราเตอร์) และใช้เป็นพารามิเตอร์ในโค้ดเรียกกลับ otNeighborTableCallback ของตารางใกล้เคียง

การแจกแจง

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

otCacheEntryInfo

struct otCacheEntryInfo otCacheEntryInfo

แสดงรายการแคช EID

otCacheEntryIterator

struct otCacheEntryIterator otCacheEntryIterator

แสดงตัววนซ้ำที่ใช้สำหรับทำซ้ำผ่านรายการในตารางแคช EID

หากต้องการเริ่มต้นตัววนซ้ำและเริ่มต้นจากรายการแรกในตารางแคช ให้ตั้งค่าฟิลด์ทั้งหมดในโครงสร้างเป็น 0 (เช่น memset ตัววนซ้ำเป็น 0)

otCacheEntryState

enum otCacheEntryState otCacheEntryState

กำหนดสถานะรายการแคช EID

otChildIp6AddressIterator

uint16_t otChildIp6AddressIterator

ใช้ในการทำซ้ำผ่านที่อยู่ IPv6 ของรายการย่อยของ Thread

otDeviceProperties

struct otDeviceProperties otDeviceProperties

แสดงพร็อพเพอร์ตี้ของอุปกรณ์ซึ่งใช้ในการคำนวณน้ำหนักของผู้นำในพื้นที่บนอุปกรณ์

โดยการตั้งค่าพารามิเตอร์ตามความสามารถของอุปกรณ์ ไม่ว่าจะทำหน้าที่เป็น Border Router, การกำหนดค่าแหล่งจ่ายไฟ ฯลฯ

mIsUnstable จะระบุความเสถียรในการทำงานของอุปกรณ์และจะกำหนดผ่านกลไกเฉพาะของผู้ให้บริการ ซึ่งอาจประกอบไปด้วยกรณีต่อไปนี้

• ภายในอุปกรณ์ตรวจพบว่าไม่มีแหล่งจ่ายไฟภายนอกหลุดบ่อยกว่าปกติ ผู้ให้บริการจะเป็นผู้กำหนดสิ่งที่ปกติ
• ภายในอุปกรณ์ตรวจพบว่ามีการรีบูตบ่อยกว่าปกติ ผู้ให้บริการจะเป็นผู้กำหนดสิ่งที่ปกติ

otNeighborTableCallback

void(* otNeighborTableCallback)(otNeighborTableEvent aEvent, const otNeighborTableEntryInfo *aEntryInfo)

ระบบจะเรียกใช้ตัวชี้เพื่อแจ้งว่ามีการเปลี่ยนแปลงในตารางใกล้เคียง

รายละเอียด
พารามิเตอร์	[in] aEvent ธงกิจกรรม [in] aEntryInfo ตัวชี้ไปยังข้อมูลรายการในตาราง

ฟังก์ชัน

otThreadBecomeLeader

otError otThreadBecomeLeader(
  otInstance *aInstance
)

มาเป็นผู้นำและเริ่มแบ่งพาร์ติชันใหม่

หมายเหตุ: API นี้สงวนไว้สำหรับการทดสอบและการสาธิตเท่านั้น การเปลี่ยนการตั้งค่าด้วย API นี้จะทำให้แอปพลิเคชันเวอร์ชันที่ใช้งานจริงไม่เป็นไปตามข้อกำหนดเทรด

รายละเอียด
พารามิเตอร์	[in] aInstance ตัวชี้ไปยังอินสแตนซ์ OpenThread
แสดงผลค่า	OT_ERROR_NONE เป็นผู้นำและเริ่มต้นพาร์ติชันใหม่เรียบร้อยแล้ว OT_ERROR_INVALID_STATE ชุดข้อความปิดใช้อยู่

otThreadBecomeRouter

otError otThreadBecomeRouter(
  otInstance *aInstance
)

ลองพยายามเป็นเราเตอร์

หมายเหตุ: API นี้สงวนไว้สำหรับการทดสอบและการสาธิตเท่านั้น การเปลี่ยนการตั้งค่าด้วย API นี้จะทำให้แอปพลิเคชันเวอร์ชันที่ใช้งานจริงไม่เป็นไปตามข้อกำหนดเทรด

รายละเอียด
พารามิเตอร์	[in] aInstance ตัวชี้ไปยังอินสแตนซ์ OpenThread
แสดงผลค่า	OT_ERROR_NONE เริ่มลองเป็นเราเตอร์เรียบร้อยแล้ว OT_ERROR_INVALID_STATE ชุดข้อความปิดใช้อยู่

otThreadGetAdvertisementTrickleIntervalMax

uint32_t otThreadGetAdvertisementTrickleIntervalMax(
  otInstance *aInstance
)

รับค่าสูงสุดของช่วงปัจจุบันที่ใช้โดยตัวจับเวลาถอยหลังของโฆษณา

API นี้ต้องใช้ OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE และมีไว้สำหรับการทดสอบเท่านั้น

รายละเอียด
การส่งคืน	ช่วงเวลาสูงสุดของตัวจับเวลาการโฆษณา หน่วยเป็นมิลลิวินาที

otThreadGetChildInfoById

otError otThreadGetChildInfoById(
  otInstance *aInstance,
  uint16_t aChildId,
  otChildInfo *aChildInfo
)

รับข้อมูลการวินิจฉัย Child ID หรือ RLOC16 ที่แนบอยู่

รายละเอียด
พารามิเตอร์	[in] aInstance ตัวชี้ไปยังอินสแตนซ์ OpenThread [in] aChildId รหัสย่อยหรือ RLOC16 สำหรับผู้เผยแพร่โฆษณาย่อยที่แนบมา [out] aChildInfo ตัวชี้ที่ไปยังตำแหน่งที่วางข้อมูลย่อย
แสดงผลค่า	OT_ERROR_NONE อัปเดต aChildInfo ด้วยข้อมูลรหัสที่ระบุเรียบร้อยแล้ว OT_ERROR_NOT_FOUND ไม่มีผู้เผยแพร่โฆษณาย่อยที่ถูกต้องที่มีรหัสผู้เผยแพร่โฆษณาย่อยนี้ OT_ERROR_INVALID_ARGS หาก aChildInfo เป็นค่าว่าง

otThreadGetChildInfoByIndex

otError otThreadGetChildInfoByIndex(
  otInstance *aInstance,
  uint16_t aChildIndex,
  otChildInfo *aChildInfo
)

ฟังก์ชันนี้จะเก็บข้อมูลการวินิจฉัยสำหรับรายการย่อยที่แนบอยู่โดยดัชนีตารางภายใน

รายละเอียด
พารามิเตอร์	[in] aInstance ตัวชี้ไปยังอินสแตนซ์ OpenThread [in] aChildIndex ดัชนีตาราง [out] aChildInfo ตัวชี้ที่ไปยังตำแหน่งที่วางข้อมูลย่อย
แสดงผลค่า	OT_ERROR_NONE อัปเดต aChildInfo ด้วยข้อมูลสำหรับดัชนีที่ระบุเรียบร้อยแล้ว OT_ERROR_NOT_FOUND ไม่มีรายการย่อยที่ถูกต้องในดัชนีนี้ OT_ERROR_INVALID_ARGS aChildInfo มีค่าเป็น NULL หรือ aChildIndex อยู่นอกช่วง (สูงกว่าดัชนีสูงสุดในตาราง)

โปรดดูเพิ่มเติมที่
otGetMaxAllowedChild

otThreadGetChildNextIp6Address

otError otThreadGetChildNextIp6Address(
  otInstance *aInstance,
  uint16_t aChildIndex,
  otChildIp6AddressIterator *aIterator,
  otIp6Address *aAddress
)

รับที่อยู่ IPv6 ถัดไป (โดยใช้ตัวซ้ำ) สำหรับส่วนย่อยที่ระบุ

รายละเอียด
พารามิเตอร์	[in] aInstance ตัวชี้ไปยังอินสแตนซ์ OpenThread [in] aChildIndex ดัชนีย่อย [in,out] aIterator ตัวชี้ไปยังตัววนซ้ำ เมื่อทำสำเร็จ ตัววนซ้ำจะได้รับการอัปเดตให้ชี้ไปยังรายการถัดไปในรายการ หากต้องการรับที่อยู่ IPv6 แรก ควรตั้งค่าตัววนซ้ำเป็น OT_CHILD_IP6_ADDRESS_ITERATOR_INIT [out] aAddress ตัวชี้ไปยังที่อยู่ IPv6 ซึ่งระบบจะป้อนที่อยู่ถัดไปของบุตรหลาน (เมื่อสำเร็จ)
แสดงผลค่า	OT_ERROR_NONE ค้นหาที่อยู่ IPv6 ถัดไปเรียบร้อยแล้ว (อัปเดต aAddress เรียบร้อยแล้ว) OT_ERROR_NOT_FOUND ผู้เผยแพร่โฆษณาย่อยจะไม่มีรายการที่อยู่ IPv6 ที่ตามมา OT_ERROR_INVALID_ARGS aIterator หรือ aAddress เป็นค่าว่าง หรือค่าย่อยที่ aChildIndex ไม่ถูกต้อง

ดูเพิ่มเติม:
otThreadGetChildInfoByIndex

otThreadGetChildRouterLinks

uint8_t otThreadGetChildRouterLinks(
  otInstance *aInstance
)

รับพารามิเตอร์ MLE_CHILD_ROUTER_LINKS ที่ใช้ในบทบาท REED

พารามิเตอร์นี้ระบุจำนวนเราเตอร์ใกล้เคียงสูงสุดที่อุปกรณ์ (เป็น FED) จะพยายามสร้างลิงก์

รายละเอียด
พารามิเตอร์	[in] aInstance ตัวชี้ไปยังอินสแตนซ์ OpenThread
การส่งคืน	ค่า MLE_CHILD_ROUTER_LINKS

ดูเพิ่มเติม:
otThreadSetChildRouterLinks

otThreadGetContextIdReuseDelay

uint32_t otThreadGetContextIdReuseDelay(
  otInstance *aInstance
)

รับพารามิเตอร์ CONTEXT_ID_REUSE_DELAY ที่ใช้ในบทบาทผู้นำ

รายละเอียด
พารามิเตอร์	[in] aInstance ตัวชี้ไปยังอินสแตนซ์ OpenThread
การส่งคืน	ค่า 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

รายละเอียด
พารามิเตอร์	[in] aInstance ตัวชี้ไปยังอินสแตนซ์ OpenThread
การส่งคืน	หมายเลขพอร์ต UDP ของผู้เชื่อม

โปรดดูข้อมูลเพิ่มเติมที่
otThreadSetJoinerUdpPort

otThreadGetLocalLeaderWeight

uint8_t otThreadGetLocalLeaderWeight(
  otInstance *aInstance
)

รับน้ำหนักของตัวนำเทรดที่ใช้เมื่อทำงานในบทบาทผู้นำ

รายละเอียด
พารามิเตอร์	[in] aInstance ตัวชี้ไปยังอินสแตนซ์ OpenThread
การส่งคืน	ค่าน้ำหนักของตัวนำชุดข้อความ

โปรดดูข้อมูลเพิ่มเติมที่
otThreadSetLeaderอื่นได้
otThreadSetDeviceProperties

otThreadGetMaxAllowedChildren

uint16_t otThreadGetMaxAllowedChildren(
  otInstance *aInstance
)

ดึงจำนวนเด็กสูงสุดที่อนุญาตในปัจจุบัน

รายละเอียด
พารามิเตอร์	[in] aInstance ตัวชี้ไปยังอินสแตนซ์ OpenThread
การส่งคืน	จำนวนเด็กสูงสุดที่อนุญาตในปัจจุบัน

ดูเพิ่มเติมที่
otThreadSetMaxAllowedChildren

otThreadGetMaxChildIpAddresses

uint8_t otThreadGetMaxChildIpAddresses(
  otInstance *aInstance
)

รับจำนวนที่อยู่ IP สูงสุดที่ผู้เผยแพร่โฆษณาย่อย MTD แต่ละรายอาจลงทะเบียนกับอุปกรณ์นี้ในฐานะระดับบนสุด

รายละเอียด
พารามิเตอร์	[in] aInstance ตัวชี้ไปยังอินสแตนซ์ OpenThread
การส่งคืน	จำนวนที่อยู่ IP สูงสุดที่ผู้เผยแพร่โฆษณาย่อย MTD แต่ละรายอาจลงทะเบียนกับอุปกรณ์นี้ในฐานะระดับบนสุด

ดูเพิ่มเติม:
otThreadSetMaxChildIpAddresses

otThreadGetMaxRouterId

uint8_t otThreadGetMaxRouterId(
  otInstance *aInstance
)

ฟังก์ชันนี้จะแสดงรหัสเราเตอร์สูงสุดที่อนุญาต

รายละเอียด
พารามิเตอร์	[in] aInstance ตัวชี้ไปยังอินสแตนซ์ OpenThread
การส่งคืน	รหัสเราเตอร์สูงสุดที่อนุญาต

otThreadGetNetworkIdTimeout

uint8_t otThreadGetNetworkIdTimeout(
  otInstance *aInstance
)

รับพารามิเตอร์ NETWORK_ID_TIMEOUT

หมายเหตุ: API นี้สงวนไว้สำหรับการทดสอบและการสาธิตเท่านั้น การเปลี่ยนการตั้งค่าด้วย API นี้จะทำให้แอปพลิเคชันเวอร์ชันที่ใช้งานจริงไม่เป็นไปตามข้อกำหนดเทรด

รายละเอียด
พารามิเตอร์	[in] aInstance ตัวชี้ไปยังอินสแตนซ์ OpenThread
การส่งคืน	ค่า NETWORK_ID_TIMEOUT

ดูเพิ่มเติม:
otThreadSetNetworkIdTimeout

otThreadGetNextCacheEntry

otError otThreadGetNextCacheEntry(
  otInstance *aInstance,
  otCacheEntryInfo *aEntryInfo,
  otCacheEntryIterator *aIterator
)

รับรายการแคช EID ถัดไป (โดยใช้ตัวซ้ำ)

รายละเอียด
พารามิเตอร์	[in] aInstance ตัวชี้ไปยังอินสแตนซ์ OpenThread [out] aEntryInfo ตัวชี้ไปยังตำแหน่งที่ใส่ข้อมูลรายการแคช EID [in,out] aIterator ตัวชี้ไปยังตัววนซ้ำ และจะอัปเดตเพื่อให้นำไปยังรายการถัดไปที่สําเร็จ หากต้องการรับรายการแรก ให้เริ่มต้นตัววนซ้ำโดยตั้งค่าช่องทั้งหมดของรายการนั้นเป็น 0 (เช่น memset โครงสร้างตัววนซ้ำเป็น 0)
แสดงผลค่า	OT_ERROR_NONE ป้อนข้อมูล aEntryInfo สำหรับรายการแคช EID ถัดไปเรียบร้อยแล้ว OT_ERROR_NOT_FOUND ไม่มีรายการเพิ่มเติมในตารางแคชที่อยู่

otThreadGetNextHopAndPathCost

void otThreadGetNextHopAndPathCost(
  otInstance *aInstance,
  uint16_t aDestRloc16,
  uint16_t *aNextHopRloc16,
  uint8_t *aPathCost
)

รับค่าใช้จ่ายสำหรับฮอพและเส้นทางถัดไปไปยังปลายทาง RLOC16 ที่ระบุ

ใช้ได้กับ aNextHopRloc16 หรือ aPathCost ที่เป็นค่าว่างซึ่งระบุว่าผู้โทรไม่ต้องการรับค่าดังกล่าว

รายละเอียด
พารามิเตอร์	[in] aInstance ตัวชี้ไปยังอินสแตนซ์ OpenThread [in] aDestRloc16 RLOC16 ของปลายทาง [out] aNextHopRloc16 ตัวชี้ที่จะแสดงผล RLOC16 ของฮอพถัดไป หรือ 0xfffe หากไม่มีฮอพถัดไป [out] aPathCost ตัวชี้ไปยังต้นทุนเส้นทางย้อนกลับไปยังปลายทาง

otThreadGetParentPriority

int8_t otThreadGetParentPriority(
  otInstance *aInstance
)

รับลำดับความสำคัญระดับบนสุดที่กำหนด

รายละเอียด
พารามิเตอร์	[in] aInstance ตัวชี้ไปยังอินสแตนซ์ OpenThread
การส่งคืน	ค่าลำดับความสำคัญหลักที่กำหนดไว้ -2 หมายความว่าไม่ได้กำหนด

โปรดดูข้อมูลเพิ่มเติมที่
otThreadSetParentPriority

otThreadGetPreferredLeaderPartitionId

uint32_t otThreadGetPreferredLeaderPartitionId(
  otInstance *aInstance
)

รับรหัสพาร์ติชันของผู้นำเทรดที่ต้องการเมื่อดําเนินการในบทบาทผู้นำ

รายละเอียด
พารามิเตอร์	[in] aInstance ตัวชี้ไปยังอินสแตนซ์ OpenThread
การส่งคืน	ค่ารหัสพาร์ติชันของตัวนําเทรด

otThreadGetPskc

void otThreadGetPskc(
  otInstance *aInstance,
  otPskc *aPskc
)

รับ Thread PSKc

รายละเอียด
พารามิเตอร์	[in] aInstance ตัวชี้ไปยังอินสแตนซ์ OpenThread [out] aPskc ตัวชี้ไปยัง otPskc เพื่อแสดงผล PSKc ที่เรียกข้อมูลมา

ดูเพิ่มเติม:
otThreadSetPskc

otThreadGetPskcRef

otPskcRef otThreadGetPskcRef(
  otInstance *aInstance
)

รับการอ้างอิงคีย์ไปยัง Thread PSKc ที่จัดเก็บไว้

ต้องเปิดใช้ฟีเจอร์ OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE เวอร์ชันสำหรับบิวด์

รายละเอียด
พารามิเตอร์	[in] aInstance ตัวชี้ไปยังอินสแตนซ์ OpenThread
การส่งคืน	ข้อมูลอ้างอิงสำคัญสำหรับ PSKc

ดูเพิ่มเติม:
otThreadSetPskcRef

otThreadGetRouterDowngradeThreshold

uint8_t otThreadGetRouterDowngradeThreshold(
  otInstance *aInstance
)

รับพารามิเตอร์ ROUTER_DOWNGRADE_THRESHOLD ที่ใช้ในบทบาทเราเตอร์

รายละเอียด
พารามิเตอร์	[in] aInstance ตัวชี้ไปยังอินสแตนซ์ OpenThread
การส่งคืน	ค่า ROUTER_DOWNGRADE_THRESHOLD

โปรดดูข้อมูลเพิ่มเติมที่
otThreadSetRouterDowngradeThreshold

otThreadGetRouterIdRange

void otThreadGetRouterIdRange(
  otInstance *aInstance,
  uint8_t *aMinRouterId,
  uint8_t *aMaxRouterId
)

รับช่วงของรหัสเราเตอร์ที่ได้รับอนุญาตให้กำหนดให้กับโหนดภายในเครือข่ายเทรด

หมายเหตุ: API นี้ต้องใช้ OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE และใช้เพื่อจุดประสงค์ในการทดสอบเท่านั้น อนุญาตให้ใช้รหัสเราเตอร์ทั้งหมดในช่วง [aMinRouterId, aMaxRouterId]

รายละเอียด
พารามิเตอร์	[in] aInstance ตัวชี้ไปยังอินสแตนซ์ OpenThread [out] aMinRouterId รหัสเราเตอร์ขั้นต่ำ [out] aMaxRouterId รหัสเราเตอร์สูงสุด

ดูเพิ่มเติม:
otThreadSetRouterIdRange

otThreadGetRouterIdSequence

uint8_t otThreadGetRouterIdSequence(
  otInstance *aInstance
)

รับลำดับรหัสเราเตอร์ปัจจุบัน

รายละเอียด
พารามิเตอร์	[in] aInstance ตัวชี้ไปยังอินสแตนซ์ OpenThread
การส่งคืน	ลำดับรหัสเราเตอร์

otThreadGetRouterInfo

otError otThreadGetRouterInfo(
  otInstance *aInstance,
  uint16_t aRouterId,
  otRouterInfo *aRouterInfo
)

ฟังก์ชันนี้จะเก็บข้อมูลการวินิจฉัยสำหรับเราเตอร์เทรดที่ระบุ

รายละเอียด
พารามิเตอร์	[in] aInstance ตัวชี้ไปยังอินสแตนซ์ OpenThread [in] aRouterId รหัสเราเตอร์หรือ RLOC16 ของเราเตอร์หนึ่งๆ [out] aRouterInfo ตัวชี้ไปยังตำแหน่งที่วางข้อมูลเราเตอร์
แสดงผลค่า	OT_ERROR_NONE เรียกข้อมูลเราเตอร์สำหรับรหัสที่ระบุเรียบร้อยแล้ว OT_ERROR_NOT_FOUND ไม่มีรายการเราเตอร์ที่มีรหัสที่ระบุ OT_ERROR_INVALID_ARGS aRouterInfo เป็นค่าว่าง

otThreadGetRouterSelectionJitter

uint8_t otThreadGetRouterSelectionJitter(
  otInstance *aInstance
)

รับพารามิเตอร์ ROUTER_SELECTION_JITTER ที่ใช้ในบทบาท REED/เราเตอร์

รายละเอียด
พารามิเตอร์	[in] aInstance ตัวชี้ไปยังอินสแตนซ์ OpenThread
การส่งคืน	ค่า ROUTER_SELECTION_JITTER

ดูเพิ่มเติม:
otThreadSetRouterSelectionJitter

otThreadGetRouterUpgradeThreshold

uint8_t otThreadGetRouterUpgradeThreshold(
  otInstance *aInstance
)

รับพารามิเตอร์ ROUTER_UPGRADE_THRESHOLD ที่ใช้ในบทบาท REED

รายละเอียด
พารามิเตอร์	[in] aInstance ตัวชี้ไปยังอินสแตนซ์ OpenThread
การส่งคืน	ค่า ROUTER_UPGRADE_THRESHOLD

โปรดดูข้อมูลเพิ่มเติมที่
otThreadSetRouterUpgradeThreshold

otThreadIsRouterEligible

bool otThreadIsRouterEligible(
  otInstance *aInstance
)

ระบุว่าอุปกรณ์มีสิทธิ์ใช้เราเตอร์หรือไม่

รายละเอียด
พารามิเตอร์	[in] aInstance ตัวชี้ไปยังอินสแตนซ์ OpenThread
แสดงผลค่า	TRUE หากอุปกรณ์มีสิทธิ์ใช้เราเตอร์ FALSE หากอุปกรณ์ไม่มีสิทธิ์ใช้เราเตอร์

otThreadIsRouterIdAllocated

bool otThreadIsRouterIdAllocated(
  otInstance *aInstance,
  uint8_t aRouterId
)

ระบุว่ามีการจัดสรรรหัสเราเตอร์ในปัจจุบันหรือไม่

รายละเอียด
พารามิเตอร์	[in] aInstance ตัวชี้ไปยังอินสแตนซ์ OpenThread [in] aRouterId รหัสเราเตอร์ที่ต้องตรวจสอบ
แสดงผลค่า	TRUE จัดสรร aRouterId แล้ว FALSE ไม่ได้จัดสรร aRouterId

otThreadRegisterNeighborTableCallback

void otThreadRegisterNeighborTableCallback(
  otInstance *aInstance,
  otNeighborTableCallback aCallback
)

ลงทะเบียนฟังก์ชันเรียกกลับของตารางใกล้เคียง

ระบบจะเรียกใช้โค้ดเรียกกลับที่ระบุ (หากไม่ใช่ NULL) เมื่อมีการเปลี่ยนแปลงในตารางใกล้เคียง (เช่น เพิ่ม/นำรายการใกล้เคียงของเราเตอร์ออก หรือมีการเปลี่ยนแปลงโหมดย่อยที่มีอยู่)

การเรียกวิธีนี้ครั้งต่อๆ ไปจะเป็นการเขียนทับโค้ดเรียกกลับก่อนหน้านี้ โปรดทราบว่าจะมีการเรียกใช้โค้ดเรียกกลับนี้ขณะที่มีการอัปเดตตารางใกล้เคียง/ย่อย และอยู่ก่อน otStateChangedCallback เสมอ

รายละเอียด
พารามิเตอร์	[in] aInstance ตัวชี้ไปยังอินสแตนซ์ OpenThread [in] aCallback ตัวชี้ไปยังฟังก์ชันตัวแฮนเดิลการเรียกกลับ

otThreadReleaseRouterId

otError otThreadReleaseRouterId(
  otInstance *aInstance,
  uint8_t aRouterId
)

ปล่อยรหัสเราเตอร์ที่อุปกรณ์ได้รับการจัดสรรในบทบาทผู้นำ

หมายเหตุ: API นี้สงวนไว้สำหรับการทดสอบและการสาธิตเท่านั้น การเปลี่ยนการตั้งค่าด้วย API นี้จะทำให้แอปพลิเคชันเวอร์ชันที่ใช้งานจริงไม่เป็นไปตามข้อกำหนดเทรด

รายละเอียด
พารามิเตอร์	[in] aInstance ตัวชี้ไปยังอินสแตนซ์ OpenThread [in] aRouterId รหัสเราเตอร์ที่จะเผยแพร่ ช่วงที่ใช้ได้คือ [0, 62]
แสดงผลค่า	OT_ERROR_NONE ปล่อยรหัสเราเตอร์เรียบร้อยแล้ว OT_ERROR_INVALID_ARGS aRouterId ไม่อยู่ในช่วง [0, 62] OT_ERROR_INVALID_STATE อุปกรณ์ไม่ได้ทำงานในฐานะผู้นำ OT_ERROR_NOT_FOUND ไม่ได้จัดสรร ID เราเตอร์ในขณะนี้

otThreadSetCcmEnabled

void otThreadSetCcmEnabled(
  otInstance *aInstance,
  bool aEnabled
)

ตั้งค่าว่าอุปกรณ์ได้รับการว่าจ้างให้ใช้ CCM หรือไม่

หมายเหตุ: API นี้ต้องใช้ OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE และใช้โดย Thread Test Harness เท่านั้นเพื่อระบุว่าอุปกรณ์นี้ได้รับการว่าจ้างให้ใช้ CCM หรือไม่

รายละเอียด
พารามิเตอร์	[in] aInstance ตัวชี้ไปยังอินสแตนซ์ OpenThread [in] aEnabled TRUE หากอุปกรณ์ได้รับมอบหมายโดยใช้ CCM หากไม่เป็นเช่นนั้น FALSE

otThreadSetChildRouterLinks

otError otThreadSetChildRouterLinks(
  otInstance *aInstance,
  uint8_t aChildRouterLinks
)

ตั้งค่าพารามิเตอร์ MLE_CHILD_ROUTER_LINKS ที่ใช้ในบทบาท REED

รายละเอียด
พารามิเตอร์	[in] aInstance ตัวชี้ไปยังอินสแตนซ์ OpenThread [in] aChildRouterLinks ค่า MLE_CHILD_ROUTER_LINKS
แสดงผลค่า	OT_ERROR_NONE กำหนดค่าสำเร็จแล้ว OT_ERROR_INVALID_STATE เปิดใช้โปรโตคอลเทรดแล้ว

ดูเพิ่มเติม:
otThreadGetChildRouterLinks

otThreadSetContextIdReuseDelay

void otThreadSetContextIdReuseDelay(
  otInstance *aInstance,
  uint32_t aDelay
)

ตั้งค่าพารามิเตอร์ CONTEXT_ID_REUSE_DELAY ที่ใช้ในบทบาทผู้นำ

หมายเหตุ: API นี้สงวนไว้สำหรับการทดสอบและการสาธิตเท่านั้น การเปลี่ยนการตั้งค่าด้วย API นี้จะทำให้แอปพลิเคชันเวอร์ชันที่ใช้งานจริงไม่เป็นไปตามข้อกำหนดเทรด

รายละเอียด
พารามิเตอร์	[in] aInstance ตัวชี้ไปยังอินสแตนซ์ OpenThread [in] aDelay ค่า CONTEXT_ID_REUSE_DELAY

ดูเพิ่มเติม:
otThreadGetContextIdReuseDelay

otThreadSetDeviceProperties

void otThreadSetDeviceProperties(
  otInstance *aInstance,
  const otDeviceProperties *aDeviceProperties
)

ตั้งค่าคุณสมบัติของอุปกรณ์ที่จะใช้กำหนดและกำหนดน้ำหนักตัวนำ

ต้องใช้ OPENTHREAD_CONFIG_MLE_DEVICE_PROPERTY_LEADER_WEIGHT_ENABLE

รายละเอียด
พารามิเตอร์	[in] aInstance ตัวชี้ไปยังอินสแตนซ์ OpenThread [in] aDeviceProperties พร็อพเพอร์ตี้ของอุปกรณ์

otThreadSetJoinerUdpPort

otError otThreadSetJoinerUdpPort(
  otInstance *aInstance,
  uint16_t aJoinerUdpPort
)

ตั้งค่าพอร์ต Joiner UDP

รายละเอียด
พารามิเตอร์	[in] aInstance ตัวชี้ไปยังอินสแตนซ์ OpenThread [in] aJoinerUdpPort หมายเลขพอร์ต UDP ของผู้เชื่อม
แสดงผลค่า	OT_ERROR_NONE ตั้งค่าพอร์ต UDP ของผู้เชื่อมสำเร็จ

ดูเพิ่มเติมที่
otThreadGetJoinerUdpPort

otThreadSetLocalLeaderWeight

void otThreadSetLocalLeaderWeight(
  otInstance *aInstance,
  uint8_t aWeight
)

ตั้งค่าน้ำหนักของตัวนำเทรดที่ใช้เมื่อทำงานในบทบาทผู้นำ

ตั้งค่าน้ำหนักของผู้นำเป็นค่าใหม่โดยตรง โดยแทนที่ค่าก่อนหน้า (ซึ่งอาจกำหนดจาก otDeviceProperties ปัจจุบัน)

รายละเอียด
พารามิเตอร์	[in] aInstance ตัวชี้ไปยังอินสแตนซ์ OpenThread [in] aWeight ค่าน้ำหนักของตัวนำชุดข้อความ

โปรดดู
otThreadGetLeaderWeight

otThreadSetMaxAllowedChildren

otError otThreadSetMaxAllowedChildren(
  otInstance *aInstance,
  uint16_t aMaxChildren
)

ตั้งค่าจำนวนสูงสุดของเด็กที่อนุญาตในปัจจุบัน

ตั้งค่าพารามิเตอร์นี้ได้เมื่อหยุดการทำงานของโปรโตคอลเทรดแล้วเท่านั้น

รายละเอียด
พารามิเตอร์	[in] aInstance ตัวชี้ไปยังอินสแตนซ์ OpenThread [in] aMaxChildren จำนวนเด็กสูงสุดที่อนุญาต
แสดงผลค่า	OT_ERROR_NONE กำหนดราคาเสนอ CPC OT_ERROR_INVALID_ARGS ถ้า aMaxChildren ไม่อยู่ในช่วง [1, OPENTHREAD_CONFIG_MLE_MAX_CHILDREN] OT_ERROR_INVALID_STATE หากเทรดไม่หยุดทำงาน

ดูเพิ่มเติมที่
otThreadGetMaxAllowedChildren

otThreadSetMaxChildIpAddresses

otError otThreadSetMaxChildIpAddresses(
  otInstance *aInstance,
  uint8_t aMaxIpAddresses
)

ตั้งค่าหรือกู้คืนจำนวนที่อยู่ IP สูงสุดที่ผู้เผยแพร่โฆษณาย่อย MTD แต่ละรายอาจลงทะเบียนกับอุปกรณ์นี้ในฐานะระดับบนสุด

ผ่าน 0 เพื่อล้างการตั้งค่าและคืนค่าเริ่มต้น

ใช้งานได้เมื่อเปิดใช้ OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE

หมายเหตุ: ใช้โดย Thread Test Harness เท่านั้นเพื่อจำกัดการลงทะเบียนที่อยู่ระดับบนสุดของข้อมูลอ้างอิงเพื่อทดสอบปฏิกิริยา MTD DUT

รายละเอียด
พารามิเตอร์	[in] aInstance ตัวชี้ไปยังอินสแตนซ์ OpenThread [in] aMaxIpAddresses จำนวนที่อยู่ IP สูงสุดที่ผู้เผยแพร่โฆษณาย่อย MTD แต่ละรายอาจลงทะเบียนกับอุปกรณ์นี้ในฐานะระดับบนสุด 0 เพื่อล้างการตั้งค่าและคืนค่าเริ่มต้น
แสดงผลค่า	OT_ERROR_NONE ตั้งค่า/ล้างหมายเลขสำเร็จแล้ว OT_ERROR_INVALID_ARGS ถ้าเกินจำนวนสูงสุดที่อนุญาต

โปรดดูเพิ่มเติมที่
otThreadGetMaxChildIpAddresses

otThreadSetNetworkIdTimeout

void otThreadSetNetworkIdTimeout(
  otInstance *aInstance,
  uint8_t aTimeout
)

ตั้งค่าพารามิเตอร์ NETWORK_ID_TIMEOUT

หมายเหตุ: API นี้สงวนไว้สำหรับการทดสอบและการสาธิตเท่านั้น การเปลี่ยนการตั้งค่าด้วย API นี้จะทำให้แอปพลิเคชันเวอร์ชันที่ใช้งานจริงไม่เป็นไปตามข้อกำหนดเทรด

รายละเอียด
พารามิเตอร์	[in] aInstance ตัวชี้ไปยังอินสแตนซ์ OpenThread [in] aTimeout ค่า NETWORK_ID_TIMEOUT

ดูเพิ่มเติม:
otThreadGetNetworkIdTimeout

otThreadSetParentPriority

otError otThreadSetParentPriority(
  otInstance *aInstance,
  int8_t aParentPriority
)

กำหนดลำดับความสำคัญของผู้ปกครอง

หมายเหตุ: API นี้สงวนไว้สำหรับการทดสอบและการสาธิตเท่านั้น การเปลี่ยนการตั้งค่าด้วย API นี้จะทำให้แอปพลิเคชันเวอร์ชันที่ใช้งานจริงไม่เป็นไปตามข้อกำหนดเทรด

รายละเอียด
พารามิเตอร์	[in] aInstance ตัวชี้ไปยังอินสแตนซ์ OpenThread [in] aParentPriority ค่าลำดับความสำคัญหลัก
แสดงผลค่า	OT_ERROR_NONE ตั้งค่าลำดับความสำคัญระดับบนสุดเรียบร้อยแล้ว OT_ERROR_INVALID_ARGS หากค่าลำดับความสำคัญหลักไม่อยู่ระหว่าง 1, 0, -1 และ -2

ดูเพิ่มเติมที่
otThreadGetParentPriority

otThreadSetPreferredLeaderPartitionId

void otThreadSetPreferredLeaderPartitionId(
  otInstance *aInstance,
  uint32_t aPartitionId
)

ตั้งค่ารหัสพาร์ติชันของผู้นำเทรดที่ต้องการเมื่อใช้ในบทบาทผู้นำ

รายละเอียด
พารามิเตอร์	[in] aInstance ตัวชี้ไปยังอินสแตนซ์ OpenThread [in] aPartitionId ค่ารหัสพาร์ติชันของตัวนําเทรด

otThreadSetPreferredRouterId

otError otThreadSetPreferredRouterId(
  otInstance *aInstance,
  uint8_t aRouterId
)

ตั้งค่ารหัสเราเตอร์ที่ต้องการ

เมื่อได้เป็นเราเตอร์/ผู้นำ โหนดจะพยายามใช้รหัสเราเตอร์นี้ หากไม่ได้กำหนดรหัสเราเตอร์ที่ต้องการหรือไม่สามารถใช้ได้ ระบบจะเลือกรหัสเราเตอร์ที่สร้างขึ้นแบบสุ่ม ตั้งค่าพร็อพเพอร์ตี้นี้ได้เฉพาะเมื่อปลดหรือปิดใช้บทบาทในอุปกรณ์เท่านั้น

หมายเหตุ: API นี้สงวนไว้สำหรับการทดสอบและการสาธิตเท่านั้น การเปลี่ยนการตั้งค่าด้วย API นี้จะทำให้แอปพลิเคชันเวอร์ชันที่ใช้งานจริงไม่เป็นไปตามข้อกำหนดเทรด

รายละเอียด
พารามิเตอร์	[in] aInstance ตัวชี้ไปยังอินสแตนซ์ OpenThread [in] aRouterId รหัสเราเตอร์ที่ต้องการ
แสดงผลค่า	OT_ERROR_NONE ตั้งค่ารหัสเราเตอร์ที่ต้องการสำเร็จแล้ว OT_ERROR_INVALID_STATE ไม่สามารถตั้งค่า (ไม่ได้ปลดหรือปิดใช้งานบทบาท)

otThreadSetPskc

otError otThreadSetPskc(
  otInstance *aInstance,
  const otPskc *aPskc
)

ตั้งค่าเทรด PSKc

จะสำเร็จก็ต่อเมื่อปิดใช้โปรโตคอลเทรด การเรียกใช้ฟังก์ชันนี้ที่สำเร็จจะทำให้ชุดข้อมูลการทำงานที่ใช้งานอยู่และรอดำเนินการในหน่วยความจำที่ไม่ผันผวนด้วย

รายละเอียด
พารามิเตอร์	[in] aInstance ตัวชี้ไปยังอินสแตนซ์ OpenThread [in] aPskc ตัวชี้ไปยัง Thread PSKc ใหม่
แสดงผลค่า	OT_ERROR_NONE ตั้งค่า Thread PSKc เรียบร้อยแล้ว OT_ERROR_INVALID_STATE เปิดใช้โปรโตคอลเทรดแล้ว

ดูเพิ่มเติม:
otThreadGetPskc

otThreadSetPskcRef

otError otThreadSetPskcRef(
  otInstance *aInstance,
  otPskcRef aKeyRef
)

ตั้งค่าการอ้างอิงคีย์เป็นเทรด PSKc

ต้องเปิดใช้ฟีเจอร์ OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE เวอร์ชันสำหรับบิวด์

จะสำเร็จก็ต่อเมื่อปิดใช้โปรโตคอลเทรด เมื่อเสร็จสิ้น การดำเนินการนี้จะทำให้ชุดข้อมูลการทำงานที่ใช้งานอยู่และรอดำเนินการในหน่วยความจำที่ไม่ผันผวนด้วย

รายละเอียด
พารามิเตอร์	[in] aInstance ตัวชี้ไปยังอินสแตนซ์ OpenThread [in] aKeyRef ข้อมูลอ้างอิงสำคัญสำหรับ Thread PSKc ใหม่
แสดงผลค่า	OT_ERROR_NONE ตั้งค่า Thread PSKc เรียบร้อยแล้ว OT_ERROR_INVALID_STATE เปิดใช้โปรโตคอลเทรดแล้ว

ดูเพิ่มเติม:
otThreadGetPskcRef

otThreadSetRouterDowngradeThreshold

void otThreadSetRouterDowngradeThreshold(
  otInstance *aInstance,
  uint8_t aThreshold
)

ตั้งค่าพารามิเตอร์ ROUTER_DOWNGRADE_THRESHOLD ที่ใช้ในบทบาทผู้นำ

หมายเหตุ: API นี้สงวนไว้สำหรับการทดสอบและการสาธิตเท่านั้น การเปลี่ยนการตั้งค่าด้วย API นี้จะทำให้แอปพลิเคชันเวอร์ชันที่ใช้งานจริงไม่เป็นไปตามข้อกำหนดเทรด

รายละเอียด
พารามิเตอร์	[in] aInstance ตัวชี้ไปยังอินสแตนซ์ OpenThread [in] aThreshold ค่า ROUTER_DOWNGRADE_THRESHOLD

โปรดดูข้อมูลเพิ่มเติมที่
otThreadGetRouterDowngradeThreshold

otThreadSetRouterEligible

otError otThreadSetRouterEligible(
  otInstance *aInstance,
  bool aEligible
)

ตั้งค่าว่าอุปกรณ์มีสิทธิ์ใช้เราเตอร์หรือไม่

หากตั้งค่า aEligible เป็น "เท็จ" และอุปกรณ์ทำงานเป็นเราเตอร์อยู่ การเรียกนี้จะทำให้อุปกรณ์ถอดออกและพยายามเชื่อมต่อใหม่เมื่อเป็นเด็ก

รายละเอียด
พารามิเตอร์	[in] aInstance ตัวชี้ไปยังอินสแตนซ์ OpenThread [in] aEligible TRUE เพื่อกำหนดค่าอุปกรณ์ว่ามีสิทธิ์ใช้เราเตอร์ มิฉะนั้นจะเป็น FALSE
แสดงผลค่า	OT_ERROR_NONE กำหนดค่าที่ใช้กับเราเตอร์ได้เรียบร้อยแล้ว OT_ERROR_NOT_CAPABLE อุปกรณ์ไม่สามารถกลายเป็นเราเตอร์ได้

otThreadSetRouterIdRange

otError otThreadSetRouterIdRange(
  otInstance *aInstance,
  uint8_t aMinRouterId,
  uint8_t aMaxRouterId
)

ตั้งค่าช่วงของรหัสเราเตอร์ที่ได้รับอนุญาตให้กำหนดให้กับโหนดภายในเครือข่ายเทรด

หมายเหตุ: API นี้ต้องใช้ OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE และใช้เพื่อจุดประสงค์ในการทดสอบเท่านั้น อนุญาตให้ใช้รหัสเราเตอร์ทั้งหมดในช่วง [aMinRouterId, aMaxRouterId]

รายละเอียด
พารามิเตอร์	[in] aInstance ตัวชี้ไปยังอินสแตนซ์ OpenThread [in] aMinRouterId รหัสเราเตอร์ขั้นต่ำ [in] aMaxRouterId รหัสเราเตอร์สูงสุด
แสดงผลค่า	OT_ERROR_NONE ตั้งค่าช่วงสำเร็จแล้ว OT_ERROR_INVALID_ARGS aMinRouterId > aMaxRouterId หรือช่วงไม่ได้ครอบคลุมอยู่ใน [0, 62]

ดูเพิ่มเติม:
otThreadGetRouterIdRange

otThreadSetRouterSelectionJitter

void otThreadSetRouterSelectionJitter(
  otInstance *aInstance,
  uint8_t aRouterJitter
)

ตั้งค่าพารามิเตอร์ ROUTER_SELECTION_JITTER ที่ใช้ในบทบาท REED/เราเตอร์

หมายเหตุ: API นี้สงวนไว้สำหรับการทดสอบและการสาธิตเท่านั้น การเปลี่ยนการตั้งค่าด้วย API นี้จะทำให้แอปพลิเคชันเวอร์ชันที่ใช้งานจริงไม่เป็นไปตามข้อกำหนดเทรด

รายละเอียด
พารามิเตอร์	[in] aInstance ตัวชี้ไปยังอินสแตนซ์ OpenThread [in] aRouterJitter ค่า ROUTER_SELECTION_JITTER

ดูเพิ่มเติม:
otThreadGetRouterSelectionJitter

otThreadSetRouterUpgradeThreshold

void otThreadSetRouterUpgradeThreshold(
  otInstance *aInstance,
  uint8_t aThreshold
)

ตั้งค่าพารามิเตอร์ ROUTER_UPGRADE_THRESHOLD ที่ใช้ในบทบาทผู้นำ

หมายเหตุ: API นี้สงวนไว้สำหรับการทดสอบและการสาธิตเท่านั้น การเปลี่ยนการตั้งค่าด้วย API นี้จะทำให้แอปพลิเคชันเวอร์ชันที่ใช้งานจริงไม่เป็นไปตามข้อกำหนดเทรด

รายละเอียด
พารามิเตอร์	[in] aInstance ตัวชี้ไปยังอินสแตนซ์ OpenThread [in] aThreshold ค่า ROUTER_UPGRADE_THRESHOLD

โปรดดูข้อมูลเพิ่มเติมที่
otThreadGetRouterUpgradeThreshold

otThreadSetSteeringData

void otThreadSetSteeringData(
  otInstance *aInstance,
  const otExtAddress *aExtAddress
)

ตั้งค่าข้อมูลพวงมาลัยอยู่นอกย่านความถี่

ควรตั้งค่าตัวเลือกการกำหนดค่า OPENTHREAD_CONFIG_MLE_STEERING_DATA_SET_OOB_ENABLE เพื่อเปิดใช้การตั้งค่าการส่งข้อมูลนอกย่านความถี่

รายละเอียด
พารามิเตอร์	[in] aInstance ตัวชี้ไปยังอินสแตนซ์ OpenThread [in] aExtAddress ที่อยู่ที่ใช้อัปเดตข้อมูลพวงมาลัย ใช้เลข 0 ทั้งหมดเพื่อล้างข้อมูลพวงมาลัย (ไม่มีข้อมูลพวงมาลัย) 0xFF ทั้งหมดเพื่อตั้งค่าตัวกรองข้อมูล/เบ่งบาน ให้ยอมรับ/อนุญาตทั้งหมด EUI64 ที่เจาะจงซึ่งระบบจะเพิ่มลงในตัวกรองข้อมูล/บลูมพวงมาลัยปัจจุบัน

otThreadSetThreadVersionCheckEnabled

void otThreadSetThreadVersionCheckEnabled(
  otInstance *aInstance,
  bool aEnabled
)

กำหนดว่าจะเปิดใช้เกณฑ์เวอร์ชัน TLV ของนโยบายความปลอดภัยสำหรับการกำหนดเส้นทาง (ฟิลด์ VR) หรือไม่

หมายเหตุ: API นี้ต้องใช้ OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE และใช้โดย Thread Test Harness เท่านั้นเพื่อระบุว่าควรข้าม VR การตรวจสอบเวอร์ชันโปรโตคอลเทรด

รายละเอียด
พารามิเตอร์	[in] aInstance ตัวชี้ไปยังอินสแตนซ์ OpenThread [in] aEnabled TRUE เพื่อเปิดใช้เกณฑ์เวอร์ชัน TLV ของนโยบายความปลอดภัยสำหรับการกำหนดเส้นทาง FALSE ในกรณีอื่นๆ

มาโคร

OT_CHILD_IP6_ADDRESS_ITERATOR_INIT

 OT_CHILD_IP6_ADDRESS_ITERATOR_INIT 0

Initializer สำหรับ otChildIP6AddressIterator

แหล่งข้อมูล

หัวข้ออ้างอิง API ของ OpenThread จะมาจากซอร์สโค้ดซึ่งพร้อมใช้งานใน GitHub ดูข้อมูลเพิ่มเติมหรือมีส่วนร่วมในเอกสารประกอบของเราได้ที่แหล่งข้อมูล