Модели устройств и схемы экземпляров

Модель устройства

Модель устройства определяется полями в этом разделе.

Поля модели устройства могут содержать только буквы, цифры и следующие символы: точка (.), дефис (-), подчеркивание (_), пробел ( ) и плюс (+). Первым символом поля должна быть буква или цифра.

Пример

{
  "project_id": "my-devices-project",
  "device_model_id": "my-devices-project-prototype-light-v1",
  "manifest": {
    "manufacturer": "Assistant SDK developer",
    "product_name": "Assistant SDK light",
    "device_description": "Assistant SDK light device"
  },
  "device_type": "action.devices.types.LIGHT",
  "traits": ["action.devices.traits.OnOff"]
}

Схема

{
  "project_id": string,
  "device_model_id": string,
  "manifest": {
    "manufacturer": string,
    "product_name": string,
    "device_description": string
  },
  "device_type": string,
  "traits": [ string ]
}

project_id : (Строка) Требуется. Идентификатор проекта Google Cloud Platform проекта Actions Console, который нужно связать с этой моделью устройства. Проект может содержать несколько моделей устройств.
device_model_id : (Строка) Обязательно. Глобально уникальный идентификатор этой модели устройства; используйте project_id в качестве префикса, чтобы избежать коллизий в диапазоне всех проектов. Используется в метриках и при регистрации устройства.
manifest : (объект(Манифест)) Обязательно. Метаданные, описывающие модель и производителя устройства. Это может быть показано в (предстоящей) консоли SDK, панелях показателей и других связанных визуальных интерфейсах.
- manifest.manufacturer : (Строка) Требуется. Название производителя устройства.
- manifest.product_name : (Строка) Обязательно. Название продукта, ориентированное на потребителя, для этой модели устройства.
- manifest.device_description : (Строка) Необязательно. Описание данной модели устройства.
device_type : (Строка) Обязательно. Тип аппаратного обеспечения устройства. Выберите из следующего:
- action.devices.types.CAMERA
- action.devices.types.DISHWASHER
- action.devices.types.DRYER
- action.devices.types.LIGHT
- action.devices.types.OUTLET
- action.devices.types.PHONE
- action.devices.types.REFRIGERATOR
- action.devices.types.SCENE
- action.devices.types.SOUNDBAR
- action.devices.types.SPEAKER
- action.devices.types.SWITCH
- action.devices.types.THERMOSTAT
- action.devices.types.TV
- action.devices.types.VACUUM
- action.devices.types.WASHER
traits : (Array<String>) Необязательно. Список функций, которые поддерживает устройство. Характеристики включают команды, атрибуты и состояния устройства. Вам не нужно определять пакет действий для использования.встроенные черты .

Экземпляр устройства

Экземпляр устройства определяется полями в этом разделе.

Поля экземпляра устройства должны начинаться с буквы или цифры. Идентификатор устройства может содержать только буквы, цифры и следующие символы: точка (.), дефис (-), подчеркивание (_) и плюс (+). Имя устройства может содержать только цифры, буквы и символ пробела ( ).

Пример

  {
    "id": "my_led_1",
    "model_id": "my-devices-project-prototype-light-v1",
    "nickname": "My Assistant Light",
    "client_type": "SDK_LIBRARY"
  }

Схема

  {
    "id": string,
    "model_id": string,
    "nickname": string,
    "client_type": string
  }

id : (Строка) Обязательно. Идентификатор тестового устройства. Должно быть уникальным на всех устройствах, зарегистрированных в одном проекте Google Developer.
model_id : (Строка) Требуется. Идентификатор модели устройства; должно совпадать с device_model_id , связанным с этим тестовым устройством. Модель устройства должна быть зарегистрирована ранее.
nickname : (Строка) Необязательно. Никнейм устройства. Это имя будет использоваться для обозначения устройства в визуальных интерфейсах, таких как настройки Ассистента.
client_type : (Строка) Требуется. Тип клиентского устройства. Должно быть одно из следующих значений: SDK_SERVICE или SDK_LIBRARY .