ทั่วไป

โมดูลนี้มีฟังก์ชันสําหรับบทบาทชุดข้อความทั้งหมด

สรุป

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

ฟังก์ชันทั้งหมดในโมดูลนี้ต้องเปิดใช้ 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
}
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

ประเภทคําจํากัดความ

otBorderRouterConfig Typedef
โครงสร้างนี้แสดงถึงการกําหนดค่าเราเตอร์เส้นขอบ
otDetachGracefullyCallback)(void *aContext) Typedef
void(*
การติดต่อกลับนี้จะแจ้งให้แอปพลิเคชันทราบว่ากระบวนการปลดออกเสร็จสมบูรณ์แล้ว
otExternalRouteConfig Typedef
โครงสร้างนี้แสดงการกําหนดค่าเส้นทางภายนอก
otIpCounters Typedef
struct otIpCounters
โครงสร้างนี้จะแสดงตัวนับระดับ IP
otLeaderData Typedef
struct otLeaderData
โครงสร้างนี้แสดงข้อมูลผู้นําของชุดข้อความ
otLinkModeConfig Typedef
โครงสร้างนี้แสดงการกําหนดค่าโหมดลิงก์ MLE
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(*
ประเภทตัวชี้ฟังก์ชันนี้จะกําหนดโค้ดเรียกกลับที่ใช้แจ้งเมื่อมีการเพิ่มหรือนําคํานําหน้า (เส้นทาง Mesh หรือเส้นทางภายนอก) ออกจากข้อมูลเครือข่ายชุดข้อความ
otNetDataPublisherEvent Typedef
การแจกแจงนี้แสดงถึงเหตุการณ์ที่รายงานจากโค้ดเรียกกลับของผู้เผยแพร่โฆษณา
otNetworkDataIterator Typedef
uint32_t
ใช้เพื่อทําซ้ําผ่านข้อมูลเครือข่าย
otNetworkDiagChildEntry Typedef
โครงสร้างนี้เป็นตัวแทนของรายการตารางย่อยของเครือข่ายการวินิจฉัย
otNetworkDiagConnectivity Typedef
โครงสร้างนี้แสดงค่าการเชื่อมต่อเครือข่ายการวินิจฉัย
otNetworkDiagIterator Typedef
uint16_t
ใช้เพื่อทําซ้ําผ่าน TLV ในการวินิจฉัยเครือข่าย
otNetworkDiagMacCounters Typedef
โครงสร้างนี้แสดงค่าตัวนับ Mac การวินิจฉัยเครือข่าย
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 Parent Response

ฟังก์ชัน

otNetDataContainsOmrPrefix(otInstance *aInstance, const otIp6Prefix *aPrefix)
bool
ฟังก์ชันนี้จะตรวจสอบว่าคํานําหน้าคํานําหน้าเป็นคํานําหน้า OMR ที่ถูกต้องได้หรือไม่ และข้อมูลเครือข่าย Leader ก็มีคํานําหน้านี้
otNetDataGet(otInstance *aInstance, bool aStable, uint8_t *aData, uint8_t *aDataLength)
วิธีนี้จะให้สําเนาข้อมูลเครือข่ายเทรดของพาร์ติชัน' เต็มรูปแบบหรือเสถียร
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
ฟังก์ชันนี้จะส่งคําขอ "DNS/SRP Service Unicast Address" เพื่อเผยแพร่ในข้อมูลเครือข่ายเทรด
otNetDataPublishDnsSrpServiceUnicastMeshLocalEid(otInstance *aInstance, uint16_t aPort)
void
ฟังก์ชันนี้จะส่งคําขอ "DNS/SRP Service Unicast Address" เพื่อเผยแพร่ในข้อมูลเครือข่ายเทรด
otNetDataPublishExternalRoute(otInstance *aInstance, const otExternalRouteConfig *aConfig)
ฟังก์ชันนี้ขอให้เผยแพร่คํานําหน้าเส้นทางภายนอกในข้อมูลเครือข่ายชุดข้อความ
otNetDataPublishOnMeshPrefix(otInstance *aInstance, const otBorderRouterConfig *aConfig)
ฟังก์ชันนี้จะส่งคําขอคํานําหน้าที่ทํางานร่วมกันเพื่อนําไปเผยแพร่ในข้อมูลเครือข่ายชุดข้อความ
otNetDataSetDnsSrpServicePublisherCallback(otInstance *aInstance, otNetDataDnsSrpServicePublisherCallback aCallback, void *aContext)
void
ฟังก์ชันนี้ตั้งค่าโค้ดเรียกกลับสําหรับแจ้งเตือนเมื่อมีการเพิ่ม "DNS/SRP Service" ที่เผยแพร่จริงในหรือนําออกจากข้อมูลเครือข่ายชุดข้อความ
otNetDataSetPrefixPublisherCallback(otInstance *aInstance, otNetDataPrefixPublisherCallback aCallback, void *aContext)
void
ฟังก์ชันนี้ตั้งค่าโค้ดเรียกกลับสําหรับแจ้งเตือนเมื่อมีการเพิ่มรายการคํานําหน้าที่เผยแพร่หรือนําออกจากข้อมูลเครือข่ายชุดข้อความจริงๆ
otNetDataSteeringDataCheckJoiner(otInstance *aInstance, const otExtAddress *aEui64)
ตรวจสอบว่าข้อมูลพวงมาลัยมีเครื่องมือรวมหรือไม่
otNetDataSteeringDataCheckJoinerWithDiscerner(otInstance *aInstance, const struct otJoinerDiscerner *aDiscerner)
ตรวจสอบว่าข้อมูลพวงมาลัยจะรวมค่า "รวม" กับค่าแยกแยะหรือไม่
otNetDataUnpublishDnsSrpService(otInstance *aInstance)
void
ยกเลิกการเผยแพร่รายการบริการ DNS/SRP (Anycast หรือ Unicast) ที่เพิ่มไว้ก่อนหน้านี้จากข้อมูลเครือข่ายชุดข้อความ
otNetDataUnpublishPrefix(otInstance *aInstance, const otIp6Prefix *aPrefix)
ยกเลิกการเผยแพร่คํานําหน้า Mesh หรือคํานําหน้าเส้นทางภายนอกที่เผยแพร่ก่อนหน้านี้
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)
รับตัวระบุตัวระบุที่ระบุด้วยตนเองสําหรับที่อยู่ 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)
ฟังก์ชันนี้ส่งคืนตัวชี้ไปยัง RSAOC ของผู้นํา
otThreadGetLeaderRouterId(otInstance *aInstance)
uint8_t
รับรหัสเราเตอร์ของผู้นํา
otThreadGetLeaderWeight(otInstance *aInstance)
uint8_t
รับน้ําหนักของผู้นํา
otThreadGetLinkLocalAllThreadNodesMulticastAddress(otInstance *aInstance)
const otIp6Address *
ฟังก์ชันนี้จะแสดงผลที่อยู่มัลติเทรดของเทรดท้องถิ่นแบบ Thread Link-Local
otThreadGetLinkLocalIp6Address(otInstance *aInstance)
const otIp6Address *
ฟังก์ชันนี้จะแสดงที่อยู่ IPv6 แบบเทรดในพื้นที่
otThreadGetLinkMode(otInstance *aInstance)
รับการกําหนดค่าโหมดลิงก์ MLE
otThreadGetMeshLocalEid(otInstance *aInstance)
const otIp6Address *
ฟังก์ชันนี้จะส่งคืนตัวชี้ไปยังที่อยู่ EID ของเครื่อง Mesh
otThreadGetMeshLocalPrefix(otInstance *aInstance)
ฟังก์ชันนี้จะส่งคืนตัวชี้ไปยังคํานําหน้าภายในของ Mesh
otThreadGetMleCounters(otInstance *aInstance)
const otMleCounters *
รับตัวนับ Thread 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 *
ฟังก์ชันนี้แสดงผลที่อยู่มัลติเทรดของเทรดเทรด Realm-Local All Thread
otThreadGetRloc(otInstance *aInstance)
const otIp6Address *
ฟังก์ชันนี้จะส่งคืนตัวชี้ไปยังที่อยู่ของ Thread Routing Locator (RSAOC)
otThreadGetRloc16(otInstance *aInstance)
uint16_t
รับ RSAOC16
otThreadGetServiceAloc(otInstance *aInstance, uint8_t aServiceId, otIp6Address *aServiceAloc)
ฟังก์ชันนี้จะดึง ALOC ของบริการสําหรับรหัสบริการที่ระบุ
otThreadGetVersion(void)
uint16_t
ฟังก์ชันนี้จะได้รับเวอร์ชันโปรโตคอลชุดข้อความ
otThreadIsAnycastLocateInProgress(otInstance *aInstance)
bool
ฟังก์ชันนี้จะระบุว่าคําขอตําแหน่งแคสต์อยู่ระหว่างดําเนินการหรือไม่
otThreadIsDiscoverInProgress(otInstance *aInstance)
bool
ฟังก์ชันนี้เป็นตัวกําหนดว่าขณะนี้มีการสํารวจชุดข้อความ MLE อยู่หรือไม่
otThreadIsSingleton(otInstance *aInstance)
bool
ฟังก์ชันนี้จะระบุว่าโหนดเป็นเราเตอร์เดียวในเครือข่ายหรือไม่
otThreadLocateAnycastDestination(otInstance *aInstance, const otIp6Address *aAnycastAddress, otThreadAnycastLocatorCallback aCallback, void *aContext)
ฟังก์ชันนี้ขอปลายทางที่ใกล้ที่สุดของที่อยู่แคสต์ใดๆ ที่ระบุ
otThreadRegisterParentResponseCallback(otInstance *aInstance, otThreadParentResponseCallback aCallback, void *aContext)
void
ฟังก์ชันนี้ลงทะเบียนโค้ดเรียกกลับเพื่อรับข้อมูลการตอบกลับของผู้เผยแพร่โฆษณา MLE
otThreadResetIp6Counters(otInstance *aInstance)
void
รีเซ็ตตัวนับ IPv6
otThreadResetMleCounters(otInstance *aInstance)
void
รีเซ็ตตัวนับ Thread MLE
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)
ฟังก์ชันนี้จะส่งข้อความแจ้งเตือนแบบเชิงรุก (PRO_BB.ntf) ในลิงก์กระดูกสันหลัง
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)
ตั้งค่า/ล้างตัวระบุอินเทอร์เฟซที่ระบุด้วยตนเองสําหรับที่อยู่ ชุดข้อความของโดเมนชุดข้อความ
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)
ตั้งชื่อเครือข่ายชุดข้อความ

