Схема характеристик управления сетью умного дома

action.devices.traits.NetworkControl — Этот трейт относится к устройствам, поддерживающим передачу сетевых данных и выполнение операций, специфичных для сети.

АТРИБУТЫ УСТРОЙСТВА

Устройства с этой особенностью могут сообщать следующие атрибуты в рамках операции SYNC . Для получения дополнительной информации об обработке намерений SYNC см. раздел «Выполнение намерений» .

Атрибуты Тип Описание
supportsEnablingGuestNetwork Логический

(По умолчанию: false )

Установите значение true, если гостевая сеть может быть включена.

supportsDisablingGuestNetwork Логический

(По умолчанию: false )

Установите значение true, если гостевую сеть можно отключить.

supportsGettingGuestNetworkPassword Логический

(По умолчанию: false )

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

networkProfiles Множество

Указывает поддерживаемые имена сетевых профилей.

[ item, ... ] Нить

Название сетевого профиля, представляющего группу связанных устройств.

supportsEnablingNetworkProfile Логический

(По умолчанию: "false" )

Установите значение true, если сетевые профили можно включить.

supportsDisablingNetworkProfile Логический

(По умолчанию: "false" )

Установите значение true, если сетевые профили можно отключить.

supportsNetworkDownloadSpeedTest Логический

(По умолчанию: false )

Установите значение true, если возможна проверка скорости загрузки.

supportsNetworkUploadSpeedTest Логический

(По умолчанию: false )

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

Примеры

Сетевое устройство, поддерживающее гостевую сеть, профили и проверку скорости.

{
  "supportsEnablingGuestNetwork": true,
  "supportsDisablingGuestNetwork": true,
  "supportsEnablingNetworkProfile": true,
  "supportsDisablingNetworkProfile": true,
  "supportsNetworkDownloadSpeedTest": true,
  "supportsNetworkUploadSpeedTest": true,
  "supportsGettingGuestNetworkPassword": true,
  "networkProfiles": [
    "Kids"
  ]
}

СОСТОЯНИЯ УСТРОЙСТВА

Сущности с этим свойством могут сообщать о следующих состояниях в рамках операции QUERY . Для получения дополнительной информации об обработке намерений QUERY см. раздел «Выполнение намерений» .

Штаты Тип Описание
networkEnabled Логический

Включена ли основная сеть.

networkSettings Объект

Содержит SSID основной сети.

ssid Нить

Необходимый.

SSID сети.

guestNetworkEnabled Логический

Включена ли гостевая сеть.

guestNetworkSettings Объект

Содержит SSID гостевой сети.

ssid Нить

Необходимый.

SSID сети.

numConnectedDevices Целое число

Количество устройств, подключенных к сети.

networkUsageMB Число

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

networkUsageLimitMB Число

Лимит использования сети в МБ (мегабайтах). Лимит использования сети действует в течение текущего расчетного периода.

networkUsageUnlimited Логический

Указывает, является ли использование сети неограниченным. Если этот параметр установлен в значение true, состояние устройства networkUsageLimitMB будет игнорироваться.

lastNetworkDownloadSpeedTest Объект

Содержит результаты последнего теста скорости загрузки по сети.

downloadSpeedMbps Число

Скорость загрузки в Мбит/с (мегабит в секунду) по результатам последнего теста скорости сети.

unixTimestampSec Целое число

Временная метка Unix (количество секунд с начала эпохи Unix), когда был выполнен последний тест скорости загрузки по сети.

status Нить

Указывает, был ли последний тест скорости загрузки по сети успешным или нет.

Поддерживаемые значения:

SUCCESS
FAILURE
lastNetworkUploadSpeedTest Объект

Содержит результаты последнего теста скорости загрузки в сеть.

uploadSpeedMbps Число

Скорость загрузки в Мбит/с (мегабит в секунду) по результатам последнего теста скорости сети.

unixTimestampSec Целое число

Временная метка Unix (количество секунд с начала эпохи Unix), когда был выполнен последний тест скорости загрузки по сети.

status Нить

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

Поддерживаемые значения:

SUCCESS
FAILURE
networkSpeedTestInProgress Логический

(По умолчанию: false )

Проводится ли в данный момент тест скорости.

networkProfilesState Объект

Состояние сетевых профилей. Этот объект верхнего уровня должен содержать пары ключ-значение, где ключом является имя одного из сетевых профилей, перечисленных в атрибуте networkProfiles , а значением — соответствующее состояние этого профиля.

