ทั่วไป

โมดูลนี้มีฟังก์ชันสำหรับบทบาทเทรดทั้งหมด

สรุป

ผู้เผยแพร่ข้อมูลเครือข่ายมีกลไกในการจำกัดจำนวนรายการบริการและ/หรือคำนำหน้าที่คล้ายกัน (คำนำหน้าแบบทำงานร่วมกันหรือเส้นทางภายนอก) ในข้อมูลเครือข่ายเทรด โดยการตรวจสอบข้อมูลเครือข่ายและจัดการว่าจะเพิ่มหรือนำรายการออกหรือไม่หรือเมื่อใด

ฟังก์ชันทั้งหมดในโมดูลนี้ต้องเปิดใช้งาน OPENTHREAD_CONFIG_NETDATA_PUBLISHER_ENABLE

การแจกแจง
anonymous enum{
  OT_NETWORK_DIAGNOSTIC_TLV_EXT_ADDRESS = 0,
  OT_NETWORK_DIAGNOSTIC_TLV_SHORT_ADDRESS = 1,
  OT_NETWORK_DIAGNOSTIC_TLV_MODE = 2,
  OT_NETWORK_DIAGNOSTIC_TLV_TIMEOUT = 3,
  OT_NETWORK_DIAGNOSTIC_TLV_CONNECTIVITY = 4,
  OT_NETWORK_DIAGNOSTIC_TLV_ROUTE = 5,
  OT_NETWORK_DIAGNOSTIC_TLV_LEADER_DATA = 6,
  OT_NETWORK_DIAGNOSTIC_TLV_NETWORK_DATA = 7,
  OT_NETWORK_DIAGNOSTIC_TLV_IP6_ADDR_LIST = 8,
  OT_NETWORK_DIAGNOSTIC_TLV_MAC_COUNTERS = 9,
  OT_NETWORK_DIAGNOSTIC_TLV_BATTERY_LEVEL = 14,
  OT_NETWORK_DIAGNOSTIC_TLV_SUPPLY_VOLTAGE = 15,
  OT_NETWORK_DIAGNOSTIC_TLV_CHILD_TABLE = 16,
  OT_NETWORK_DIAGNOSTIC_TLV_CHANNEL_PAGES = 17,
  OT_NETWORK_DIAGNOSTIC_TLV_TYPE_LIST = 18,
  OT_NETWORK_DIAGNOSTIC_TLV_MAX_CHILD_TIMEOUT = 19,
  OT_NETWORK_DIAGNOSTIC_TLV_VERSION = 24,
  OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_NAME = 25,
  OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_MODEL = 26,
  OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_SW_VERSION = 27,
  OT_NETWORK_DIAGNOSTIC_TLV_THREAD_STACK_VERSION = 28,
  OT_NETWORK_DIAGNOSTIC_TLV_CHILD = 29,
  OT_NETWORK_DIAGNOSTIC_TLV_CHILD_IP6_ADDR_LIST = 30,
  OT_NETWORK_DIAGNOSTIC_TLV_ROUTER_NEIGHBOR = 31,
  OT_NETWORK_DIAGNOSTIC_TLV_ANSWER = 32,
  OT_NETWORK_DIAGNOSTIC_TLV_QUERY_ID = 33,
  OT_NETWORK_DIAGNOSTIC_TLV_MLE_COUNTERS = 34
} 		enum
otDeviceRole{
  OT_DEVICE_ROLE_DISABLED = 0,
  OT_DEVICE_ROLE_DETACHED = 1,
  OT_DEVICE_ROLE_CHILD = 2,
  OT_DEVICE_ROLE_ROUTER = 3,
  OT_DEVICE_ROLE_LEADER = 4
} 		enum
แสดงบทบาทในอุปกรณ์เทรด
otNetDataPublisherEvent{
  OT_NETDATA_PUBLISHER_EVENT_ENTRY_ADDED = 0,
  OT_NETDATA_PUBLISHER_EVENT_ENTRY_REMOVED = 1
} 		enum
แสดงเหตุการณ์ที่รายงานจากโค้ดเรียกกลับของผู้เผยแพร่โฆษณา
otRoutePreference{
  OT_ROUTE_PREFERENCE_LOW = -1,
  OT_ROUTE_PREFERENCE_MED = 0,
  OT_ROUTE_PREFERENCE_HIGH = 1
} 		enum
กำหนดค่าที่ถูกต้องสำหรับ mPreference ใน otExternalRouteConfig และ otBorderRouterConfig

