ประธานสมาคม

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

สรุป

การแจกแจง
otCommissionerJoinerEvent enum
กำหนดกิจกรรมของผู้เข้าร่วมในคณะกรรมาธิการ
otCommissionerState{
  OT_COMMISSIONER_STATE_DISABLED = 0,
  OT_COMMISSIONER_STATE_PETITION = 1,
  OT_COMMISSIONER_STATE_ACTIVE = 2
} 		enum
กำหนดรัฐคณะกรรมาธิการ
otJoinerInfoType{
  OT_JOINER_INFO_TYPE_ANY = 0,
  OT_JOINER_INFO_TYPE_EUI64 = 1,
  OT_JOINER_INFO_TYPE_DISCERNER = 2
} 		enum
กำหนดประเภทข้อมูลผู้เชื่อม

Typedef
otCommissionerEnergyReportCallback)(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext) typedef
void(*
ระบบจะเรียกใช้ตัวชี้เมื่อคณะกรรมาธิการได้รับรายงานการใช้พลังงาน
otCommissionerJoinerCallback)(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext) typedef
void(*
ระบบจะเรียกตัวชี้เมื่อสถานะของเครื่องมือเชื่อมต่อมีการเปลี่ยนแปลง
otCommissionerJoinerEvent typedef
กำหนดกิจกรรมของผู้เข้าร่วมในคณะกรรมาธิการ
otCommissionerPanIdConflictCallback)(uint16_t aPanId, uint32_t aChannelMask, void *aContext) typedef
void(*
ระบบจะเรียกใช้ตัวชี้เมื่อค่าคอมมิชชันได้รับข้อความข้อขัดแย้งเกี่ยวกับรหัส PAN
otCommissionerState typedef
กำหนดรัฐคณะกรรมาธิการ
otCommissionerStateCallback)(otCommissionerState aState, void *aContext) typedef
void(*
ระบบจะเรียกใช้ตัวชี้เมื่อสถานะของค่าคอมมิชชันมีการเปลี่ยนแปลง
otCommissioningDataset typedef
หมายถึงชุดข้อมูลการจัดเตรียม
otJoinerInfo typedef
struct otJoinerInfo
แสดงข้อมูลผู้เชื่อม
otJoinerInfoType typedef
กำหนดประเภทข้อมูลผู้เชื่อม
otJoinerPskd typedef
struct otJoinerPskd
แทนสัญลักษณ์ Joiner PSKd
otSteeringData typedef
แสดงข้อมูลพวงมาลัย

ฟังก์ชัน
otCommissionerAddJoiner(otInstance *aInstance, const otExtAddress *aEui64, const char *aPskd, uint32_t aTimeout)
เพิ่มรายการเครื่องมือผนวก
otCommissionerAddJoinerWithDiscerner(otInstance *aInstance, const otJoinerDiscerner *aDiscerner, const char *aPskd, uint32_t aTimeout)
เพิ่มรายการเครื่องมือร่วมด้วยค่า Joiner Discerner ที่ระบุ
otCommissionerAnnounceBegin(otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, const otIp6Address *aAddress)
ส่งข้อความประกาศเริ่ม
otCommissionerEnergyScan(otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, uint16_t aScanDuration, const otIp6Address *aAddress, otCommissionerEnergyReportCallback aCallback, void *aContext)
ส่งข้อความคำค้นหาการสแกนพลังงาน
otCommissionerGetId(otInstance *aInstance)
const char *
แสดงรหัสค่าคอมมิชชัน
otCommissionerGetNextJoinerInfo(otInstance *aInstance, uint16_t *aIterator, otJoinerInfo *aJoiner)
รับข้อมูล Joiner ที่ตำแหน่ง aIterator
otCommissionerGetProvisioningUrl(otInstance *aInstance)
const char *
รับ URL การจัดสรร
otCommissionerGetSessionId(otInstance *aInstance)
uint16_t
แสดงรหัสเซสชันของค่าคอมมิชชัน
otCommissionerGetState(otInstance *aInstance)
ส่งคืนรัฐกรรมาธิการ
otCommissionerPanIdQuery(otInstance *aInstance, uint16_t aPanId, uint32_t aChannelMask, const otIp6Address *aAddress, otCommissionerPanIdConflictCallback aCallback, void *aContext)
ส่งข้อความการค้นหารหัส PAN
otCommissionerRemoveJoiner(otInstance *aInstance, const otExtAddress *aEui64)
นำรายการเครื่องมือเชื่อมต่อออก
otCommissionerRemoveJoinerWithDiscerner(otInstance *aInstance, const otJoinerDiscerner *aDiscerner)
นำรายการเครื่องมือเชื่อมต่อออก
otCommissionerSendMgmtGet(otInstance *aInstance, const uint8_t *aTlvs, uint8_t aLength)
ส่ง MGMT_COMMISSIONER_GET แล้ว
otCommissionerSendMgmtSet(otInstance *aInstance, const otCommissioningDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength)
ส่ง MGMT_COMMISSIONER_SET
otCommissionerSetId(otInstance *aInstance, const char *aId)
กำหนดรหัสค่าคอมมิชชัน
otCommissionerSetProvisioningUrl(otInstance *aInstance, const char *aProvisioningUrl)
ตั้งค่า URL การจัดสรร
otCommissionerStart(otInstance *aInstance, otCommissionerStateCallback aStateCallback, otCommissionerJoinerCallback aJoinerCallback, void *aCallbackContext)
เปิดใช้บทบาท Thread Commissioner
otCommissionerStop(otInstance *aInstance)
ปิดใช้บทบาท Thread Commissioner

โครงสร้าง
otCommissioningDataset

หมายถึงชุดข้อมูลการจัดเตรียม

otJoinerInfo

แสดงข้อมูลผู้เชื่อม

otJoinerPskd

แทนสัญลักษณ์ Joiner PSKd

otSteeringData

แสดงข้อมูลพวงมาลัย

การแจกแจง

otCommissionerJoinerEvent

 otCommissionerJoinerEvent

กำหนดกิจกรรมของผู้เข้าร่วมในคณะกรรมาธิการ

otCommissionerState

 otCommissionerState

กำหนดรัฐคณะกรรมาธิการ

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

มีบทบาทค่าคอมมิชชันอยู่

OT_COMMISSIONER_STATE_DISABLED

ปิดใช้บทบาทผู้บัญชาการ

OT_COMMISSIONER_STATE_PETITION

ปัจจุบันยื่นคำร้องเพื่อขอเข้าเป็นกรรมาธิการ

otJoinerInfoType

 otJoinerInfoType

กำหนดประเภทข้อมูลผู้เชื่อม

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

ยอมรับ Joiner ใดๆ (ไม่ได้ระบุ EUI64 หรือ Discerner)

OT_JOINER_INFO_TYPE_DISCERNER

ระบุตัวเชื่อม (mSharedId.mDiscerner ใน otJoinerInfo)

OT_JOINER_INFO_TYPE_EUI64

มีการระบุตัวเชื่อม EUI-64 (mSharedId.mEui64 ใน otJoinerInfo)

Typedef

otCommissionerEnergyReportCallback

void(* otCommissionerEnergyReportCallback)(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext)

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

รายละเอียด
พารามิเตอร์
[in] aChannelMask
ค่ามาสก์แชแนล
[in] aEnergyList
ตัวชี้ไปยังรายการวัดพลังงาน
[in] aEnergyListLength
จำนวนรายการใน aEnergyListLength
[in] aContext
ตัวชี้ไปยังบริบทเฉพาะแอปพลิเคชัน

otCommissionerJoinerCallback

void(* otCommissionerJoinerCallback)(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext)

ระบบจะเรียกตัวชี้เมื่อสถานะของเครื่องมือเชื่อมต่อมีการเปลี่ยนแปลง

รายละเอียด
พารามิเตอร์
[in] aEvent
ประเภทเหตุการณ์ของผู้เข้าร่วม
[in] aJoinerInfo
ตัวชี้ไปยังข้อมูลผู้เชื่อม
[in] aJoinerId
ตัวชี้ไปยังรหัส Joiner (หากไม่ทราบ จะเป็น NULL)
[in] aContext
ตัวชี้ไปยังบริบทเฉพาะแอปพลิเคชัน

otCommissionerJoinerEvent

enum otCommissionerJoinerEvent otCommissionerJoinerEvent

กำหนดกิจกรรมของผู้เข้าร่วมในคณะกรรมาธิการ

otCommissionerPanIdConflictCallback

void(* otCommissionerPanIdConflictCallback)(uint16_t aPanId, uint32_t aChannelMask, void *aContext)

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

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

otCommissionerState

enum otCommissionerState otCommissionerState

กำหนดรัฐคณะกรรมาธิการ

otCommissionerStateCallback

void(* otCommissionerStateCallback)(otCommissionerState aState, void *aContext)

ระบบจะเรียกใช้ตัวชี้เมื่อสถานะของค่าคอมมิชชันมีการเปลี่ยนแปลง

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

otCommissioningDataset

struct otCommissioningDataset otCommissioningDataset

หมายถึงชุดข้อมูลการจัดเตรียม

otJoinerInfo

struct otJoinerInfo otJoinerInfo

แสดงข้อมูลผู้เชื่อม

otJoinerInfoType

enum otJoinerInfoType otJoinerInfoType

กำหนดประเภทข้อมูลผู้เชื่อม

otJoinerPskd

struct otJoinerPskd otJoinerPskd

แทนสัญลักษณ์ Joiner PSKd

otSteeringData

struct otSteeringData otSteeringData

แสดงข้อมูลพวงมาลัย

ฟังก์ชัน

otCommissionerAddJoiner

otError otCommissionerAddJoiner(
  otInstance *aInstance,
  const otExtAddress *aEui64,
  const char *aPskd,
  uint32_t aTimeout
)

เพิ่มรายการเครื่องมือผนวก

รายละเอียด
พารามิเตอร์
[in] aInstance
ตัวชี้ไปยังอินสแตนซ์ OpenThread
[in] aEui64
ตัวชี้ไปยัง IEEE EUI-64 หรือ NULL ของ Joiner สำหรับ Joiner ใดๆ
[in] aPskd
ตัวชี้ไปยัง PSKd
[in] aTimeout
เวลาหลังจากที่เครื่องมือผนวกถูกนำออกโดยอัตโนมัติ หน่วยเป็นวินาที
แสดงผลค่า
OT_ERROR_NONE
เพิ่มเครื่องมือเชื่อมต่อเรียบร้อยแล้ว
OT_ERROR_NO_BUFS
ไม่มีบัฟเฟอร์ให้เพิ่ม Joiner
OT_ERROR_INVALID_ARGS
aEui64 หรือ aPskd ไม่ถูกต้อง
OT_ERROR_INVALID_STATE
ค่าคอมมิชชันไม่ทำงาน

otCommissionerAddJoinerWithDiscerner

otError otCommissionerAddJoinerWithDiscerner(
  otInstance *aInstance,
  const otJoinerDiscerner *aDiscerner,
  const char *aPskd,
  uint32_t aTimeout
)

เพิ่มรายการเครื่องมือร่วมด้วยค่า Joiner Discerner ที่ระบุ

รายละเอียด
พารามิเตอร์
[in] aInstance
ตัวชี้ไปยังอินสแตนซ์ OpenThread
[in] aDiscerner
ตัวชี้ไปยังตัวแยกส่วน
[in] aPskd
ตัวชี้ไปยัง PSKd
[in] aTimeout
เวลาหลังจากที่เครื่องมือผนวกถูกนำออกโดยอัตโนมัติ หน่วยเป็นวินาที
แสดงผลค่า
OT_ERROR_NONE
เพิ่มเครื่องมือเชื่อมต่อเรียบร้อยแล้ว
OT_ERROR_NO_BUFS
ไม่มีบัฟเฟอร์ให้เพิ่ม Joiner
OT_ERROR_INVALID_ARGS
aDiscerner หรือ aPskd ไม่ถูกต้อง
OT_ERROR_INVALID_STATE
ค่าคอมมิชชันไม่ทำงาน

otCommissionerAnnounceBegin

otError otCommissionerAnnounceBegin(
  otInstance *aInstance,
  uint32_t aChannelMask,
  uint8_t aCount,
  uint16_t aPeriod,
  const otIp6Address *aAddress
)

ส่งข้อความประกาศเริ่ม

รายละเอียด
พารามิเตอร์
[in] aInstance
ตัวชี้ไปยังอินสแตนซ์ OpenThread
[in] aChannelMask
ค่ามาสก์แชแนล
[in] aCount
จำนวนข้อความประกาศต่อช่อง
[in] aPeriod
เวลาระหว่างการส่งประกาศ MLE ติดต่อกัน 2 ครั้ง (หน่วยเป็นมิลลิวินาที)
[in] aAddress
ตัวชี้ไปยังปลายทาง IPv6
แสดงผลค่า
OT_ERROR_NONE
อยู่ในคิวข้อความ "ประกาศเริ่ม" เรียบร้อยแล้ว
OT_ERROR_NO_BUFS
บัฟเฟอร์ไม่เพียงพอที่จะสร้างข้อความการเริ่มประกาศ
OT_ERROR_INVALID_STATE
ค่าคอมมิชชันไม่ทำงาน

otCommissionerEnergyScan

otError otCommissionerEnergyScan(
  otInstance *aInstance,
  uint32_t aChannelMask,
  uint8_t aCount,
  uint16_t aPeriod,
  uint16_t aScanDuration,
  const otIp6Address *aAddress,
  otCommissionerEnergyReportCallback aCallback,
  void *aContext
)

ส่งข้อความคำค้นหาการสแกนพลังงาน

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

otCommissionerGetId

const char * otCommissionerGetId(
  otInstance *aInstance
)

แสดงรหัสค่าคอมมิชชัน

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

otCommissionerGetNextJoinerInfo

otError otCommissionerGetNextJoinerInfo(
  otInstance *aInstance,
  uint16_t *aIterator,
  otJoinerInfo *aJoiner
)

รับข้อมูล Joiner ที่ตำแหน่ง aIterator

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

otCommissionerGetProvisioningUrl

const char * otCommissionerGetProvisioningUrl(
  otInstance *aInstance
)

รับ URL การจัดสรร

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

otCommissionerGetSessionId

uint16_t otCommissionerGetSessionId(
  otInstance *aInstance
)

แสดงรหัสเซสชันของค่าคอมมิชชัน

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

otCommissionerGetState

otCommissionerState otCommissionerGetState(
  otInstance *aInstance
)

ส่งคืนรัฐกรรมาธิการ

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

otCommissionerPanIdQuery

otError otCommissionerPanIdQuery(
  otInstance *aInstance,
  uint16_t aPanId,
  uint32_t aChannelMask,
  const otIp6Address *aAddress,
  otCommissionerPanIdConflictCallback aCallback,
  void *aContext
)

ส่งข้อความการค้นหารหัส PAN

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

otCommissionerRemoveJoiner

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

นำรายการเครื่องมือเชื่อมต่อออก

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

otCommissionerRemoveJoinerWithDiscerner

otError otCommissionerRemoveJoinerWithDiscerner(
  otInstance *aInstance,
  const otJoinerDiscerner *aDiscerner
)

นำรายการเครื่องมือเชื่อมต่อออก

รายละเอียด
พารามิเตอร์
[in] aInstance
ตัวชี้ไปยังอินสแตนซ์ OpenThread
[in] aDiscerner
ตัวชี้ไปยังตัวแยกส่วน
แสดงผลค่า
OT_ERROR_NONE
นำเครื่องมือเชื่อมต่อออกเรียบร้อยแล้ว
OT_ERROR_NOT_FOUND
ไม่พบ Joiner ที่ระบุโดย aEui64
OT_ERROR_INVALID_ARGS
aDiscerner ไม่ถูกต้อง
OT_ERROR_INVALID_STATE
ค่าคอมมิชชันไม่ทำงาน

otCommissionerSendMgmtGet

otError otCommissionerSendMgmtGet(
  otInstance *aInstance,
  const uint8_t *aTlvs,
  uint8_t aLength
)

ส่ง MGMT_COMMISSIONER_GET แล้ว

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

otCommissionerSendMgmtSet

otError otCommissionerSendMgmtSet(
  otInstance *aInstance,
  const otCommissioningDataset *aDataset,
  const uint8_t *aTlvs,
  uint8_t aLength
)

ส่ง MGMT_COMMISSIONER_SET

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

otCommissionerSetId

otError otCommissionerSetId(
  otInstance *aInstance,
  const char *aId
)

กำหนดรหัสค่าคอมมิชชัน

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

otCommissionerSetProvisioningUrl

otError otCommissionerSetProvisioningUrl(
  otInstance *aInstance,
  const char *aProvisioningUrl
)

ตั้งค่า URL การจัดสรร

รายละเอียด
พารามิเตอร์
[in] aInstance
ตัวชี้ไปยังอินสแตนซ์ OpenThread
[in] aProvisioningUrl
ตัวชี้ไปยัง URL การจัดสรร (อาจเป็น NULL เพื่อตั้งค่าเป็นสตริงว่างเปล่า)
แสดงผลค่า
OT_ERROR_NONE
ตั้งค่า URL การจัดสรรสำเร็จแล้ว
OT_ERROR_INVALID_ARGS
aProvisioningUrl ไม่ถูกต้อง (ยาวเกินไป)

otCommissionerStart

otError otCommissionerStart(
  otInstance *aInstance,
  otCommissionerStateCallback aStateCallback,
  otCommissionerJoinerCallback aJoinerCallback,
  void *aCallbackContext
)

เปิดใช้บทบาท Thread Commissioner

รายละเอียด
พารามิเตอร์
[in] aInstance
ตัวชี้ไปยังอินสแตนซ์ OpenThread
[in] aStateCallback
ตัวชี้ไปยังฟังก์ชันที่เรียกใช้เมื่อสถานะของค่าคอมมิชชันมีการเปลี่ยนแปลง
[in] aJoinerCallback
ตัวชี้ไปยังฟังก์ชันที่เรียกพร้อมกับเหตุการณ์ผนวก
[in] aCallbackContext
ตัวชี้ไปยังบริบทเฉพาะแอปพลิเคชัน
แสดงผลค่า
OT_ERROR_NONE
เริ่มบริการค่าคอมมิชชันเรียบร้อยแล้ว
OT_ERROR_ALREADY
เริ่มใช้แล้ว
OT_ERROR_INVALID_STATE
อุปกรณ์ไม่ได้เชื่อมต่อกับเครือข่ายในขณะนี้

otCommissionerStop

otError otCommissionerStop(
  otInstance *aInstance
)

ปิดใช้บทบาท Thread Commissioner

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

มาโคร

OT_COMMISSIONING_PASSPHRASE_MAX_SIZE

 OT_COMMISSIONING_PASSPHRASE_MAX_SIZE 255

ขนาดสูงสุดของวลีรหัสผ่านค่าคอมมิชชัน

OT_COMMISSIONING_PASSPHRASE_MIN_SIZE

 OT_COMMISSIONING_PASSPHRASE_MIN_SIZE 6

ขนาดขั้นต่ำของรหัสผ่านการมอบหมาย

OT_JOINER_MAX_PSKD_LENGTH

 OT_JOINER_MAX_PSKD_LENGTH 32

ความยาวสูงสุดของสตริงของ Joiner PSKd (ไม่รวมอักขระ Null)

OT_PROVISIONING_URL_MAX_SIZE

 OT_PROVISIONING_URL_MAX_SIZE 64

ขนาดสูงสุด (จำนวนอักขระ) ในสตริง URL การจัดสรร (ไม่รวมอักขระ Null)

OT_STEERING_DATA_MAX_LENGTH

 OT_STEERING_DATA_MAX_LENGTH 16

ความยาวข้อมูลพวงมาลัยสูงสุด (ไบต์)

แหล่งข้อมูล

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