เมตริกลิงก์

โมดูลนี้ประกอบด้วยฟังก์ชันที่ควบคุมโปรโตคอลเมตริกลิงก์

สรุป

การแจกแจง
otLinkMetricsEnhAckFlags{
  OT_LINK_METRICS_ENH_ACK_CLEAR = 0,
  OT_LINK_METRICS_ENH_ACK_REGISTER = 1
} 		enum
การตั้งค่าสถานะ ACK ขั้นสูง
otLinkMetricsStatus enum
ค่าสถานะเมตริกการลิงก์

Typedef
otLinkMetricsEnhAckFlags typedef
การตั้งค่าสถานะ ACK ขั้นสูง
otLinkMetricsEnhAckProbingIeReportCallback)(otShortAddress aShortAddress, const otExtAddress *aExtAddress, const otLinkMetricsValues *aMetricsValues, void *aContext) typedef
void(*
ระบบจะเรียกตัวชี้เมื่อได้รับ Enh-ACK Probing IE
otLinkMetricsMgmtResponseCallback)(const otIp6Address *aSource, otLinkMetricsStatus aStatus, void *aContext) typedef
void(*
ระบบจะเรียกตัวชี้เมื่อได้รับการตอบกลับการจัดการเมตริกลิงก์
otLinkMetricsReportCallback)(const otIp6Address *aSource, const otLinkMetricsValues *aMetricsValues, otLinkMetricsStatus aStatus, void *aContext) typedef
void(*
ระบบจะเรียกใช้ตัวชี้เมื่อได้รับรายงานเมตริกลิงก์
otLinkMetricsSeriesFlags typedef
แสดงเฟรมที่ประกอบขึ้นในซีรีส์การติดตามไปข้างหน้า
otLinkMetricsStatus typedef
ค่าสถานะเมตริกการลิงก์
otLinkMetricsValues typedef
แสดงผลลัพธ์ (ค่า) สำหรับการค้นหาเมตริกลิงก์

ฟังก์ชัน
otLinkMetricsConfigEnhAckProbing(otInstance *aInstance, const otIp6Address *aDestination, otLinkMetricsEnhAckFlags aEnhAckFlags, const otLinkMetrics *aLinkMetricsFlags, otLinkMetricsMgmtResponseCallback aCallback, void *aCallbackContext, otLinkMetricsEnhAckProbingIeReportCallback aEnhAckCallback, void *aEnhAckCallbackContext)
ส่งคำขอการจัดการเมตริกลิงก์ MLE เพื่อกำหนดค่า/ล้างการตรวจสอบตาม ACK ที่ปรับปรุงแล้ว
otLinkMetricsConfigForwardTrackingSeries(otInstance *aInstance, const otIp6Address *aDestination, uint8_t aSeriesId, otLinkMetricsSeriesFlags aSeriesFlags, const otLinkMetrics *aLinkMetricsFlags, otLinkMetricsMgmtResponseCallback aCallback, void *aCallbackContext)
ส่งคำขอจัดการเมตริกลิงก์ MLE เพื่อกำหนดค่าหรือล้างชุดการติดตามการส่งต่อ
otLinkMetricsManagerGetMetricsValueByExtAddr(otInstance *aInstance, const otExtAddress *aExtAddress, otLinkMetricsValues *aLinkMetricsValues)
รับข้อมูลเมตริกลิงก์ของเพื่อนบ้านตามที่อยู่แบบขยาย
otLinkMetricsManagerSetEnabled(otInstance *aInstance, bool aEnable)
void
เปิดหรือปิดใช้เครื่องมือจัดการเมตริกลิงก์
otLinkMetricsQuery(otInstance *aInstance, const otIp6Address *aDestination, uint8_t aSeriesId, const otLinkMetrics *aLinkMetricsFlags, otLinkMetricsReportCallback aCallback, void *aCallbackContext)
ส่งคำขอข้อมูล MLE เพื่อค้นหาเมตริกลิงก์
otLinkMetricsSendLinkProbe(otInstance *aInstance, const otIp6Address *aDestination, uint8_t aSeriesId, uint8_t aLength)
ส่งข้อความ MLE Link Probe

โครงสร้าง
otLinkMetricsSeriesFlags

แสดงเฟรมที่ประกอบขึ้นในซีรีส์การติดตามไปข้างหน้า

otLinkMetricsValues

แสดงผลลัพธ์ (ค่า) สำหรับการค้นหาเมตริกลิงก์

การแจกแจง

otLinkMetricsEnhAckFlags

 otLinkMetricsEnhAckFlags

การตั้งค่าสถานะ ACK ขั้นสูง

ค่าเหล่านี้ใช้ในการตรวจสอบแบบ Enhanced-ACK เพื่อระบุว่าจะลงทะเบียนหรือล้างการตรวจสอบหรือไม่

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

เข้าใจง่าย

OT_LINK_METRICS_ENH_ACK_REGISTER

ลงทะเบียน

otLinkMetricsStatus

 otLinkMetricsStatus

ค่าสถานะเมตริกการลิงก์

Typedef

otLinkMetricsEnhAckFlags

enum otLinkMetricsEnhAckFlags otLinkMetricsEnhAckFlags

การตั้งค่าสถานะ ACK ขั้นสูง

ค่าเหล่านี้ใช้ในการตรวจสอบแบบ Enhanced-ACK เพื่อระบุว่าจะลงทะเบียนหรือล้างการตรวจสอบหรือไม่

otLinkMetricsEnhAckProbingIeReportCallback

void(* otLinkMetricsEnhAckProbingIeReportCallback)(otShortAddress aShortAddress, const otExtAddress *aExtAddress, const otLinkMetricsValues *aMetricsValues, void *aContext)

ระบบจะเรียกตัวชี้เมื่อได้รับ Enh-ACK Probing IE

รายละเอียด
พารามิเตอร์
[in] aShortAddress
ที่อยู่แบบย่อของ Mac ของ Probing Subject
[in] aExtAddress
ตัวชี้ไปยังที่อยู่แบบขยายของ Mac ของส่วน Probing Subject
[in] aMetricsValues
ตัวชี้ไปยังค่าเมตริกลิงก์ที่ได้รับจาก IE
[in] aContext
ตัวชี้ไปยังบริบทเฉพาะแอปพลิเคชัน

otLinkMetricsMgmtResponseCallback

void(* otLinkMetricsMgmtResponseCallback)(const otIp6Address *aSource, otLinkMetricsStatus aStatus, void *aContext)

ระบบจะเรียกตัวชี้เมื่อได้รับการตอบกลับการจัดการเมตริกลิงก์

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

otLinkMetricsReportCallback

void(* otLinkMetricsReportCallback)(const otIp6Address *aSource, const otLinkMetricsValues *aMetricsValues, otLinkMetricsStatus aStatus, void *aContext)

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

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

otLinkMetricsSeriesFlags

struct otLinkMetricsSeriesFlags otLinkMetricsSeriesFlags

แสดงเฟรมที่ประกอบขึ้นในซีรีส์การติดตามไปข้างหน้า

otLinkMetricsStatus

enum otLinkMetricsStatus otLinkMetricsStatus

ค่าสถานะเมตริกการลิงก์

otLinkMetricsValues

struct otLinkMetricsValues otLinkMetricsValues

แสดงผลลัพธ์ (ค่า) สำหรับการค้นหาเมตริกลิงก์

ฟังก์ชัน

otLinkMetricsConfigEnhAckProbing

otError otLinkMetricsConfigEnhAckProbing(
  otInstance *aInstance,
  const otIp6Address *aDestination,
  otLinkMetricsEnhAckFlags aEnhAckFlags,
  const otLinkMetrics *aLinkMetricsFlags,
  otLinkMetricsMgmtResponseCallback aCallback,
  void *aCallbackContext,
  otLinkMetricsEnhAckProbingIeReportCallback aEnhAckCallback,
  void *aEnhAckCallbackContext
)

ส่งคำขอการจัดการเมตริกลิงก์ MLE เพื่อกำหนดค่า/ล้างการตรวจสอบตาม ACK ที่ปรับปรุงแล้ว

ฟังก์ชันนี้ต้องมีการเปิดใช้ฟีเจอร์ OT_LINK_METRICS_INITIATOR

รายละเอียด
พารามิเตอร์
[in] aInstance
ตัวชี้ไปยังอินสแตนซ์ OpenThread
[in] aDestination
ตัวชี้ไปยังที่อยู่ปลายทาง
[in] aEnhAckFlags
Enh-ACK Flag เพื่อระบุว่าลงทะเบียนหรือล้างการตรวจสอบ 0เพื่อล้างและ 1 เพื่อลงทะเบียน ค่าอื่นๆ จะสงวนไว้
[in] aLinkMetricsFlags
ตัวชี้ไปยังแฟล็กซึ่งระบุเมตริกที่จะค้นหา ควรเป็น NULL เมื่อ aEnhAckFlags มีสถานะเป็น 0
[in] aCallback
ตัวชี้ไปยังฟังก์ชันที่เรียกใช้เมื่อได้รับ Ack ที่ได้รับการปรับปรุงพร้อมเมตริกลิงก์
[in] aCallbackContext
ตัวชี้ไปยังบริบทเฉพาะแอปพลิเคชัน
แสดงผลค่า
OT_ERROR_NONE
ส่งข้อความคำขอจัดการเมตริกลิงก์เรียบร้อยแล้ว
OT_ERROR_NO_BUFS
บัฟเฟอร์ไม่เพียงพอที่จะสร้างข้อความคำขอจัดการเมตริกลิงก์ MLE
OT_ERROR_INVALID_ARGS
aEnhAckFlags ไม่ใช่ค่าที่ถูกต้องหรือ aLinkMetricsFlags ไม่ถูกต้อง
OT_ERROR_UNKNOWN_NEIGHBOR
aDestination ไม่ใช่ลิงก์ภายในหรือไม่พบเพื่อนบ้าน
OT_ERROR_NOT_CAPABLE
เพื่อนบ้านไม่ใช่อุปกรณ์ Thread 1.2 และไม่รองรับเมตริกลิงก์

otLinkMetricsConfigForwardTrackingSeries

otError otLinkMetricsConfigForwardTrackingSeries(
  otInstance *aInstance,
  const otIp6Address *aDestination,
  uint8_t aSeriesId,
  otLinkMetricsSeriesFlags aSeriesFlags,
  const otLinkMetrics *aLinkMetricsFlags,
  otLinkMetricsMgmtResponseCallback aCallback,
  void *aCallbackContext
)

ส่งคำขอจัดการเมตริกลิงก์ MLE เพื่อกำหนดค่าหรือล้างชุดการติดตามการส่งต่อ

รายละเอียด
พารามิเตอร์
[in] aInstance
ตัวชี้ไปยังอินสแตนซ์ OpenThread
[in] aDestination
ตัวชี้ไปยังที่อยู่ปลายทาง
[in] aSeriesId
รหัสซีรีส์ที่จะใช้
[in] aSeriesFlags
แฟล็กซีรีส์ซึ่งระบุเฟรมที่จะพิจารณา
[in] aLinkMetricsFlags
ตัวชี้ไปยังแฟล็กซึ่งระบุเมตริกที่จะค้นหา ควรเป็น NULL เมื่อ aSeriesFlags มีสถานะเป็น 0
[in] aCallback
ตัวชี้ไปยังฟังก์ชันที่เรียกใช้เมื่อได้รับการตอบกลับการจัดการเมตริกลิงก์
[in] aCallbackContext
ตัวชี้ไปยังบริบทเฉพาะแอปพลิเคชัน
แสดงผลค่า
OT_ERROR_NONE
ส่งข้อความคำขอจัดการเมตริกลิงก์เรียบร้อยแล้ว
OT_ERROR_NO_BUFS
บัฟเฟอร์ไม่เพียงพอที่จะสร้างข้อความคำขอจัดการเมตริกลิงก์ MLE
OT_ERROR_INVALID_ARGS
aSeriesId ไม่ได้อยู่ในช่วงที่ถูกต้อง
OT_ERROR_UNKNOWN_NEIGHBOR
aDestination ไม่ใช่ลิงก์ภายในหรือไม่พบเพื่อนบ้าน
OT_ERROR_NOT_CAPABLE
เพื่อนบ้านไม่ใช่อุปกรณ์ Thread 1.2 และไม่รองรับเมตริกลิงก์

otLinkMetricsManagerGetMetricsValueByExtAddr

otError otLinkMetricsManagerGetMetricsValueByExtAddr(
  otInstance *aInstance,
  const otExtAddress *aExtAddress,
  otLinkMetricsValues *aLinkMetricsValues
)

รับข้อมูลเมตริกลิงก์ของเพื่อนบ้านตามที่อยู่แบบขยาย

รายละเอียด
พารามิเตอร์
[in] aInstance
ตัวชี้ไปยังอินสแตนซ์ OpenThread
[in] aExtAddress
ตัวชี้ไปยังที่อยู่แบบขยายของ Mac ของส่วน Probing Subject
[out] aLinkMetricsValues
ตัวชี้ไปยังค่าเมตริกลิงก์ของเรื่อง
แสดงผลค่า
OT_ERROR_NONE
รับข้อมูลเมตริกลิงก์เรียบร้อยแล้ว
OT_ERROR_INVALID_ARGS
อาร์กิวเมนต์ไม่ถูกต้อง
OT_ERROR_NOT_FOUND
ไม่พบเพื่อนบ้านที่มีที่อยู่แบบขยายที่ให้ไว้

otLinkMetricsManagerSetEnabled

void otLinkMetricsManagerSetEnabled(
  otInstance *aInstance,
  bool aEnable
)

เปิดหรือปิดใช้เครื่องมือจัดการเมตริกลิงก์

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

otLinkMetricsQuery

otError otLinkMetricsQuery(
  otInstance *aInstance,
  const otIp6Address *aDestination,
  uint8_t aSeriesId,
  const otLinkMetrics *aLinkMetricsFlags,
  otLinkMetricsReportCallback aCallback,
  void *aCallbackContext
)

ส่งคำขอข้อมูล MLE เพื่อค้นหาเมตริกลิงก์

อาจเป็นได้ทั้งชุดการตรวจสอบแบบ Single Probe หรือ Forward Tracking Series

รายละเอียด
พารามิเตอร์
[in] aInstance
ตัวชี้ไปยังอินสแตนซ์ OpenThread
[in] aDestination
ตัวชี้ไปยังที่อยู่ปลายทาง
[in] aSeriesId
รหัส Series ที่ต้องการค้นหา, 0 สำหรับ Single Probe
[in] aLinkMetricsFlags
ตัวชี้ไปยังแฟล็กซึ่งระบุเมตริกที่จะค้นหา
[in] aCallback
ตัวชี้ไปยังฟังก์ชันที่เรียกใช้เมื่อได้รับรายงานเมตริกลิงก์
[in] aCallbackContext
ตัวชี้ไปยังบริบทเฉพาะแอปพลิเคชัน
แสดงผลค่า
OT_ERROR_NONE
ส่งข้อความการค้นหาเมตริกลิงก์สำเร็จแล้ว
OT_ERROR_NO_BUFS
บัฟเฟอร์ไม่เพียงพอที่จะสร้างข้อความคำขอข้อมูล MLE
OT_ERROR_UNKNOWN_NEIGHBOR
aDestination ไม่ใช่ลิงก์ภายในหรือไม่พบเพื่อนบ้าน
OT_ERROR_NOT_CAPABLE
เพื่อนบ้านไม่ใช่อุปกรณ์ Thread 1.2 และไม่รองรับเมตริกลิงก์

otLinkMetricsSendLinkProbe

otError otLinkMetricsSendLinkProbe(
  otInstance *aInstance,
  const otIp6Address *aDestination,
  uint8_t aSeriesId,
  uint8_t aLength
)

ส่งข้อความ MLE Link Probe

รายละเอียด
พารามิเตอร์
[in] aInstance
ตัวชี้ไปยังอินสแตนซ์ OpenThread
[in] aDestination
ตัวชี้ไปยังที่อยู่ปลายทาง
[in] aSeriesId
Series ID [1, 254] ที่ข้อความ Probe เล็งไปที่
[in] aLength
ความยาวของเพย์โหลดข้อมูลใน Link Probe TLV, 0, 64
แสดงผลค่า
OT_ERROR_NONE
ส่งข้อความ Link Probe สำเร็จแล้ว
OT_ERROR_NO_BUFS
บัฟเฟอร์ไม่เพียงพอที่จะสร้างข้อความ MLE Link Probe
OT_ERROR_INVALID_ARGS
aSeriesId หรือ aLength ไม่ได้อยู่ในช่วงที่ถูกต้อง
OT_ERROR_UNKNOWN_NEIGHBOR
aDestination ไม่ใช่ลิงก์ภายในหรือไม่พบเพื่อนบ้าน
OT_ERROR_NOT_CAPABLE
เพื่อนบ้านไม่ใช่อุปกรณ์ Thread 1.2 และไม่รองรับเมตริกลิงก์

แหล่งข้อมูล

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