Комиссар

Этот модуль включает функции для роли уполномоченного по потокам.

Резюме

Перечисления

otCommissionerJoinerEvent перечислить
Это перечисление определяет событие присоединения к уполномоченному.
otCommissionerState {
OT_COMMISSIONER_STATE_DISABLED = 0,
OT_COMMISSIONER_STATE_PETITION = 1,
OT_COMMISSIONER_STATE_ACTIVE = 2
}
перечислить
Это перечисление определяет государство комиссара.
otJoinerInfoType {
OT_JOINER_INFO_TYPE_ANY = 0,
OT_JOINER_INFO_TYPE_EUI64 = 1,
OT_JOINER_INFO_TYPE_DISCERNER = 2
}
перечислить
Это перечисление определяет тип информации о присоединяемом.

Typedefs

otCommissionerEnergyReportCallback )(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext) typedef
void(*
Этот указатель функции вызывается, когда комиссар получает отчет об энергопотреблении.
otCommissionerJoinerCallback )(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext) typedef
void(*
Этот указатель на функцию вызывается всякий раз, когда изменяется состояние соединения.
otCommissionerJoinerEvent typedef
Это перечисление определяет событие присоединения к уполномоченному.
otCommissionerPanIdConflictCallback )(uint16_t aPanId, uint32_t aChannelMask, void *aContext) typedef
void(*
Этот указатель функции вызывается, когда комиссар получает сообщение о конфликте идентификатора PAN.
otCommissionerState typedef
Это перечисление определяет государство комиссара.
otCommissionerStateCallback )(otCommissionerState aState, void *aContext) typedef
void(*
Этот указатель на функцию вызывается всякий раз, когда изменяется состояние комиссара.
otCommissioningDataset typedef
Эта структура представляет собой набор данных ввода в эксплуатацию.
otJoinerInfo typedef
struct otJoinerInfo
Эта структура представляет информацию о присоединении.
otJoinerInfoType typedef
Это перечисление определяет тип информации о присоединяемом.
otJoinerPskd typedef
struct otJoinerPskd
Эта структура представляет собой Joiner PSKd.
otSteeringData typedef
Эта структура представляет данные рулевого управления.

Функции

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)
Эта функция отправляет сообщение Announce Begin.
otCommissionerEnergyScan ( otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, uint16_t aScanDuration, const otIp6Address *aAddress, otCommissionerEnergyReportCallback aCallback, void *aContext)
Эта функция отправляет сообщение запроса сканирования энергии.
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.
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.
otCommissionerSetProvisioningUrl ( otInstance *aInstance, const char *aProvisioningUrl)
Эта функция устанавливает URL-адрес инициализации.
otCommissionerStart ( otInstance *aInstance, otCommissionerStateCallback aStateCallback, otCommissionerJoinerCallback aJoinerCallback, void *aCallbackContext)
Эта функция включает роль уполномоченного по потокам.
otCommissionerStop ( otInstance *aInstance)
Эта функция отключает роль уполномоченного по потокам.

Структуры

otCommissioningDataset

Эта структура представляет собой набор данных ввода в эксплуатацию.

otJoinerInfo

Эта структура представляет информацию о присоединении.

otJoinerPskd

Эта структура представляет собой Joiner PSKd.

otSteeringData

Эта структура представляет данные рулевого управления.

Перечисления

otCommissionerJoinerEvent

 otCommissionerJoinerEvent

Это перечисление определяет событие присоединения к уполномоченному.

otCommissionerState

 otCommissionerState

Это перечисление определяет государство комиссара.

Характеристики
OT_COMMISSIONER_STATE_ACTIVE

Роль комиссара активна.

OT_COMMISSIONER_STATE_DISABLED

Роль комиссара отключена.

OT_COMMISSIONER_STATE_PETITION

В настоящее время подает прошение о назначении комиссара.

otJoinerInfoType

 otJoinerInfoType

Это перечисление определяет тип информации о присоединяемом.

Характеристики
OT_JOINER_INFO_TYPE_ANY

Принять любого Joiner (не указаны EUI64 или Discerner).

OT_JOINER_INFO_TYPE_DISCERNER

Столяр различает указано ( mSharedId.mDiscerner в otJoinerInfo ).

OT_JOINER_INFO_TYPE_EUI64

Столяр EUI-64 задается ( mSharedId.mEui64 в otJoinerInfo ).

Typedefs

otCommissionerEnergyReportCallback

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

Этот указатель функции вызывается, когда комиссар получает отчет об энергопотреблении.

Подробности
Параметры
[in] aChannelMask
Значение маски канала.
[in] aEnergyList
Указатель на список измерений энергии.
[in] aEnergyListLength
Количество записей в aEnergyListLength .
[in] aContext
Указатель на контекст приложения.

otCommissionerJoinerCallback

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

Этот указатель на функцию вызывается всякий раз, когда изменяется состояние соединения.

Подробности
Параметры
[in] aEvent
Тип присоединяемого события.
[in] aJoinerInfo
Указатель на информацию о присоединении.
[in] aJoinerId
Указатель на идентификатор Joiner ID (если он не известен, он будет NULL).
[in] aContext
Указатель на контекст приложения.

