ช่างเชื่อม

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

สรุป

คําอธิบาย

otJoinerState enum
การแจงนับนี้ระบุสถานะการรวม

พิมพ์ดีด

otJoinerCallback)(otError aError, void *aContext) typedef
void(*
มีการเรียกใช้ตัวชี้ของฟังก์ชันนี้เพื่อแจ้งถึงการดําเนินการเข้าร่วมให้เสร็จสิ้น
otJoinerDiscerner typedef
โครงสร้างนี้แสดงถึงจุดเชื่อมต่อ
otJoinerState typedef
การแจงนับนี้ระบุสถานะการรวม

ฟังก์ชัน

otJoinerGetDiscerner(otInstance *aInstance)
ฟังก์ชันนี้จะได้รับ Diserner สําหรับเชื่อมต่อ
otJoinerGetId(otInstance *aInstance)
const otExtAddress *
ฟังก์ชันนี้จะได้รับรหัสผู้รวบรวมข้อมูล
otJoinerGetState(otInstance *aInstance)
ฟังก์ชันนี้จะแสดงสถานะผู้เข้าร่วม
otJoinerSetDiscerner(otInstance *aInstance, otJoinerDiscerner *aDiscerner)
ฟังก์ชันนี้ตั้งค่า Diserner Disciner
otJoinerStart(otInstance *aInstance, const char *aPskd, const char *aProvisioningUrl, const char *aVendorName, const char *aVendorModel, const char *aVendorSwVersion, const char *aVendorData, otJoinerCallback aCallback, void *aContext)
ฟังก์ชันนี้จะเปิดใช้บทบาทผู้รวบรวมข้อมูลชุดข้อความ
otJoinerStateToString(otJoinerState aState)
const char *
ฟังก์ชันนี้จะแปลงค่าการแจงนับของสถานะผู้เข้าร่วมที่ระบุเป็นสตริงที่มนุษย์อ่านได้
otJoinerStop(otInstance *aInstance)
void
ฟังก์ชันนี้ปิดใช้บทบาท Thread Joiner

โครงสร้าง

otJoinerDiscerner

โครงสร้างนี้แสดงถึงจุดเชื่อมต่อ

คําอธิบาย

รวมศูนย์

 otJoinerState

การแจงนับนี้ระบุสถานะการรวม

พิมพ์ดีด

กลับเข้าร่วม Otterer

void(* otJoinerCallback)(otError aError, void *aContext)

มีการเรียกใช้ตัวชี้ของฟังก์ชันนี้เพื่อแจ้งถึงการดําเนินการเข้าร่วมให้เสร็จสิ้น

รายละเอียด
พารามิเตอร์
[in] aError
OT_ERROR_NONE หากกระบวนการเข้าร่วมสําเร็จแล้ว OT_ERROR_GCCIN หากกระบวนการเข้าร่วมล้มเหลวเพราะข้อมูลเข้าสู่ระบบความปลอดภัย OT_ERROR_NOT_FOUND หากไม่พบเครือข่ายที่เข้าร่วมได้ OT_ERROR_Response_TIMEOUT หากหมดเวลาการตอบกลับ
[in] aContext
ตัวชี้ไปยังบริบทเฉพาะแอปพลิเคชัน

พนักงานของ OTJoinerDiscerner

struct otJoinerDiscerner otJoinerDiscerner

โครงสร้างนี้แสดงถึงจุดเชื่อมต่อ

รวมศูนย์

enum otJoinerState otJoinerState

การแจงนับนี้ระบุสถานะการรวม

ฟังก์ชัน

OTเข้าร่วมช่างประจํา

const otJoinerDiscerner * otJoinerGetDiscerner(
  otInstance *aInstance
)

ฟังก์ชันนี้จะได้รับ Diserner สําหรับเชื่อมต่อ

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

รหัสเข้าร่วม otเข้าร่วม

const otExtAddress * otJoinerGetId(
  otInstance *aInstance
)

ฟังก์ชันนี้จะได้รับรหัสผู้รวบรวมข้อมูล

หากไม่ได้ตั้งค่า Diserner ร่วมกัน รหัสผู้เข้าร่วมจะเป็น 64 บิตแรกของผลลัพธ์จากการประมวลผล SHA-256 แทน IEEE EUI-64 ที่กําหนดเป็นค่าเริ่มต้น ไม่เช่นนั้นระบบจะคํานวณรหัสผู้เข้าร่วมจากค่า Diserner ของตัวเข้าร่วม

รหัสผู้เข้าร่วมยังใช้เป็นที่อยู่แบบขยายของ IEEE 802.15.4 ของอุปกรณ์ในระหว่างกระบวนการขึ้นทะเบียน

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

OTOTERGETState

otJoinerState otJoinerGetState(
  otInstance *aInstance
)

ฟังก์ชันนี้จะแสดงสถานะผู้เข้าร่วม

รายละเอียด
พารามิเตอร์
[in] aInstance
ตัวชี้ไปยังอินสแตนซ์ OpenThread
แสดงผลค่า
OT_JOINER_STATE_IDLE
OT_JOINER_STATE_DISCOVER
OT_JOINER_STATE_CONNECT
OT_JOINER_STATE_CONNECTED
OT_JOINER_STATE_ENTRUST
OT_JOINER_STATE_JOINED

OTJoinerSetDiscerner

otError otJoinerSetDiscerner(
  otInstance *aInstance,
  otJoinerDiscerner *aDiscerner
)

ฟังก์ชันนี้ตั้งค่า Diserner Disciner

ระบบใช้ตัวผนวกเพื่อคํานวณรหัสผู้เข้าร่วมซึ่งใช้ระหว่างกระบวนการจัดหา/เข้าร่วม

โดยค่าเริ่มต้น (เมื่อไม่มีการระบุหรือกําหนดดิสก์ให้เป็น NUL) รหัสผู้เข้าร่วมจะได้มาในรูปแบบ 64 บิตแรกของผลการประมวลผล SHA-256 แทน IEEE EUI-64 ที่กําหนดเป็นค่าเริ่มต้น โปรดทราบว่านี่เป็นลักษณะการทํางานหลักที่คาดไว้โดยข้อกําหนดของชุดข้อความ

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

เริ่มต้นการเข้าร่วม

otError otJoinerStart(
  otInstance *aInstance,
  const char *aPskd,
  const char *aProvisioningUrl,
  const char *aVendorName,
  const char *aVendorModel,
  const char *aVendorSwVersion,
  const char *aVendorData,
  otJoinerCallback aCallback,
  void *aContext
)

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

รายละเอียด
พารามิเตอร์
[in] aInstance
ตัวชี้ไปยังอินสแตนซ์ OpenThread
[in] aPskd
ตัวชี้ไปยัง PSKd
[in] aProvisioningUrl
ตัวชี้ไปยัง URL การจัดสรร (อาจเป็น NULL)
[in] aVendorName
ตัวชี้ไปยังชื่อผู้ให้บริการ (อาจเป็น NULL)
[in] aVendorModel
ตัวชี้ไปยังรูปแบบผู้ให้บริการ (อาจเป็น NULL)
[in] aVendorSwVersion
ชี้ไปที่เวอร์ชัน SW ของผู้ให้บริการ (อาจเป็น NULL)
[in] aVendorData
ตัวชี้ข้อมูลผู้ให้บริการ (อาจเป็น NULL)
[in] aCallback
ตัวชี้ไปยังฟังก์ชันที่เรียกเมื่อการดําเนินการเข้าร่วมเสร็จสมบูรณ์
[in] aContext
ตัวชี้ไปยังบริบทเฉพาะแอปพลิเคชัน
แสดงผลค่า
OT_ERROR_NONE
เริ่มต้นบทบาทผู้เข้าร่วมแล้ว
OT_ERROR_BUSY
การดําเนินการก่อนหน้านี้ยังคงดําเนินอยู่
OT_ERROR_INVALID_ARGS
aPskd หรือ aProvisioningUrl ไม่ถูกต้อง
OT_ERROR_INVALID_STATE
ไม่ได้เปิดใช้สแต็ก IPv6 หรือมีการเปิดใช้สแต็กชุดข้อความโดยสมบูรณ์

สตริงสําหรับ OTJoinerState

const char * otJoinerStateToString(
  otJoinerState aState
)

ฟังก์ชันนี้จะแปลงค่าการแจงนับของสถานะผู้เข้าร่วมที่ระบุเป็นสตริงที่มนุษย์อ่านได้

รายละเอียด
พารามิเตอร์
[in] aState
รัฐที่เข้าร่วม
ส่งคืน
การแสดงสตริง aState ที่มนุษย์อ่านได้

OTเข้าร่วม

void otJoinerStop(
  otInstance *aInstance
)

ฟังก์ชันนี้ปิดใช้บทบาท Thread Joiner

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

มาโคร

OT_JOINER_MAX_DISCERNER_LENGTH

 OT_JOINER_MAX_DISCERNER_LENGTH 64

ความยาวสูงสุดของตัวหมุนข้อต่อร่วมในหน่วยบิต

ทรัพยากร

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