โครงสร้าง

otBorderRouterConfig

โครงสร้างนี้แสดงถึงการกําหนดค่าเราเตอร์เส้นขอบ

otExternalRouteConfig

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

otIpCounters

โครงสร้างนี้จะแสดงตัวนับระดับ IP

otLeaderData

โครงสร้างนี้แสดงข้อมูลผู้นําของชุดข้อความ

otLinkModeConfig

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

otMleCounter

โครงสร้างนี้แสดงตัวนับ MLE

otNeighborInfo

โครงสร้างนี้มีข้อมูลการวินิจฉัยสําหรับโหนดชุดข้อความที่อยู่ใกล้เคียง

OTNetworkDiagChildEntry

โครงสร้างนี้เป็นตัวแทนของรายการตารางย่อยของเครือข่ายการวินิจฉัย

otNetworkDiagConnectivity

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

otNetworkDiagMacCounters

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

otNetworkDiagRoute

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

otNetworkDiagRouteData

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

OTNetworkDiagTlv

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

otRouterInfo

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

otServerConfig

โครงสร้างนี้แสดงถึงการกําหนดค่าเซิร์ฟเวอร์

otServiceConfig

โครงสร้างนี้แสดงถึงการกําหนดค่าบริการ

otThreadDiscoveryRequestInfo

