Ủy viên
Học phần này có các chức năng dành cho vai trò Uỷ viên luồng.
Tóm tắt
Bảng liệt kê |
|
---|---|
otCommissionerJoinerEvent
|
enum Xác định Sự kiện kết hợp trên Uỷ viên. |
otCommissionerState{
|
enum Xác định Trạng thái uỷ viên. |
otJoinerInfoType{
|
enum Xác định Loại thông tin trình kết hợp. |
Typedef |
|
---|---|
otCommissionerEnergyReportCallback)(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext)
|
typedefvoid(*
Con trỏ được gọi khi Uỷ viên nhận được Báo cáo năng lượng. |
otCommissionerJoinerCallback)(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext)
|
typedefvoid(*
Con trỏ sẽ được gọi mỗi khi trạng thái của trình kết hợp thay đổi. |
otCommissionerJoinerEvent
|
typedef Xác định Sự kiện kết hợp trên Uỷ viên. |
otCommissionerPanIdConflictCallback)(uint16_t aPanId, uint32_t aChannelMask, void *aContext)
|
typedefvoid(*
Con trỏ sẽ được gọi khi Uỷ viên nhận được thông báo Xung đột mã nhận dạng PAN. |
otCommissionerState
|
typedefenum otCommissionerState
Xác định Trạng thái uỷ viên. |
otCommissionerStateCallback)(otCommissionerState aState, void *aContext)
|
typedefvoid(*
Con trỏ sẽ được gọi mỗi khi trạng thái của quản trị viên thay đổi. |
otCommissioningDataset
|
typedefstruct otCommissioningDataset
Đại diện cho Tập dữ liệu được uỷ quyền. |
otJoinerInfo
|
typedefstruct otJoinerInfo
Đại diện cho thông tin trình kết hợp. |
otJoinerInfoType
|
typedefenum otJoinerInfoType
Xác định Loại thông tin trình kết hợp. |
otJoinerPskd
|
typedefstruct otJoinerPskd
Đại diện cho một Joiner PSKd. |
otSteeringData
|
typedefstruct otSteeringData
Đại diện cho dữ liệu lái. |
Hàm |
|
---|---|
otCommissionerAddJoiner(otInstance *aInstance, const otExtAddress *aEui64, const char *aPskd, uint32_t aTimeout)
|
Thêm một mục nhập Joiner.
|
otCommissionerAddJoinerWithDiscerner(otInstance *aInstance, const otJoinerDiscerner *aDiscerner, const char *aPskd, uint32_t aTimeout)
|
Thêm một mục nhập Joiner có giá trị Joiner Discerner cho trước.
|
otCommissionerAnnounceBegin(otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, const otIp6Address *aAddress)
|
Gửi 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)
|
Gửi thông báo Truy vấn quét năng lượng.
|
otCommissionerGetId(otInstance *aInstance)
|
const char *
Trả về mã của uỷ viên.
|
otCommissionerGetNextJoinerInfo(otInstance *aInstance, uint16_t *aIterator, otJoinerInfo *aJoiner)
|
Nhận thông tin về người tham gia tại vị trí aIterator.
|
otCommissionerGetProvisioningUrl(otInstance *aInstance)
|
const char *
Lấy URL cấp phép.
|
otCommissionerGetSessionId(otInstance *aInstance)
|
uint16_t
Trả về mã phiên làm việc với uỷ viên.
|
otCommissionerGetState(otInstance *aInstance)
|
Trả về Trạng thái uỷ viên.
|
otCommissionerPanIdQuery(otInstance *aInstance, uint16_t aPanId, uint32_t aChannelMask, const otIp6Address *aAddress, otCommissionerPanIdConflictCallback aCallback, void *aContext)
|
Gửi thông báo Truy vấn mã PAN.
|
otCommissionerRemoveJoiner(otInstance *aInstance, const otExtAddress *aEui64)
|
Xoá một mục nhập Ký tự kết hợp.
|
otCommissionerRemoveJoinerWithDiscerner(otInstance *aInstance, const otJoinerDiscerner *aDiscerner)
|
Xoá một mục nhập Ký tự kết hợp.
|
otCommissionerSendMgmtGet(otInstance *aInstance, const uint8_t *aTlvs, uint8_t aLength)
|
Gửi MGMT_COMMISSIONER_GET.
|
otCommissionerSendMgmtSet(otInstance *aInstance, const otCommissioningDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength)
|
Gửi MGMT_COMMISSIONER_Set.
|
otCommissionerSetId(otInstance *aInstance, const char *aId)
|
Đặt mã uỷ viên.
|
otCommissionerSetProvisioningUrl(otInstance *aInstance, const char *aProvisioningUrl)
|
Thiết lập URL cấp phép.
|
otCommissionerStart(otInstance *aInstance, otCommissionerStateCallback aStateCallback, otCommissionerJoinerCallback aJoinerCallback, void *aCallbackContext)
|
Bật vai trò Ủy viên luồng.
|
otCommissionerStop(otInstance *aInstance)
|
Tắt vai trò Ủy viên luồng.
|
Cấu trúc |
|
---|---|
otCommissioningDataset |
Đại diện cho Tập dữ liệu được uỷ quyền. |
otJoinerInfo |
Đại diện cho thông tin trình kết hợp. |
otJoinerPskd |
Đại diện cho một Joiner PSKd. |
otSteeringData |
Đại diện cho dữ liệu lái. |
Bảng liệt kê
otCommissionerJoinerEvent
otCommissionerJoinerEvent
Xác định Sự kiện kết hợp trên Uỷ viên.
otCommissionerState
otCommissionerState
Xác định Trạng thái uỷ viên.
Thuộc tính | |
---|---|
OT_COMMISSIONER_STATE_ACTIVE
|
Vai trò Uỷ viên đang hoạt động. |
OT_COMMISSIONER_STATE_DISABLED
|
Đã tắt vai trò uỷ viên. |
OT_COMMISSIONER_STATE_PETITION
|
Hiện đang kiến nghị trở thành Uỷ viên. |
otJoinerInfoType
otJoinerInfoType
Xác định Loại thông tin trình kết hợp.
Thuộc tính | |
---|---|
OT_JOINER_INFO_TYPE_ANY
|
Chấp nhận bất kỳ Người tham gia nào (không chỉ định EUI64 hoặc Discerner). |
OT_JOINER_INFO_TYPE_DISCERNER
|
Trình phân biệt tham gia được chỉ định ( |
OT_JOINER_INFO_TYPE_EUI64
|
EUI-64 đã được chỉ định ( |
Typedef
otCommissionerEnergyReportCallback
void(* otCommissionerEnergyReportCallback)(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext)
Con trỏ được gọi khi Uỷ viên nhận được Báo cáo năng lượng.
Thông tin chi tiết | |||||||||
---|---|---|---|---|---|---|---|---|---|
Thông số |
|
otCommissionerJoinerCallback
void(* otCommissionerJoinerCallback)(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext)
Con trỏ sẽ được gọi mỗi khi trạng thái của trình kết hợp thay đổi.
Thông tin chi tiết | |||||||||
---|---|---|---|---|---|---|---|---|---|
Thông số |
|
otCommissionerJoinerEvent
enum otCommissionerJoinerEvent otCommissionerJoinerEvent
Xác định Sự kiện kết hợp trên Uỷ viên.
otCommissionerPanIdConflictCallback
void(* otCommissionerPanIdConflictCallback)(uint16_t aPanId, uint32_t aChannelMask, void *aContext)
Con trỏ sẽ được gọi khi Uỷ viên nhận được thông báo Xung đột mã nhận dạng PAN.
Thông tin chi tiết | |||||||
---|---|---|---|---|---|---|---|
Thông số |
|
otCommissionerStateCallback
void(* otCommissionerStateCallback)(otCommissionerState aState, void *aContext)
Con trỏ sẽ được gọi mỗi khi trạng thái của quản trị viên thay đổi.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Thông số |
|
otCommissioningDataset
struct otCommissioningDataset otCommissioningDataset
Đại diện cho Tập dữ liệu được uỷ quyền.
Hàm
otCommissionerAddJoiner
otError otCommissionerAddJoiner( otInstance *aInstance, const otExtAddress *aEui64, const char *aPskd, uint32_t aTimeout )
Thêm một mục nhập Joiner.
Thông tin chi tiết | |||||||||
---|---|---|---|---|---|---|---|---|---|
Thông số |
|
||||||||
Giá trị trả về |
|
otCommissionerAddJoinerWithDiscerner
otError otCommissionerAddJoinerWithDiscerner( otInstance *aInstance, const otJoinerDiscerner *aDiscerner, const char *aPskd, uint32_t aTimeout )
Thêm một mục nhập Joiner có giá trị Joiner Discerner cho trước.
Thông tin chi tiết | |||||||||
---|---|---|---|---|---|---|---|---|---|
Thông số |
|
||||||||
Giá trị trả về |
|
otCommissionerAnnounceBegin
otError otCommissionerAnnounceBegin( otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, const otIp6Address *aAddress )
Gửi thông báo Bắt đầu thông báo.
Thông tin chi tiết | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Thông số |
|
||||||||||
Giá trị trả về |
|
otCommissionerEnergyScan
otError otCommissionerEnergyScan( otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, uint16_t aScanDuration, const otIp6Address *aAddress, otCommissionerEnergyReportCallback aCallback, void *aContext )
Gửi thông báo Truy vấn quét năng lượng.
Thông tin chi tiết | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Thông số |
|
||||||||||||||||
Giá trị trả về |
|
otCommissionerGetId
const char * otCommissionerGetId( otInstance *aInstance )
Trả về mã của uỷ viên.
Thông tin chi tiết | |||
---|---|---|---|
Thông số |
|
||
Trả về |
Mã của uỷ viên.
|
otCommissionerGetNextJoinerInfo
otError otCommissionerGetNextJoinerInfo( otInstance *aInstance, uint16_t *aIterator, otJoinerInfo *aJoiner )
Nhận thông tin về người tham gia tại vị trí aIterator.
Thông tin chi tiết | |||||||
---|---|---|---|---|---|---|---|
Thông số |
|
||||||
Giá trị trả về |
|
otCommissionerGetProvisioningUrl
const char * otCommissionerGetProvisioningUrl( otInstance *aInstance )
Lấy URL cấp phép.
Thông tin chi tiết | |||
---|---|---|---|
Thông số |
|
||
Trả về |
Con trỏ đến chuỗi URL.
|
otCommissionerGetSessionId
uint16_t otCommissionerGetSessionId( otInstance *aInstance )
Trả về mã phiên làm việc với uỷ viên.
Thông tin chi tiết | |||
---|---|---|---|
Thông số |
|
||
Trả về |
Mã phiên hội viên hiện tại.
|
otCommissionerGetState
otCommissionerState otCommissionerGetState( otInstance *aInstance )
Trả về Trạng thái uỷ viên.
Thông tin chi tiết | |||||||
---|---|---|---|---|---|---|---|
Thông số |
|
||||||
Giá trị trả về |
|
otCommissionerPanIdQuery
otError otCommissionerPanIdQuery( otInstance *aInstance, uint16_t aPanId, uint32_t aChannelMask, const otIp6Address *aAddress, otCommissionerPanIdConflictCallback aCallback, void *aContext )
Gửi thông báo Truy vấn mã PAN.
Thông tin chi tiết | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Thông số |
|
||||||||||||
Giá trị trả về |
|
otCommissionerRemoveJoiner
otError otCommissionerRemoveJoiner( otInstance *aInstance, const otExtAddress *aEui64 )
Xoá một mục nhập Ký tự kết hợp.
Thông tin chi tiết | |||||||||
---|---|---|---|---|---|---|---|---|---|
Thông số |
|
||||||||
Giá trị trả về |
|
otCommissionerRemoveJoinerWithDiscerner
otError otCommissionerRemoveJoinerWithDiscerner( otInstance *aInstance, const otJoinerDiscerner *aDiscerner )
Xoá một mục nhập Ký tự kết hợp.
Thông tin chi tiết | |||||||||
---|---|---|---|---|---|---|---|---|---|
Thông số |
|
||||||||
Giá trị trả về |
|
otCommissionerSendMgmtGet
otError otCommissionerSendMgmtGet( otInstance *aInstance, const uint8_t *aTlvs, uint8_t aLength )
Gửi MGMT_COMMISSIONER_GET.
Thông tin chi tiết | |||||||
---|---|---|---|---|---|---|---|
Thông số |
|
||||||
Giá trị trả về |
|
otCommissionerSendMgmtSet
otError otCommissionerSendMgmtSet( otInstance *aInstance, const otCommissioningDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength )
Gửi MGMT_COMMISSIONER_Set.
Thông tin chi tiết | |||||||||
---|---|---|---|---|---|---|---|---|---|
Thông số |
|
||||||||
Giá trị trả về |
|
otCommissionerSetId
otError otCommissionerSetId( otInstance *aInstance, const char *aId )
Đặt mã uỷ viên.
Thông tin chi tiết | |||||||
---|---|---|---|---|---|---|---|
Thông số |
|
||||||
Giá trị trả về |
|
otCommissionerSetProvisioningUrl
otError otCommissionerSetProvisioningUrl( otInstance *aInstance, const char *aProvisioningUrl )
Thiết lập URL cấp phép.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Thông số |
|
||||
Giá trị trả về |
|
otCommissionerStart
otError otCommissionerStart( otInstance *aInstance, otCommissionerStateCallback aStateCallback, otCommissionerJoinerCallback aJoinerCallback, void *aCallbackContext )
Bật vai trò Ủy viên luồng.
Thông tin chi tiết | |||||||||
---|---|---|---|---|---|---|---|---|---|
Thông số |
|
||||||||
Giá trị trả về |
|
otCommissionerStop
otError otCommissionerStop( otInstance *aInstance )
Tắt vai trò Ủy viên luồng.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Thông số |
|
||||
Giá trị trả về |
|
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 uỷ quyền.
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 uỷ quyền.
OT_JOINER_MAX_PSKD_LENGTH
OT_JOINER_MAX_PSKD_LENGTH 32
Độ dài chuỗi tối đa của một Joiner PSKd (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)
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.