ตัวอย่าง

โมดูลนี้มีฟังก์ชั่นที่ควบคุมอินสแตนซ์ OpenThread

สรุป

enumerations
anonymous enum { OT_CHANGED_IP6_ADDRESS_ADDED = 1 << 0, OT_CHANGED_IP6_ADDRESS_REMOVED = 1 << 1, OT_CHANGED_THREAD_ROLE = 1 << 2, OT_CHANGED_THREAD_LL_ADDR = 1 << 3, OT_CHANGED_THREAD_ML_ADDR = 1 << 4, OT_CHANGED_THREAD_RLOC_ADDED = 1 << 5, OT_CHANGED_THREAD_RLOC_REMOVED = 1 << 6, OT_CHANGED_THREAD_PARTITION_ID = 1 << 7, OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER = 1 << 8, OT_CHANGED_THREAD_NETDATA = 1 << 9, OT_CHANGED_THREAD_CHILD_ADDED = 1 << 10, OT_CHANGED_THREAD_CHILD_REMOVED = 1 << 11, OT_CHANGED_IP6_MULTICAST_SUBSCRIBED = 1 << 12, OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED = 1 << 13, OT_CHANGED_THREAD_CHANNEL = 1 << 14, OT_CHANGED_THREAD_PANID = 1 << 15, OT_CHANGED_THREAD_NETWORK_NAME = 1 << 16, OT_CHANGED_THREAD_EXT_PANID = 1 << 17, OT_CHANGED_MASTER_KEY = 1 << 18, OT_CHANGED_PSKC = 1 << 19, OT_CHANGED_SECURITY_POLICY = 1 << 20, OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL = 1 << 21, OT_CHANGED_SUPPORTED_CHANNEL_MASK = 1 << 22, OT_CHANGED_COMMISSIONER_STATE = 1 << 23, OT_CHANGED_THREAD_NETIF_STATE = 1 << 24, OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE = 1 << 25, OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL = 1 << 26, OT_CHANGED_JOINER_STATE = 1 << 27 }	enum การแจงนับนี้กำหนดค่าสถานะที่ส่งผ่านเป็นส่วนหนึ่งของ `otStateChangedCallback`

enumerations

anonymous enum { 
 OT_CHANGED_IP6_ADDRESS_ADDED = 1 << 0, 
 OT_CHANGED_IP6_ADDRESS_REMOVED = 1 << 1, 
 OT_CHANGED_THREAD_ROLE = 1 << 2, 
 OT_CHANGED_THREAD_LL_ADDR = 1 << 3, 
 OT_CHANGED_THREAD_ML_ADDR = 1 << 4, 
 OT_CHANGED_THREAD_RLOC_ADDED = 1 << 5, 
 OT_CHANGED_THREAD_RLOC_REMOVED = 1 << 6, 
 OT_CHANGED_THREAD_PARTITION_ID = 1 << 7, 
 OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER = 1 << 8, 
 OT_CHANGED_THREAD_NETDATA = 1 << 9, 
 OT_CHANGED_THREAD_CHILD_ADDED = 1 << 10, 
 OT_CHANGED_THREAD_CHILD_REMOVED = 1 << 11, 
 OT_CHANGED_IP6_MULTICAST_SUBSCRIBED = 1 << 12, 
 OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED = 1 << 13, 
 OT_CHANGED_THREAD_CHANNEL = 1 << 14, 
 OT_CHANGED_THREAD_PANID = 1 << 15, 
 OT_CHANGED_THREAD_NETWORK_NAME = 1 << 16, 
 OT_CHANGED_THREAD_EXT_PANID = 1 << 17, 
 OT_CHANGED_MASTER_KEY = 1 << 18, 
 OT_CHANGED_PSKC = 1 << 19, 
 OT_CHANGED_SECURITY_POLICY = 1 << 20, 
 OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL = 1 << 21, 
 OT_CHANGED_SUPPORTED_CHANNEL_MASK = 1 << 22, 
 OT_CHANGED_COMMISSIONER_STATE = 1 << 23, 
 OT_CHANGED_THREAD_NETIF_STATE = 1 << 24, 
 OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE = 1 << 25, 
 OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL = 1 << 26, 
 OT_CHANGED_JOINER_STATE = 1 << 27 
 }