โครงสร้างนี้แสดงข้อมูลคําขอสํารวจชุดข้อความ

otThreadParentResponseInfo

โครงสร้างนี้แสดงข้อมูล MLE Parent Response

การแจกแจง

enum ที่ไม่ระบุชื่อ

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

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

OT_NETWORK_DIAGNOSTIC_TLV_CHANNEL_PAGES

TLV ของหน้าเว็บของช่อง

OT_NETWORK_DIAGNOSTIC_TLV_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

ตัวนับ MAC ของ MAC

OT_NETWORK_DIAGNOSTIC_TLV_MAX_CHILD_TIMEOUT

TLV หมดเวลาสําหรับเด็กสูงสุด

OT_NETWORK_DIAGNOSTIC_TLV_MODE

โหมด TLV

OT_NETWORK_DIAGNOSTIC_TLV_NETWORK_DATA

TLV สําหรับข้อมูลเครือข่าย

OT_NETWORK_DIAGNOSTIC_TLV_ROUTE

Route64 TLV

OT_NETWORK_DIAGNOSTIC_TLV_SHORT_ADDRESS

Address16 TLV

OT_NETWORK_DIAGNOSTIC_TLV_SUPPLY_VOLTAGE

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

OT_NETWORK_DIAGNOSTIC_TLV_TIMEOUT

TLV หมดเวลา (ระยะเวลาแบบสํารวจสูงสุดสําหรับ SED)

OT_NETWORK_DIAGNOSTIC_TLV_TYPE_LIST

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

บทบาทอุปกรณ์

 otDeviceRole

แสดงถึงบทบาทของอุปกรณ์ชุดข้อความ

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

บทบาทย่อยของชุดข้อความ

OT_DEVICE_ROLE_DETACHED

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

OT_DEVICE_ROLE_DISABLED

ปิดใช้สแต็กชุดข้อความแล้ว

OT_DEVICE_ROLE_LEADER

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

OT_DEVICE_ROLE_ROUTER

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

เหตุการณ์ OTNetDataPublisher

 otNetDataPublisherEvent

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

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

ระบบจะเพิ่มรายการที่เผยแพร่แล้วลงในข้อมูลเครือข่ายชุดข้อความ

OT_NETDATA_PUBLISHER_EVENT_ENTRY_REMOVED

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

คําอธิบายเส้นทาง

 otRoutePreference

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

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

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

OT_ROUTE_PREFERENCE_LOW

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

OT_ROUTE_PREFERENCE_MED

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

ประเภทคําจํากัดความ

OTBorderRouterConfig

struct otBorderRouterConfig otBorderRouterConfig

โครงสร้างนี้แสดงถึงการกําหนดค่าเราเตอร์เส้นขอบ

otDetachGraceful โทรกลับ

void(* otDetachGracefullyCallback)(void *aContext)

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

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