otCommissionerJoinerEvent

enum otCommissionerJoinerEvent otCommissionerJoinerEvent

Это перечисление определяет событие присоединения к уполномоченному.

otCommissionerPanIdConflictCallback

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

Этот указатель на функцию вызывается, когда комиссар получает сообщение о конфликте идентификатора PAN.

Подробности
Параметры
[in] aPanId
Значение PAN ID.
[in] aChannelMask
Значение маски канала.
[in] aContext
Указатель на контекст приложения.

otCommissionerState

enum otCommissionerState otCommissionerState

Это перечисление определяет государство комиссара.

otCommissionerStateCallback

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

Этот указатель на функцию вызывается всякий раз, когда изменяется состояние комиссара.

Подробности
Параметры
[in] aChannelMask
Значение маски канала.
[in] aEnergyList
Указатель на список измерений энергии.
[in] aEnergyListLength
Количество записей в aEnergyListLength .
[in] aContext
Указатель на контекст приложения.

otCommissioningDataset

struct otCommissioningDataset otCommissioningDataset

Эта структура представляет собой набор данных ввода в эксплуатацию.

otJoinerInfo

struct otJoinerInfo otJoinerInfo

Эта структура представляет информацию о присоединении.

otJoinerInfoType

enum otJoinerInfoType otJoinerInfoType

Это перечисление определяет тип информации о присоединяемом.

otJoinerPskd

struct otJoinerPskd otJoinerPskd

Эта структура представляет собой Joiner PSKd.

otSteeringData

struct otSteeringData otSteeringData

Эта структура представляет данные рулевого управления.

Функции

otCommissionerAddJoiner

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

Эта функция добавляет запись Joiner.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aEui64
Указатель на IEEE EUI-64 объекта Joiner или NULL для любого объекта Joiner.
[in] aPskd
Указатель на PSKd.
[in] aTimeout
Время в секундах, по истечении которого объект Joiner автоматически удаляется.
Возвращаемые значения
OT_ERROR_NONE
Столяр успешно добавлен.
OT_ERROR_NO_BUFS
Нет доступных буферов для добавления Joiner.
OT_ERROR_INVALID_ARGS
aEui64 или aPskd является недействительным.
OT_ERROR_INVALID_STATE
Комиссар не действует.

otCommissionerAddJoinerWithDiscerner

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

Эта функция добавляет запись Joiner с заданным значением Joiner Discerner.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aDiscerner
Указатель на Joiner Discerner.
[in] aPskd
Указатель на PSKd.
[in] aTimeout
Время в секундах, по истечении которого объект Joiner автоматически удаляется.
Возвращаемые значения
OT_ERROR_NONE
Столяр успешно добавлен.
OT_ERROR_NO_BUFS
Нет доступных буферов для добавления Joiner.
OT_ERROR_INVALID_ARGS
aDiscerner или aPskd является недействительным.
OT_ERROR_INVALID_STATE
Комиссар не действует.

otCommissionerAnnounceBegin

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

Эта функция отправляет сообщение Announce Begin.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aChannelMask
Значение маски канала.
[in] aCount
Количество сообщений с объявлением на канал.
[in] aPeriod
Время между двумя последовательными передачами MLE Announce (в миллисекундах).
[in] aAddress
Указатель на место назначения IPv6.
Возвращаемые значения
OT_ERROR_NONE
Сообщение о начале объявления успешно поставлено в очередь.
OT_ERROR_NO_BUFS
Недостаточно буферов для создания сообщения Announce Begin.
OT_ERROR_INVALID_STATE
Комиссар не действует.

otCommissionerEnergyScan

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

Эта функция отправляет сообщение запроса сканирования энергии.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aChannelMask
Значение маски канала.
[in] aCount
Количество измерений энергии на канал.
[in] aPeriod
Время между измерениями энергии (миллисекунды).
[in] aScanDuration
Продолжительность сканирования для каждого измерения энергии (миллисекунды).
[in] aAddress
Указатель на место назначения IPv6.
[in] aCallback
Указатель на функцию, вызываемую при получении сообщения Energy Report.
[in] aContext
Указатель на контекст приложения.
Возвращаемые значения
OT_ERROR_NONE
Успешно поставлено в очередь сообщение запроса сканирования энергии.
OT_ERROR_NO_BUFS
Недостаточно буферов для создания сообщения запроса сканирования энергии.
OT_ERROR_INVALID_STATE
Комиссар не действует.

otCommissionerGetNextJoinerInfo

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

Этот метод получает информацию о присоединении в позиции aIterator.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр.
[in,out] aIterator
Указатель на контекст итератора Joiner Info.
[out] aJoiner
Ссылка на информацию о присоединении.
Возвращаемые значения
OT_ERROR_NONE
Успешно получить информацию о присоединении.
OT_ERROR_NOT_FOUND
Не найден следующий Столяр.

otCommissionerGetProvisioningUrl

