Thợ làm đồ gỗ

Mô-đun này bao gồm các hàm cho vai trò Thread Joiner (Trình kết hợp luồng).

Tóm tắt

Bảng liệt kê
otJoinerState enum
Xác định Trạng thái kết hợp.

Typedef
otJoinerCallback)(otError aError, void *aContext) typedef
void(*
Con trỏ được gọi để thông báo về việc hoàn tất hoạt động kết hợp.
otJoinerDiscerner typedef
Đại diện cho một Joiner Discerner.
otJoinerState typedef
Xác định Trạng thái kết hợp.

Hàm
otJoinerGetDiscerner(otInstance *aInstance)
Tham gia Joiner Discerner.
otJoinerGetId(otInstance *aInstance)
const otExtAddress *
Lấy mã nhận dạng người kết hợp.
otJoinerGetState(otInstance *aInstance)
Lấy trạng thái Joiner State.
otJoinerSetDiscerner(otInstance *aInstance, otJoinerDiscerner *aDiscerner)
Thiết lập Joiner Discerner.
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)
Bật vai trò Thread Joiner (Trình tham gia chuỗi).
otJoinerStateToString(otJoinerState aState)
const char *
Chuyển đổi một giá trị liệt kê trạng thái kết hợp cho trước thành một chuỗi mà con người có thể đọc được.
otJoinerStop(otInstance *aInstance)
void
Tắt vai trò Thread Joiner (Trình tham gia luồng).

Cấu trúc
otJoinerDiscerner

Đại diện cho một Joiner Discerner.

Bảng liệt kê

otJoinerState

 otJoinerState

Xác định Trạng thái kết hợp.

Typedef

otJoinerCallback

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

Con trỏ được gọi để thông báo về việc hoàn tất hoạt động kết hợp.

Thông tin chi tiết
Các tham số
[in] aError
OT_ERROR_NONE nếu quá trình tham gia thành công. OT_ERROR_SECURE nếu quá trình tham gia không thành công do thông tin đăng nhập bảo mật. OT_ERROR_NOT_FOUND nếu không phát hiện thấy mạng có thể kết nối nào. OT_ERROR_"}_TIMEOUT nếu một phản hồi hết thời gian chờ.
[in] aContext
Con trỏ đến ngữ cảnh dành riêng cho ứng dụng.

otJoinerDiscerner

struct otJoinerDiscerner otJoinerDiscerner

Đại diện cho một Joiner Discerner.

otJoinerState

enum otJoinerState otJoinerState

Xác định Trạng thái kết hợp.

Hàm

otJoinerGetDiscerner

const otJoinerDiscerner * otJoinerGetDiscerner(
  otInstance *aInstance
)

Tham gia Joiner Discerner.

Để biết thêm thông tin, hãy tham khảo otJoinerSetDiscerner.

Thông tin chi tiết
Các tham số
[in] aInstance
Con trỏ đến thực thể OpenThread.
Trả về
Con trỏ tới Joiner Discerner hoặc NULL nếu không có giá trị nào được đặt.

otJoinerGetId

const otExtAddress * otJoinerGetId(
  otInstance *aInstance
)

Lấy mã nhận dạng người kết hợp.

Nếu một Joiner Discerner không được thiết lập, thì Joiner ID là 64 bit đầu tiên của kết quả của việc tính toán SHA-256 qua IEEE EUI-64 do nhà máy chỉ định. Nếu không, Mã kết hợp sẽ được tính từ giá trị Trình phân biệt của phép kết hợp.

Trong quá trình vận hành, mã nhận dạng bộ ghép nối cũng được dùng làm địa chỉ mở rộng IEEE 802.15.4 của thiết bị.

Thông tin chi tiết
Các tham số
[in] aInstance
Con trỏ đến thực thể OpenThread.
Trả về
Con trỏ đến Mã tổ hợp.

otJoinerGetState

otJoinerState otJoinerGetState(
  otInstance *aInstance
)