OTExternalRouteConfigConfig

struct otExternalRouteConfig otExternalRouteConfig

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

ตัวนับ OTIp

struct otIpCounters otIpCounters

โครงสร้างนี้จะแสดงตัวนับระดับ IP

ข้อมูลโอกาสในการขาย

struct otLeaderData otLeaderData

โครงสร้างนี้แสดงข้อมูลผู้นําของชุดข้อความ

โหมดการลิงก์

struct otLinkModeConfig otLinkModeConfig

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

OTMleCounter

struct otMleCounters otMleCounters

โครงสร้างนี้แสดงตัวนับ MLE

OTNeighborInfoIterator

int16_t otNeighborInfoIterator

ใช้เพื่อทําซ้ําผ่านตารางข้างเคียง

OTNetDataDnsSrpServicePublisherการติดต่อกลับ

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

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

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

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

otNetDataPrefixของผู้เผยแพร่โฆษณาของโค้ดเรียกกลับ

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

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

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

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

เหตุการณ์ OTNetDataPublisher

enum otNetDataPublisherEvent otNetDataPublisherEvent

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

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

uint32_t otNetworkDataIterator

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

OTNetworkDiagChildEntry

struct otNetworkDiagChildEntry otNetworkDiagChildEntry

โครงสร้างนี้เป็นตัวแทนของรายการตารางย่อยของเครือข่ายการวินิจฉัย

OTNetworkDiagConnectivity

struct otNetworkDiagConnectivity otNetworkDiagConnectivity

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

OTNetworkDiagIterator

uint16_t otNetworkDiagIterator

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

OTNetworkDiagMacCounter

struct otNetworkDiagMacCounters otNetworkDiagMacCounters

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

โปรดดู RFC 2863 สําหรับคํานิยามของช่องสมาชิก

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
ตัวชี้ไปยังบริบทเฉพาะแอปพลิเคชัน

คําอธิบายเส้นทาง

enum otRoutePreference otRoutePreference

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

เวลาของเซิร์ฟเวอร์

struct otServerConfig otServerConfig

โครงสร้างนี้แสดงถึงการกําหนดค่าเซิร์ฟเวอร์

OTServiceConfig

struct otServiceConfig otServiceConfig

โครงสร้างนี้แสดงถึงการกําหนดค่าบริการ

OTThreadAnycastLocator โค้ดเรียกกลับ

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 Mesh-local ของปลายทางที่ใกล้ที่สุดของที่อยู่แคสต์เมื่อ aError คือ OT_ERROR_NONE, NULL หรือไม่
[in] aRloc16
หากพบ RSAOC16 ของปลายทาง หรืออาจพบ RSAOC16 (0xfffe) ที่ไม่ถูกต้อง

OTThreadDiscoveryRequest โค้ดเรียกกลับ

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

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

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

OTXMDiscoveryRequestInfo

struct otThreadDiscoveryRequestInfo otThreadDiscoveryRequestInfo

โครงสร้างนี้แสดงข้อมูลคําขอสํารวจชุดข้อความ

otThreadParentResponseResponse โค้ดเรียกกลับ

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

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

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

OTThreadParentResponseInfo

struct otThreadParentResponseInfo otThreadParentResponseInfo

โครงสร้างนี้แสดงข้อมูล MLE Parent Response

ฟังก์ชัน

otNetDataContainsOmrPrefix

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

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