enum

การแจงนับนี้กำหนดค่าสถานะที่ส่งผ่านเป็นส่วนหนึ่งของ otStateChangedCallback

typedefs
`otChangedFlags`	typedef `uint32_t` ชนิดนี้แสดงถึงบิตฟิลด์ที่ระบุสถานะ / การกำหนดค่าเฉพาะที่เปลี่ยนแปลง
`otInstance`	typedef `struct otInstance` โครงสร้างนี้แสดงถึงโครงสร้างอินสแตนซ์ OpenThread
`otStateChangedCallback )(otChangedFlags aFlags, void *aContext)`	typedef `void(*` ตัวชี้ฟังก์ชันนี้ถูกเรียกใช้เพื่อแจ้งการกำหนดค่าบางอย่างหรือการเปลี่ยนแปลงสถานะภายใน OpenThread

ฟังก์ชั่น
`otGetRadioVersionString ( otInstance *aInstance)`	`const char *` ฟังก์ชั่นนี้รับสตริงเวอร์ชั่นวิทยุ OpenThread
`otGetVersionString (void)`	`const char *` ฟังก์ชั่นนี้ได้รับสตริงรุ่น OpenThread
`otInstanceErasePersistentInfo ( otInstance *aInstance)`	`otError` ฟังก์ชั่นนี้จะลบข้อมูลถาวร OpenThread ทั้งหมด (การตั้งค่าเครือข่าย) ที่เก็บไว้ในหน่วยความจำที่ไม่ลบเลือน
`otInstanceFactoryReset ( otInstance *aInstance)`	`void` วิธีนี้จะลบการตั้งค่าทั้งหมดที่เก็บไว้ในหน่วยความจำที่ไม่ลบเลือนแล้วทริกเกอร์การรีเซ็ตแพลตฟอร์ม
`otInstanceFinalize ( otInstance *aInstance)`	`void` ฟังก์ชันนี้ปิดใช้งานไลบรารี OpenThread
`otInstanceInit (void aInstanceBuffer, size_t aInstanceBufferSize)`	`otInstance *` ฟังก์ชันนี้เริ่มต้นไลบรารี OpenThread
`otInstanceInitSingle (void)`	`otInstance *` ฟังก์ชันนี้เริ่มต้นอินสแตนซ์เดียวแบบคงที่ของไลบรารี OpenThread
`otInstanceIsInitialized ( otInstance *aInstance)`	`bool` ฟังก์ชั่นนี้ระบุว่าอินสแตนซ์นั้นถูกต้อง / เริ่มต้น
`otInstanceReset ( otInstance *aInstance)`	`void` วิธีนี้เรียกใช้การรีเซ็ตแพลตฟอร์ม
`otRemoveStateChangeCallback ( otInstance aInstance, otStateChangedCallback aCallback, void aContext)`	`void` ฟังก์ชั่นนี้จะลบการติดต่อกลับเพื่อระบุว่าการกำหนดค่าบางอย่างหรือสถานะการเปลี่ยนแปลงภายใน OpenThread
`otSetStateChangedCallback ( otInstance aInstance, otStateChangedCallback aCallback, void aContext)`	`otError` ฟังก์ชั่นนี้ลงทะเบียนการโทรกลับเพื่อระบุว่าการกำหนดค่าบางอย่างหรือสถานะการเปลี่ยนแปลงภายใน OpenThread

enumerations

ระบุ Enum

 anonymous enum

การแจงนับนี้กำหนดค่าสถานะที่ส่งผ่านเป็นส่วนหนึ่งของ otStateChangedCallback

