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

อินสแตนซ์

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

สรุป

การแจกแจง

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_NETWORK_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,
  OT_CHANGED_ACTIVE_DATASET = 1 << 28,
  OT_CHANGED_PENDING_DATASET = 1 << 29,
  OT_CHANGED_NAT64_TRANSLATOR_STATE = 1 << 30
}
enum
การแจกแจงนี้กําหนดแฟล็กที่ส่งผ่านเป็นส่วนหนึ่งของ otStateChangedCallback

ประเภทการแก้ไข

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

ฟังก์ชัน

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

การแจกแจง

enum นิรนาม

 anonymous enum

การแจกแจงนี้กําหนดแฟล็กที่ส่งผ่านเป็นส่วนหนึ่งของ otStateChangedCallback

พร็อพเพอร์ตี้
OT_CHANGED_ACTIVE_DATASET

เปลี่ยนชุดข้อมูลการดําเนินการที่ใช้งานอยู่แล้ว

OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL

มีการเปลี่ยนแปลงช่องชุดข้อความใหม่ที่รอดําเนินการของเครื่องมือจัดการช่อง

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_NAT64_TRANSLATOR_STATE

สถานะนักแปล NAT64 มีการเปลี่ยนแปลง

OT_CHANGED_NETWORK_KEY

เปลี่ยนคีย์เครือข่ายแล้ว

OT_CHANGED_PENDING_DATASET

มีการเปลี่ยนแปลงชุดข้อมูลการดําเนินการที่รอดําเนินการ

OT_CHANGED_PSKC

เปลี่ยน PSKc แล้ว

OT_CHANGED_SECURITY_POLICY

เปลี่ยนนโยบายความปลอดภัยแล้ว

OT_CHANGED_SUPPORTED_CHANNEL_MASK

เปลี่ยนมาสก์ของช่องที่รองรับแล้ว

OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL

เปลี่ยนการกําหนดค่าเราเตอร์ Backbone ในเครื่องแล้ว

OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE

เปลี่ยนสถานะเราเตอร์ Backbone แล้ว

OT_CHANGED_THREAD_CHANNEL

เปลี่ยนช่องของเครือข่ายเทรดแล้ว

OT_CHANGED_THREAD_CHILD_ADDED

เพิ่มบุตรหลานแล้ว

OT_CHANGED_THREAD_CHILD_REMOVED

นําบุตรหลานออกแล้ว

OT_CHANGED_THREAD_EXT_PANID

เปลี่ยนรหัส PAN เพื่อขยายเครือข่ายเทรดแล้ว

OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER

เปลี่ยนลําดับชุดข้อความแล้ว

OT_CHANGED_THREAD_LL_ADDR

เปลี่ยนที่อยู่ท้องถิ่นของลิงก์แล้ว

OT_CHANGED_THREAD_ML_ADDR

ที่อยู่ Mesh-Local มีการเปลี่ยนแปลง

OT_CHANGED_THREAD_NETDATA

ข้อมูลเครือข่ายเทรดมีการเปลี่ยนแปลง

OT_CHANGED_THREAD_NETIF_STATE

สถานะอินเทอร์เฟซเครือข่ายเทรดมีการเปลี่ยนแปลง

OT_CHANGED_THREAD_NETWORK_NAME

เปลี่ยนชื่อเครือข่ายเทรดแล้ว

OT_CHANGED_THREAD_PANID

เปลี่ยนรหัส PAN ของเครือข่ายเทรดแล้ว

OT_CHANGED_THREAD_PARTITION_ID

เปลี่ยนรหัสพาร์ติชันแล้ว

OT_CHANGED_THREAD_RLOC_ADDED

เพิ่ม RLOC แล้ว

OT_CHANGED_THREAD_RLOC_REMOVED

นํา RLOC ออกแล้ว

OT_CHANGED_THREAD_ROLE

บทบาท (ปิดใช้ แยกออก ย่อย เราเตอร์ ผู้นํา) มีการเปลี่ยนแปลง

ประเภทการแก้ไข

otChangedFlags

uint32_t otChangedFlags

ประเภทนี้แสดงช่องบิตที่แสดงสถานะ/การกําหนดค่าที่เจาะจงที่มีการเปลี่ยนแปลง

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

OTInstance

struct otInstance otInstance

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

OTState เปลี่ยนการเรียกกลับ

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

otInstanceDeletePersistentInfo

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

otInstanceGetUptime

uint64_t otInstanceGetUptime(
  otInstance *aInstance
)