Lấy trạng thái Joiner State.

Thông tin chi tiết
Các tham số
[in] aInstance
Con trỏ đến một thực thể OpenThread.
Trả về
Trạng thái của trình kết hợp.

otJoinerSetDiscerner

otError otJoinerSetDiscerner(
  otInstance *aInstance,
  otJoinerDiscerner *aDiscerner
)

Thiết lập Joiner Discerner.

Joiner Discerner được dùng để tính mã nhận dạng người kết hợp trong quá trình uỷ quyền luồng. Để biết thêm thông tin, hãy tham khảo otJoinerGetId.

Thông tin chi tiết
Các tham số
[in] aInstance
Con trỏ đến thực thể OpenThread.
[in] aDiscerner
Con trỏ đến Joiner Discerner. Nếu giá trị NULL sẽ xoá mọi điểm phân biệt đã đặt trước đó.
Giá trị trả về
OT_ERROR_NONE
Đã cập nhật thành công Joiner Discerner.
OT_ERROR_INVALID_ARGS
aDiscerner không hợp lệ (độ dài được chỉ định không nằm trong phạm vi hợp lệ).
OT_ERROR_INVALID_STATE
Quá trình Tham gia đang diễn ra nên bạn không thể thay đổi Trình phân biệt người tham gia.

otJoinerStart

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
)

Bật vai trò Thread Joiner (Trình tham gia chuỗi).

Thông tin chi tiết
Các tham số
[in] aInstance
Con trỏ đến một thực thể OpenThread.
[in] aPskd
Con trỏ đến PSKd.
[in] aProvisioningUrl
Con trỏ đến URL cấp phép (có thể là NULL).
[in] aVendorName
Con trỏ đến Tên nhà cung cấp (có thể là NULL).
[in] aVendorModel
Con trỏ đến Mô hình nhà cung cấp (có thể là giá trị NULL).
[in] aVendorSwVersion
Con trỏ đến Phiên bản SW của nhà cung cấp (có thể là NULL).
[in] aVendorData
Con trỏ đến Dữ liệu nhà cung cấp (có thể có giá trị là NULL).
[in] aCallback
Con trỏ đến một hàm được gọi khi thao tác kết hợp hoàn tất.
[in] aContext
Con trỏ đến ngữ cảnh dành riêng cho ứng dụng.
Giá trị trả về
OT_ERROR_NONE
Đã bắt đầu thành công vai trò Người tham gia.
OT_ERROR_BUSY
Lần thử trước đó vẫn đang diễn ra.
OT_ERROR_INVALID_ARGS
aPskd hoặc aProvisioningUrl không hợp lệ.
OT_ERROR_INVALID_STATE
Ngăn xếp IPv6 chưa được bật hoặc ngăn xếp luồng được bật hoàn toàn.

otJoinerStateToString

const char * otJoinerStateToString(
  otJoinerState aState
)

Chuyển đổi một giá trị liệt kê trạng thái kết hợp cho trước thành một chuỗi mà con người có thể đọc được.

Thông tin chi tiết
Các tham số
[in] aState
Trạng thái của trình kết hợp.
Trả về
Chuỗi ký tự aState mà con người đọc được.

otJoinerStop

void otJoinerStop(
  otInstance *aInstance
)

Tắt vai trò Thread Joiner (Trình tham gia luồng).

Thông tin chi tiết
Các tham số
[in] aInstance
Con trỏ đến một thực thể OpenThread.

Macro

OT_JOINER_MAX_DISCERNER_LENGTH

 OT_JOINER_MAX_DISCERNER_LENGTH 64

Độ dài tối đa của Bộ phân biệt tham số tính bằng bit.

Tài nguyên

Các chủ đề tham khảo API OpenThread bắt nguồn từ mã nguồn, có trên GitHub. Để biết thêm thông tin hoặc để đóng góp cho tài liệu của chúng tôi, hãy tham khảo Tài nguyên.