คุณสมบัติ
`OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL`	Channel Manager ช่องทางเธรดที่รอดำเนินการใหม่มีการเปลี่ยนแปลง
`OT_CHANGED_COMMISSIONER_STATE`	เปลี่ยนสถานะผู้บัญชาการ
`OT_CHANGED_IP6_ADDRESS_ADDED`	เพิ่มที่อยู่ IPv6 แล้ว
`OT_CHANGED_IP6_ADDRESS_REMOVED`	ลบที่อยู่ IPv6 แล้ว
`OT_CHANGED_IP6_MULTICAST_SUBSCRIBED`	สมัครสมาชิกไปยังที่อยู่มัลติคาสต์ IPv6
`OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED`	ยกเลิกการสมัครจากที่อยู่มัลติคาสต์ IPv6
`OT_CHANGED_JOINER_STATE`	เปลี่ยนสถานะช่างไม้แล้ว
`OT_CHANGED_MASTER_KEY`	เปลี่ยนมาสเตอร์คีย์แล้ว
`OT_CHANGED_PSKC`	เปลี่ยน PSKc แล้ว
`OT_CHANGED_SECURITY_POLICY`	นโยบายความปลอดภัยมีการเปลี่ยนแปลง
`OT_CHANGED_SUPPORTED_CHANNEL_MASK`	รูปแบบช่องที่รองรับเปลี่ยนไป
`OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL`	เปลี่ยนการกำหนดค่า Local Backbone Router
`OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE`	สถานะของ Backbone Router เปลี่ยนแปลงแล้ว
`OT_CHANGED_THREAD_CHANNEL`	ช่องทางเครือข่ายเธรดเปลี่ยนไป
`OT_CHANGED_THREAD_CHILD_ADDED`	เพิ่มเด็กแล้ว
`OT_CHANGED_THREAD_CHILD_REMOVED`	เด็กถูกลบ
`OT_CHANGED_THREAD_EXT_PANID`	เปลี่ยน PAN ID แบบขยายเครือข่ายเธรดแล้ว
`OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER`	ลำดับของคีย์เธรดเปลี่ยนไป
`OT_CHANGED_THREAD_LL_ADDR`	ที่อยู่ลิงค์ท้องถิ่นมีการเปลี่ยนแปลง
`OT_CHANGED_THREAD_ML_ADDR`	ที่อยู่ตาข่ายท้องถิ่นมีการเปลี่ยนแปลง
`OT_CHANGED_THREAD_NETDATA`	เปลี่ยนข้อมูลเครือข่ายเธรดแล้ว
`OT_CHANGED_THREAD_NETIF_STATE`	สถานะของอินเตอร์เฟสเครือข่ายเธรดเปลี่ยนไป
`OT_CHANGED_THREAD_NETWORK_NAME`	เปลี่ยนชื่อเครือข่ายเธรดแล้ว
`OT_CHANGED_THREAD_PANID`	เปลี่ยนรหัส PAN ของเครือข่ายเธรดแล้ว
`OT_CHANGED_THREAD_PARTITION_ID`	ID พาร์ติชันมีการเปลี่ยนแปลง
`OT_CHANGED_THREAD_RLOC_ADDED`	เพิ่ม RLOC แล้ว
`OT_CHANGED_THREAD_RLOC_REMOVED`	ลบ RLOC แล้ว
`OT_CHANGED_THREAD_ROLE`	เปลี่ยนบทบาท (ปิดใช้งาน, แยกออก, เด็ก, เราเตอร์, ผู้นำ)

typedefs

otChangedFlags

uint32_t otChangedFlags

ประเภทนี้แสดงถึงบิตฟิลด์ที่ระบุสถานะ / การกำหนดค่าเฉพาะที่เปลี่ยนแปลง

ดูคำจำกัดความ OT_CHANGED_*

otInstance

struct otInstance otInstance

โครงสร้างนี้แสดงถึงโครงสร้างอินสแตนซ์ OpenThread

otStateChangedCallback

void(* otStateChangedCallback)(otChangedFlags aFlags, void *aContext)