const char * otCommissionerGetProvisioningUrl(
  otInstance *aInstance
)

Эта функция получает URL-адрес инициализации.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
Возврат
Указатель на строку URL.

otCommissionerGetSessionId

uint16_t otCommissionerGetSessionId(
  otInstance *aInstance
)

Эта функция возвращает идентификатор сеанса комиссара.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
Возврат
Идентификатор текущей сессии комиссара.

otCommissionerGetState

otCommissionerState otCommissionerGetState(
  otInstance *aInstance
)

Эта функция возвращает состояние комиссара.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
Возвращаемые значения
OT_COMMISSIONER_STATE_DISABLED
Комиссар отключен.
OT_COMMISSIONER_STATE_PETITION
Став комиссаром.
OT_COMMISSIONER_STATE_ACTIVE
Комиссар включен.

otCommissionerPanIdQuery

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

Эта функция отправляет сообщение запроса идентификатора PAN.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aPanId
PAN ID для запроса.
[in] aChannelMask
Значение маски канала.
[in] aAddress
Указатель на место назначения IPv6.
[in] aCallback
Указатель на функцию, вызываемую при получении сообщения о конфликте идентификатора PAN.
[in] aContext
Указатель на контекст приложения.
Возвращаемые значения
OT_ERROR_NONE
Сообщение запроса идентификатора PAN успешно поставлено в очередь.
OT_ERROR_NO_BUFS
Недостаточно буферов для создания сообщения запроса идентификатора PAN.
OT_ERROR_INVALID_STATE
Комиссар не действует.

otCommissionerRemoveJoiner

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

Эта функция удаляет запись Joiner.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aEui64
Указатель на IEEE EUI-64 объекта Joiner или NULL для любого объекта Joiner.
Возвращаемые значения
OT_ERROR_NONE
Столяр успешно удален.
OT_ERROR_NOT_FOUND
Столяр указанный aEui64 не был найден.
OT_ERROR_INVALID_ARGS
aEui64 является недействительным.
OT_ERROR_INVALID_STATE
Комиссар не действует.

otCommissionerRemoveJoinerWithDiscerner

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

Эта функция удаляет запись Joiner.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aEui64
Указатель на Joiner Discerner.
Возвращаемые значения
OT_ERROR_NONE
Столяр успешно удален.
OT_ERROR_NOT_FOUND
Столяр указанный aEui64 не был найден.
OT_ERROR_INVALID_ARGS
aDiscerner является недействительным.
OT_ERROR_INVALID_STATE
Комиссар не действует.

otCommissionerSendMgmtGet

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

Эта функция отправляет MGMT_COMMISSIONER_GET.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aTlvs
Указатель на TLV.
[in] aLength
Длина TLV.
Возвращаемые значения
OT_ERROR_NONE
Успешно отправьте команду набора данных meshcop.
OT_ERROR_NO_BUFS
Недостаточно места в буфере для отправки.
OT_ERROR_INVALID_STATE
Комиссар не действует.

otCommissionerSendMgmtSet

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

Эта функция отправляет MGMT_COMMISSIONER_SET.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aDataset
Указатель на набор данных для ввода в эксплуатацию.
[in] aTlvs
Указатель на TLV.
[in] aLength
Длина TLV.
Возвращаемые значения
OT_ERROR_NONE
Успешно отправьте команду набора данных meshcop.
OT_ERROR_NO_BUFS
Недостаточно места в буфере для отправки.
OT_ERROR_INVALID_STATE
Комиссар не действует.

otCommissionerSetProvisioningUrl

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

Эта функция устанавливает URL-адрес инициализации.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aProvisioningUrl
Указатель на URL-адрес инициализации (может иметь значение NULL, чтобы установить как пустую строку).
Возвращаемые значения
OT_ERROR_NONE
Успешно установите URL-адрес инициализации.
OT_ERROR_INVALID_ARGS
aProvisioningUrl является недействительным (слишком долго).

otCommissionerStart

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

Эта функция включает роль уполномоченного по потокам.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aStateCallback
Указатель на функцию, которая вызывается при изменении состояния комиссара.
[in] aJoinerCallback
Происходит указатель на функцию, которая вызывается с событием соединения.
[in] aCallbackContext
Указатель на контекст приложения.
Возвращаемые значения
OT_ERROR_NONE
Успешно запущена служба комиссара.
OT_ERROR_ALREADY
Комиссар уже запущен.
OT_ERROR_INVALID_STATE
Устройство в настоящее время не подключено к сети.

otCommissionerStop

otError otCommissionerStop(
  otInstance *aInstance
)

Эта функция отключает роль уполномоченного по потокам.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
Возвращаемые значения
OT_ERROR_NONE
Успешно остановлена ​​служба комиссара.
OT_ERROR_ALREADY
Комиссара уже остановили.

Макросы

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

Максимальный размер (количество символов) в строке Provisioning URL (исключая нулевой символ).

OT_STEERING_DATA_MAX_LENGTH

 OT_STEERING_DATA_MAX_LENGTH 16

Максимальная длина данных рулевого управления (байты)