<string> Объект

Объект, хранящий состояние отдельного сетевого профиля. Значение В качестве параметра key следует указать имя одного из сетевых профилей, указанных в атрибуте networkProfiles .

enabled Логический

Текущее состояние включения/выключения профиля сети.

Примеры

Устройство с активной сетью.

{
  "networkEnabled": true,
  "networkSettings": {
    "ssid": "home-network-123"
  },
  "guestNetworkSettings": {
    "ssid": "home-network-123-guest"
  },
  "numConnectedDevices": 4,
  "networkUsageMB": 100.8
}

Устройство с активной сетью и результатами теста скорости.

{
  "networkEnabled": true,
  "networkSettings": {
    "ssid": "home-network-123"
  },
  "guestNetworkSettings": {
    "ssid": "home-network-123-guest"
  },
  "numConnectedDevices": 4,
  "networkUsageMB": 100.8,
  "lastNetworkDownloadSpeedTest": {
    "downloadSpeedMbps": 159.8,
    "unixTimestampSec": 1563215576,
    "status": "SUCCESS"
  },
  "lastNetworkUploadSpeedTest": {
    "uploadSpeedMbps": 64.1,
    "unixTimestampSec": 1563215576,
    "status": "SUCCESS"
  }
}

Устройство находится в режиме активного тестирования сети, и в данный момент проводится проверка скорости.

{
  "networkEnabled": true,
  "networkSettings": {
    "ssid": "home-network-123"
  },
  "guestNetworkSettings": {
    "ssid": "home-network-123-guest"
  },
  "numConnectedDevices": 4,
  "networkUsageMB": 100.8,
  "networkSpeedTestInProgress": true
}

Устройство с отключенным сетевым профилем "дети".

{
  "networkEnabled": true,
  "networkSettings": {
    "ssid": "home-network-123"
  },
  "networkProfilesState": {
    "parents": {
      "enabled": true
    },
    "kids": {
      "enabled": false
    }
  }
}

КОМАНДЫ УСТРОЙСТВА

Устройства с этой особенностью могут реагировать на следующие команды в рамках операции EXECUTE . Для получения дополнительной информации об обработке намерений EXECUTE см. раздел «Выполнение намерений» .

action.devices.commands.EnableDisableGuestNetwork

Включение или отключение гостевой сети. Необходимо использовать дополнительную проверку пользователя с помощью PIN-кода. Отключение других устройств безопасности с помощью этих команд может повлиять на безопасность домашней сети пользователя.

Для выполнения этой команды требуются следующие атрибуты: 
{
  "supportsEnablingGuestNetwork": true,
  "supportsDisablingGuestNetwork": true
}

Параметры

Параметры Тип Описание
enable Логический

Необходимый.

Значение True включает гостевую сеть, значение False отключает гостевую сеть.

Примеры

Включите гостевую сеть.

{
  "command": "action.devices.commands.EnableDisableGuestNetwork",
  "params": {
    "enable": true
  }
}

action.devices.commands.EnableDisableNetworkProfile

Включение или отключение сетевого профиля. Необходимо использовать дополнительную проверку пользователя с помощью PIN-кода. Отключение других устройств безопасности с помощью этих команд может повлиять на безопасность домашней сети пользователя.

Для выполнения этой команды требуются следующие атрибуты: 
{
  "supportsEnablingNetworkProfile": true,
  "supportsDisablingNetworkProfile": true
}

Параметры

Параметры Тип Описание
profile Нить

Необходимый.

Имя профиля из атрибута networkProfiles .

enable Логический

Необходимый.

Значение True включает профиль, значение False отключает профиль.

Примеры

Выключите интернет для детей.

{
  "command": "action.devices.commands.EnableDisableNetworkProfile",
  "params": {
    "profile": "Kids",
    "enable": false
  }
}

Произошла ошибка при попытке управления указанным сетевым профилем.

Поддерживаемые значения:

networkProfileNotRecognized

action.devices.commands.GetGuestNetworkPassword

Получите пароль гостевой сети. Необходимо использовать дополнительную проверку пользователя с помощью PIN-кода. Если другие устройства безопасности отключены с помощью этих команд, это может повлиять на безопасность домашней сети пользователя.

Для выполнения этой команды требуются следующие атрибуты: 
{
  "supportsGettingGuestNetworkPassword": true
}