รายละเอียด
พารามิเตอร์
[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 ชี้ จํานวนไบต์ที่คัดลอกเมื่อออก

OTNetDataGetNextOnMeshPrefix

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

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

รายละเอียด
พารามิเตอร์
[in] aInstance
ตัวชี้ไปยังอินสแตนซ์ OpenThread
[in,out] aIterator
ตัวชี้ไปยังบริบทตัวทําซ้ําข้อมูลเครือข่าย หากต้องการกําหนดรายการแรกที่ Mesh Mesh ควรตั้งค่าเป็น OT_NETWORK_DATA_ITERATOR_INIT
[out] aConfig
ตัวชี้ที่จะนําข้อมูลคํานําหน้า Mesh ไปวาง
แสดงผลค่า
OT_ERROR_NONE
พบคํานําหน้า On Mesh ถัดไปเรียบร้อยแล้ว
OT_ERROR_NOT_FOUND
ไม่มีคํานําหน้า 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
พบ External Route Route ถัดไปแล้ว
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
การคืนสินค้า
เวอร์ชันข้อมูลเครือข่ายเสถียร

เวอร์ชันสุทธิของข้อมูล

uint8_t otNetDataGetVersion(
  otInstance *aInstance
)

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

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

otNetDataIsDnsSrpServiceAdd

bool otNetDataIsDnsSrpServiceAdded(
  otInstance *aInstance
)

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

ฟังก์ชันนี้ต้องใช้ฟีเจอร์ OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE

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

otNetDataIsPrefix เพิ่ม

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 Service" ก่อนหน้าที่เผยแพร่ (จากการเรียกก่อนหน้าไปยังฟังก์ชันใดๆ ใน otNetDataPublishDnsSrpService{Type}())

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

OTNetDataPublishDnsSrpServiceUnicast

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

ฟังก์ชันนี้จะส่งคําขอ "DNS/SRP Service Unicast Address" เพื่อเผยแพร่ในข้อมูลเครือข่ายเทรด

ฟังก์ชันนี้ต้องใช้ฟีเจอร์ OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE

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

ฟังก์ชันนี้จะเผยแพร่ "DNS/SRP Service Unicast Address&quot โดยรวมที่อยู่และข้อมูลพอร์ตไว้ในข้อมูล TLV ของบริการ

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

OTNetDataPublishDnsSrpServiceUnicastMeshLocalEid

void otNetDataPublishDnsSrpServiceUnicastMeshLocalEid(
  otInstance *aInstance,
  uint16_t aPort
)

ฟังก์ชันนี้จะส่งคําขอ "DNS/SRP Service Unicast Address" เพื่อเผยแพร่ในข้อมูลเครือข่ายเทรด

ฟังก์ชันนี้ต้องใช้ฟีเจอร์ OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE

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

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

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

OTNetDataPublishภายนอก

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

OTNetDataSetDnsSrpServicePublisherการติดต่อกลับ

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

ฟังก์ชันนี้ตั้งค่าโค้ดเรียกกลับสําหรับแจ้งเตือนเมื่อมีการเพิ่ม "DNS/SRP Service" ที่เผยแพร่จริงในหรือนําออกจากข้อมูลเครือข่ายชุดข้อความ

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

ฟังก์ชันนี้ต้องใช้ฟีเจอร์ OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE

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

otNetDataSetPrefixPublisherของผู้เผยแพร่โฆษณา

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
)

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

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

otNetDataSteeringDataCheckCheckerWithDiscerner

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

OTNetDataUnpublish คํานําหน้า

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

ยกเลิกการเผยแพร่คํานําหน้า Mesh หรือคํานําหน้าเส้นทางภายนอกที่เผยแพร่ก่อนหน้านี้

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

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

OTOTการเป็นเด็ก

otError otThreadBecomeChild(
  otInstance *aInstance
)

พยายามแนบกับบุตรหลานอีกครั้ง

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

OTThreadของคุณมีการปลดออก

otError otThreadBecomeDetached(
  otInstance *aInstance
)

ปลดออกจากเครือข่ายชุดข้อความ

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

OTThreadDetachGraceful

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 (ตั้งค่าเป็น Broadcast PAN เพื่อปิดใช้ตัวกรอง)
[in] aJoiner
ค่าของแฟล็กเครื่องมือร่วมกันใน TLV คําขอ Discovery
[in] aEnableEui64Filtering
TRUE เพื่อกรองคําตอบในสหภาพยุโรป (EUI-64) หรือ FALSE (เท็จ)
[in] aCallback
ตัวชี้ไปยังฟังก์ชันที่เรียกว่าการรับการตอบกลับการค้นหา MLE หรือการสแกนเสร็จสมบูรณ์
[in] aCallbackContext
ตัวชี้ไปยังบริบทเฉพาะแอปพลิเคชัน
แสดงผลค่า
OT_ERROR_NONE
เริ่มการสแกนชุดข้อความของชุดข้อความเรียบร้อยแล้ว
OT_ERROR_INVALID_STATE
ไม่ได้เปิดใช้อินเทอร์เฟซ IPv6 (netif ยังไม่อัปเดต)
OT_ERROR_NO_BUFS
จัดสรรข้อความสําหรับคําขอ Discovery ไม่ได้
OT_ERROR_BUSY
การสแกนชุดข้อความของชุดข้อความอยู่ระหว่างดําเนินการแล้ว

OTXMGetChildTimeout

uint32_t otThreadGetChildTimeout(
  otInstance *aInstance
)

กําหนดระยะหมดเวลาย่อยของชุดข้อความที่ใช้เมื่อทํางานในบทบาทย่อย

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

คัดลอกชุดข้อความรับอุปกรณ์

otDeviceRole otThreadGetDeviceRole(
  otInstance *aInstance
)

รับข้อมูลบทบาทของอุปกรณ์

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

OTชุดข้อความที่ได้รับ

const char * otThreadGetDomainName(
  otInstance *aInstance
)

รับชื่อโดเมนชุดข้อความ

ฟังก์ชันนี้ใช้งานได้ตั้งแต่ชุดข้อความชุดข้อความ 1.2 เท่านั้น

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

OTชุดข้อความที่ได้รับการขยายPanId

const otExtendedPanId * otThreadGetExtendedPanId(
  otInstance *aInstance
)

รับรหัส PAN แบบขยาย IEEE 802.15.4

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

OTXMGetFixDuaInterfaceIdentifier

const otIp6InterfaceIdentifier * otThreadGetFixedDuaInterfaceIdentifier(
  otInstance *aInstance
)

