нл:: Переплетение:: Профили:: Описание устройства

Это пространство имен включает в себя все интерфейсы внутри Weave для профиля описания устройства Weave.

Краткое содержание

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

@177 перечисление
@178 перечисление
Типы сообщений для профиля описания устройства.
@179 {
kTag_WeaveDeviceDescriptor = 1,
kTag_VendorId = 0,
kTag_ProductId = 1,
kTag_ProductRevision = 2,
kTag_ManufacturingDate = 3,
kTag_SerialNumber = 4,
kTag_Primary802154MACAddress = 5,
kTag_PrimaryWiFiMACAddress = 6,
kTag_RendezvousWiFiESSID = 7,
kTag_PairingCode = 8,
kTag_SoftwareVersion = 9,
kTag_DeviceId = 10,
kTag_FabricId = 11,
kTag_PairingCompatibilityVersionMajor = 12,
kTag_PairingCompatibilityVersionMinor = 13,
kTag_RendezvousWiFiESSIDSuffix = 14,
kTag_DeviceFeature_HomeAlarmLinkCapable = 100,
kTag_DeviceFeature_LinePowered = 101
}
перечисление
Теги элементов данных для профиля описания устройства.
TargetDeviceModes {
kTargetDeviceMode_Any = 0x00000000,
kTargetDeviceMode_UserSelectedMode = 0x00000001
}
перечисление
Битовое поле (максимум 32 бита), определяющее, какие устройства должны отвечать на сообщение LocateRequest в зависимости от их текущего режима.
TargetFabricIds {
kTargetFabricId_NotInFabric = kFabricIdNotSpecified,
kTargetFabricId_AnyFabric = kReservedFabricIdStart,
kTargetFabricId_Any = kMaxFabricId
}
перечисление
Идентификаторы специальной целевой структуры.

Функции

MatchTargetFabricId (uint64_t fabricId, uint64_t targetFabricId)
NL_DLL_EXPORT bool
Сравните два идентификатора структуры, чтобы определить, совпадают ли они (учитывая значения подстановочных знаков).

Классы

nl:: Weave:: Profiles:: DeviceDescription:: DeviceDescriptionClient

Клиентский объект для выдачи запросов описания устройства.

nl:: Weave:: Profiles:: DeviceDescription:: DeviceDescriptionServer

Объект сервера для ответа на запросы описания устройства.

nl::Weave::Profiles::DeviceDescription::IdentDeviceCriteria

Представляет критерии, используемые для выбора устройств в протоколе IdentifyDevice.

nl:: Weave:: Profiles:: DeviceDescription:: IdentRequestMessage

Разобранная форма сообщения IdentRequest.

nl:: Weave:: Profiles:: DeviceDescription:: IdentResponseMessage

Разобранная форма сообщения идентификации.

nl:: Weave:: Profiles:: DeviceDescription:: TextDescriptorReader
nl:: Weave:: Profiles:: DeviceDescription:: TextDescriptorWriter
nl:: Weave:: Profiles:: DeviceDescription:: WeaveDeviceDescriptor

Содержит описательную информацию об устройстве Weave.

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

@177

 @177

@178

 @178

Типы сообщений для профиля описания устройства.

@179

 @179

Теги элементов данных для профиля описания устройства.

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

[логическое значение] Обозначает Nest Protect, который поддерживает подключение к домашней панели сигнализации.

Тег функции

kTag_DeviceFeature_LinePowered

[логическое значение] Указывает устройство, которому требуется сетевое питание.

Тег функции

kTag_DeviceId

[ uint, максимум 2^64 ] Идентификатор устройства Weave.

Контекстно-ориентированный тег

kTag_FabricId

[ uint, 2^64 max ] Идентификатор ткани Weave, к которой принадлежит устройство.

Контекстно-ориентированный тег

kTag_ManufacturingDate

[ uint, диапазон 1-65535 ] Календарная дата изготовления в закодированном виде.

Контекстно-ориентированный тег

kTag_PairingCode

[ Строка UTF-8, длина 6–16 ] Код сопряжения для устройства.

Контекстно-ориентированный тег

kTag_PairingCompatibilityVersionMajor

[ uint, диапазон 1-65535 ] Основная версия совместимости программного обеспечения для сопряжения.

Контекстно-ориентированный тег

kTag_PairingCompatibilityVersionMinor

[ uint, диапазон 1-65535 ] Дополнительная версия совместимости программного обеспечения для сопряжения.

Контекстно-ориентированный тег

kTag_Primary802154MACAddress

[байтовая строка, len = 8] MAC-адрес основного интерфейса 802.15.4 устройства.

Контекстно-ориентированный тег

kTag_PrimaryWiFiMACAddress

[байтовая строка, len = 6] MAC-адрес основного интерфейса Wi-Fi устройства.

Контекстно-ориентированный тег

kTag_ProductId

[ uint, диапазон 1-65535 ] Код, идентифицирующий продукт.

Контекстно-ориентированный тег

kTag_ProductRevision

[ uint, диапазон 1-65535 ] Код, идентифицирующий версию продукта.

Контекстно-ориентированный тег

kTag_RendezvousWiFiESSID

[строка UTF-8, длина 1–32] ESSID для сети встречи Wi-Fi устройства.

Контекстно-зависимый тег.

kTag_RendezvousWiFiESSIDSuffix

[ Строка UTF-8, длина 1–32 ] Суффикс ESSID для сети встречи Wi-Fi устройства.

Контекстно-зависимый тег.

kTag_SerialNumber

[ Строка UTF-8, длина 1–32 ] Серийный номер устройства.

Контекстно-ориентированный тег

kTag_SoftwareVersion

[ Строка UTF-8, длина 1–32 ] Версия программного обеспечения на устройстве.

Контекстно-ориентированный тег

kTag_VendorId

[ uint, диапазон 1-65535 ] Код, идентифицирующий поставщика продукта.

Контекстно-ориентированный тег

kTag_WeaveDeviceDescriptor

Структура, содержащая информацию, описывающую устройство Weave.

Тег верхнего уровня

TargetDeviceModes

 TargetDeviceModes

Битовое поле (максимум 32 бита), определяющее, какие устройства должны отвечать на сообщение LocateRequest в зависимости от их текущего режима.

Обратите внимание, что определенные здесь режимы являются общими и могут применяться к различным типам устройств.

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

Найдите все устройства независимо от режима.

kTargetDeviceMode_UserSelectedMode

Найдите все устройства в режиме «выбрано пользователем», то есть когда устройство было непосредственно идентифицировано пользователем путем нажатия кнопки (или ее эквивалента).

TargetFabricIds

 TargetFabricIds

Идентификаторы специальной целевой структуры.

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

Указывает, что все устройства должны отвечать независимо от принадлежности к структуре.

kTargetFabricId_AnyFabric

Указывает, что отвечать должны только устройства, которые __являются_ членами структуры.

kTargetFabricId_NotInFabric

Указывает, что должны отвечать только устройства, не являющиеся членами структуры.

Функции

MatchTargetFabricId

NL_DLL_EXPORT bool MatchTargetFabricId(
  uint64_t fabricId,
  uint64_t targetFabricId
)

Сравните два идентификатора структуры, чтобы определить, совпадают ли они (учитывая значения подстановочных знаков).

Подробности
Параметры
[in] fabricId
Идентификатор структуры для проверки.
[in] targetFabricId
Идентификатор структуры для проверки.
Возвращаемые значения
TRUE
Если идентификаторы ткани совпадают.
FALSE
Если идентификаторы ткани не совпадают.