Google is committed to advancing racial equity for Black communities. See how.
หน้านี้ได้รับการแปลโดย Cloud Translation API
Switch to English

ตัวอย่าง

โมดูลนี้มีฟังก์ชันที่ควบคุมอินสแตนซ์ 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_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,
OT_CHANGED_ACTIVE_DATASET = 1 << 28,
OT_CHANGED_PENDING_DATASET = 1 << 29
}
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)
ฟังก์ชันนี้จะลบข้อมูลถาวรของ OpenThread (การตั้งค่าเครือข่าย) ทั้งหมดที่เก็บไว้ในหน่วยความจำแบบไม่ลบเลือน
otInstanceFactoryReset ( otInstance *aInstance)
void
วิธีนี้จะลบการตั้งค่าทั้งหมดที่จัดเก็บไว้ในหน่วยความจำแบบไม่ลบเลือนจากนั้นจึงทริกเกอร์การรีเซ็ตแพลตฟอร์ม
otInstanceFinalize ( otInstance *aInstance)
void
ฟังก์ชันนี้ปิดใช้งานไลบรารี OpenThread
otInstanceInit (void *aInstanceBuffer, size_t *aInstanceBufferSize)
ฟังก์ชันนี้เริ่มต้นไลบรารี OpenThread
otInstanceInitSingle (void)
ฟังก์ชันนี้เริ่มต้นอินสแตนซ์เดียวแบบคงที่ของไลบรารี 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)
ฟังก์ชันนี้จะลงทะเบียนการเรียกกลับเพื่อระบุเมื่อการกำหนดค่าหรือสถานะบางอย่างเปลี่ยนแปลงภายใน OpenThread

การแจงนับ

enum นิรนาม

 anonymous enum

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

คุณสมบัติ
OT_CHANGED_ACTIVE_DATASET

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

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_PENDING_DATASET

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

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 ของเครือข่ายเธรดแล้ว

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

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

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 API ในภายหลัง ต้องเรียกใช้ฟังก์ชันนี้ก่อนการเรียกใช้ OpenThread อื่น ๆ

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

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

otInstanceIsInitialized

bool otInstanceIsInitialized(
  otInstance *aInstance
)

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

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

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

otInstanceReset

void otInstanceReset(
  otInstance *aInstance
)

วิธีนี้ทำให้เกิดการรีเซ็ตแพลตฟอร์ม

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

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

otRemoveStateChangeCallback

รถแท็กซี่ 4584356

ฟังก์ชันนี้จะลบการเรียกกลับเพื่อระบุเมื่อการกำหนดค่าหรือสถานะบางอย่างเปลี่ยนแปลงภายใน 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
ไม่สามารถเพิ่มการติดต่อกลับเนื่องจากข้อ จำกัด ของทรัพยากร