รับตัวระบุตัวระบุที่ระบุด้วยตนเองสําหรับที่อยู่ Unicast ของโดเมน

ฟังก์ชันนี้ใช้งานได้ตั้งแต่ชุดข้อความ 1.2 เมื่อเปิดใช้ OPENTHREAD_CONFIG_DUA_ENABLE เท่านั้น

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

ตัวนับ OTThreadGetIp6

const otIpCounters * otThreadGetIp6Counters(
  otInstance *aInstance
)

รับตัวนับ IPv6

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

OTThreadGetKeySequenceCounter

uint32_t otThreadGetKeySequenceCounter(
  otInstance *aInstance
)

รับ thrKeySequenceCounter

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

เวลารับชุดข้อความของ OTThreadGet

uint32_t otThreadGetKeySwitchGuardTime(
  otInstance *aInstance
)

รับ thrKeySwitchGuardTime

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

OTXMGetLeaderData

otError otThreadGetLeaderData(
  otInstance *aInstance,
  otLeaderData *aLeaderData
)

โดยฟังก์ชันนี้จะได้รับข้อมูลของผู้นําชุดข้อความ

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

OTXMGetLeaderRloc

otError otThreadGetLeaderRloc(
  otInstance *aInstance,
  otIp6Address *aLeaderRloc
)

ฟังก์ชันนี้ส่งคืนตัวชี้ไปยัง RSAOC ของผู้นํา

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

ชุดข้อความชุดข้อความรับโอกาสในการขาย

uint8_t otThreadGetLeaderRouterId(
  otInstance *aInstance
)

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

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

OTOTรับโอกาสในการขาย

uint8_t otThreadGetLeaderWeight(
  otInstance *aInstance
)

รับน้ําหนักของผู้นํา

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

OTThreadGetLinkLocalAllThreadNodesMulticastAddress

const otIp6Address * otThreadGetLinkLocalAllThreadNodesMulticastAddress(
  otInstance *aInstance
)

ฟังก์ชันนี้จะแสดงผลที่อยู่มัลติเทรดของเทรดท้องถิ่นแบบ Thread Link-Local

ที่อยู่นั้นเป็นที่อยู่แบบเนทีฟที่ใช้คํานําหน้า Unicast แบบลิงก์ท้องถิ่น [RFC 3306] โดยมีสิ่งต่อไปนี้

  • Flgs กําหนดเป็น 3 (P = 1 และ T = 1)
  • ตั้งค่า Scop เป็น 2
  • ตั้งไปที่ 64 แล้ว
  • คํานําหน้าเครือข่ายเป็นคํานําหน้าท้องถิ่นที่ทํางานร่วมกัน
  • ตั้งค่ารหัสกลุ่มเป็น 1

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

OTThreadGetLinkLocalIp6ที่อยู่

const otIp6Address * otThreadGetLinkLocalIp6Address(
  otInstance *aInstance
)

ฟังก์ชันนี้จะแสดงที่อยู่ IPv6 แบบเทรดในพื้นที่

ที่อยู่ภายในของลิงก์ชุดข้อความได้มาจากการใช้ IEEE802.15.4 Extended Address เป็นตัวระบุอินเทอร์เฟซ

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

โหมดการรับชุดข้อความ

otLinkModeConfig otThreadGetLinkMode(
  otInstance *aInstance
)

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

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

OTThreadGetMeshLocalEid

const otIp6Address * otThreadGetMeshLocalEid(
  otInstance *aInstance
)

ฟังก์ชันนี้จะส่งคืนตัวชี้ไปยังที่อยู่ EID ของเครื่อง Mesh

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

ปลดล็อกชุดข้อความหลังจากนั้น

const otMeshLocalPrefix * otThreadGetMeshLocalPrefix(
  otInstance *aInstance
)

ฟังก์ชันนี้จะส่งคืนตัวชี้ไปยังคํานําหน้าภายในของ Mesh

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

OTThreadGetMleCounter

const otMleCounters * otThreadGetMleCounters(
  otInstance *aInstance
)

รับตัวนับ Thread MLE

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

คัดลอกคีย์เครือข่ายการรับข้อมูล

void otThreadGetNetworkKey(
  otInstance *aInstance,
  otNetworkKey *aNetworkKey
)

รับคีย์เครือข่ายชุดข้อความ

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

คัดลอกชุดข้อความผ่านเครือข่ายคีย์

otNetworkKeyRef otThreadGetNetworkKeyRef(
  otInstance *aInstance
)

รับotNetworkKeyRefสําหรับคีย์เครือข่ายชุดข้อความ

ฟังก์ชันนี้ต้องใช้ฟีเจอร์เวลาบิลด์ OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE

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

ชื่อชุดข้อความของ GetOT

const char * otThreadGetNetworkName(
  otInstance *aInstance
)

รับชื่อเครือข่ายชุดข้อความ

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

OTชุดข้อความที่ได้รับถัดไปของการวินิจฉัย

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