ฟังก์ชันนี้จะแสดงผลระยะเวลาทํางานของอินสแตนซ์ปัจจุบัน (หน่วยเป็นมิลลิวินาที)

ต้องเปิดใช้ OPENTHREAD_CONFIG_UPTIME_ENABLE ฟังก์ชันนี้

ระยะเวลาทํางานจะระบุเป็นจํานวนมิลลิวินาทีนับตั้งแต่เริ่มต้นอินสแตนซ์ OpenThread

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

otInstanceGetUptimeAsString

void otInstanceGetUptimeAsString(
  otInstance *aInstance,
  char *aBuffer,
  uint16_t aSize
)

ฟังก์ชันนี้จะแสดงผลระยะเวลาทํางานของอินสแตนซ์ปัจจุบันเป็นสตริงที่มนุษย์อ่านได้

ต้องเปิดใช้ OPENTHREAD_CONFIG_UPTIME_ENABLE ฟังก์ชันนี้

สตริงจะอยู่ในรูปแบบ "::"" สําหรับชั่วโมง นาที วินาที และมิลลิวินาที (หากระยะเวลาทํางานสั้นกว่า 1 วัน) หรือ "

ง.::." (หากเกิน 1 วัน)

หากสตริงผลลัพธ์ไม่พอดีกับ aBuffer (ภายในอักขระ aSize ตัว) สตริงจะถูกตัดออก แต่สตริงที่แสดงผลลัพธ์จะเป็นค่าว่างเสมอ

รายละเอียด
พารามิเตอร์
[in] aInstance
ตัวชี้ไปยังอินสแตนซ์ OpenThread
[out] aBuffer
ตัวชี้ไปยังอาร์เรย์อักขระเพื่อแสดงผลลัพธ์สตริง
[in] aSize
ขนาด aBuffer (หน่วยเป็นไบต์) แนะนําให้ใช้ OT_UPTIME_STRING_SIZE

otInstanceInit

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

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

ฟังก์ชันนี้จะเริ่มต้น Openthread API และเตรียมพร้อมสําหรับการเรียก OpenThread API ที่ตามมา ต้องเรียกใช้ฟังก์ชันนี้ก่อนการเรียกใช้ OpenThread อื่นๆ

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

รายละเอียด
พารามิเตอร์
[in] aInstanceBuffer
บัฟเฟอร์สําหรับ OpenThread ที่จะใช้เพื่อจัดสรรโครงสร้าง otInstance
[in,out] aInstanceBufferSize
ขนาดของ a InstanceBuffer เมื่ออินพุต บนเอาต์พุต หากมีพื้นที่ว่างสําหรับ otInst ไม่เพียงพอ จํานวนไบต์ที่จําเป็นสําหรับ otInstance
การคืนสินค้า
ตัวชี้ไปยังอินสแตนซ์ OpenThread ใหม่
ดูเพิ่มเติม:
otInstanceFinalize

otInstanceInitเดี่ยว

otInstance * otInstanceInitSingle(
  void
)

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

ฟังก์ชันนี้จะเริ่มต้น Openthread API และเตรียมพร้อมสําหรับการเรียก OpenThread API ที่ตามมา ต้องเรียกใช้ฟังก์ชันนี้ก่อนการเรียกใช้ OpenThread อื่นๆ

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

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

otInstanceIsDefaults

bool otInstanceIsInitialized(
  otInstance *aInstance
)

ฟังก์ชันนี้จะระบุว่าอินสแตนซ์ถูกต้อง/เริ่มต้นหรือไม่

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

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

รีเซ็ต Instance

void otInstanceReset(
  otInstance *aInstance
)

การดําเนินการนี้จะเรียกการรีเซ็ตแพลตฟอร์ม

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

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

OTInstanceResetRadioStack

void otInstanceResetRadioStack(
  otInstance *aInstance
)

การดําเนินการนี้จะรีเซ็ตสถานะภายในของสแต็กวิทยุของ OpenThread

โค้ดเรียกกลับและการกําหนดค่าจะยังคงอยู่

API นี้ใช้ได้เฉพาะในบิลด์วิทยุ (OPENTHREAD_RADIO = 1) เท่านั้น

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

otRemoveStateเปลี่ยนการติดต่อกลับ

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

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

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

otSetStateเปลี่ยนdback

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
เพิ่มโค้ดเรียกกลับไม่ได้เนื่องจากข้อจํากัดของทรัพยากร

มาโคร

OT_UPTIME_STRING_SIZE

 OT_UPTIME_STRING_SIZE 24

ขนาดที่แนะนําสําหรับการแสดงระยะเวลาทํางานเป็นสตริง

ทรัพยากร

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