ตัวชี้ฟังก์ชันนี้ถูกเรียกใช้เพื่อแจ้งการกำหนดค่าบางอย่างหรือการเปลี่ยนแปลงสถานะภายใน OpenThread

รายละเอียด

พารามิเตอร์

`[in] aFlags`	บิตฟิลด์ที่ระบุสถานะที่เปลี่ยนแปลง ดูคำจำกัดความ `OT_CHANGED_*`
`[in] aContext`	ตัวชี้ไปยังบริบทเฉพาะแอปพลิเคชัน

ฟังก์ชั่น

otGetRadioVersionString

const char * otGetRadioVersionString(
  otInstance *aInstance
)

ฟังก์ชั่นนี้รับสตริงเวอร์ชั่นวิทยุ OpenThread

รายละเอียด

พารามิเตอร์

[in] aInstance

ตัวชี้ไปยังอินสแตนซ์ OpenThread

ผลตอบแทน

ตัวชี้ไปยังรุ่นวิทยุ OpenThread

otGetVersionString

const char * otGetVersionString(
  void
)

ฟังก์ชั่นนี้ได้รับสตริงรุ่น OpenThread

รายละเอียด
ผลตอบแทน	ตัวชี้ไปยังรุ่น OpenThread

otInstanceErasePersistentInfo

 otError otInstanceErasePersistentInfo(
  otInstance *aInstance
)

ฟังก์ชั่นนี้จะลบข้อมูลถาวร OpenThread ทั้งหมด (การตั้งค่าเครือข่าย) ที่เก็บไว้ในหน่วยความจำที่ไม่ลบเลือน

การลบจะสำเร็จก็ต่อเมื่ออุปกรณ์อยู่ในสถานะ / บทบาทที่ disabled

รายละเอียด

พารามิเตอร์

[in] aInstance

ตัวชี้ไปยังอินสแตนซ์ OpenThread

คืนค่า

`OT_ERROR_NONE`	ข้อมูล / สถานะถาวรทั้งหมดถูกลบเรียบร้อยแล้ว
`OT_ERROR_INVALID_STATE`	อุปกรณ์ไม่ได้อยู่ในสถานะ / บทบาทที่ `disabled`

otInstanceFactoryReset

void otInstanceFactoryReset(
  otInstance *aInstance
)

วิธีนี้จะลบการตั้งค่าทั้งหมดที่เก็บไว้ในหน่วยความจำที่ไม่ลบเลือนแล้วทริกเกอร์การรีเซ็ตแพลตฟอร์ม

รายละเอียด

พารามิเตอร์

[in] aInstance

ตัวชี้ไปยังอินสแตนซ์ OpenThread

otInstanceFinalize

void otInstanceFinalize(
  otInstance *aInstance
)

ฟังก์ชันนี้ปิดใช้งานไลบรารี OpenThread

เรียกใช้ฟังก์ชันนี้เมื่อไม่ได้ใช้งาน OpenThread

รายละเอียด

พารามิเตอร์

[in] aInstance

ตัวชี้ไปยังอินสแตนซ์ OpenThread

otInstanceInit

 otInstance * otInstanceInit(
  void *aInstanceBuffer,
  size_t *aInstanceBufferSize
)

ฟังก์ชันนี้เริ่มต้นไลบรารี OpenThread

ฟังก์ชั่นนี้เริ่มต้น OpenThread และเตรียมความพร้อมสำหรับการโทร OpenThread API ครั้งต่อไป ฟังก์ชั่นนี้จะต้องถูกเรียกก่อนที่จะมีการโทรไปยัง OpenThread อื่น ๆ

ฟังก์ชั่นนี้สามารถใช้งานได้และสามารถใช้งานได้ก็ต่อเมื่อรองรับ OpenThread อินสแตนซ์หลายตัวเท่านั้น

รายละเอียด

พารามิเตอร์

`[in] aInstanceBuffer`	บัฟเฟอร์สำหรับ OpenThread เพื่อใช้สำหรับการจัดสรรโครงสร้าง otInstance
`[in,out] aInstanceBufferSize`	บนอินพุตขนาดของ aInstanceBuffer บนเอาต์พุตหากพื้นที่ไม่เพียงพอสำหรับ otInstance จำนวนไบต์ที่จำเป็นสำหรับ otInstance