โดยฟังก์ชันนี้จะได้รับ TLV การวินิจฉัยเครือข่ายถัดไปในข้อความ

อนุญาตให้เรียกใช้ฟังก์ชันนี้ภายหลังก็ต่อเมื่อค่าการคืนสินค้าปัจจุบันคือ 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

ชุดข้อความรับผู้ปกครองเฉลี่ยRssi

otError otThreadGetParentAverageRssi(
  otInstance *aInstance,
  int8_t *aParentRssi
)

ฟังก์ชันนี้จะดึงข้อมูล RSSI เฉลี่ยสําหรับชุดข้อความหลัก

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

OTชุดข้อความที่รับผู้ปกครอง

otError otThreadGetParentInfo(
  otInstance *aInstance,
  otRouterInfo *aParentInfo
)

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

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

OTXMถึงผู้ปกครองรายการสุดท้าย

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 เป็นค่าว่าง

รหัสหัวข้อพาร์ติชันการรับ

uint32_t otThreadGetPartitionId(
  otInstance *aInstance
)

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

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

otThreadGetRealmLocalAllThreadNodesMulticastAddress

const otIp6Address * otThreadGetRealmLocalAllThreadNodesMulticastAddress(
  otInstance *aInstance
)

ฟังก์ชันนี้แสดงผลที่อยู่มัลติเทรดของเทรดเทรด Realm-Local All Thread

ที่อยู่นั้นเป็น Mutcast Address ตาม Unicast ที่อยู่ในพื้นที่จริง [RFC 3306] โดยมีรายละเอียดดังนี้

  • Flgs กําหนดเป็น 3 (P = 1 และ T = 1)
  • ตั้งค่า Scop เป็น 3
  • ตั้งไปที่ 64 แล้ว
  • คํานําหน้าเครือข่ายเป็นคํานําหน้าท้องถิ่นที่ทํางานร่วมกัน
  • ตั้งค่ารหัสกลุ่มเป็น 1

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

OTThreadGetRloc

const otIp6Address * otThreadGetRloc(
  otInstance *aInstance
)

ฟังก์ชันนี้จะส่งคืนตัวชี้ไปยังที่อยู่ของ Thread Routing Locator (RSAOC)

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

OTThreadGetRloc16

uint16_t otThreadGetRloc16(
  otInstance *aInstance
)

รับ RSAOC16

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

OTXMGetServiceAloc

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
ปัจจุบันอินเทอร์เฟซชุดข้อความไม่ได้แนบกับพาร์ติชันชุดข้อความ

เวอร์ชันชุดข้อความ

uint16_t otThreadGetVersion(
  void
)

ฟังก์ชันนี้จะได้รับเวอร์ชันโปรโตคอลชุดข้อความ

รายละเอียด
การคืนสินค้า
เวอร์ชันโปรโตคอลชุดข้อความ

OTThreadIsAnycastLocationeInProgress

bool otThreadIsAnycastLocateInProgress(
  otInstance *aInstance
)

ฟังก์ชันนี้จะระบุว่าคําขอตําแหน่งแคสต์อยู่ระหว่างดําเนินการหรือไม่

ฟังก์ชันนี้ใช้งานได้เมื่อเปิดใช้ OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE เท่านั้น

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

OTThreadIsDiscoverInProgress

bool otThreadIsDiscoverInProgress(
  otInstance *aInstance
)

ฟังก์ชันนี้เป็นตัวกําหนดว่าขณะนี้มีการสํารวจชุดข้อความ MLE อยู่หรือไม่

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

OTThreadIsSingle

bool otThreadIsSingleton(
  otInstance *aInstance
)

ฟังก์ชันนี้จะระบุว่าโหนดเป็นเราเตอร์เดียวในเครือข่ายหรือไม่

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

OTThreadloceAnycastDestination

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

ฟังก์ชันนี้ขอปลายทางที่ใกล้ที่สุดของที่อยู่แคสต์ใดๆ ที่ระบุ

ฟังก์ชันนี้ใช้งานได้เมื่อเปิดใช้ OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE เท่านั้น

หากคําขอก่อนหน้ายังดําเนินอยู่ การเรียกไปยังฟังก์ชันนี้ที่ตามมาจะเป็นการยกเลิกและแทนที่คําขอก่อนหน้า

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

otThreadลงทะเบียนสําหรับผู้ปกครองในการตอบกลับ

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

ฟังก์ชันนี้ลงทะเบียนโค้ดเรียกกลับเพื่อรับข้อมูลการตอบกลับของผู้เผยแพร่โฆษณา MLE

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

ตัวนับชุดข้อความที่รีเซ็ตแล้ว

void otThreadResetIp6Counters(
  otInstance *aInstance
)

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

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

ตัวนับชุดข้อความรีเซ็ต

void otThreadResetMleCounters(
  otInstance *aInstance
)

รีเซ็ตตัวนับ Thread MLE

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

