комиссар
Этот модуль включает функции для роли комиссара потоков.
Краткое содержание
Перечисления | |
---|---|
otCommissionerJoinerEvent | перечисление Определяет событие соединения на комиссаре. |
otCommissionerState { | перечисление Определяет состояние комиссара. |
otJoinerInfoType { | перечисление Определяет тип информации о соединении. |
Определения типов | |
---|---|
otCommissionerEnergyReportCallback )(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext) | определение типаvoid(* Указатель вызывается, когда комиссар получает энергетический отчет. |
otCommissionerJoinerCallback )(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext) | определение типаvoid(* Указатель вызывается всякий раз, когда изменяется состояние соединения. |
otCommissionerJoinerEvent | определение типа Определяет событие соединения на комиссаре. |
otCommissionerPanIdConflictCallback )(uint16_t aPanId, uint32_t aChannelMask, void *aContext) | определение типаvoid(* Указатель вызывается, когда комиссар получает сообщение о конфликте PAN ID. |
otCommissionerState | определение типаenum otCommissionerState Определяет состояние комиссара. |
otCommissionerStateCallback )(otCommissionerState aState, void *aContext) | определение типаvoid(* Указатель вызывается всякий раз, когда изменяется состояние комиссара. |
otCommissioningDataset | определение типаstruct otCommissioningDataset Представляет набор данных для ввода в эксплуатацию. |
otJoinerInfo | определение типаstruct otJoinerInfo Представляет информацию о соединении. |
otJoinerInfoType | определение типаenum otJoinerInfoType Определяет тип информации о соединении. |
otJoinerPskd | определение типаstruct otJoinerPskd Представляет Столяр PSKd. |
otSteeringData | определение типаstruct otSteeringData Представляет данные рулевого управления. |
Функции | |
---|---|
otCommissionerAddJoiner ( otInstance *aInstance, const otExtAddress *aEui64, const char *aPskd, uint32_t aTimeout) | Добавляет запись Joiner. |
otCommissionerAddJoinerWithDiscerner ( otInstance *aInstance, const otJoinerDiscerner *aDiscerner, const char *aPskd, uint32_t aTimeout) | Добавляет запись Joiner с заданным значением 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) | Получите информацию о соединении в позиции 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 ID. |
otCommissionerRemoveJoiner ( otInstance *aInstance, const otExtAddress *aEui64) | Удаляет запись Joiner. |
otCommissionerRemoveJoinerWithDiscerner ( otInstance *aInstance, const otJoinerDiscerner *aDiscerner) | Удаляет запись Joiner. |
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) | Включает роль комиссара потоков. |
otCommissionerStop ( otInstance *aInstance) | Отключает роль комиссара потоков. |
Структуры | |
---|---|
otCommissioningDataset | Представляет набор данных для ввода в эксплуатацию. |
отДжойнерИнфо | Представляет информацию о соединении. |
отJoinerPskd | Представляет Столяр PSKd. |
otSteeringData | Представляет данные рулевого управления. |
Перечисления
otCommissionerJoinerEvent
otCommissionerJoinerEvent
Определяет событие соединения на комиссаре.
otCommissionerState
otCommissionerState
Определяет состояние комиссара.
Характеристики | |
---|---|
OT_COMMISSIONER_STATE_ACTIVE | Роль комиссара активна. |
OT_COMMISSIONER_STATE_DISABLED | Роль комиссара отключена. |
OT_COMMISSIONER_STATE_PETITION | В настоящее время подает прошение о том, чтобы стать комиссаром. |
отДжойнерИнфоТип
otJoinerInfoType
Определяет тип информации о соединении.
Характеристики | |
---|---|
OT_JOINER_INFO_TYPE_ANY | Примите любой Joiner (не указан EUI64 или Discerner). |
OT_JOINER_INFO_TYPE_DISCERNER | Указан средство распознавания соединений ( |
OT_JOINER_INFO_TYPE_EUI64 | Указан соединитель EUI-64 ( |
Определения типов
otCommissionerEnergyReportCallback
void(* otCommissionerEnergyReportCallback)(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext)
Указатель вызывается, когда комиссар получает энергетический отчет.
Подробности | |||||||||
---|---|---|---|---|---|---|---|---|---|
Параметры |
|
otCommissionerJoinerCallback
void(* otCommissionerJoinerCallback)(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext)
Указатель вызывается всякий раз, когда изменяется состояние соединения.
Подробности | |||||||||
---|---|---|---|---|---|---|---|---|---|
Параметры |
|
otCommissionerJoinerEvent
enum otCommissionerJoinerEvent otCommissionerJoinerEvent
Определяет событие соединения на комиссаре.
otCommissionerPanIdConflictCallback
void(* otCommissionerPanIdConflictCallback)(uint16_t aPanId, uint32_t aChannelMask, void *aContext)
Указатель вызывается, когда комиссар получает сообщение о конфликте PAN ID.
Подробности | |||||||
---|---|---|---|---|---|---|---|
Параметры |
|
otCommissionerStateCallback
void(* otCommissionerStateCallback)(otCommissionerState aState, void *aContext)
Указатель вызывается всякий раз, когда изменяется состояние комиссара.
Подробности | |||||
---|---|---|---|---|---|
Параметры |
|
otCommissioningDataset
struct otCommissioningDataset otCommissioningDataset
Представляет набор данных для ввода в эксплуатацию.
Функции
otCommissionerAddJoiner
otError otCommissionerAddJoiner(
otInstance *aInstance,
const otExtAddress *aEui64,
const char *aPskd,
uint32_t aTimeout
)
Добавляет запись Joiner.
Подробности | |||||||||
---|---|---|---|---|---|---|---|---|---|
Параметры |
| ||||||||
Возвращаемые значения |
|
otCommissionerAddJoinerWithDiscerner
otError otCommissionerAddJoinerWithDiscerner(
otInstance *aInstance,
const otJoinerDiscerner *aDiscerner,
const char *aPskd,
uint32_t aTimeout
)
Добавляет запись Joiner с заданным значением Joiner Discerner.
Подробности | |||||||||
---|---|---|---|---|---|---|---|---|---|
Параметры |
| ||||||||
Возвращаемые значения |
|
otCommissionerAnnounceBegin
otError otCommissionerAnnounceBegin(
otInstance *aInstance,
uint32_t aChannelMask,
uint8_t aCount,
uint16_t aPeriod,
const otIp6Address *aAddress
)
Отправляет сообщение «Объявление о начале».
Подробности | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Параметры |
| ||||||||||
Возвращаемые значения |
|
otCommissionerEnergyScan
otError otCommissionerEnergyScan(
otInstance *aInstance,
uint32_t aChannelMask,
uint8_t aCount,
uint16_t aPeriod,
uint16_t aScanDuration,
const otIp6Address *aAddress,
otCommissionerEnergyReportCallback aCallback,
void *aContext
)
Отправляет сообщение с запросом на сканирование энергии.
Подробности | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Параметры |
| ||||||||||||||||
Возвращаемые значения |
|
otCommissionerGetId
const char * otCommissionerGetId(
otInstance *aInstance
)
Возвращает идентификатор комиссара.
Подробности | |||
---|---|---|---|
Параметры |
| ||
Возврат | Комиссар Ид. |
otCommissionerGetNextJoinerInfo
otError otCommissionerGetNextJoinerInfo(
otInstance *aInstance,
uint16_t *aIterator,
otJoinerInfo *aJoiner
)
Получите информацию о соединении в позиции aIterator.
Подробности | |||||||
---|---|---|---|---|---|---|---|
Параметры |
| ||||||
Возвращаемые значения |
|
otCommissionerGetProvisioningUrl
const char * otCommissionerGetProvisioningUrl(
otInstance *aInstance
)
Получает URL-адрес подготовки.
Подробности | |||
---|---|---|---|
Параметры |
| ||
Возврат | Указатель на строку URL. |
откомиссионержетсессионид
uint16_t otCommissionerGetSessionId(
otInstance *aInstance
)
Возвращает идентификатор сеанса комиссара.
Подробности | |||
---|---|---|---|
Параметры |
| ||
Возврат | Идентификатор текущего сеанса комиссара. |
otCommissionerGetState
otCommissionerState otCommissionerGetState(
otInstance *aInstance
)
Возвращает состояние комиссара.
Подробности | |||||||
---|---|---|---|---|---|---|---|
Параметры |
| ||||||
Возвращаемые значения |
|
откоммиссерпанидкуери
otError otCommissionerPanIdQuery(
otInstance *aInstance,
uint16_t aPanId,
uint32_t aChannelMask,
const otIp6Address *aAddress,
otCommissionerPanIdConflictCallback aCallback,
void *aContext
)
Отправляет сообщение запроса PAN ID.
Подробности | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Параметры |
| ||||||||||||
Возвращаемые значения |
|
otCommissionerRemoveJoiner
otError otCommissionerRemoveJoiner(
otInstance *aInstance,
const otExtAddress *aEui64
)
Удаляет запись Joiner.
Подробности | |||||||||
---|---|---|---|---|---|---|---|---|---|
Параметры |
| ||||||||
Возвращаемые значения |
|
otCommissionerRemoveJoinerWithDiscerner
otError otCommissionerRemoveJoinerWithDiscerner(
otInstance *aInstance,
const otJoinerDiscerner *aDiscerner
)
Удаляет запись Joiner.
Подробности | |||||||||
---|---|---|---|---|---|---|---|---|---|
Параметры |
| ||||||||
Возвращаемые значения |
|
otCommissionerSendMgmtGet
otError otCommissionerSendMgmtGet(
otInstance *aInstance,
const uint8_t *aTlvs,
uint8_t aLength
)
Отправляет MGMT_COMMISSIONER_GET.
Подробности | |||||||
---|---|---|---|---|---|---|---|
Параметры |
| ||||||
Возвращаемые значения |
|
откомиссерсендмгмтсет
otError otCommissionerSendMgmtSet(
otInstance *aInstance,
const otCommissioningDataset *aDataset,
const uint8_t *aTlvs,
uint8_t aLength
)
Отправляет MGMT_COMMISSIONER_SET.
Подробности | |||||||||
---|---|---|---|---|---|---|---|---|---|
Параметры |
| ||||||||
Возвращаемые значения |
|
откомиссерсетид
otError otCommissionerSetId(
otInstance *aInstance,
const char *aId
)
Устанавливает идентификатор комиссара.
Подробности | |||||||
---|---|---|---|---|---|---|---|
Параметры |
| ||||||
Возвращаемые значения |
|
откомиссерсетпровисионингурл
otError otCommissionerSetProvisioningUrl(
otInstance *aInstance,
const char *aProvisioningUrl
)
Устанавливает URL-адрес предоставления.
Подробности | |||||
---|---|---|---|---|---|
Параметры |
| ||||
Возвращаемые значения |
|
otCommissionerStart
otError otCommissionerStart(
otInstance *aInstance,
otCommissionerStateCallback aStateCallback,
otCommissionerJoinerCallback aJoinerCallback,
void *aCallbackContext
)
Включает роль комиссара потоков.
Подробности | |||||||||
---|---|---|---|---|---|---|---|---|---|
Параметры |
| ||||||||
Возвращаемые значения |
|
otCommissionerStop
otError otCommissionerStop(
otInstance *aInstance
)
Отключает роль комиссара потоков.
Подробности | |||||
---|---|---|---|---|---|
Параметры |
| ||||
Возвращаемые значения |
|
Макросы
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 (не включает нулевые символы).
OT_PROVISIONING_URL_MAX_SIZE
OT_PROVISIONING_URL_MAX_SIZE 64
Максимальный размер (количество символов) в строке URL-адреса предоставления (исключая нулевые символы).
OT_STEERING_DATA_MAX_LENGTH
OT_STEERING_DATA_MAX_LENGTH 16
Максимальная длина данных рулевого управления (байты)
Ресурсы
Справочные разделы API OpenThread взяты из исходного кода, доступного на GitHub . Для получения дополнительной информации или внесения вклада в нашу документацию обратитесь к Ресурсам .