Столяр

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

Резюме

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

otJoinerState перечислить
Это перечисление определяет состояние соединения.

Typedefs

otJoinerCallback )(otError aError, void *aContext) typedef
void(*
Этот указатель на функцию вызывается для уведомления о завершении операции соединения.
otJoinerDiscerner typedef
Эта структура представляет собой Столяров, различающих.
otJoinerState typedef
Это перечисление определяет состояние соединения.

Функции

otJoinerGetDiscerner ( otInstance *aInstance)
Этот метод получает Joiner Discerner.
otJoinerGetId ( otInstance *aInstance)
const otExtAddress *
Этот метод получает идентификатор Joiner ID.
otJoinerGetState ( otInstance *aInstance)
Эта функция возвращает состояние соединения.
otJoinerSetDiscerner ( otInstance *aInstance, otJoinerDiscerner *aDiscerner)
Этот метод устанавливает 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)
Эта функция включает роль присоединителя к потоку.
otJoinerStop ( otInstance *aInstance)
void
Эта функция отключает роль присоединения к потоку.

Структуры

otJoinerDiscerner

Эта структура представляет собой Столяров, различающих.

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

otJoinerState

 otJoinerState

Это перечисление определяет состояние соединения.

Typedefs

otJoinerCallback

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

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

Подробности
Параметры
[in] aError
OT_ERROR_NONE, если процесс присоединения прошел успешно. OT_ERROR_SECURITY, если процесс присоединения не удался из-за учетных данных. OT_ERROR_NOT_FOUND, если сеть, к которой можно присоединиться, не обнаружена. OT_ERROR_RESPONSE_TIMEOUT, если время ответа истекло.
[in] aContext
Указатель на контекст приложения.

otJoinerDiscerner

struct otJoinerDiscerner otJoinerDiscerner

Эта структура представляет собой Столяров, различающих.

otJoinerState

enum otJoinerState otJoinerState

Это перечисление определяет состояние соединения.

Функции

otJoinerGetDiscerner

const otJoinerDiscerner * otJoinerGetDiscerner(
  otInstance *aInstance
)

Этот метод получает Joiner Discerner.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
Возврат
Указатель на Joiner Discerner или NULL, если ничего не задано.

otJoinerGetId

const otExtAddress * otJoinerGetId(
  otInstance *aInstance
)

Этот метод получает идентификатор Joiner ID.

Если Joiner Discerner не установлен, Joiner ID - это первые 64 бита результата вычисления SHA-256 по заданному на заводе стандарту IEEE EUI-64. В противном случае идентификатор Joiner ID рассчитывается на основе значения Joiner Discerner.

Идентификатор присоединения также используется в качестве расширенного адреса устройства IEEE 802.15.4 во время процесса ввода в эксплуатацию.

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

otJoinerGetState

otJoinerState otJoinerGetState(
  otInstance *aInstance
)

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

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
Возвращаемые значения
OT_JOINER_STATE_IDLE
OT_JOINER_STATE_DISCOVER
OT_JOINER_STATE_CONNECT
OT_JOINER_STATE_CONNECTED
OT_JOINER_STATE_ENTRUST
OT_JOINER_STATE_JOINED

otJoinerSetDiscerner

otError otJoinerSetDiscerner(
  otInstance *aInstance,
  otJoinerDiscerner *aDiscerner
)

Этот метод устанавливает Joiner Discerner.

Joiner Discerner используется для расчета идентификатора Joiner ID, используемого в процессе ввода в эксплуатацию / присоединения.

По умолчанию (когда распознаватель не указан или установлен в NULL), Joiner ID выводится как первые 64 бита результата вычисления SHA-256 по заданному на заводе стандарту IEEE EUI-64. Обратите внимание, что это основное поведение, ожидаемое спецификацией потока.

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

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
)

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

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aPskd
Указатель на PSKd.
[in] aProvisioningUrl
Указатель на URL-адрес инициализации (может иметь значение NULL).
[in] aVendorName
Указатель на имя поставщика (может иметь значение NULL).
[in] aVendorModel
Указатель на модель поставщика (может иметь значение NULL).
[in] aVendorSwVersion
Указатель на версию ПО поставщика (может иметь значение NULL).
[in] aVendorData
Указатель на данные поставщика (может иметь значение NULL).
[in] aCallback
Указатель на функцию, которая вызывается после завершения операции соединения.
[in] aContext
Указатель на контекст приложения.
Возвращаемые значения
OT_ERROR_NONE
Успешно запущена роль объединителя.
OT_ERROR_BUSY
Предыдущая попытка все еще продолжается.
OT_ERROR_INVALID_ARGS
aPskd или aProvisioningUrl недопустимы.
OT_ERROR_INVALID_STATE
Стек IPv6 не включен или стек потоков полностью включен.

otJoinerStop

void otJoinerStop(
  otInstance *aInstance
)

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

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

Макросы

OT_JOINER_MAX_DISCERNER_LENGTH

 OT_JOINER_MAX_DISCERNER_LENGTH 64

Максимальная длина Joiner Discerner в битах.