การแจ้งเตือนการส่งคําเชิญ

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
ที่อยู่เป้าหมายของข้อความ HREF_NTF.ntf
[in] aMlIid
ML-IID ของข้อความ ADDR_NTF.ntf

OTชุดข้อความที่ส่งการวินิจฉัย

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

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

รายละเอียด
พารามิเตอร์
[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

รีเซ็ตชุดข้อความการวินิจฉัย

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

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

รายละเอียด
พารามิเตอร์
[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

OTThreadSendเชิงรุก

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

ฟังก์ชันนี้จะส่งข้อความแจ้งเตือนแบบเชิงรุก (PRO_BB.ntf) ในลิงก์กระดูกสันหลัง

ฟังก์ชันนี้ใช้งานได้เมื่อเปิดใช้ 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
หากมีบัฟเฟอร์ข้อความไม่เพียงพอ

ระยะหมดเวลาของชุดข้อความ

void otThreadSetChildTimeout(
  otInstance *aInstance,
  uint32_t aTimeout
)

ตั้งค่าระยะหมดเวลาย่อยของชุดข้อความที่ใช้เมื่อทํางานในบทบาทย่อย

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

OTThreadSetDiscoveryRequest

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

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

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

ชุดข้อความชุดข้อความ

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

ตั้งค่าชื่อโดเมนชุดข้อความ

ฟังก์ชันนี้ใช้งานได้ตั้งแต่ชุดข้อความชุดข้อความ 1.2 เท่านั้น ฟังก์ชันนี้สําเร็จได้เฉพาะเมื่อปิดใช้โปรโตคอลชุดข้อความเท่านั้น

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

OTThreadSetEnabled

otError otThreadSetEnabled(
  otInstance *aInstance,
  bool aEnabled
)

ฟังก์ชันนี้จะเริ่มการดําเนินการโปรโตคอลชุดข้อความ

อินเทอร์เฟซต้องเพิ่มขึ้นเมื่อเรียกใช้ฟังก์ชันนี้

การเรียกฟังก์ชันนี้ด้วย aEnabled ที่ตั้งค่าเป็น FALSE จะหยุดกระบวนการปลดออกที่ต่อเนื่องโดย otThreadDetachGraceful() ระบบจะเรียกใช้โค้ดเรียกกลับของฟังก์ชันดังกล่าว

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

ชุดข้อความของชุดข้อความแบบขยาย

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
)

ตั้งค่า/ล้างตัวระบุอินเทอร์เฟซที่ระบุด้วยตนเองสําหรับที่อยู่ ชุดข้อความของโดเมนชุดข้อความ

ฟังก์ชันนี้ใช้งานได้ตั้งแต่ชุดข้อความ 1.2 เมื่อเปิดใช้ OPENTHREAD_CONFIG_DUA_ENABLE เท่านั้น

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

OTThreadSetเพื่อเข้าร่วม

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

เมธอดนี้จะกําหนดการโฆษณาเครื่องมือเชื่อมต่อชุดข้อความเมื่อค้นพบเครือข่ายชุดข้อความ

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

รายละเอียด
พารามิเตอร์
[in] aInstance
ตัวชี้ไปยังอินสแตนซ์ OpenThread
[in] aOui
ค่า IEEE OU ของผู้ให้บริการที่จะรวมอยู่ในโฆษณาสมัครร่วม ระบบจะใช้เฉพาะไบต์ที่สําคัญที่สุด 3 ไบต์เท่านั้น และระบบจะละเว้นไบต์ที่สําคัญที่สุด
[in] aAdvData
ตัวชี้ไปยัง AdvData ที่จะรวมไว้ในโฆษณาการเข้าร่วม
[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

เวลาของ OTThreadSetKeySwitchGuard

void otThreadSetKeySwitchGuardTime(
  otInstance *aInstance,
  uint32_t aKeySwitchGuardTime
)

ตั้งค่า thrKeySwitchGuardTime

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

โหมดลิงก์ชุดข้อความ

otError otThreadSetLinkMode(
  otInstance *aInstance,
  otLinkModeConfig aConfig
)

กําหนดการตั้งค่าโหมดลิงก์ MLE

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

OT3SetMeshLocalPrefix

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

ฟังก์ชันนี้ตั้งค่าคํานําหน้าท้องถิ่นของ Mesh

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

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

ชุดคีย์เครือข่าย

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

ตั้งค่าคีย์เครือข่ายชุดข้อความ

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

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

ชุดข้อความชุดเครือข่าย

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

ชื่อชุดข้อความ

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

ตั้งชื่อเครือข่ายชุดข้อความ

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

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

มาโคร

OT_JOINER_ADVDATA_MAX_LENGTH

 OT_JOINER_ADVDATA_MAX_LENGTH 64

ความยาวสูงสุดของ AdvData ในการโฆษณาเครื่องมือเชื่อมต่อ

OTOT

 OT_NEIGHBOR_INFO_ITERATOR_INIT 0

Initializer สําหรับ 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_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

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

ทรัพยากร

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