ผลตอบแทน

ตัวชี้ไปยังอินสแตนซ์ OpenThread ใหม่

ดูสิ่งนี้ด้วย:
otInstanceFinalize

otInstanceInitSingle

 otInstance * otInstanceInitSingle(
  void
)

ฟังก์ชันนี้เริ่มต้นอินสแตนซ์เดียวแบบคงที่ของไลบรารี OpenThread

ฟังก์ชั่นนี้สามารถใช้งานได้และสามารถใช้งานได้เฉพาะเมื่อการสนับสนุนอินสแตนซ์ OpenThread หลายรายการถูกปิดใช้งาน

รายละเอียด
ผลตอบแทน	ตัวชี้ไปยังอินสแตนซ์ OpenThread เดียว

otInstanceIsInitialized

bool otInstanceIsInitialized(
  otInstance *aInstance
)

ฟังก์ชั่นนี้บ่งชี้ว่าอินสแตนซ์ที่ถูกต้อง / เริ่มต้น

อินสแตนซ์นั้นถือว่าถูกต้องหากได้รับมาและเริ่มต้นโดยใช้ otInstanceInitSingle() (ในกรณีอินสแตนซ์เดี่ยว) หรือ otInstanceInit() (ในกรณีอินสแตนซ์หลายกรณี) การเรียกไปยัง otInstanceFinalize() ทำให้อินสแตนซ์ถูกพิจารณา otInstanceFinalize() กำหนดค่าเริ่มต้น

รายละเอียด

พารามิเตอร์

[in] aInstance

ตัวชี้ไปยังอินสแตนซ์ OpenThread

ผลตอบแทน

TRUE หากอินสแตนซ์ที่ให้มานั้นถูกต้อง / เริ่มต้นให้เป็น FALSE มิฉะนั้น

otInstanceReset

void otInstanceReset(
  otInstance *aInstance
)

วิธีนี้เรียกใช้การรีเซ็ตแพลตฟอร์ม

กระบวนการรีเซ็ตทำให้มั่นใจได้ว่าสถานะ / ข้อมูล OpenThread ทั้งหมด (ที่เก็บไว้ในหน่วยความจำระเหย) จะถูกลบ โปรดทราบว่า otPlatformReset จะไม่ลบสถานะ / ข้อมูลถาวรใด ๆ ที่บันทึกไว้ในหน่วยความจำที่ไม่ลบเลือน

รายละเอียด

พารามิเตอร์

[in] aInstance

ตัวชี้ไปยังอินสแตนซ์ OpenThread

otRemoveStateChangeCallback

void otRemoveStateChangeCallback(
  otInstance *aInstance,
  otStateChangedCallback aCallback,
  void *aContext
)

ฟังก์ชั่นนี้จะลบการติดต่อกลับเพื่อระบุว่าการกำหนดค่าบางอย่างหรือสถานะการเปลี่ยนแปลงภายใน OpenThread

รายละเอียด

พารามิเตอร์

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

otSetStateChangedCallback

 otError otSetStateChangedCallback(
  otInstance *aInstance,
  otStateChangedCallback aCallback,
  void *aContext
)

ฟังก์ชั่นนี้ลงทะเบียนการโทรกลับเพื่อระบุว่าการกำหนดค่าบางอย่างหรือสถานะการเปลี่ยนแปลงภายใน OpenThread

รายละเอียด

พารามิเตอร์

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

คืนค่า

`OT_ERROR_NONE`	เพิ่มการโทรกลับไปยังรายการโทรกลับ
`OT_ERROR_ALREADY`	การโทรกลับได้รับการลงทะเบียนแล้ว
`OT_ERROR_NO_BUFS`	ไม่สามารถเพิ่มการโทรกลับเนื่องจากข้อ จำกัด ของทรัพยากร