Параметры

Параметры Тип Описание

Нет объектов недвижимости

Примеры

Показать пароль от гостевой сети Wi-Fi. 

{
  "command": "action.devices.commands.GetGuestNetworkPassword",
  "params": {}
}

Результаты

Результаты Тип Описание
guestNetworkPassword Нить

Необходимый.

Пароль для гостевой сети.

Примеры

Показать пароль от гостевой сети Wi-Fi. 

{
  "guestNetworkPassword": "123456"
}

action.devices.commands.TestNetworkSpeed

Проверьте скорость загрузки и выгрузки данных по сети.

Для выполнения этой команды требуются следующие атрибуты: 
{
  "supportsNetworkDownloadSpeedTest": true,
  "supportsNetworkUploadSpeedTest": true
}

Параметры

Параметры Тип Описание
testDownloadSpeed Логический

Необходимый.

Указывает, следует ли проверять скорость загрузки.

testUploadSpeed Логический

Необходимый.

Указывает, следует ли проверять скорость загрузки.

followUpToken Нить

Необходимый.

Токен, предоставленный Google, для последующего ответа.

Примеры

Какова скорость Wi-Fi? 

{
  "command": "action.devices.commands.TestNetworkSpeed",
  "params": {
    "testDownloadSpeed": true,
    "testUploadSpeed": true,
    "followUpToken": "123"
  }
}

Произошла ошибка при попытке запросить проверку скорости.

Поддерживаемые значения:

networkSpeedTestInProgress

Дополнительные ответы

Устройства с этой особенностью могут возвращать следующий ответ в рамках операции EXECUTE . Для получения дополнительной информации о реализации последующих ответов см. раздел «Уведомления для действий умного дома» .

Полезная нагрузка содержит один из следующих компонентов:

Успех: networkDownloadSpeedMbps

Поля Тип Описание
followUpToken Нить

Необходимый.

Токен предоставлен в исходном запросе EXECUTE.

status Нить

Необходимый.

Результат запроса.

Поддерживаемые значения:

SUCCESS
networkDownloadSpeedMbps Число

Необходимый.

Скорость загрузки по сети измеряется в мегабитах в секунду.

Успех: networkUploadSpeedMbps

Поля Тип Описание
followUpToken Нить

Необходимый.

Токен предоставлен в исходном запросе EXECUTE.

status Нить

Необходимый.

Результат запроса.

Поддерживаемые значения:

SUCCESS
networkUploadSpeedMbps Число

Необходимый.

Скорость загрузки данных в сеть измеряется в мегабитах в секунду.

Успех: networkDownloadSpeedMbps и networkUploadSpeedMbps

Поля Тип Описание
followUpToken Нить

Необходимый.

Токен предоставлен в исходном запросе EXECUTE.

status Нить

Необходимый.

Результат запроса.

Поддерживаемые значения:

SUCCESS
networkDownloadSpeedMbps Число

Необходимый.

Скорость загрузки по сети измеряется в мегабитах в секунду.

networkUploadSpeedMbps Число

Необходимый.

Скорость загрузки данных в сеть измеряется в мегабитах в секунду.

Отказ

Поля Тип Описание
followUpToken Нить

Необходимый.

Токен предоставлен в исходном запросе EXECUTE.

status Нить

Необходимый.

Результат запроса.

Поддерживаемые значения:

FAILURE
errorCode Нить

Необходимый.

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

Примеры

Какова скорость Wi-Fi? (дополнительный ответ) 

{
  "NetworkControl": {
    "priority": 0,
    "followUpResponse": {
      "status": "SUCCESS",
      "networkDownloadSpeedMbps": 23.3,
      "networkUploadSpeedMbps": 10.2,
      "followUpToken": "1234"
    }
  }
}

Какова скорость Wi-Fi? (дополнительный ответ при возникновении проблемы) 

{
  "NetworkControl": {
    "priority": 0,
    "followUpResponse": {
      "status": "FAILURE",
      "errorCode": "transientError",
      "followUpToken": "1234"
    }
  }
}

ОШИБКИ устройства

См. полный список ошибок и исключений .

Произошла ошибка при попытке управления указанным сетевым профилем.

Поддерживаемые значения:

networkProfileNotRecognized

Произошла ошибка при попытке запросить проверку скорости.

Поддерживаемые значения:

networkSpeedTestInProgress