Typedef
otBorderRouterConfig typedef
แสดงการกำหนดค่า Border Router
otDetachGracefullyCallback)(void *aContext) typedef
void(*
โค้ดเรียกกลับนี้จะแจ้งให้แอปพลิเคชันทราบว่ากระบวนการปลดออกได้เสร็จสมบูรณ์แล้ว
otExternalRouteConfig typedef
แสดงการกำหนดค่าเส้นทางภายนอก
otIpCounters typedef
struct otIpCounters
แสดงตัวนับระดับ IP
otLeaderData typedef
struct otLeaderData
แสดงข้อมูลผู้นำชุดข้อความ
otLinkModeConfig typedef
แสดงการกำหนดค่าโหมดลิงก์ MLE
otLowpanContextInfo typedef
แสดงข้อมูลรหัสบริบท 6LoWPAN ที่เชื่อมโยงกับคำนำหน้าในข้อมูลเครือข่าย
otMleCounters typedef
struct otMleCounters
แสดงตัวนับ MLE ของเทรด
otNeighborInfoIterator typedef
int16_t
ใช้ในการทำซ้ำผ่านตารางใกล้เคียง
otNetDataDnsSrpServicePublisherCallback)(otNetDataPublisherEvent aEvent, void *aContext) typedef
void(*
ประเภทตัวชี้จะกำหนดโค้ดเรียกกลับที่ใช้เพื่อแจ้งเตือนเมื่อมีการเพิ่มหรือนำรายการ "DNS/SRP Service" ออกจากข้อมูลเครือข่ายเทรด
otNetDataPrefixPublisherCallback)(otNetDataPublisherEvent aEvent, const otIp6Prefix *aPrefix, void *aContext) typedef
void(*
ประเภทตัวชี้จะกำหนดโค้ดเรียกกลับที่ใช้เพื่อแจ้งเตือนเมื่อมีการเพิ่มหรือนํารายการคำนำหน้า (แบบเชื่อมต่อหรือเส้นทางภายนอก) ออกจากข้อมูลเครือข่ายเทรด
otNetDataPublisherEvent typedef
แสดงเหตุการณ์ที่รายงานจากโค้ดเรียกกลับของผู้เผยแพร่โฆษณา
otNetworkDataIterator typedef
uint32_t
ใช้ในการทำซ้ำผ่านข้อมูลเครือข่าย
otNetworkDiagChildEntry typedef
แสดงรายการตารางย่อยการวินิจฉัยเครือข่าย
otNetworkDiagConnectivity typedef
แสดงค่าการเชื่อมต่อการวินิจฉัยเครือข่าย
otNetworkDiagIterator typedef
uint16_t
ใช้ในการทำซ้ำผ่าน TLV การวินิจฉัยเครือข่าย
otNetworkDiagMacCounters typedef
แสดงค่า Mac Counters สำหรับการวินิจฉัยเครือข่าย
otNetworkDiagMleCounters typedef
แสดงค่าตัวนับ MLE ในการวินิจฉัยเครือข่าย
otNetworkDiagRoute typedef
แสดงค่า TLV ของเส้นทางการวินิจฉัยเครือข่าย
otNetworkDiagRouteData typedef
แสดงข้อมูลเส้นทางการวินิจฉัยเครือข่าย
otNetworkDiagTlv typedef
แสดง TLV การวินิจฉัยเครือข่าย
otReceiveDiagnosticGetCallback)(otError aError, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext) typedef
void(*
ระบบจะเรียกใช้ตัวชี้เมื่อได้รับการตอบกลับเพื่อรับการวินิจฉัยเครือข่าย
otRoutePreference typedef
กำหนดค่าที่ถูกต้องสำหรับ mPreference ใน otExternalRouteConfig และ otBorderRouterConfig
otServerConfig typedef
แสดงการกำหนดค่าเซิร์ฟเวอร์
otServiceConfig typedef
แสดงการกำหนดค่าบริการ
otThreadAnycastLocatorCallback)(void *aContext, otError aError, const otIp6Address *aMeshLocalAddress, uint16_t aRloc16) typedef
void(*
ประเภทตัวชี้จะกำหนดโค้ดเรียกกลับเพื่อแจ้งผลลัพธ์ของคำขอ otThreadLocateAnycastDestination()
otThreadDiscoveryRequestCallback)(const otThreadDiscoveryRequestInfo *aInfo, void *aContext) typedef
void(*
ระบบจะเรียกตัวชี้ทุกครั้งที่ได้รับข้อความคำขอการค้นพบ MLE
otThreadDiscoveryRequestInfo typedef
แสดงข้อมูลคำขอการค้นพบชุดข้อความ
otThreadParentResponseCallback)(otThreadParentResponseInfo *aInfo, void *aContext) typedef
void(*
ระบบจะเรียกเคอร์เซอร์ทุกครั้งที่ได้รับข้อความตอบกลับจากผู้ปกครองของ MLE
otThreadParentResponseInfo typedef
แสดงข้อมูลการตอบกลับหลักของ MLE

ฟังก์ชัน
otConvertDurationInSecondsToString(uint32_t aDuration, char *aBuffer, uint16_t aSize)
void
แปลงระยะเวลา uint32_t (เป็นวินาที) เป็นสตริงที่มนุษย์อ่านได้
otNetDataContainsOmrPrefix(otInstance *aInstance, const otIp6Prefix *aPrefix)
bool
ตรวจสอบว่าคำนำหน้าที่กำหนดใช้เป็นคำนำหน้า OMR ที่ถูกต้องได้หรือไม่ และข้อมูลเครือข่ายของผู้นำมีคำนำหน้านี้ด้วย
otNetDataGet(otInstance *aInstance, bool aStable, uint8_t *aData, uint8_t *aDataLength)
ให้สำเนาข้อมูลเครือข่ายเทรดของพาร์ติชันที่สมบูรณ์หรือเสถียร
otNetDataGetCommissioningDataset(otInstance *aInstance, otCommissioningDataset *aDataset)
void
รับชุดข้อมูลการจัดเตรียมจากข้อมูลเครือข่ายของพาร์ติชัน
otNetDataGetLength(otInstance *aInstance)
uint8_t
รับความยาวปัจจุบัน (จำนวนไบต์) ของข้อมูลเครือข่ายเทรดของพาร์ติชัน
otNetDataGetMaxLength(otInstance *aInstance)
uint8_t
รับความยาวสูงสุดที่สังเกตได้ของข้อมูลเครือข่ายเทรดตั้งแต่เริ่มต้นสแต็ก OT หรือตั้งแต่การเรียกไปยัง otNetDataResetMaxLength() ครั้งล่าสุด
otNetDataGetNextLowpanContextInfo(otInstance *aInstance, otNetworkDataIterator *aIterator, otLowpanContextInfo *aContextInfo)
รับข้อมูลรหัสบริบท 6LoWPAN ถัดไปในข้อมูลเครือข่ายของพาร์ติชัน
otNetDataGetNextOnMeshPrefix(otInstance *aInstance, otNetworkDataIterator *aIterator, otBorderRouterConfig *aConfig)
รับคำนำหน้า On Mesh รายการถัดไปในข้อมูลเครือข่ายของพาร์ติชัน
otNetDataGetNextRoute(otInstance *aInstance, otNetworkDataIterator *aIterator, otExternalRouteConfig *aConfig)
ดูเส้นทางภายนอกถัดไปในข้อมูลเครือข่ายของพาร์ติชัน
otNetDataGetNextService(otInstance *aInstance, otNetworkDataIterator *aIterator, otServiceConfig *aConfig)
รับบริการถัดไปในข้อมูลเครือข่ายของพาร์ติชัน
otNetDataGetStableVersion(otInstance *aInstance)
uint8_t
ดาวน์โหลดเวอร์ชันข้อมูลเครือข่ายเสถียร
otNetDataGetVersion(otInstance *aInstance)
uint8_t
รับเวอร์ชันข้อมูลเครือข่าย
otNetDataIsDnsSrpServiceAdded(otInstance *aInstance)
bool
ระบุว่าปัจจุบันมีการเพิ่มรายการ "DNS/SRP Service" ในข้อมูลเครือข่ายเทรดหรือไม่
otNetDataIsPrefixAdded(otInstance *aInstance, const otIp6Prefix *aPrefix)
bool
ระบุว่าปัจจุบันมีการเพิ่มรายการคำนำหน้าที่เผยแพร่แล้ว (บนเส้นทางแบบเชื่อมต่อหรือภายนอก) ไปยังข้อมูลเครือข่ายเทรดหรือไม่
otNetDataPublishDnsSrpServiceAnycast(otInstance *aInstance, uint8_t aSequenceNUmber)
void
คำขอเผยแพร่ "DNS/SRP Service Anycast Address" ในข้อมูลเครือข่ายเทรด
otNetDataPublishDnsSrpServiceUnicast(otInstance *aInstance, const otIp6Address *aAddress, uint16_t aPort)
void
ขอเผยแพร่ "ที่อยู่ Unicast ของบริการ DNS/SRP" ในข้อมูลเครือข่ายเทรด
otNetDataPublishDnsSrpServiceUnicastMeshLocalEid(otInstance *aInstance, uint16_t aPort)
void
ขอเผยแพร่ "ที่อยู่ Unicast ของบริการ DNS/SRP" ในข้อมูลเครือข่ายเทรด
otNetDataPublishExternalRoute(otInstance *aInstance, const otExternalRouteConfig *aConfig)
ขอให้เผยแพร่คำนำหน้าเส้นทางภายนอกในข้อมูลเครือข่ายเทรด
otNetDataPublishOnMeshPrefix(otInstance *aInstance, const otBorderRouterConfig *aConfig)
ขอให้เผยแพร่คำนำหน้าที่ทำงานร่วมกันในข้อมูลเครือข่ายเทรด
otNetDataReplacePublishedExternalRoute(otInstance *aInstance, const otIp6Prefix *aPrefix, const otExternalRouteConfig *aConfig)
แทนที่เส้นทางภายนอกที่เผยแพร่ก่อนหน้านี้ในข้อมูลเครือข่ายเทรด
otNetDataResetMaxLength(otInstance *aInstance)
void
รีเซ็ตความยาวสูงสุดของข้อมูลเครือข่ายเทรดที่ติดตาม
otNetDataSetDnsSrpServicePublisherCallback(otInstance *aInstance, otNetDataDnsSrpServicePublisherCallback aCallback, void *aContext)
void
ตั้งค่าโค้ดเรียกกลับสำหรับการแจ้งเตือนเมื่อมีการเพิ่มหรือนำ "บริการ DNS/SRP" ที่เผยแพร่ออกจากข้อมูลเครือข่ายเทรด
otNetDataSetPrefixPublisherCallback(otInstance *aInstance, otNetDataPrefixPublisherCallback aCallback, void *aContext)
void
ตั้งค่าโค้ดเรียกกลับสำหรับการแจ้งเตือนเมื่อมีการเพิ่มหรือนำรายการคำนำหน้าที่เผยแพร่ออกจากข้อมูลเครือข่ายเทรด
otNetDataSteeringDataCheckJoiner(otInstance *aInstance, const otExtAddress *aEui64)
ตรวจสอบว่าข้อมูลการบังคับเลี้ยวมี Joiner หรือไม่
otNetDataSteeringDataCheckJoinerWithDiscerner(otInstance *aInstance, const struct otJoinerDiscerner *aDiscerner)
ตรวจสอบว่าข้อมูลการบังคับเลี้ยวมีเครื่องมือเชื่อมต่อที่มีค่าเฉพาะของข้อมูลหรือไม่
otNetDataUnpublishDnsSrpService(otInstance *aInstance)
void
ยกเลิกการเผยแพร่รายการบริการ DNS/SRP (Anycast หรือ Unicast) ที่เพิ่มก่อนหน้านี้จากข้อมูลเครือข่ายเทรด
otNetDataUnpublishPrefix(otInstance *aInstance, const otIp6Prefix *aPrefix)
ยกเลิกการเผยแพร่คำนำหน้าเส้นทาง On-Mesh หรือ External Route ที่เผยแพร่ก่อนหน้านี้
otThreadBecomeChild(otInstance *aInstance)
ลองแนบไฟล์อีกครั้งตอนเด็ก
otThreadBecomeDetached(otInstance *aInstance)
ปลดจากเครือข่ายเทรด
otThreadDetachGracefully(otInstance *aInstance, otDetachGracefullyCallback aCallback, void *aContext)
แจ้งเตือนโหนดอื่นๆ ในเครือข่าย (หากมี) จากนั้นจะหยุดการดำเนินการของโปรโตคอลเทรด
otThreadDeviceRoleToString(otDeviceRole aRole)
const char *
แปลงบทบาทอุปกรณ์เป็นสตริงที่มนุษย์อ่านได้
otThreadDiscover(otInstance *aInstance, uint32_t aScanChannels, uint16_t aPanId, bool aJoiner, bool aEnableEui64Filtering, otHandleActiveScanResult aCallback, void *aCallbackContext)
เริ่มสแกนการค้นพบชุดข้อความ
otThreadGetChildTimeout(otInstance *aInstance)
uint32_t
รับระยะหมดเวลาของเทรดย่อย (เป็นวินาที) ที่ใช้เมื่อดำเนินการในบทบาทย่อย
otThreadGetDeviceRole(otInstance *aInstance)
รับบทบาทในอุปกรณ์
otThreadGetDomainName(otInstance *aInstance)
const char *
รับชื่อโดเมนเทรด
otThreadGetExtendedPanId(otInstance *aInstance)
const otExtendedPanId *
รับรหัส PAN ที่ขยาย IEEE 802.15.4
otThreadGetFixedDuaInterfaceIdentifier(otInstance *aInstance)
รับตัวระบุอินเทอร์เฟซที่ระบุไว้ด้วยตนเองสำหรับที่อยู่ Thread Domain Unicast
otThreadGetIp6Counters(otInstance *aInstance)
const otIpCounters *
รับตัวนับ IPv6
otThreadGetKeySequenceCounter(otInstance *aInstance)
uint32_t
รับ thrKeySequenceCounter
otThreadGetKeySwitchGuardTime(otInstance *aInstance)
uint32_t
รับ thrKeySwitchGuardTime (เป็นชั่วโมง)
otThreadGetLeaderData(otInstance *aInstance, otLeaderData *aLeaderData)
รับข้อมูลผู้นำชุดข้อความ
otThreadGetLeaderRloc(otInstance *aInstance, otIp6Address *aLeaderRloc)
แสดงตัวชี้ไปยัง RLOC ของผู้นำ
otThreadGetLeaderRouterId(otInstance *aInstance)
uint8_t
รับรหัสเราเตอร์ของผู้นำ
otThreadGetLeaderWeight(otInstance *aInstance)
uint8_t
ถ่วงน้ำหนักผู้นำ
otThreadGetLinkLocalAllThreadNodesMulticastAddress(otInstance *aInstance)
const otIp6Address *
รับที่อยู่มัลติแคสต์สำหรับโหนดเทรดทั้งหมดแบบ Thread Link
otThreadGetLinkLocalIp6Address(otInstance *aInstance)
const otIp6Address *
รับที่อยู่ IPv6 ภายในลิงก์เทรด
otThreadGetLinkMode(otInstance *aInstance)
รับการกำหนดค่าโหมดลิงก์ MLE
otThreadGetMaxTimeInQueue(otInstance *aInstance)
uint32_t
รับการกำหนดเวลาเข้าคิวสูงสุดสำหรับข้อความในคิว TX
otThreadGetMeshLocalEid(otInstance *aInstance)
const otIp6Address *
รับที่อยู่ EID ในเครื่องของ Mesh
otThreadGetMeshLocalPrefix(otInstance *aInstance)
แสดงผลตัวชี้ไปยังคำนำหน้า Mesh Local
otThreadGetMleCounters(otInstance *aInstance)
const otMleCounters *
รับตัวนับ MLE ของเทรด
otThreadGetNetworkKey(otInstance *aInstance, otNetworkKey *aNetworkKey)
void
รับคีย์เครือข่ายเทรด
otThreadGetNetworkKeyRef(otInstance *aInstance)
รับ otNetworkKeyRef สำหรับคีย์เครือข่ายเทรด
otThreadGetNetworkName(otInstance *aInstance)
const char *
รับชื่อเครือข่ายเทรด
otThreadGetNextDiagnosticTlv(const otMessage *aMessage, otNetworkDiagIterator *aIterator, otNetworkDiagTlv *aNetworkDiagTlv)
รับ TLV การวินิจฉัยเครือข่ายถัดไปในข้อความ
otThreadGetNextNeighborInfo(otInstance *aInstance, otNeighborInfoIterator *aIterator, otNeighborInfo *aInfo)
รับข้อมูลเพื่อนบ้านถัดไป
otThreadGetParentAverageRssi(otInstance *aInstance, int8_t *aParentRssi)
ฟังก์ชันนี้ดึงข้อมูล RSSI โดยเฉลี่ยสำหรับเทรดระดับบน
otThreadGetParentInfo(otInstance *aInstance, otRouterInfo *aParentInfo)
ฟังก์ชันนี้จะเรียกข้อมูลการวินิจฉัยสำหรับเราเตอร์เทรดในฐานะระดับบนสุด
otThreadGetParentLastRssi(otInstance *aInstance, int8_t *aLastRssi)
ฟังก์ชันจะเรียก RSSI ของแพ็กเก็ตล่าสุดจากเทรดระดับบนสุด
otThreadGetPartitionId(otInstance *aInstance)
uint32_t
รับรหัสพาร์ติชัน
otThreadGetRealmLocalAllThreadNodesMulticastAddress(otInstance *aInstance)
const otIp6Address *
รับที่อยู่มัลติแคสต์สำหรับโหนดเทรดทั้งหมดของ Thread Realm-Local
otThreadGetRloc(otInstance *aInstance)
const otIp6Address *
รับที่อยู่ Thread Routing Locator (RLOC)
otThreadGetRloc16(otInstance *aInstance)
uint16_t
รับ RLOC16
otThreadGetServiceAloc(otInstance *aInstance, uint8_t aServiceId, otIp6Address *aServiceAloc)
เรียกข้อมูล ALOC ของบริการสำหรับรหัสบริการที่ระบุ
otThreadGetTimeInQueueHistogram(otInstance *aInstance, uint16_t *aNumBins, uint32_t *aBinInterval)
const uint32_t *
รับฮิสโตแกรมการอยู่ในคิวของข้อความในคิว TX
otThreadGetVendorModel(otInstance *aInstance)
const char *
รับสตริงรูปแบบของผู้ให้บริการ
otThreadGetVendorName(otInstance *aInstance)
const char *
รับสตริงชื่อผู้ให้บริการ
otThreadGetVendorSwVersion(otInstance *aInstance)
const char *
รับสตริงเวอร์ชัน sw ของผู้ให้บริการ
otThreadGetVersion(void)
uint16_t
รับเวอร์ชันโปรโตคอลเทรด
otThreadIsAnycastLocateInProgress(otInstance *aInstance)
bool
ระบุว่าขณะนี้คำขอค้นหา Anycast อยู่ระหว่างดำเนินการหรือไม่
otThreadIsDiscoverInProgress(otInstance *aInstance)
bool
ระบุว่าการค้นพบเทรด MLE อยู่ระหว่างดำเนินการหรือไม่
otThreadIsSingleton(otInstance *aInstance)
bool
ระบุว่าโหนดเป็นเราเตอร์เดียวในเครือข่ายหรือไม่
otThreadLocateAnycastDestination(otInstance *aInstance, const otIp6Address *aAnycastAddress, otThreadAnycastLocatorCallback aCallback, void *aContext)
ร้องขอปลายทางที่ใกล้ที่สุดของที่อยู่ Anycast ที่ระบุ
otThreadRegisterParentResponseCallback(otInstance *aInstance, otThreadParentResponseCallback aCallback, void *aContext)
void
ลงทะเบียนการติดต่อกลับเพื่อรับข้อมูลการตอบกลับระดับบนสุดของ MLE
otThreadResetIp6Counters(otInstance *aInstance)
void
รีเซ็ตตัวนับ IPv6
otThreadResetMleCounters(otInstance *aInstance)
void
รีเซ็ตตัวนับ MLE ของเทรด
otThreadResetTimeInQueueStat(otInstance *aInstance)
void
รีเซ็ตสถิติเวลาอยู่ในคิวของคิว TX
otThreadSearchForBetterParent(otInstance *aInstance)
เริ่มกระบวนการให้บุตรหลานค้นหาผู้ปกครองที่ดีกว่าโดยที่ยังอยู่กับผู้ปกครองคนปัจจุบัน
otThreadSendAddressNotification(otInstance *aInstance, otIp6Address *aDestination, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid)
void
ส่งข้อความแจ้งเตือนที่อยู่เชิงรุก (ADDR_NTF.ntf)
otThreadSendDiagnosticGet(otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount, otReceiveDiagnosticGetCallback aCallback, void *aCallbackContext)
ส่งคำขอรับการวินิจฉัยเครือข่าย
otThreadSendDiagnosticReset(otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount)
ส่งคำขอรีเซ็ตการวินิจฉัยเครือข่าย
otThreadSendProactiveBackboneNotification(otInstance *aInstance, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid, uint32_t aTimeSinceLastTransaction)
ส่งข้อความ Proactive Backbone Notification (PRO_BB.ntf) ในลิงก์ Backbone
otThreadSetChildTimeout(otInstance *aInstance, uint32_t aTimeout)
void
ตั้งค่าระยะหมดเวลาของเทรดย่อย (เป็นวินาที) ที่ใช้เมื่อดำเนินการในบทบาทย่อย
otThreadSetDiscoveryRequestCallback(otInstance *aInstance, otThreadDiscoveryRequestCallback aCallback, void *aContext)
void
ตั้งค่าโค้ดเรียกกลับเพื่อรับข้อมูลคำขอการค้นพบ MLE
otThreadSetDomainName(otInstance *aInstance, const char *aDomainName)
ตั้งค่าชื่อโดเมนเทรด
otThreadSetEnabled(otInstance *aInstance, bool aEnabled)
เริ่มการดำเนินการโปรโตคอลเทรด
otThreadSetExtendedPanId(otInstance *aInstance, const otExtendedPanId *aExtendedPanId)
ตั้งค่ารหัส PAN ที่ขยาย IEEE 802.15.4
otThreadSetFixedDuaInterfaceIdentifier(otInstance *aInstance, const otIp6InterfaceIdentifier *aIid)
ตั้งค่าหรือล้างตัวระบุอินเทอร์เฟซที่ระบุไว้ด้วยตนเองสำหรับที่อยู่ Thread Domain Unicast
otThreadSetJoinerAdvertisement(otInstance *aInstance, uint32_t aOui, const uint8_t *aAdvData, uint8_t aAdvDataLength)
ตั้งค่าโฆษณาเครื่องมือเชื่อมต่อชุดข้อความเมื่อค้นพบเครือข่ายเทรด
otThreadSetKeySequenceCounter(otInstance *aInstance, uint32_t aKeySequenceCounter)
void
ตั้งค่า thrKeySequenceCounter
otThreadSetKeySwitchGuardTime(otInstance *aInstance, uint32_t aKeySwitchGuardTime)
void
ตั้งค่า thrKeySwitchGuardTime (เป็นชั่วโมง)
otThreadSetLinkMode(otInstance *aInstance, otLinkModeConfig aConfig)
กำหนดค่าโหมดลิงก์ MLE
otThreadSetMeshLocalPrefix(otInstance *aInstance, const otMeshLocalPrefix *aMeshLocalPrefix)
ตั้งค่าคำนำหน้าภายใน Mesh
otThreadSetNetworkKey(otInstance *aInstance, const otNetworkKey *aKey)
ตั้งค่าคีย์เครือข่ายเทรด
otThreadSetNetworkKeyRef(otInstance *aInstance, otNetworkKeyRef aKeyRef)
ตั้งค่าคีย์เครือข่ายเทรดเป็น otNetworkKeyRef
otThreadSetNetworkName(otInstance *aInstance, const char *aNetworkName)
ตั้งชื่อเครือข่ายเทรด
otThreadSetVendorModel(otInstance *aInstance, const char *aVendorModel)
ตั้งค่าสตริงรูปแบบของผู้ให้บริการ
otThreadSetVendorName(otInstance *aInstance, const char *aVendorName)
ตั้งค่าสตริงชื่อผู้ให้บริการ
otThreadSetVendorSwVersion(otInstance *aInstance, const char *aVendorSwVersion)
ตั้งค่าสตริงเวอร์ชันซอฟต์แวร์ของผู้ให้บริการ

โครงสร้าง
otBorderRouterConfig

แสดงการกำหนดค่า Border Router

otExternalRouteConfig

แสดงการกำหนดค่าเส้นทางภายนอก

otIpCounters

แสดงตัวนับระดับ IP

otLeaderData

แสดงข้อมูลผู้นำชุดข้อความ

otLinkModeConfig

แสดงการกำหนดค่าโหมดลิงก์ MLE

otLowpanContextInfo

แสดงข้อมูลรหัสบริบท 6LoWPAN ที่เชื่อมโยงกับคำนำหน้าในข้อมูลเครือข่าย

otMleCounters

แสดงตัวนับ MLE ของเทรด

otNeighborInfo

เก็บข้อมูลการวินิจฉัยสำหรับโหนดเทรดข้างเคียง

otNetworkDiagChildEntry

แสดงรายการตารางย่อยการวินิจฉัยเครือข่าย

otNetworkDiagConnectivity

แสดงค่าการเชื่อมต่อการวินิจฉัยเครือข่าย

otNetworkDiagMacCounters

แสดงค่า Mac Counters สำหรับการวินิจฉัยเครือข่าย

otNetworkDiagMleCounters

แสดงค่าตัวนับ MLE ในการวินิจฉัยเครือข่าย

otNetworkDiagRoute

แสดงค่า TLV ของเส้นทางการวินิจฉัยเครือข่าย

otNetworkDiagRouteData

แสดงข้อมูลเส้นทางการวินิจฉัยเครือข่าย

otNetworkDiagTlv

แสดง TLV การวินิจฉัยเครือข่าย

otRouterInfo

เก็บข้อมูลการวินิจฉัยสำหรับเราเตอร์เทรด

otServerConfig

แสดงการกำหนดค่าเซิร์ฟเวอร์

otServiceConfig

แสดงการกำหนดค่าบริการ

otThreadDiscoveryRequestInfo

แสดงข้อมูลคำขอการค้นพบชุดข้อความ

otThreadParentResponseInfo

แสดงข้อมูลการตอบกลับหลักของ MLE

การแจกแจง

enum ที่ไม่ระบุตัวตน

 anonymous enum
พร็อพเพอร์ตี้
OT_NETWORK_DIAGNOSTIC_TLV_ANSWER

คำตอบ TLV

OT_NETWORK_DIAGNOSTIC_TLV_BATTERY_LEVEL

TLV ระดับแบตเตอรี่

OT_NETWORK_DIAGNOSTIC_TLV_CHANNEL_PAGES

TLV หน้าช่อง

OT_NETWORK_DIAGNOSTIC_TLV_CHILD

Child TLV.

OT_NETWORK_DIAGNOSTIC_TLV_CHILD_IP6_ADDR_LIST

TLV ของรายการที่อยู่ IPv6 ย่อย

OT_NETWORK_DIAGNOSTIC_TLV_CHILD_TABLE

Child Table TLV.

OT_NETWORK_DIAGNOSTIC_TLV_CONNECTIVITY

TLV การเชื่อมต่อ

OT_NETWORK_DIAGNOSTIC_TLV_EXT_ADDRESS

TLV ที่อยู่แบบขยายของ MAC

OT_NETWORK_DIAGNOSTIC_TLV_IP6_ADDR_LIST

TLV ของรายการที่อยู่ IPv6

OT_NETWORK_DIAGNOSTIC_TLV_LEADER_DATA

TLV ข้อมูลผู้นำ

OT_NETWORK_DIAGNOSTIC_TLV_MAC_COUNTERS

TLV ตัวนับ MAC

OT_NETWORK_DIAGNOSTIC_TLV_MAX_CHILD_TIMEOUT

TLV ระยะหมดเวลาของผู้เผยแพร่โฆษณาย่อยสูงสุด

OT_NETWORK_DIAGNOSTIC_TLV_MLE_COUNTERS

MLE Counters TLV

OT_NETWORK_DIAGNOSTIC_TLV_MODE

โหมด TLV

OT_NETWORK_DIAGNOSTIC_TLV_NETWORK_DATA

TLV ข้อมูลเครือข่าย

OT_NETWORK_DIAGNOSTIC_TLV_QUERY_ID

รหัสการค้นหา TLV

OT_NETWORK_DIAGNOSTIC_TLV_ROUTE

Route64 TLV

OT_NETWORK_DIAGNOSTIC_TLV_ROUTER_NEIGHBOR

TLV เราเตอร์ใกล้เคียง

OT_NETWORK_DIAGNOSTIC_TLV_SHORT_ADDRESS

ที่อยู่ 16 TLV.

OT_NETWORK_DIAGNOSTIC_TLV_SUPPLY_VOLTAGE

แรงดันไฟฟ้า TLV

OT_NETWORK_DIAGNOSTIC_TLV_THREAD_STACK_VERSION

เทรดสแต็กเวอร์ชัน TLV

OT_NETWORK_DIAGNOSTIC_TLV_TIMEOUT

ระยะหมดเวลา TLV (ระยะเวลาการหยั่งสัญญาณสูงสุดสำหรับ SED)

OT_NETWORK_DIAGNOSTIC_TLV_TYPE_LIST

พิมพ์รายการ TLV

OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_MODEL

TLV รูปแบบผู้ให้บริการ

OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_NAME

TLV ชื่อผู้ให้บริการ

OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_SW_VERSION

ผู้ให้บริการ SW เวอร์ชัน TLV

OT_NETWORK_DIAGNOSTIC_TLV_VERSION

เวอร์ชัน TLV.

otDeviceRole

 otDeviceRole

แสดงบทบาทในอุปกรณ์เทรด

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

บทบาทผู้เผยแพร่โฆษณาย่อยในเทรด

OT_DEVICE_ROLE_DETACHED

ไม่ได้เข้าร่วมในเครือข่าย/พาร์ติชันเทรดในขณะนี้

OT_DEVICE_ROLE_DISABLED

กลุ่มเทรดปิดใช้อยู่

OT_DEVICE_ROLE_LEADER

บทบาทผู้นำชุดข้อความ

OT_DEVICE_ROLE_ROUTER

บทบาทเราเตอร์เทรด

otNetDataPublisherEvent

 otNetDataPublisherEvent

แสดงเหตุการณ์ที่รายงานจากโค้ดเรียกกลับของผู้เผยแพร่โฆษณา

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

รายการที่เผยแพร่แล้วจะเพิ่มไปยังข้อมูลเครือข่ายเทรด

OT_NETDATA_PUBLISHER_EVENT_ENTRY_REMOVED

รายการที่เผยแพร่แล้วจะถูกนำออกจากข้อมูลเครือข่ายเทรด

otRoutePreference

 otRoutePreference

กำหนดค่าที่ถูกต้องสำหรับ mPreference ใน otExternalRouteConfig และ otBorderRouterConfig

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

ค่ากำหนดเส้นทางสูง

OT_ROUTE_PREFERENCE_LOW

ค่ากำหนดเส้นทางต่ำ

OT_ROUTE_PREFERENCE_MED

ค่ากำหนดเส้นทางปานกลาง

Typedef

otBorderRouterConfig

struct otBorderRouterConfig otBorderRouterConfig

แสดงการกำหนดค่า Border Router

otDetachGracefullyCallback

void(* otDetachGracefullyCallback)(void *aContext)

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

รายละเอียด
พารามิเตอร์
[in] aContext
ตัวชี้ไปยังบริบทเฉพาะแอปพลิเคชัน

otExternalRouteConfig

struct otExternalRouteConfig otExternalRouteConfig

แสดงการกำหนดค่าเส้นทางภายนอก

otIpCounters

struct otIpCounters otIpCounters

แสดงตัวนับระดับ IP

otLeaderData

struct otLeaderData otLeaderData

แสดงข้อมูลผู้นำชุดข้อความ

otLinkModeConfig

struct otLinkModeConfig otLinkModeConfig

แสดงการกำหนดค่าโหมดลิงก์ MLE

otLowpanContextInfo

struct otLowpanContextInfo otLowpanContextInfo

แสดงข้อมูลรหัสบริบท 6LoWPAN ที่เชื่อมโยงกับคำนำหน้าในข้อมูลเครือข่าย

otMleCounters

struct otMleCounters otMleCounters

แสดงตัวนับ MLE ของเทรด

otNeighborInfoIterator

int16_t otNeighborInfoIterator

ใช้ในการทำซ้ำผ่านตารางใกล้เคียง

otNetDataDnsSrpServicePublisherCallback

void(* otNetDataDnsSrpServicePublisherCallback)(otNetDataPublisherEvent aEvent, void *aContext)

ประเภทตัวชี้จะกำหนดโค้ดเรียกกลับที่ใช้เพื่อแจ้งเตือนเมื่อมีการเพิ่มหรือนำรายการ "DNS/SRP Service" ออกจากข้อมูลเครือข่ายเทรด

เมื่อนำโค้ดเรียกกลับออก ระบบจะเรียกใช้โดยไม่เกี่ยวข้องกับว่า Publisher จะนำรายการออกหรือไม่ (เช่น เมื่อมีรายการที่คล้ายกันมากเกินไปในข้อมูลเครือข่ายอยู่แล้ว) หรือผ่านการเรียกอย่างชัดแจ้งเพื่อเลิกเผยแพร่รายการ (เช่น การเรียกไปยัง otNetDataUnpublishDnsSrpService())

รายละเอียด
พารามิเตอร์
[in] aEvent
ระบุกิจกรรม (ว่ามีการเพิ่มหรือนำรายการออกหรือไม่)
[in] aContext
ตัวชี้ไปยังบริบทเฉพาะแอปพลิเคชัน

otNetDataPrefixPublisherCallback

void(* otNetDataPrefixPublisherCallback)(otNetDataPublisherEvent aEvent, const otIp6Prefix *aPrefix, void *aContext)

ประเภทตัวชี้จะกำหนดโค้ดเรียกกลับที่ใช้เพื่อแจ้งเตือนเมื่อมีการเพิ่มหรือนํารายการคำนำหน้า (แบบเชื่อมต่อหรือเส้นทางภายนอก) ออกจากข้อมูลเครือข่ายเทรด

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

รายละเอียด
พารามิเตอร์
[in] aEvent
ระบุกิจกรรม (ว่ามีการเพิ่มหรือนำรายการออกหรือไม่)
[in] aPrefix
ตัวชี้ไปยังข้อความนำหน้า
[in] aContext
ตัวชี้ไปยังบริบทเฉพาะแอปพลิเคชัน

otNetDataPublisherEvent

enum otNetDataPublisherEvent otNetDataPublisherEvent

แสดงเหตุการณ์ที่รายงานจากโค้ดเรียกกลับของผู้เผยแพร่โฆษณา

otNetworkDataIterator

uint32_t otNetworkDataIterator

ใช้ในการทำซ้ำผ่านข้อมูลเครือข่าย

otNetworkDiagChildEntry

struct otNetworkDiagChildEntry otNetworkDiagChildEntry

แสดงรายการตารางย่อยการวินิจฉัยเครือข่าย

otNetworkDiagConnectivity

struct otNetworkDiagConnectivity otNetworkDiagConnectivity

แสดงค่าการเชื่อมต่อการวินิจฉัยเครือข่าย

otNetworkDiagIterator

uint16_t otNetworkDiagIterator

ใช้ในการทำซ้ำผ่าน TLV การวินิจฉัยเครือข่าย

otNetworkDiagMacCounters

struct otNetworkDiagMacCounters otNetworkDiagMacCounters

แสดงค่า Mac Counters สำหรับการวินิจฉัยเครือข่าย

โปรดดูคำนิยามของช่องสมาชิกใน RFC 2863

otNetworkDiagMleCounters

struct otNetworkDiagMleCounters otNetworkDiagMleCounters

แสดงค่าตัวนับ MLE ในการวินิจฉัยเครือข่าย

otNetworkDiagRoute

struct otNetworkDiagRoute otNetworkDiagRoute

แสดงค่า TLV ของเส้นทางการวินิจฉัยเครือข่าย

otNetworkDiagRouteData

struct otNetworkDiagRouteData otNetworkDiagRouteData

แสดงข้อมูลเส้นทางการวินิจฉัยเครือข่าย

otNetworkDiagTlv

struct otNetworkDiagTlv otNetworkDiagTlv

แสดง TLV การวินิจฉัยเครือข่าย

otReceiveDiagnosticGetCallback

void(* otReceiveDiagnosticGetCallback)(otError aError, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext)

ระบบจะเรียกใช้ตัวชี้เมื่อได้รับการตอบกลับเพื่อรับการวินิจฉัยเครือข่าย

รายละเอียด
พารามิเตอร์
[in] aError
ข้อผิดพลาดเมื่อไม่ได้รับการตอบกลับ
[in] aMessage
ตัวชี้ไปยังบัฟเฟอร์ข้อความที่มีเพย์โหลดการตอบกลับสำหรับรับการวินิจฉัยเครือข่ายที่ได้รับ ใช้ได้เฉพาะเมื่อaErrorเป็นOT_ERROR_NONE
[in] aMessageInfo
ตัวชี้ไปยังข้อมูลข้อความสำหรับ aMessage ใช้ได้เฉพาะเมื่อaErrorเป็นOT_ERROR_NONE
[in] aContext
ตัวชี้ไปยังบริบทเฉพาะแอปพลิเคชัน

otRoutePreference

enum otRoutePreference otRoutePreference

กำหนดค่าที่ถูกต้องสำหรับ mPreference ใน otExternalRouteConfig และ otBorderRouterConfig

otServerConfig

struct otServerConfig otServerConfig

แสดงการกำหนดค่าเซิร์ฟเวอร์

otServiceConfig

struct otServiceConfig otServiceConfig

แสดงการกำหนดค่าบริการ

otThreadAnycastLocatorCallback

void(* otThreadAnycastLocatorCallback)(void *aContext, otError aError, const otIp6Address *aMeshLocalAddress, uint16_t aRloc16)

ประเภทตัวชี้จะกำหนดโค้ดเรียกกลับเพื่อแจ้งผลลัพธ์ของคำขอ otThreadLocateAnycastDestination()

รายละเอียด
พารามิเตอร์
[in] aContext
ตัวชี้ไปยังบริบทที่กำหนดเอง (ระบุเมื่อลงทะเบียนโค้ดเรียกกลับ)
[in] aError
ข้อผิดพลาดเมื่อจัดการคำขอ OT_ERROR_NONE บ่งบอกว่าประสบความสำเร็จ OT_ERROR_RESPONSE_TIMEOUT ระบุว่าไม่พบปลายทาง OT_ERROR_ABORT บ่งบอกว่าคำขอถูกยกเลิก
[in] aMeshLocalAddress
ตัวชี้ไปยัง EID ที่ทำงานร่วมกันของปลายทางที่ใกล้ที่สุดของที่อยู่ Anycast เมื่อ aError เป็น OT_ERROR_NONE หรือ NULL ในกรณีอื่นๆ
[in] aRloc16
หากพบ RLOC16 ของปลายทาง หรือ RLOC16 (0xfffe) ไม่ถูกต้อง

otThreadDiscoveryRequestCallback

void(* otThreadDiscoveryRequestCallback)(const otThreadDiscoveryRequestInfo *aInfo, void *aContext)

ระบบจะเรียกตัวชี้ทุกครั้งที่ได้รับข้อความคำขอการค้นพบ MLE

รายละเอียด
พารามิเตอร์
[in] aInfo
ตัวชี้ไปยังข้อมูลคำขอการค้นพบ
[in] aContext
ตัวชี้ไปยังบริบทเฉพาะแอปพลิเคชันการเรียกกลับ

otThreadDiscoveryRequestInfo

struct otThreadDiscoveryRequestInfo otThreadDiscoveryRequestInfo

แสดงข้อมูลคำขอการค้นพบชุดข้อความ

otThreadParentResponseCallback

void(* otThreadParentResponseCallback)(otThreadParentResponseInfo *aInfo, void *aContext)

ระบบจะเรียกเคอร์เซอร์ทุกครั้งที่ได้รับข้อความตอบกลับจากผู้ปกครองของ MLE

ชื่อนี้ใช้ในotThreadRegisterParentResponseCallback()

รายละเอียด
พารามิเตอร์
[in] aInfo
ตัวชี้ไปยังตำแหน่งบนสแต็กที่มีข้อมูลสถิติ
[in] aContext
ตัวชี้ไปยังบริบทเฉพาะไคลเอ็นต์ของโค้ดเรียกกลับ

otThreadParentResponseInfo

struct otThreadParentResponseInfo otThreadParentResponseInfo

แสดงข้อมูลการตอบกลับหลักของ MLE

ฟังก์ชัน

otConvertDurationInSecondsToString

void otConvertDurationInSecondsToString(
  uint32_t aDuration,
  char *aBuffer,
  uint16_t aSize
)

แปลงระยะเวลา uint32_t (เป็นวินาที) เป็นสตริงที่มนุษย์อ่านได้

ต้องเปิดใช้ OPENTHREAD_CONFIG_UPTIME_ENABLE

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

ง.::" (ถ้านานกว่าหนึ่งวัน)

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

มีไว้สำหรับใช้กับ mAge หรือ mConnectionTime ในโครงสร้าง otNeighborInfo หรือ otChildInfo

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

otNetDataContainsOmrPrefix

bool otNetDataContainsOmrPrefix(
  otInstance *aInstance,
  const otIp6Prefix *aPrefix
)

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

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

otNetDataGet

otError otNetDataGet(
  otInstance *aInstance,
  bool aStable,
  uint8_t *aData,
  uint8_t *aDataLength
)

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

รายละเอียด
พารามิเตอร์
[in] aInstance
ตัวชี้ไปยังอินสแตนซ์ OpenThread
[in] aStable
TRUE เมื่อคัดลอกเวอร์ชันเสถียร FALSE เมื่อคัดลอกเวอร์ชันเต็ม
[out] aData
ตัวชี้ไปยังบัฟเฟอร์ข้อมูล
[in,out] aDataLength
ในรายการ ขนาดของบัฟเฟอร์ข้อมูลที่ชี้ไป aData เมื่อออก จำนวนไบต์ที่คัดลอก
แสดงผลค่า
OT_ERROR_NONE
คัดลอกข้อมูลเครือข่ายเทรดไปยัง aData และอัปเดต aDataLength เรียบร้อยแล้ว
OT_ERROR_NO_BUFS
มีพื้นที่ว่างใน aData ไม่เพียงพอที่จะคัดลอกข้อมูลเครือข่ายเทรดโดยสมบูรณ์

otNetDataGetCommissioningDataset

void otNetDataGetCommissioningDataset(
  otInstance *aInstance,
  otCommissioningDataset *aDataset
)

รับชุดข้อมูลการจัดเตรียมจากข้อมูลเครือข่ายของพาร์ติชัน

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

otNetDataGetLength

uint8_t otNetDataGetLength(
  otInstance *aInstance
)

รับความยาวปัจจุบัน (จำนวนไบต์) ของข้อมูลเครือข่ายเทรดของพาร์ติชัน

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

otNetDataGetMaxLength

uint8_t otNetDataGetMaxLength(
  otInstance *aInstance
)

รับความยาวสูงสุดที่สังเกตได้ของข้อมูลเครือข่ายเทรดตั้งแต่เริ่มต้นสแต็ก OT หรือตั้งแต่การเรียกไปยัง otNetDataResetMaxLength() ครั้งล่าสุด

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

otNetDataGetNextLowpanContextInfo

otError otNetDataGetNextLowpanContextInfo(
  otInstance *aInstance,
  otNetworkDataIterator *aIterator,
  otLowpanContextInfo *aContextInfo
)

รับข้อมูลรหัสบริบท 6LoWPAN ถัดไปในข้อมูลเครือข่ายของพาร์ติชัน

รายละเอียด
พารามิเตอร์
[in] aInstance
ตัวชี้ไปยังอินสแตนซ์ OpenThread
[in,out] aIterator
ตัวชี้ไปยังตัววนซ้ำข้อมูลเครือข่าย หากต้องการรับบริการแรก ควรตั้งค่าเป็น OT_NETWORK_DATA_ITERATOR_INIT
[out] aContextInfo
ตัวชี้ไปยังตำแหน่งที่แสดงข้อมูลรหัสบริบท 6LoWPAN ที่ดึงมา
แสดงผลค่า
OT_ERROR_NONE
พบข้อมูลรหัสบริบท 6LoWPAN ถัดไปเรียบร้อยแล้ว
OT_ERROR_NOT_FOUND
ไม่มีข้อมูลบริบท 6LoWPAN ที่ตามมาในข้อมูลเครือข่ายของพาร์ติชัน

otNetDataGetNextOnMeshPrefix

otError otNetDataGetNextOnMeshPrefix(
  otInstance *aInstance,
  otNetworkDataIterator *aIterator,
  otBorderRouterConfig *aConfig
)

รับคำนำหน้า On Mesh รายการถัดไปในข้อมูลเครือข่ายของพาร์ติชัน

รายละเอียด
พารามิเตอร์
[in] aInstance
ตัวชี้ไปยังอินสแตนซ์ OpenThread
[in,out] aIterator
ตัวชี้ไปยังบริบทของตัววนซ้ำข้อมูลเครือข่าย หากต้องการรับรายการใน Mesh รายการแรก ควรตั้งค่าเป็น OT_NETWORK_DATA_ITERATOR_INIT
[out] aConfig
ตัวชี้ไปยังตำแหน่งที่ใส่ข้อมูลคำนำหน้า Mesh
แสดงผลค่า
OT_ERROR_NONE
พบคำนำหน้า On Mesh รายการถัดไปเรียบร้อยแล้ว
OT_ERROR_NOT_FOUND
ไม่มีคำนำหน้า On Mesh ที่ตามมาในข้อมูลเครือข่ายเทรด

otNetDataGetNextRoute

otError otNetDataGetNextRoute(
  otInstance *aInstance,
  otNetworkDataIterator *aIterator,
  otExternalRouteConfig *aConfig
)

ดูเส้นทางภายนอกถัดไปในข้อมูลเครือข่ายของพาร์ติชัน

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

otNetDataGetNextService

otError otNetDataGetNextService(
  otInstance *aInstance,
  otNetworkDataIterator *aIterator,
  otServiceConfig *aConfig
)

รับบริการถัดไปในข้อมูลเครือข่ายของพาร์ติชัน

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

otNetDataGetStableVersion

uint8_t otNetDataGetStableVersion(
  otInstance *aInstance
)

ดาวน์โหลดเวอร์ชันข้อมูลเครือข่ายเสถียร

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

otNetDataGetVersion

uint8_t otNetDataGetVersion(
  otInstance *aInstance
)

รับเวอร์ชันข้อมูลเครือข่าย

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

otNetDataIsDnsSrpServiceAdded

bool otNetDataIsDnsSrpServiceAdded(
  otInstance *aInstance
)

ระบุว่าปัจจุบันมีการเพิ่มรายการ "DNS/SRP Service" ในข้อมูลเครือข่ายเทรดหรือไม่

ต้องเปิดใช้ฟีเจอร์ OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE

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

otNetDataIsPrefixAdded

bool otNetDataIsPrefixAdded(
  otInstance *aInstance,
  const otIp6Prefix *aPrefix
)

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

ต้องเปิดใช้ฟีเจอร์ OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE

รายละเอียด
พารามิเตอร์
[in] aInstance
ตัวชี้ไปยังอินสแตนซ์ OpenThread
[in] aPrefix
ตัวชี้ไปยังคำนำหน้า (ต้องไม่ใช่ NULL)
แสดงผลค่า
TRUE
รายการคำนำหน้าที่เผยแพร่จะเพิ่มไปยังข้อมูลเครือข่ายเทรด
FALSE
รายการไม่ได้ถูกเพิ่มลงในข้อมูลเครือข่ายเทรด หรือไม่มีรายการที่จะเผยแพร่

otNetDataPublishDnsSrpServiceAnycast

void otNetDataPublishDnsSrpServiceAnycast(
  otInstance *aInstance,
  uint8_t aSequenceNUmber
)

คำขอเผยแพร่ "DNS/SRP Service Anycast Address" ในข้อมูลเครือข่ายเทรด

ต้องเปิดใช้ฟีเจอร์ OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE

การเรียกฟังก์ชันนี้จะลบและแทนที่รายการ "บริการ DNS/SRP" ใดๆ ที่เคยเผยแพร่ไว้ (จากการเรียกใช้ก่อนหน้าไปยังฟังก์ชัน otNetDataPublishDnsSrpService{Type}() ใดก็ตาม)

รายละเอียด
พารามิเตอร์
[in] aInstance
ตัวชี้ไปยังอินสแตนซ์ OpenThread
[in] aSequenceNUmber
หมายเลขลำดับของ DNS/SRP Anycast Service

otNetDataPublishDnsSrpServiceUnicast

void otNetDataPublishDnsSrpServiceUnicast(
  otInstance *aInstance,
  const otIp6Address *aAddress,
  uint16_t aPort
)

ขอเผยแพร่ "ที่อยู่ Unicast ของบริการ DNS/SRP" ในข้อมูลเครือข่ายเทรด

ต้องเปิดใช้ฟีเจอร์ OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE

การเรียกฟังก์ชันนี้จะลบและแทนที่รายการ "บริการ DNS/SRP" ใดๆ ที่เคยเผยแพร่ไว้ (จากการเรียกใช้ก่อนหน้าไปยังฟังก์ชัน otNetDataPublishDnsSrpService{Type}() ใดก็ตาม)

เผยแพร่ "DNS/SRP Service Unicast Address" โดยใส่ที่อยู่และข้อมูลพอร์ตในข้อมูล TLV ของบริการ

รายละเอียด
พารามิเตอร์
[in] aInstance
ตัวชี้ไปยังอินสแตนซ์ OpenThread
[in] aAddress
ที่อยู่เซิร์ฟเวอร์ DNS/SRP ที่จะเผยแพร่ (ต้องไม่ใช่ NULL)
[in] aPort
หมายเลขพอร์ตเซิร์ฟเวอร์ SRP ที่จะเผยแพร่

otNetDataPublishDnsSrpServiceUnicastMeshLocalEid

void otNetDataPublishDnsSrpServiceUnicastMeshLocalEid(
  otInstance *aInstance,
  uint16_t aPort
)

ขอเผยแพร่ "ที่อยู่ Unicast ของบริการ DNS/SRP" ในข้อมูลเครือข่ายเทรด

ต้องเปิดใช้ฟีเจอร์ OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE

การเรียกฟังก์ชันนี้จะลบและแทนที่รายการ "บริการ DNS/SRP" ใดๆ ที่เคยเผยแพร่ไว้ (จากการเรียกใช้ก่อนหน้าไปยังฟังก์ชัน otNetDataPublishDnsSrpService{Type}() ใดก็ตาม)

ฟังก์ชันนี้ต่างจาก otNetDataPublishDnsSrpServiceUnicast() ที่กำหนดให้ต้องระบุที่อยู่ที่เผยแพร่และมีข้อมูลใน TLV ของบริการ แต่ฟังก์ชันนี้ใช้ EID ที่ทำงานร่วมกันของอุปกรณ์และรวมข้อมูลไว้ในข้อมูล TLV ของเซิร์ฟเวอร์

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

otNetDataPublishExternalRoute

otError otNetDataPublishExternalRoute(
  otInstance *aInstance,
  const otExternalRouteConfig *aConfig
)

ขอให้เผยแพร่คำนำหน้าเส้นทางภายนอกในข้อมูลเครือข่ายเทรด

ต้องเปิดใช้ฟีเจอร์ OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE

เผยแพร่ได้เฉพาะรายการแบบคงที่เท่านั้น (เช่นaConfig.mStable ต้องเป็นจริง)

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

รายละเอียด
พารามิเตอร์
[in] aInstance
ตัวชี้ไปยังอินสแตนซ์ OpenThread
[in] aConfig
การกำหนดค่าเส้นทางภายนอกที่จะเผยแพร่ (ต้องไม่ใช่ NULL)
แสดงผลค่า
OT_ERROR_NONE
เผยแพร่เส้นทางภายนอกเรียบร้อยแล้ว
OT_ERROR_INVALID_ARGS
aConfig ไม่ถูกต้อง (คำนำหน้าไม่ถูกต้อง ชุดค่าผสมของแฟล็กไม่ถูกต้อง หรือไม่เสถียร)
OT_ERROR_NO_BUFS
จัดสรรรายการสำหรับคำขอใหม่ไม่ได้ ผู้เผยแพร่โฆษณารองรับรายการได้ในจำนวนจำกัด (แชร์ระหว่างคำนำหน้าใน Mesh และเส้นทางภายนอก) ซึ่งกำหนดโดยการกำหนดค่า OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES

otNetDataPublishOnMeshPrefix

otError otNetDataPublishOnMeshPrefix(
  otInstance *aInstance,
  const otBorderRouterConfig *aConfig
)

ขอให้เผยแพร่คำนำหน้าที่ทำงานร่วมกันในข้อมูลเครือข่ายเทรด

ต้องเปิดใช้ฟีเจอร์ OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE

เผยแพร่ได้เฉพาะรายการแบบคงที่เท่านั้น (เช่นaConfig.mStable ต้องเป็นจริง)

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

รายละเอียด
พารามิเตอร์
[in] aInstance
ตัวชี้ไปยังอินสแตนซ์ OpenThread
[in] aConfig
การกำหนดค่าคำนำหน้าใน Mesh สำหรับเผยแพร่ (ต้องไม่ใช่ NULL)
แสดงผลค่า
OT_ERROR_NONE
เผยแพร่คำนำหน้าที่ทำงานร่วมกันเรียบร้อยแล้ว
OT_ERROR_INVALID_ARGS
aConfig ไม่ถูกต้อง (คำนำหน้าไม่ถูกต้อง ชุดค่าผสมของแฟล็กไม่ถูกต้อง หรือไม่เสถียร)
OT_ERROR_NO_BUFS
จัดสรรรายการสำหรับคำขอใหม่ไม่ได้ ผู้เผยแพร่โฆษณารองรับรายการได้ในจำนวนจำกัด (แชร์ระหว่างคำนำหน้าใน Mesh และเส้นทางภายนอก) ซึ่งกำหนดโดยการกำหนดค่า OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES

otNetDataReplacePublishedExternalRoute

otError otNetDataReplacePublishedExternalRoute(
  otInstance *aInstance,
  const otIp6Prefix *aPrefix,
  const otExternalRouteConfig *aConfig
)

แทนที่เส้นทางภายนอกที่เผยแพร่ก่อนหน้านี้ในข้อมูลเครือข่ายเทรด

ต้องเปิดใช้ฟีเจอร์ OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE

หากไม่มีเส้นทางภายนอกที่เผยแพร่ก่อนหน้าที่ตรงกับ aPrefix ฟังก์ชันนี้จะทำงานคล้ายกับ otNetDataPublishExternalRoute() กล่าวคือ จะเริ่มขั้นตอนการเผยแพร่ aConfig เป็นเส้นทางภายนอกในข้อมูลเครือข่ายเทรด

หากมีรายการเส้นทางที่ได้รับการเผยแพร่ก่อนหน้านี้ตรงกับ aPrefix ระบบจะแทนที่รายการนั้นด้วยคำนำหน้าใหม่จาก aConfig

  • ถ้ามีการเพิ่ม aPrefix ในข้อมูลเครือข่ายแล้ว การเปลี่ยนแปลงคำนำหน้าใหม่ใน aConfig จะปรากฏในข้อมูลเครือข่ายทันที เพื่อให้แน่ใจว่ารายการเส้นทางในข้อมูลเครือข่ายไม่ถูกลบออกในทันที และการเปลี่ยนจากคำนำหน้าเป็นคำนำหน้าใหม่เป็นไปอย่างราบรื่น
  • หากไม่มีการเพิ่ม aPrefix เดิมที่เผยแพร่ในข้อมูลเครือข่าย aConfig ใหม่จะถูกแทนที่ด้วยคำนำหน้าใหม่ แต่จะไม่มีการเพิ่มในทันที แต่จะเริ่มขั้นตอนการเผยแพร่ค่าดังกล่าวในข้อมูลเครือข่าย (การตรวจสอบข้อมูลเครือข่ายเพื่อกำหนดเวลา/หากจะเพิ่มคำนำหน้า ทั้งนี้ขึ้นอยู่กับจำนวนของคำนำหน้าที่คล้ายกันที่มีอยู่ในข้อมูลเครือข่าย)

รายละเอียด
พารามิเตอร์
[in] aInstance
ตัวชี้ไปยังอินสแตนซ์ OpenThread
[in] aPrefix
คำนำหน้าเส้นทางภายนอกที่เผยแพร่ก่อนหน้านี้ที่จะแทนที่
[in] aConfig
การกำหนดค่าเส้นทางภายนอกที่จะเผยแพร่
แสดงผลค่า
OT_ERROR_NONE
เผยแพร่เส้นทางภายนอกเรียบร้อยแล้ว
OT_ERROR_INVALID_ARGS
aConfig ไม่ถูกต้อง (คำนำหน้าไม่ถูกต้อง ชุดค่าผสมของแฟล็กไม่ถูกต้อง หรือไม่เสถียร)
OT_ERROR_NO_BUFS
จัดสรรรายการสำหรับคำขอใหม่ไม่ได้ ผู้เผยแพร่โฆษณารองรับรายการได้ในจำนวนจำกัด (แชร์ระหว่างคำนำหน้าใน Mesh และเส้นทางภายนอก) ซึ่งกำหนดโดยการกำหนดค่า OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES

otNetDataResetMaxLength

void otNetDataResetMaxLength(
  otInstance *aInstance
)

รีเซ็ตความยาวสูงสุดของข้อมูลเครือข่ายเทรดที่ติดตาม

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

otNetDataSetDnsSrpServicePublisherCallback

void otNetDataSetDnsSrpServicePublisherCallback(
  otInstance *aInstance,
  otNetDataDnsSrpServicePublisherCallback aCallback,
  void *aContext
)

ตั้งค่าโค้ดเรียกกลับสำหรับการแจ้งเตือนเมื่อมีการเพิ่มหรือนำ "บริการ DNS/SRP" ที่เผยแพร่ออกจากข้อมูลเครือข่ายเทรด

การเรียกฟังก์ชันนี้ในภายหลังจะแทนที่ฟังก์ชันเรียกกลับที่ตั้งค่าไว้ก่อนหน้านี้

ต้องเปิดใช้ฟีเจอร์ OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE

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

otNetDataSetPrefixPublisherCallback

void otNetDataSetPrefixPublisherCallback(
  otInstance *aInstance,
  otNetDataPrefixPublisherCallback aCallback,
  void *aContext
)

ตั้งค่าโค้ดเรียกกลับสำหรับการแจ้งเตือนเมื่อมีการเพิ่มหรือนำรายการคำนำหน้าที่เผยแพร่ออกจากข้อมูลเครือข่ายเทรด

การเรียกฟังก์ชันนี้ในภายหลังจะแทนที่ฟังก์ชันเรียกกลับที่ตั้งค่าไว้ก่อนหน้านี้

ต้องเปิดใช้ฟีเจอร์ OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE

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

otNetDataSteeringDataCheckJoiner

otError otNetDataSteeringDataCheckJoiner(
  otInstance *aInstance,
  const otExtAddress *aEui64
)

ตรวจสอบว่าข้อมูลการบังคับเลี้ยวมี Joiner หรือไม่

รายละเอียด
พารามิเตอร์
[in] aInstance
ตัวชี้ไปยังอินสแตนซ์ OpenThread
[in] aEui64
ตัวชี้ไปยัง IEEE EUI-64 ของ Joiner
แสดงผลค่า
OT_ERROR_NONE
aEui64 รวมอยู่ในข้อมูลพวงมาลัยแล้ว
OT_ERROR_INVALID_STATE
ไม่มีข้อมูลการบังคับเลี้ยว
OT_ERROR_NOT_FOUND
aEui64 ไม่รวมอยู่ในข้อมูลพวงมาลัย

otNetDataSteeringDataCheckJoinerWithDiscerner

otError otNetDataSteeringDataCheckJoinerWithDiscerner(
  otInstance *aInstance,
  const struct otJoinerDiscerner *aDiscerner
)

ตรวจสอบว่าข้อมูลการบังคับเลี้ยวมีเครื่องมือเชื่อมต่อที่มีค่าเฉพาะของข้อมูลหรือไม่

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

otNetDataUnpublishDnsSrpService

void otNetDataUnpublishDnsSrpService(
  otInstance *aInstance
)

ยกเลิกการเผยแพร่รายการบริการ DNS/SRP (Anycast หรือ Unicast) ที่เพิ่มก่อนหน้านี้จากข้อมูลเครือข่ายเทรด

ต้องเปิดใช้ OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE

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

otNetDataUnpublishPrefix

otError otNetDataUnpublishPrefix(
  otInstance *aInstance,
  const otIp6Prefix *aPrefix
)

ยกเลิกการเผยแพร่คำนำหน้าเส้นทาง On-Mesh หรือ External Route ที่เผยแพร่ก่อนหน้านี้

ต้องเปิดใช้ OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE

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

otThreadBecomeChild

otError otThreadBecomeChild(
  otInstance *aInstance
)

ลองแนบไฟล์อีกครั้งตอนเด็ก

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

otThreadBecomeDetached

otError otThreadBecomeDetached(
  otInstance *aInstance
)

ปลดจากเครือข่ายเทรด

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

otThreadDetachGracefully

otError otThreadDetachGracefully(
  otInstance *aInstance,
  otDetachGracefullyCallback aCallback,
  void *aContext
)

แจ้งเตือนโหนดอื่นๆ ในเครือข่าย (หากมี) จากนั้นจะหยุดการดำเนินการของโปรโตคอลเทรด

ซึ่งจะส่งการเผยแพร่ที่อยู่หากเป็นเราเตอร์ หรือตั้งค่าระยะหมดเวลาย่อยเป็น 0 ในกรณีที่เป็นเราเตอร์ย่อย

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

otThreadDeviceRoleToString

const char * otThreadDeviceRoleToString(
  otDeviceRole aRole
)

แปลงบทบาทอุปกรณ์เป็นสตริงที่มนุษย์อ่านได้

รายละเอียด
พารามิเตอร์
[in] aRole
บทบาทอุปกรณ์ที่จะทำ Conversion
การส่งคืน
สตริงที่มีค่าแทน aRole

otThreadDiscover

otError otThreadDiscover(
  otInstance *aInstance,
  uint32_t aScanChannels,
  uint16_t aPanId,
  bool aJoiner,
  bool aEnableEui64Filtering,
  otHandleActiveScanResult aCallback,
  void *aCallbackContext
)

เริ่มสแกนการค้นพบชุดข้อความ

รายละเอียด
พารามิเตอร์
[in] aInstance
ตัวชี้ไปยังอินสแตนซ์ OpenThread
[in] aScanChannels
เวกเตอร์เล็กน้อยที่ระบุช่องที่จะสแกน (เช่น OT_CHANNEL_11_MASK)
[in] aPanId
ตัวกรองรหัส PAN (ตั้งค่าเป็น PAN สำหรับการออกอากาศเพื่อปิดใช้ตัวกรอง)
[in] aJoiner
ค่าของแฟล็กผู้ผนวกใน TLV ของคำขอการค้นพบ
[in] aEnableEui64Filtering
TRUE เพื่อกรองคำตอบใน EUI-64 หากไม่เป็นเช่นนั้น
[in] aCallback
ตัวชี้ไปยังฟังก์ชันที่เรียกใช้เมื่อได้รับการตอบกลับการค้นพบ MLE หรือการสแกนเสร็จสมบูรณ์
[in] aCallbackContext
ตัวชี้ไปยังบริบทเฉพาะแอปพลิเคชัน
แสดงผลค่า
OT_ERROR_NONE
เริ่มสแกนการค้นพบชุดข้อความเรียบร้อยแล้ว
OT_ERROR_INVALID_STATE
อินเทอร์เฟซ IPv6 ไม่ได้เปิดใช้งาน (netif ไม่เปิดใช้งาน)
OT_ERROR_NO_BUFS
ไม่สามารถจัดสรรข้อความสำหรับคำขอการค้นพบ
OT_ERROR_BUSY
กำลังดำเนินการสแกนการค้นหาชุดข้อความ

otThreadGetChildTimeout

uint32_t otThreadGetChildTimeout(
  otInstance *aInstance
)

รับระยะหมดเวลาของเทรดย่อย (เป็นวินาที) ที่ใช้เมื่อดำเนินการในบทบาทย่อย

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

otThreadGetDeviceRole

otDeviceRole otThreadGetDeviceRole(
  otInstance *aInstance
)

รับบทบาทในอุปกรณ์

รายละเอียด
พารามิเตอร์
[in] aInstance
ตัวชี้ไปยังอินสแตนซ์ OpenThread
แสดงผลค่า
OT_DEVICE_ROLE_DISABLED
กลุ่มเทรดปิดใช้อยู่
OT_DEVICE_ROLE_DETACHED
ขณะนี้อุปกรณ์ไม่ได้เข้าร่วมเครือข่าย/พาร์ติชันเทรด
OT_DEVICE_ROLE_CHILD
ปัจจุบันอุปกรณ์ทำงานเป็น Thread Child
OT_DEVICE_ROLE_ROUTER
อุปกรณ์กำลังทำงานเป็นเราเตอร์เทรด
OT_DEVICE_ROLE_LEADER
ปัจจุบันอุปกรณ์กำลังทำงานในฐานะผู้นำชุดข้อความ

otThreadGetDomainName

const char * otThreadGetDomainName(
  otInstance *aInstance
)

รับชื่อโดเมนเทรด

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

otThreadGetExtendedPanId

const otExtendedPanId * otThreadGetExtendedPanId(
  otInstance *aInstance
)

รับรหัส PAN ที่ขยาย IEEE 802.15.4

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

otThreadGetFixedDuaInterfaceIdentifier

const otIp6InterfaceIdentifier * otThreadGetFixedDuaInterfaceIdentifier(
  otInstance *aInstance
)

รับตัวระบุอินเทอร์เฟซที่ระบุไว้ด้วยตนเองสำหรับที่อยู่ Thread Domain Unicast

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

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

otThreadGetIp6Counters

const otIpCounters * otThreadGetIp6Counters(
  otInstance *aInstance
)

รับตัวนับ IPv6

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

otThreadGetKeySequenceCounter

uint32_t otThreadGetKeySequenceCounter(
  otInstance *aInstance
)

รับ thrKeySequenceCounter

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

otThreadGetKeySwitchGuardTime

uint32_t otThreadGetKeySwitchGuardTime(
  otInstance *aInstance
)

รับ thrKeySwitchGuardTime (เป็นชั่วโมง)

รายละเอียด
พารามิเตอร์
[in] aInstance
ตัวชี้ไปยังอินสแตนซ์ OpenThread
การส่งคืน
ค่า thrKeySwitchGuardTime (เป็นชั่วโมง)
ดูเพิ่มเติม:
otThreadSetKeySwitchGuardTime

otThreadGetLeaderData

otError otThreadGetLeaderData(
  otInstance *aInstance,
  otLeaderData *aLeaderData
)

รับข้อมูลผู้นำชุดข้อความ

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

otThreadGetLeaderRloc

otError otThreadGetLeaderRloc(
  otInstance *aInstance,
  otIp6Address *aLeaderRloc
)

แสดงตัวชี้ไปยัง RLOC ของผู้นำ

รายละเอียด
พารามิเตอร์
[in] aInstance
ตัวชี้ไปยังอินสแตนซ์ OpenThread
[out] aLeaderRloc
ตัวชี้ไปยัง RLOC ของผู้นำ
แสดงผลค่า
OT_ERROR_NONE
เขียน RLOC ของผู้นำไปยัง aLeaderRloc เรียบร้อยแล้ว
OT_ERROR_INVALID_ARGS
aLeaderRloc มีค่าเป็น NULL
OT_ERROR_DETACHED
ไม่ได้แนบกับพาร์ติชันเทรดในขณะนี้

otThreadGetLeaderRouterId

uint8_t otThreadGetLeaderRouterId(
  otInstance *aInstance
)

รับรหัสเราเตอร์ของผู้นำ

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

otThreadGetLeaderWeight

uint8_t otThreadGetLeaderWeight(
  otInstance *aInstance
)

ถ่วงน้ำหนักผู้นำ

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

otThreadGetLinkLocalAllThreadNodesMulticastAddress

const otIp6Address * otThreadGetLinkLocalAllThreadNodesMulticastAddress(
  otInstance *aInstance
)

รับที่อยู่มัลติแคสต์สำหรับโหนดเทรดทั้งหมดแบบ Thread Link

ที่อยู่เป็นที่อยู่มัลติแคสต์ที่อิงตามคำนำหน้ายูนิแคสต์ที่ลิงก์ภายในเครื่อง [RFC 3306] โดยมี:

  • ตั้งค่า flgs เป็น 3 (P = 1 และ T = 1)
  • ตั้งค่า scop เป็น 2
  • ตั้งค่า plen เป็น 64
  • ตั้งค่าคำนำหน้าเครือข่ายเป็นคำนำหน้า Mesh Local แล้ว
  • ตั้งรหัสกลุ่มเป็น 1 แล้ว

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

otThreadGetLinkLocalIp6Address

const otIp6Address * otThreadGetLinkLocalIp6Address(
  otInstance *aInstance
)

รับที่อยู่ IPv6 ภายในลิงก์เทรด

ที่อยู่ภายในของลิงก์เทรดจะได้มาโดยใช้ IEEE802.15.4 Extended Address เป็น Interface Identifier

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

otThreadGetLinkMode

otLinkModeConfig otThreadGetLinkMode(
  otInstance *aInstance
)

รับการกำหนดค่าโหมดลิงก์ MLE

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

otThreadGetMaxTimeInQueue

uint32_t otThreadGetMaxTimeInQueue(
  otInstance *aInstance
)

รับการกำหนดเวลาเข้าคิวสูงสุดสำหรับข้อความในคิว TX

ต้องใช้ OPENTHREAD_CONFIG_TX_QUEUE_STATISTICS_ENABLE

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

สถิติที่เก็บรวบรวมไว้สามารถรีเซ็ตได้โดยการเรียกใช้ otThreadResetTimeInQueueStat()

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

otThreadGetMeshLocalEid

const otIp6Address * otThreadGetMeshLocalEid(
  otInstance *aInstance
)

รับที่อยู่ EID ในเครื่องของ Mesh

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

otThreadGetMeshLocalPrefix

const otMeshLocalPrefix * otThreadGetMeshLocalPrefix(
  otInstance *aInstance
)

แสดงผลตัวชี้ไปยังคำนำหน้า Mesh Local

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

otThreadGetMleCounters

const otMleCounters * otThreadGetMleCounters(
  otInstance *aInstance
)

รับตัวนับ MLE ของเทรด

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

otThreadGetNetworkKey

void otThreadGetNetworkKey(
  otInstance *aInstance,
  otNetworkKey *aNetworkKey
)

รับคีย์เครือข่ายเทรด

รายละเอียด
พารามิเตอร์
[in] aInstance
ตัวชี้ไปยังอินสแตนซ์ OpenThread
[out] aNetworkKey
ตัวชี้ไปยัง otNetworkKey เพื่อส่งคืนคีย์เครือข่ายของเทรด
ดูเพิ่มเติม:
otThreadSetNetworkKey

otThreadGetNetworkKeyRef

otNetworkKeyRef otThreadGetNetworkKeyRef(
  otInstance *aInstance
)

รับ otNetworkKeyRef สำหรับคีย์เครือข่ายเทรด

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

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

otThreadGetNetworkName

const char * otThreadGetNetworkName(
  otInstance *aInstance
)

รับชื่อเครือข่ายเทรด

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

otThreadGetNextDiagnosticTlv

otError otThreadGetNextDiagnosticTlv(
  const otMessage *aMessage,
  otNetworkDiagIterator *aIterator,
  otNetworkDiagTlv *aNetworkDiagTlv
)

รับ TLV การวินิจฉัยเครือข่ายถัดไปในข้อความ

ต้องใช้ OPENTHREAD_CONFIG_TMF_NETDIAG_CLIENT_ENABLE

ระบบจะอนุญาตให้เรียกฟังก์ชันนี้ในภายหลังเมื่อค่าการแสดงผลปัจจุบันคือ OT_ERROR_NONE เท่านั้น

รายละเอียด
พารามิเตอร์
[in] aMessage
ตัวชี้ไปยังข้อความ
[in,out] aIterator
ตัวชี้ไปยังบริบทของตัวซ้ำการวินิจฉัยเครือข่าย หากต้องการรับ TLV การวินิจฉัยเครือข่ายรายการแรก ควรตั้งค่าเป็น OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT
[out] aNetworkDiagTlv
ตัวชี้ไปยังตำแหน่งที่แสดงข้อมูล TLV การวินิจฉัยเครือข่าย
แสดงผลค่า
OT_ERROR_NONE
พบ TLV การวินิจฉัยเครือข่ายถัดไปเรียบร้อยแล้ว
OT_ERROR_NOT_FOUND
ไม่มี TLV การวินิจฉัยเครือข่ายที่ตามมาในข้อความนี้
OT_ERROR_PARSE
การแยกวิเคราะห์การวินิจฉัยเครือข่ายถัดไปล้มเหลว

otThreadGetNextNeighborInfo

otError otThreadGetNextNeighborInfo(
  otInstance *aInstance,
  otNeighborInfoIterator *aIterator,
  otNeighborInfo *aInfo
)

รับข้อมูลเพื่อนบ้านถัดไป

ซึ่งใช้สำหรับดูรายการของตารางใกล้เคียง

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

otThreadGetParentAverageRssi

otError otThreadGetParentAverageRssi(
  otInstance *aInstance,
  int8_t *aParentRssi
)

ฟังก์ชันนี้ดึงข้อมูล RSSI โดยเฉลี่ยสำหรับเทรดระดับบน

รายละเอียด
พารามิเตอร์
[in] aInstance
ตัวชี้ไปยังอินสแตนซ์ OpenThread
[out] aParentRssi
ตัวชี้ไปยังจุดที่ควรวาง RSSI ระดับบนสุด

otThreadGetParentInfo

otError otThreadGetParentInfo(
  otInstance *aInstance,
  otRouterInfo *aParentInfo
)

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

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

otThreadGetParentLastRssi

otError otThreadGetParentLastRssi(
  otInstance *aInstance,
  int8_t *aLastRssi
)

ฟังก์ชันจะเรียก RSSI ของแพ็กเก็ตล่าสุดจากเทรดระดับบนสุด

รายละเอียด
พารามิเตอร์
[in] aInstance
ตัวชี้ไปยังอินสแตนซ์ OpenThread
[out] aLastRssi
ตัวชี้ไปยังจุดที่ควรวาง RSSI ตัวสุดท้าย
แสดงผลค่า
OT_ERROR_NONE
ดึงข้อมูล RSSI เรียบร้อยแล้ว
OT_ERROR_FAILED
รับข้อมูล RSSI ไม่ได้
OT_ERROR_INVALID_ARGS
aLastRssi เป็นค่าว่าง

otThreadGetPartitionId

uint32_t otThreadGetPartitionId(
  otInstance *aInstance
)

รับรหัสพาร์ติชัน

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

otThreadGetRealmLocalAllThreadNodesMulticastAddress

const otIp6Address * otThreadGetRealmLocalAllThreadNodesMulticastAddress(
  otInstance *aInstance
)

รับที่อยู่มัลติแคสต์สำหรับโหนดเทรดทั้งหมดของ Thread Realm-Local

ที่อยู่เป็นที่อยู่มัลติแคสต์ตามคำนำหน้า Unicast ในพื้นที่จริง [RFC 3306] โดยมี:

  • ตั้งค่า flgs เป็น 3 (P = 1 และ T = 1)
  • ตั้งค่า scop เป็น 3
  • ตั้งค่า plen เป็น 64
  • ตั้งค่าคำนำหน้าเครือข่ายเป็นคำนำหน้า Mesh Local แล้ว
  • ตั้งรหัสกลุ่มเป็น 1 แล้ว

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

otThreadGetRloc

const otIp6Address * otThreadGetRloc(
  otInstance *aInstance
)

รับที่อยู่ Thread Routing Locator (RLOC)

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

otThreadGetRloc16

uint16_t otThreadGetRloc16(
  otInstance *aInstance
)

รับ RLOC16

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

otThreadGetServiceAloc

otError otThreadGetServiceAloc(
  otInstance *aInstance,
  uint8_t aServiceId,
  otIp6Address *aServiceAloc
)

เรียกข้อมูล ALOC ของบริการสำหรับรหัสบริการที่ระบุ

รายละเอียด
พารามิเตอร์
[in] aInstance
ตัวชี้ไปยังอินสแตนซ์ OpenThread
[in] aServiceId
รหัสบริการที่จะรับ ALOC
[out] aServiceAloc
ตัวชี้สำหรับแสดงผล ALOC ของบริการ ต้องไม่เป็นค่าว่าง
แสดงผลค่า
OT_ERROR_NONE
เรียกข้อมูล ALOC บริการเรียบร้อยแล้ว
OT_ERROR_DETACHED
ปัจจุบันอินเทอร์เฟซเทรดไม่ได้เชื่อมต่อกับพาร์ติชันเทรด

otThreadGetTimeInQueueHistogram

const uint32_t * otThreadGetTimeInQueueHistogram(
  otInstance *aInstance,
  uint16_t *aNumBins,
  uint32_t *aBinInterval
)

รับฮิสโตแกรมการอยู่ในคิวของข้อความในคิว TX

ต้องใช้ OPENTHREAD_CONFIG_TX_QUEUE_STATISTICS_ENABLE

ฮิสโตแกรมของคิวการส่งข้อความในคิวการส่งได้รับการรวบรวม ระบบจะติดตามเวลาในคิวสำหรับการส่งโดยตรงเท่านั้น และจะวัดเป็นระยะเวลานับจากเวลาที่เพิ่มข้อความลงในคิวการส่งจนกระทั่งส่งไปยังเลเยอร์ MAC เพื่อการส่งหรือปล่อย

ฮิสโตแกรมจะแสดงผลเป็นอาร์เรย์ของค่า uint32_t โดยมี aNumBins รายการ รายการแรกในอาร์เรย์ (ที่ดัชนี 0) แสดงจำนวนข้อความที่มีเวลาในคิวน้อยกว่า aBinInterval รายการที่สองหมายถึงจำนวนข้อความที่มีคิวเวลามากกว่าหรือเท่ากับ aBinInterval แต่น้อยกว่า 2 * aBinInterval เป็นต้น รายการสุดท้ายแสดงจำนวนข้อความที่มีเวลาในคิวมากกว่าหรือเท่ากับ (aNumBins - 1) * aBinInterval

สถิติที่เก็บรวบรวมไว้สามารถรีเซ็ตได้โดยการเรียกใช้ otThreadResetTimeInQueueStat() ระบบจะเก็บรวบรวมข้อมูลฮิสโตแกรมตั้งแต่เริ่มต้นอินสแตนซ์ OpenThread หรือตั้งแต่ครั้งล่าสุดที่มีการรีเซ็ตการรวบรวมสถิติโดยการเรียกใช้ otThreadResetTimeInQueueStat()

ตัวชี้ aNumBins และ aBinInterval ต้องไม่เป็นค่าว่าง

รายละเอียด
พารามิเตอร์
[in] aInstance
ตัวชี้ไปยังอินสแตนซ์ OpenThread
[out] aNumBins
ตัวชี้ที่จะแสดงผลจำนวน Bin ในฮิสโตแกรม (ความยาวอาร์เรย์)
[out] aBinInterval
ตัวชี้เพื่อแสดงผลความยาวของช่วงเวลา Bin ของฮิสโตแกรมเป็นมิลลิวินาที
การส่งคืน
ตัวชี้ไปยังอาร์เรย์ของ aNumBins ที่แสดงข้อมูลฮิสโตแกรมที่เก็บรวบรวม

otThreadGetVendorModel

const char * otThreadGetVendorModel(
  otInstance *aInstance
)

รับสตริงรูปแบบของผู้ให้บริการ

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

otThreadGetVendorName

const char * otThreadGetVendorName(
  otInstance *aInstance
)

รับสตริงชื่อผู้ให้บริการ

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

otThreadGetVendorSwVersion

const char * otThreadGetVendorSwVersion(
  otInstance *aInstance
)

รับสตริงเวอร์ชัน sw ของผู้ให้บริการ

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

otThreadGetVersion

uint16_t otThreadGetVersion(
  void
)

รับเวอร์ชันโปรโตคอลเทรด

รายละเอียด
การส่งคืน
เวอร์ชันโปรโตคอลเทรด

otThreadIsAnycastLocateInProgress

bool otThreadIsAnycastLocateInProgress(
  otInstance *aInstance
)

ระบุว่าขณะนี้คำขอค้นหา Anycast อยู่ระหว่างดำเนินการหรือไม่

พร้อมใช้งานเมื่อเปิดใช้ OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE เท่านั้น

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

otThreadIsDiscoverInProgress

bool otThreadIsDiscoverInProgress(
  otInstance *aInstance
)

ระบุว่าการค้นพบเทรด MLE อยู่ระหว่างดำเนินการหรือไม่

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

otThreadIsSingleton

bool otThreadIsSingleton(
  otInstance *aInstance
)

ระบุว่าโหนดเป็นเราเตอร์เดียวในเครือข่ายหรือไม่

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

otThreadLocateAnycastDestination

otError otThreadLocateAnycastDestination(
  otInstance *aInstance,
  const otIp6Address *aAnycastAddress,
  otThreadAnycastLocatorCallback aCallback,
  void *aContext
)

ร้องขอปลายทางที่ใกล้ที่สุดของที่อยู่ Anycast ที่ระบุ

พร้อมใช้งานเมื่อเปิดใช้ OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE เท่านั้น

หากคำขอก่อนหน้านี้ดำเนินอยู่ การเรียกใช้ฟังก์ชันนี้ในภายหลังจะยกเลิกและแทนที่คำขอก่อนหน้า

รายละเอียด
พารามิเตอร์
[in] aInstance
ตัวชี้ไปยังอินสแตนซ์ OpenThread
[in] aAnycastAddress
ที่อยู่ Anycast ที่จะค้นหา ต้องไม่ใช่ NULL
[in] aCallback
ฟังก์ชันเรียกกลับที่จะรายงานผลลัพธ์
[in] aContext
บริบทที่กำหนดเองที่ใช้กับ aCallback
แสดงผลค่า
OT_ERROR_NONE
ส่งคำขอเรียบร้อยแล้ว ระบบจะเรียกใช้ aCallback เพื่อรายงานผลลัพธ์
OT_ERROR_INVALID_ARGS
aAnycastAddress ไม่ใช่ที่อยู่ Anycast ที่ถูกต้อง หรือ aCallback เป็นค่าว่าง
OT_ERROR_NO_BUFS
บัฟเฟอร์ไม่เพียงพอสำหรับการเตรียมและส่งข้อความคำขอ

otThreadRegisterParentResponseCallback

void otThreadRegisterParentResponseCallback(
  otInstance *aInstance,
  otThreadParentResponseCallback aCallback,
  void *aContext
)

ลงทะเบียนการติดต่อกลับเพื่อรับข้อมูลการตอบกลับระดับบนสุดของ MLE

ต้องใช้ OPENTHREAD_CONFIG_MLE_PARENT_RESPONSE_CALLBACK_API_ENABLE

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

otThreadResetIp6Counters

void otThreadResetIp6Counters(
  otInstance *aInstance
)

รีเซ็ตตัวนับ IPv6

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

otThreadResetMleCounters

void otThreadResetMleCounters(
  otInstance *aInstance
)

รีเซ็ตตัวนับ MLE ของเทรด

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

otThreadResetTimeInQueueStat

void otThreadResetTimeInQueueStat(
  otInstance *aInstance
)

รีเซ็ตสถิติเวลาอยู่ในคิวของคิว TX

ต้องใช้ OPENTHREAD_CONFIG_TX_QUEUE_STATISTICS_ENABLE

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

otThreadSearchForBetterParent

otError otThreadSearchForBetterParent(
  otInstance *aInstance
)

เริ่มกระบวนการให้บุตรหลานค้นหาผู้ปกครองที่ดีกว่าโดยที่ยังอยู่กับผู้ปกครองคนปัจจุบัน

ต้องใช้เมื่อมีการเชื่อมต่ออุปกรณ์ของบุตรหลาน

รายละเอียด
แสดงผลค่า
OT_ERROR_NONE
เริ่มกระบวนการค้นหาผู้ปกครองที่ดีกว่าเรียบร้อยแล้ว
OT_ERROR_INVALID_STATE
บทบาทของอุปกรณ์ไม่ใช่บทบาทย่อย

otThreadSendAddressNotification

void otThreadSendAddressNotification(
  otInstance *aInstance,
  otIp6Address *aDestination,
  otIp6Address *aTarget,
  otIp6InterfaceIdentifier *aMlIid
)

ส่งข้อความแจ้งเตือนที่อยู่เชิงรุก (ADDR_NTF.ntf)

พร้อมใช้งานเมื่อเปิดใช้ OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE เท่านั้น

รายละเอียด
พารามิเตอร์
[in] aInstance
ตัวชี้ไปยังอินสแตนซ์ OpenThread
[in] aDestination
ปลายทางที่จะส่งข้อความ ADDR_NTF.ntf
[in] aTarget
ที่อยู่เป้าหมายของข้อความ ADDR_NTF.ntf
[in] aMlIid
ML-IID ของข้อความ ADDR_NTF.ntf

otThreadSendDiagnosticGet

otError otThreadSendDiagnosticGet(
  otInstance *aInstance,
  const otIp6Address *aDestination,
  const uint8_t aTlvTypes[],
  uint8_t aCount,
  otReceiveDiagnosticGetCallback aCallback,
  void *aCallbackContext
)

ส่งคำขอรับการวินิจฉัยเครือข่าย

ต้องใช้ OPENTHREAD_CONFIG_TMF_NETDIAG_CLIENT_ENABLE

รายละเอียด
พารามิเตอร์
[in] aInstance
ตัวชี้ไปยังอินสแตนซ์ OpenThread
[in] aDestination
ตัวชี้ไปยังที่อยู่ปลายทาง
[in] aTlvTypes
อาร์เรย์ของประเภท TLV การวินิจฉัยเครือข่าย
[in] aCount
จำนวนประเภทใน aTlvTypes
[in] aCallback
ตัวชี้ไปยังฟังก์ชันที่เรียกใช้เมื่อมีการได้รับการตอบกลับเพื่อรับการวินิจฉัยเครือข่ายหรือเป็นค่า NULL เพื่อปิดใช้งานการเรียกกลับ
[in] aCallbackContext
ตัวชี้ไปยังบริบทเฉพาะแอปพลิเคชัน
แสดงผลค่า
OT_ERROR_NONE
จัดคิว DIAG_GET.req เรียบร้อยแล้ว
OT_ERROR_NO_BUFS
บัฟเฟอร์ข้อความไม่เพียงพอที่จะส่ง DIAG_GET.req

otThreadSendDiagnosticReset

otError otThreadSendDiagnosticReset(
  otInstance *aInstance,
  const otIp6Address *aDestination,
  const uint8_t aTlvTypes[],
  uint8_t aCount
)

ส่งคำขอรีเซ็ตการวินิจฉัยเครือข่าย

ต้องใช้ OPENTHREAD_CONFIG_TMF_NETDIAG_CLIENT_ENABLE

รายละเอียด
พารามิเตอร์
[in] aInstance
ตัวชี้ไปยังอินสแตนซ์ OpenThread
[in] aDestination
ตัวชี้ไปยังที่อยู่ปลายทาง
[in] aTlvTypes
อาร์เรย์ของประเภท TLV การวินิจฉัยเครือข่าย ตอนนี้อนุญาตเฉพาะประเภท 9 เท่านั้น
[in] aCount
จำนวนประเภทใน aTlvTypes
แสดงผลค่า
OT_ERROR_NONE
จัดคิว DIAG_RST.ntf เรียบร้อยแล้ว
OT_ERROR_NO_BUFS
มีบัฟเฟอร์ข้อความไม่เพียงพอที่จะส่ง DIAG_RST.ntf

otThreadSendProactiveBackboneNotification

otError otThreadSendProactiveBackboneNotification(
  otInstance *aInstance,
  otIp6Address *aTarget,
  otIp6InterfaceIdentifier *aMlIid,
  uint32_t aTimeSinceLastTransaction
)

ส่งข้อความ Proactive Backbone Notification (PRO_BB.ntf) ในลิงก์ Backbone

พร้อมใช้งานเมื่อเปิดใช้ OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE เท่านั้น

รายละเอียด
พารามิเตอร์
[in] aInstance
ตัวชี้ไปยังอินสแตนซ์ OpenThread
[in] aTarget
ที่อยู่เป้าหมายของข้อความ PRO_BB.ntf
[in] aMlIid
ML-IID ของข้อความ PRO_BB.ntf
[in] aTimeSinceLastTransaction
เวลานับตั้งแต่ธุรกรรมครั้งล่าสุด (เป็นวินาที)
แสดงผลค่า
OT_ERROR_NONE
ส่ง PRO_BB.ntf บนลิงก์หลักเรียบร้อยแล้ว
OT_ERROR_NO_BUFS
หากมีบัฟเฟอร์ข้อความไม่เพียงพอ

otThreadSetChildTimeout

void otThreadSetChildTimeout(
  otInstance *aInstance,
  uint32_t aTimeout
)

ตั้งค่าระยะหมดเวลาของเทรดย่อย (เป็นวินาที) ที่ใช้เมื่อดำเนินการในบทบาทย่อย

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

otThreadSetDiscoveryRequestCallback

void otThreadSetDiscoveryRequestCallback(
  otInstance *aInstance,
  otThreadDiscoveryRequestCallback aCallback,
  void *aContext
)

ตั้งค่าโค้ดเรียกกลับเพื่อรับข้อมูลคำขอการค้นพบ MLE

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

otThreadSetDomainName

otError otThreadSetDomainName(
  otInstance *aInstance,
  const char *aDomainName
)

ตั้งค่าชื่อโดเมนเทรด

จะสำเร็จก็ต่อเมื่อปิดใช้โปรโตคอลเทรด

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

otThreadSetEnabled

otError otThreadSetEnabled(
  otInstance *aInstance,
  bool aEnabled
)

เริ่มการดำเนินการโปรโตคอลเทรด

อินเทอร์เฟซต้องเปิดอยู่เมื่อเรียกใช้ฟังก์ชันนี้

การเรียกใช้ฟังก์ชันนี้ด้วย aEnabled ที่ตั้งค่าเป็น FALSE จะหยุดกระบวนการที่ดำเนินอยู่ของการปลดออกซึ่งเริ่มต้นโดย otThreadDetachGracefully() ระบบจะเรียกใช้โค้ดเรียกกลับ

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

otThreadSetExtendedPanId

otError otThreadSetExtendedPanId(
  otInstance *aInstance,
  const otExtendedPanId *aExtendedPanId
)

ตั้งค่ารหัส PAN ที่ขยาย IEEE 802.15.4

รายละเอียด
พารามิเตอร์
[in] aInstance
ตัวชี้ไปยังอินสแตนซ์ OpenThread
[in] aExtendedPanId
ตัวชี้ไปยังรหัส PAN ที่ขยาย IEEE 802.15.4
แสดงผลค่า
OT_ERROR_NONE
ตั้งค่ารหัส PAN ที่ขยายเรียบร้อยแล้ว
OT_ERROR_INVALID_STATE
เปิดใช้โปรโตคอลเทรดแล้ว
ดูเพิ่มเติม:
otThreadGetExtendedPanId

otThreadSetFixedDuaInterfaceIdentifier

otError otThreadSetFixedDuaInterfaceIdentifier(
  otInstance *aInstance,
  const otIp6InterfaceIdentifier *aIid
)

ตั้งค่าหรือล้างตัวระบุอินเทอร์เฟซที่ระบุไว้ด้วยตนเองสำหรับที่อยู่ Thread Domain Unicast

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

รายละเอียด
พารามิเตอร์
[in] aInstance
ตัวชี้ไปยังอินสแตนซ์ OpenThread
[in] aIid
ตัวชี้ไปยังตัวระบุอินเทอร์เฟซเพื่อตั้งค่า หรือ NULL เพื่อล้าง
แสดงผลค่า
OT_ERROR_NONE
ตั้งค่า/ล้างตัวระบุอินเทอร์เฟซเรียบร้อยแล้ว
OT_ERROR_INVALID_ARGS
มีการจองตัวระบุอินเทอร์เฟซที่ระบุไว้
ดูเพิ่มเติม:
otThreadGetFixedDuaInterfaceIdentifier

otThreadSetJoinerAdvertisement

otError otThreadSetJoinerAdvertisement(
  otInstance *aInstance,
  uint32_t aOui,
  const uint8_t *aAdvData,
  uint8_t aAdvDataLength
)

ตั้งค่าโฆษณาเครื่องมือเชื่อมต่อชุดข้อความเมื่อค้นพบเครือข่ายเทรด

มีการใช้โฆษณา Thread Joiner เพื่ออนุญาตให้ Joiner โฆษณาข้อมูลเฉพาะแอปพลิเคชันของตนเอง (เช่น รหัสผู้ให้บริการ รหัสผลิตภัณฑ์, Discriminator ฯลฯ) ผ่าน TLV โฆษณาของผู้เชื่อมที่เสนอใหม่ และเผยแพร่ข้อมูลนี้แก่เจ้าหน้าที่หรือผู้สมัครของคณะกรรมการโดยไม่ต้องมีการปฏิสัมพันธ์กับมนุษย์

รายละเอียด
พารามิเตอร์
[in] aInstance
ตัวชี้ไปยังอินสแตนซ์ OpenThread
[in] aOui
ค่า IEEE OUI ของผู้ให้บริการที่จะรวมอยู่ในโฆษณา Joinment ระบบจะใช้เฉพาะ 3 ไบต์ที่มีนัยสำคัญน้อยที่สุด โดยไม่สนใจไบต์ที่มีนัยสำคัญมากที่สุด
[in] aAdvData
ตัวชี้ไปยัง AdvData ที่จะรวมอยู่ในโฆษณา Joiner
[in] aAdvDataLength
ความยาวของ AdvData ในหน่วยไบต์
แสดงผลค่า
OT_ERROR_NONE
ตั้งค่าโฆษณาเครื่องมือเข้าร่วมเรียบร้อยแล้ว
OT_ERROR_INVALID_ARGS
AdvData ไม่ถูกต้อง

otThreadSetKeySequenceCounter

void otThreadSetKeySequenceCounter(
  otInstance *aInstance,
  uint32_t aKeySequenceCounter
)

ตั้งค่า thrKeySequenceCounter

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

otThreadSetKeySwitchGuardTime

void otThreadSetKeySwitchGuardTime(
  otInstance *aInstance,
  uint32_t aKeySwitchGuardTime
)

ตั้งค่า thrKeySwitchGuardTime (เป็นชั่วโมง)

รายละเอียด
พารามิเตอร์
[in] aInstance
ตัวชี้ไปยังอินสแตนซ์ OpenThread
[in] aKeySwitchGuardTime
ค่า thrKeySwitchGuardTime (เป็นชั่วโมง)
ดูเพิ่มเติม:
otThreadGetKeySwitchGuardTime

otThreadSetLinkMode

otError otThreadSetLinkMode(
  otInstance *aInstance,
  otLinkModeConfig aConfig
)

กำหนดค่าโหมดลิงก์ MLE

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

otThreadSetMeshLocalPrefix

otError otThreadSetMeshLocalPrefix(
  otInstance *aInstance,
  const otMeshLocalPrefix *aMeshLocalPrefix
)

ตั้งค่าคำนำหน้าภายใน Mesh

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

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

otThreadSetNetworkKey

otError otThreadSetNetworkKey(
  otInstance *aInstance,
  const otNetworkKey *aKey
)

ตั้งค่าคีย์เครือข่ายเทรด

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

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

otThreadSetNetworkKeyRef

otError otThreadSetNetworkKeyRef(
  otInstance *aInstance,
  otNetworkKeyRef aKeyRef
)

ตั้งค่าคีย์เครือข่ายเทรดเป็น otNetworkKeyRef

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

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

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

otThreadSetNetworkName

otError otThreadSetNetworkName(
  otInstance *aInstance,
  const char *aNetworkName
)

ตั้งชื่อเครือข่ายเทรด

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

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

otThreadSetVendorModel

otError otThreadSetVendorModel(
  otInstance *aInstance,
  const char *aVendorModel
)

ตั้งค่าสตริงรูปแบบของผู้ให้บริการ

ต้องใช้ OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE

aVendorModel ควรเป็น UTF8 โดยมีความยาวสูงสุด 32 อักขระ (MAX_VENDOR_MODEL_TLV_LENGTH) ความยาวสูงสุดจะไม่รวมอักขระ Null \0

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

otThreadSetVendorName

otError otThreadSetVendorName(
  otInstance *aInstance,
  const char *aVendorName
)

ตั้งค่าสตริงชื่อผู้ให้บริการ

ต้องใช้ OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE

aVendorName ควรเป็น UTF8 โดยมีความยาวสูงสุด 32 อักขระ (MAX_VENDOR_NAME_TLV_LENGTH) ความยาวสูงสุดจะไม่รวมอักขระ Null \0

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

otThreadSetVendorSwVersion

otError otThreadSetVendorSwVersion(
  otInstance *aInstance,
  const char *aVendorSwVersion
)

ตั้งค่าสตริงเวอร์ชันซอฟต์แวร์ของผู้ให้บริการ

ต้องใช้ OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE

aVendorSwVersion ควรเป็น UTF8 โดยมีความยาวสูงสุด 16 อักขระ(MAX_VENDOR_SW_VERSION_TLV_LENGTH) ความยาวสูงสุดจะไม่รวมอักขระ Null \0

รายละเอียด
พารามิเตอร์
[in] aInstance
ตัวชี้ไปยังอินสแตนซ์ OpenThread
[in] aVendorSwVersion
สตริงเวอร์ชันของซอฟต์แวร์ของผู้ให้บริการ
แสดงผลค่า
OT_ERROR_NONE
ตั้งค่าเวอร์ชันซอฟต์แวร์ของผู้ให้บริการเรียบร้อยแล้ว
OT_ERROR_INVALID_ARGS
aVendorSwVersion ไม่ถูกต้อง (ยาวเกินไปหรือไม่ใช่ UTF8)

มาโคร

OT_DURATION_STRING_SIZE

 OT_DURATION_STRING_SIZE 21

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

OT_JOINER_ADVDATA_MAX_LENGTH

 OT_JOINER_ADVDATA_MAX_LENGTH 64

ความยาวสูงสุดของโฆษณาที่เข้าร่วม

OT_NEIGHBOR_INFO_ITERATOR_INIT

 OT_NEIGHBOR_INFO_ITERATOR_INIT 0

โปรแกรมเริ่มต้นสำหรับ otNeighborInfoIterator

OT_NETWORK_BASE_TLV_MAX_LENGTH

 OT_NETWORK_BASE_TLV_MAX_LENGTH 254

ความยาวสูงสุดของ TLV ฐานเทรด

OT_NETWORK_DATA_ITERATOR_INIT

 OT_NETWORK_DATA_ITERATOR_INIT 0

ค่าที่จะเริ่มต้น otNetworkDataIterator

OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE

 OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE 3

ขนาดของรายการตารางย่อยการวินิจฉัยเครือข่าย

OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT

 OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT 0

Initializer สำหรับ otNetworkDiagIterator

OT_NETWORK_DIAGNOSTIC_MAX_THREAD_STACK_VERSION_TLV_LENGTH

 OT_NETWORK_DIAGNOSTIC_MAX_THREAD_STACK_VERSION_TLV_LENGTH 64

ความยาวสูงสุดของเวอร์ชันสแต็กเทรด TLV

OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_MODEL_TLV_LENGTH

 OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_MODEL_TLV_LENGTH 32

ความยาวสูงสุดของโมเดล TLV ของผู้ให้บริการ

OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_NAME_TLV_LENGTH

 OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_NAME_TLV_LENGTH 32

ความยาวสูงสุดของชื่อผู้ให้บริการ TLV

OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_SW_VERSION_TLV_LENGTH

 OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_SW_VERSION_TLV_LENGTH 16

ความยาวสูงสุดของผู้ให้บริการ SW เวอร์ชัน TLV

OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES

 OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES 19

จำนวนประเภท TLV การวินิจฉัยเครือข่ายสูงสุดที่จะขอหรือรีเซ็ต

OT_NETWORK_MAX_ROUTER_ID

 OT_NETWORK_MAX_ROUTER_ID 62

รหัสเราเตอร์สูงสุด

OT_SERVER_DATA_MAX_SIZE

 OT_SERVER_DATA_MAX_SIZE 248

ขนาดสูงสุดของข้อมูลเซิร์ฟเวอร์ในหน่วยไบต์ ขีดจำกัดทางทฤษฎี ต่ำกว่ามากจริงๆ

OT_SERVICE_DATA_MAX_SIZE

 OT_SERVICE_DATA_MAX_SIZE 252

ขนาดสูงสุดของข้อมูลบริการในหน่วยไบต์

แหล่งข้อมูล

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