Google cam kết thúc đẩy công bằng chủng tộc cho Cộng đồng người da đen. Xem cách thực hiện.
Trang này được dịch bởi Cloud Translation API.
Switch to English

Ủy viên

Mô-đun này bao gồm các chức năng cho vai trò Ủy viên Chủ đề.

Tóm lược

Bảng kê

otCommissionerJoinerEvent enum
Việc liệt kê này xác định Sự kiện tham gia trên Ủy viên.
otCommissionerState {
OT_COMMISSIONER_STATE_DISABLED = 0,
OT_COMMISSIONER_STATE_PETITION = 1,
OT_COMMISSIONER_STATE_ACTIVE = 2
}
enum
Sự liệt kê này xác định Quốc gia Ủy viên.
otJoinerInfoType {
OT_JOINER_INFO_TYPE_ANY = 0,
OT_JOINER_INFO_TYPE_EUI64 = 1,
OT_JOINER_INFO_TYPE_DISCERNER = 2
}
enum
Việc liệt kê này xác định một Bộ gõ thông tin tham gia.

Typedefs

otCommissionerEnergyReportCallback )(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext) typedef
void(*
Con trỏ chức năng này được gọi khi Ủy viên nhận được Báo cáo năng lượng.
otCommissionerJoinerCallback )(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext) typedef
void(*
Con trỏ hàm này được gọi bất cứ khi nào trạng thái nối thay đổi.
otCommissionerJoinerEvent typedef
Việc liệt kê này xác định Sự kiện tham gia trên Ủy viên.
otCommissionerPanIdConflictCallback )(uint16_t aPanId, uint32_t aChannelMask, void *aContext) typedef
void(*
Con trỏ chức năng này được gọi khi Ủy viên nhận được thông báo Xung đột ID PAN.
otCommissionerState typedef
Việc liệt kê này xác định Quốc gia Ủy viên.
otCommissionerStateCallback )(otCommissionerState aState, void *aContext) typedef
void(*
Con trỏ hàm này được gọi bất cứ khi nào trạng thái ủy ban thay đổi.
otCommissioningDataset typedef
Cấu trúc này đại diện cho một Tập dữ liệu chạy thử.
otJoinerInfo typedef
struct otJoinerInfo
Cấu trúc này đại diện cho một thông tin người tham gia.
otJoinerInfoType typedef
Phép liệt kê này xác định một Bộ gõ thông tin tham gia.
otJoinerPskd typedef
struct otJoinerPskd
Cấu trúc này đại diện cho một PSKd Joiner.
otSteeringData typedef
Cấu trúc này đại diện cho dữ liệu lái.

Chức năng

otCommissionerAddJoiner ( otInstance *aInstance, const otExtAddress *aEui64, const char *aPskd, uint32_t aTimeout)
Chức năng này thêm một mục Joiner.
otCommissionerAddJoinerWithDiscerner ( otInstance *aInstance, const otJoinerDiscerner *aDiscerner, const char *aPskd, uint32_t aTimeout)
Hàm này thêm một mục Joiner với giá trị Joiner Discerner đã cho.
otCommissionerAnnounceBegin ( otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, const otIp6Address *aAddress)
Chức năng này gửi một thông báo Bắt đầu thông báo.
otCommissionerEnergyScan ( otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, uint16_t aScanDuration, const otIp6Address *aAddress, otCommissionerEnergyReportCallback aCallback, void *aContext)
Chức năng này sẽ gửi một thông báo Truy vấn quét năng lượng.
otCommissionerGetNextJoinerInfo ( otInstance *aInstance, uint16_t *aIterator, otJoinerInfo *aJoiner)
Phương pháp này nhận thông tin người tham gia ở vị trí aIterator.
otCommissionerGetProvisioningUrl ( otInstance *aInstance)
const char *
Hàm này lấy URL cấp phép.
otCommissionerGetSessionId ( otInstance *aInstance)
uint16_t
Hàm này trả về ID phiên ủy viên.
otCommissionerGetState ( otInstance *aInstance)
Hàm này trả về Trạng thái Ủy viên.
otCommissionerPanIdQuery ( otInstance *aInstance, uint16_t aPanId, uint32_t aChannelMask, const otIp6Address *aAddress, otCommissionerPanIdConflictCallback aCallback, void *aContext)
Chức năng này gửi một tin nhắn Truy vấn ID PAN.
otCommissionerRemoveJoiner ( otInstance *aInstance, const otExtAddress *aEui64)
Hàm này loại bỏ một mục Joiner.
otCommissionerRemoveJoinerWithDiscerner ( otInstance *aInstance, const otJoinerDiscerner *aDiscerner)
Hàm này loại bỏ một mục Joiner.
otCommissionerSendMgmtGet ( otInstance *aInstance, const uint8_t *aTlvs, uint8_t aLength)
Hàm này gửi MGMT_COMMISSIONER_GET.
otCommissionerSendMgmtSet ( otInstance *aInstance, const otCommissioningDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength)
Hàm này gửi MGMT_COMMISSIONER_SET.
otCommissionerSetProvisioningUrl ( otInstance *aInstance, const char *aProvisioningUrl)
Hàm này đặt URL cấp phép.
otCommissionerStart ( otInstance *aInstance, otCommissionerStateCallback aStateCallback, otCommissionerJoinerCallback aJoinerCallback, void *aCallbackContext)
Chức năng này cho phép vai trò Ủy viên chủ đề.
otCommissionerStop ( otInstance *aInstance)
Chức năng này vô hiệu hóa vai trò Ủy viên chủ đề.

Cấu trúc

otCommiss OperatingDataset

Cấu trúc này đại diện cho một Tập dữ liệu chạy thử.

otJoinerInfo

Cấu trúc này đại diện cho một thông tin người tham gia.

otJoinerPskd

Cấu trúc này đại diện cho một PSKd Joiner.

otSteeringData

Cấu trúc này đại diện cho dữ liệu lái.

Bảng kê

otCom MemberJoinerEvent

 otCommissionerJoinerEvent

Việc liệt kê này xác định Sự kiện tham gia trên Ủy viên.

otCom MemberState

 otCommissionerState

Việc liệt kê này xác định Quốc gia Ủy viên.

Tính chất
OT_COMMISSIONER_STATE_ACTIVE

Vai trò ủy viên đang hoạt động.

OT_COMMISSIONER_STATE_DISABLED

Vai trò ủy viên bị vô hiệu hóa.

OT_COMMISSIONER_STATE_PETITION

Hiện đang xin làm Ủy viên.

otJoinerInfoType

 otJoinerInfoType

Phép liệt kê này xác định một Bộ gõ thông tin tham gia.

Tính chất
OT_JOINER_INFO_TYPE_ANY

Chấp nhận bất kỳ Trình kết hợp nào (không có EUI64 hoặc Trình phân biệt được chỉ định).

OT_JOINER_INFO_TYPE_DISCERNER

Joiner mSharedId.mDiscerner được chỉ định ( mSharedId.mDiscerner trong otJoinerInfo ).

OT_JOINER_INFO_TYPE_EUI64

Joiner EUI-64 được chỉ định ( mSharedId.mEui64 trong otJoinerInfo ).

Typedefs

otCom MemberEnergyReportCallback

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

Con trỏ chức năng này được gọi khi Ủy viên nhận được Báo cáo năng lượng.

Chi tiết
Thông số
[in] aChannelMask
Giá trị mặt nạ kênh.
[in] aEnergyList
Một con trỏ đến danh sách đo năng lượng.
[in] aEnergyListLength
Số mục nhập trong aEnergyListLength .
[in] aContext
Một con trỏ đến ngữ cảnh dành riêng cho ứng dụng.

otCom MemberJoinerCallback

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

Con trỏ hàm này được gọi bất cứ khi nào trạng thái nối thay đổi.

Chi tiết
Thông số
[in] aEvent
Loại sự kiện kết hợp.
[in] aJoinerInfo
Một con trỏ đến Thông tin người tham gia.
[in] aJoinerId
Một con trỏ đến ID Joiner (nếu không biết, nó sẽ là NULL).
[in] aContext
Một con trỏ đến ngữ cảnh dành riêng cho ứng dụng.

otCom MemberJoinerEvent

enum otCommissionerJoinerEvent otCommissionerJoinerEvent

Sự liệt kê này xác định Sự kiện tham gia trên Ủy viên.

otCom MemberPanIdConflictCallback

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

Con trỏ chức năng này được gọi khi Ủy viên nhận được thông báo Xung đột ID PAN.

Chi tiết
Thông số
[in] aPanId
Giá trị PAN ID.
[in] aChannelMask
Giá trị mặt nạ kênh.
[in] aContext
Một con trỏ đến ngữ cảnh dành riêng cho ứng dụng.

otCom MemberState

enum otCommissionerState otCommissionerState

Việc liệt kê này xác định Quốc gia Ủy viên.

otCom MemberStateCallback

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

Con trỏ hàm này được gọi bất cứ khi nào trạng thái ủy ban thay đổi.

Chi tiết
Thông số
[in] aChannelMask
Giá trị mặt nạ kênh.
[in] aEnergyList
Một con trỏ đến danh sách đo năng lượng.
[in] aEnergyListLength
Số mục nhập trong aEnergyListLength .
[in] aContext
Một con trỏ đến ngữ cảnh dành riêng cho ứng dụng.

otCommiss OperatingDataset

struct otCommissioningDataset otCommissioningDataset

Cấu trúc này đại diện cho một Tập dữ liệu chạy thử.

otJoinerInfo

struct otJoinerInfo otJoinerInfo

Cấu trúc này đại diện cho một thông tin người tham gia.

otJoinerInfoType

enum otJoinerInfoType otJoinerInfoType

Việc liệt kê này xác định một Bộ gõ thông tin tham gia.

otJoinerPskd

struct otJoinerPskd otJoinerPskd

Cấu trúc này đại diện cho một PSKd Joiner.

otSteeringData

struct otSteeringData otSteeringData

Cấu trúc này đại diện cho dữ liệu lái.

Chức năng

otCom MemberAddJoiner

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

Chức năng này thêm một mục Joiner.

Chi tiết
Thông số
[in] aInstance
Một con trỏ đến một phiên bản OpenThread.
[in] aEui64
Một con trỏ tới IEEE EUI-64 hoặc NULL của Joiner cho bất kỳ Joiner nào.
[in] aPskd
Một con trỏ đến PSKd.
[in] aTimeout
Khoảng thời gian sau đó Trình kết hợp tự động bị xóa, tính bằng giây.
Giá trị trả lại
OT_ERROR_NONE
Đã thêm thành công Trình kết hợp.
OT_ERROR_NO_BUFS
Không có bộ đệm nào để thêm Joiner.
OT_ERROR_INVALID_ARGS
aEui64 hoặc aPskd không hợp lệ.
OT_ERROR_INVALID_STATE
Ủy viên không hoạt động.

otCom MemberAddJoinerWithDiscerner

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

Hàm này thêm một mục Joiner với giá trị Joiner Discerner đã cho.

Chi tiết
Thông số
[in] aInstance
Một con trỏ đến một phiên bản OpenThread.
[in] aDiscerner
Một con trỏ đến Trình phân biệt Joiner.
[in] aPskd
Một con trỏ đến PSKd.
[in] aTimeout
Khoảng thời gian sau đó Trình kết hợp tự động bị xóa, tính bằng giây.
Giá trị trả lại
OT_ERROR_NONE
Đã thêm thành công Trình kết hợp.
OT_ERROR_NO_BUFS
Không có bộ đệm nào để thêm Joiner.
OT_ERROR_INVALID_ARGS
aDiscerner hoặc aPskd không hợp lệ.
OT_ERROR_INVALID_STATE
Ủy viên không hoạt động.

otCom MemberAntificationBegin

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

Chức năng này sẽ gửi một thông báo Bắt đầu thông báo.

Chi tiết
Thông số
[in] aInstance
Một con trỏ đến một phiên bản OpenThread.
[in] aChannelMask
Giá trị mặt nạ kênh.
[in] aCount
Số lượng tin nhắn Thông báo trên mỗi kênh.
[in] aPeriod
Thời gian giữa hai lần truyền MLE liên tiếp Thông báo (tính bằng mili giây).
[in] aAddress
Một con trỏ đến đích IPv6.
Giá trị trả lại
OT_ERROR_NONE
Đã xếp thành công thông báo Bắt đầu thông báo.
OT_ERROR_NO_BUFS
Không đủ bộ đệm để tạo thông báo Bắt đầu thông báo.
OT_ERROR_INVALID_STATE
Ủy viên không hoạt động.

otCom MemberEnergyScan

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

Chức năng này sẽ gửi một thông báo Truy vấn quét năng lượng.

Chi tiết
Thông số
[in] aInstance
Một con trỏ đến một phiên bản OpenThread.
[in] aChannelMask
Giá trị mặt nạ kênh.
[in] aCount
Số lần đo năng lượng trên mỗi kênh.
[in] aPeriod
Thời gian giữa các lần đo năng lượng (mili giây).
[in] aScanDuration
Thời lượng quét cho mỗi lần đo năng lượng (mili giây).
[in] aAddress
Một con trỏ đến đích IPv6.
[in] aCallback
Một con trỏ đến một chức năng được gọi khi nhận được thông báo Báo cáo năng lượng.
[in] aContext
Một con trỏ đến ngữ cảnh dành riêng cho ứng dụng.
Giá trị trả lại
OT_ERROR_NONE
Đã xếp hàng thành công thông báo Truy vấn quét năng lượng.
OT_ERROR_NO_BUFS
Không đủ bộ đệm để tạo thông báo Truy vấn quét năng lượng.
OT_ERROR_INVALID_STATE
Ủy viên không hoạt động.

otCom MemberGetNextJoinerInfo

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

Phương pháp này nhận thông tin người tham gia ở vị trí aIterator.

Chi tiết
Thông số
[in] aInstance
Một con trỏ để ví dụ.
[in,out] aIterator
Một con trỏ đến ngữ cảnh trình lặp Thông tin tham gia.
[out] aJoiner
Tham chiếu đến thông tin Joiner.
Giá trị trả lại
OT_ERROR_NONE
Lấy thông tin Joiner thành công.
OT_ERROR_NOT_FOUND
Không tìm thấy Người kết hợp tiếp theo.

otCom MemberGetProvisratingUrl

const char * otCommissionerGetProvisioningUrl(
  otInstance *aInstance
)

Hàm này lấy URL cấp phép.

Chi tiết
Thông số
[in] aInstance
Một con trỏ đến một phiên bản OpenThread.
Lợi nhuận
Một con trỏ đến chuỗi URL.

otCom MemberGetSessionId

uint16_t otCommissionerGetSessionId(
  otInstance *aInstance
)

Hàm này trả về ID phiên ủy viên.

Chi tiết
Thông số
[in] aInstance
Một con trỏ đến một phiên bản OpenThread.
Lợi nhuận
Id phiên ủy viên hiện tại.

otCom MemberGetState

otCommissionerState otCommissionerGetState(
  otInstance *aInstance
)

Hàm này trả về Trạng thái Ủy viên.

Chi tiết
Thông số
[in] aInstance
Một con trỏ đến một phiên bản OpenThread.
Giá trị trả lại
OT_COMMISSIONER_STATE_DISABLED
Ủy viên bị vô hiệu hóa.
OT_COMMISSIONER_STATE_PETITION
Trở thành ủy viên.
OT_COMMISSIONER_STATE_ACTIVE
Đã bật ủy viên.

otCom MemberPanIdQuery

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

Chức năng này gửi một tin nhắn Truy vấn ID PAN.

Chi tiết
Thông số
[in] aInstance
Một con trỏ đến một phiên bản OpenThread.
[in] aPanId
ID PAN để truy vấn.
[in] aChannelMask
Giá trị mặt nạ kênh.
[in] aAddress
Một con trỏ đến đích IPv6.
[in] aCallback
Một con trỏ đến một chức năng được gọi khi nhận được thông báo Xung đột ID PAN.
[in] aContext
Một con trỏ đến ngữ cảnh dành riêng cho ứng dụng.
Giá trị trả lại
OT_ERROR_NONE
Đã xếp thành công thông báo Truy vấn ID PAN.
OT_ERROR_NO_BUFS
Không đủ bộ đệm để tạo thông báo Truy vấn ID PAN.
OT_ERROR_INVALID_STATE
Ủy viên không hoạt động.

otCom MemberRemoveJoiner

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

Hàm này loại bỏ một mục Joiner.

Chi tiết
Thông số
[in] aInstance
Một con trỏ đến một phiên bản OpenThread.
[in] aEui64
Một con trỏ tới IEEE EUI-64 hoặc NULL của Joiner cho bất kỳ Joiner nào.
Giá trị trả lại
OT_ERROR_NONE
Đã xóa Joiner thành công.
OT_ERROR_NOT_FOUND
Không tìm thấy Joiner được chỉ định bởi aEui64 .
OT_ERROR_INVALID_ARGS
aEui64 không hợp lệ.
OT_ERROR_INVALID_STATE
Ủy viên không hoạt động.

otCom MemberRemoveJoinerWithDiscerner

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

Hàm này loại bỏ một mục Joiner.

Chi tiết
Thông số
[in] aInstance
Một con trỏ đến một phiên bản OpenThread.
[in] aEui64
Một con trỏ đến Trình phân biệt Joiner.
Giá trị trả lại
OT_ERROR_NONE
Đã xóa Joiner thành công.
OT_ERROR_NOT_FOUND
Không tìm thấy Joiner được chỉ định bởi aEui64 .
OT_ERROR_INVALID_ARGS
aDiscerner không hợp lệ.
OT_ERROR_INVALID_STATE
Ủy viên không hoạt động.

otCom MemberSendMgmtGet

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

Hàm này gửi MGMT_COMMISSIONER_GET.

Chi tiết
Thông số
[in] aInstance
Một con trỏ đến một phiên bản OpenThread.
[in] aTlvs
Một con trỏ đến TLV.
[in] aLength
Độ dài của các TLV.
Giá trị trả lại
OT_ERROR_NONE
Gửi thành công lệnh tập dữ liệu meshcop.
OT_ERROR_NO_BUFS
Không đủ dung lượng bộ đệm để gửi.
OT_ERROR_INVALID_STATE
Ủy viên không hoạt động.

otCom MemberSendMgmtSet

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

Hàm này gửi MGMT_COMMISSIONER_SET.

Chi tiết
Thông số
[in] aInstance
Một con trỏ đến một phiên bản OpenThread.
[in] aDataset
Một con trỏ đến tập dữ liệu vận hành.
[in] aTlvs
Một con trỏ tới TLV.
[in] aLength
Độ dài của các TLV.
Giá trị trả lại
OT_ERROR_NONE
Gửi thành công lệnh tập dữ liệu meshcop.
OT_ERROR_NO_BUFS
Không đủ dung lượng bộ đệm để gửi.
OT_ERROR_INVALID_STATE
Ủy viên không hoạt động.

otCom MemberSetProvisratingUrl

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

Hàm này đặt URL cấp phép.

Chi tiết
Thông số
[in] aInstance
Một con trỏ đến một phiên bản OpenThread.
[in] aProvisioningUrl
Một con trỏ đến URL cấp phép (có thể là NULL để đặt làm chuỗi trống).
Giá trị trả lại
OT_ERROR_NONE
Đặt thành công URL cấp phép.
OT_ERROR_INVALID_ARGS
aProvisioningUrl không hợp lệ (quá dài).

otCom MemberStart

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

Chức năng này cho phép vai trò Ủy viên chủ đề.

Chi tiết
Thông số
[in] aInstance
Một con trỏ đến một phiên bản OpenThread.
[in] aStateCallback
Một con trỏ đến một hàm được gọi khi trạng thái ủy ban thay đổi.
[in] aJoinerCallback
Một con trỏ đến một hàm được gọi với một sự kiện nối xảy ra.
[in] aCallbackContext
Một con trỏ đến ngữ cảnh dành riêng cho ứng dụng.
Giá trị trả lại
OT_ERROR_NONE
Bắt đầu thành công dịch vụ Ủy viên.
OT_ERROR_ALREADY
Ủy viên đã bắt đầu.
OT_ERROR_INVALID_STATE
Thiết bị hiện không được kết nối với mạng.

otCom MemberStop

otError otCommissionerStop(
  otInstance *aInstance
)

Chức năng này vô hiệu hóa vai trò Ủy viên chủ đề.

Chi tiết
Thông số
[in] aInstance
Một con trỏ đến một phiên bản OpenThread.
Giá trị trả lại
OT_ERROR_NONE
Đã dừng thành công dịch vụ Ủy viên.
OT_ERROR_ALREADY
Ủy viên đã dừng lại.

Macro

OT_COMMISSIONING_PASSPHRASE_MAX_SIZE

 OT_COMMISSIONING_PASSPHRASE_MAX_SIZE 255

Kích thước tối đa của Cụm mật khẩu đăng ký.

OT_COMMISSIONING_PASSPHRASE_MIN_SIZE

 OT_COMMISSIONING_PASSPHRASE_MIN_SIZE 6

Kích thước tối thiểu của Cụm mật khẩu đăng ký.

OT_JOINER_MAX_PSKD_LENGTH

 OT_JOINER_MAX_PSKD_LENGTH 32

Độ dài chuỗi tối đa của một PSKd Joiner (không bao gồm ký tự rỗng).

OT_PROVISIONING_URL_MAX_SIZE

 OT_PROVISIONING_URL_MAX_SIZE 64

Kích thước tối đa (số ký tự) trong chuỗi URL cấp phép (không bao gồm ký tự rỗng).

OT_STEERING_DATA_MAX_LENGTH

 OT_STEERING_DATA_MAX_LENGTH 16

Độ dài dữ liệu lái tối đa (byte)