Modelo de dispositivo e esquemas de instâncias

Modelo do dispositivo

O modelo do dispositivo é definido pelos campos desta seção.

Os campos do modelo de dispositivo só podem conter letras, números e o seguinte símbolos: ponto (.), hífen (-), sublinhado (_), espaço ( ) e mais (+). O primeiro caractere de um campo precisa ser uma letra ou um número.

Exemplo
{
  "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"]
}
Esquema
{
  "project_id": string,
  "device_model_id": string,
  "manifest": {
    "manufacturer": string,
    "product_name": string,
    "device_description": string
  },
  "device_type": string,
  "traits": [ string ]
}
  • project_id (string): obrigatório. ID do projeto do Google Cloud Platform do projeto do Console do Actions para associar a este modelo de dispositivo. Um projeto pode conter vários modelos de dispositivos.
  • device_model_id (string): obrigatório. Identificador globalmente exclusivo para este modelo de dispositivo. usar o project_id como um prefixo para ajudar a evitar colisões ao longo de todos os projetos. Usado nas métricas e durante o registro de dispositivos.
  • manifest: (objeto(Manifesto)) obrigatório. Metadados que descrevem o modelo do dispositivo e o fabricante. Isso poderá ser exibido no SDK (em breve) console do Cloud, painéis de métricas e outras interfaces visuais relacionadas.
    • manifest.manufacturer (string): obrigatório. Nome do dispositivo fabricante.
    • manifest.product_name (string): obrigatório. Voltado ao consumidor nome de produto deste modelo de dispositivo.
    • manifest.device_description (string): opcional. Descrição desse modelo de dispositivo.
  • device_type (string): obrigatório. O tipo de hardware do dispositivo. Selecionar um dos seguintes:
    • 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>) é opcional. Lista de características do dispositivo suporta. Os traços incluem os comandos, atributos e estados da dispositivo. Não é preciso definir um pacote de ação. para usar características integradas.

Instância do dispositivo

A instância do dispositivo é definida pelos campos desta seção.

Os campos da instância do dispositivo precisam começar com uma letra ou um número. O ID do dispositivo pode conter somente letras, números e os seguintes símbolos: ponto (.), hífen (-), sublinhado (_) e sinal de adição (+). O apelido do dispositivo só pode conter números, letras e o símbolo de espaço ( ).

Exemplo
  {
    "id": "my_led_1",
    "model_id": "my-devices-project-prototype-light-v1",
    "nickname": "My Assistant Light",
    "client_type": "SDK_LIBRARY"
  }
Esquema
  {
    "id": string,
    "model_id": string,
    "nickname": string,
    "client_type": string
  }
  • id (string): obrigatório. Identificador do dispositivo de teste. Deve ser exclusivos para todos os dispositivos registrados no mesmo serviço Projeto do desenvolvedor.
  • model_id (string): obrigatório. Identificador do modelo do dispositivo. precisa é igual a device_model_id. associados a este dispositivo de teste. O modelo do dispositivo precisa ter sido registrado antes.
  • nickname (string): opcional. Apelido do dispositivo. Este nome será usado para se referir ao dispositivo em interfaces visuais, como o Configurações do Google Assistente.
  • client_type (string): obrigatório. O tipo de dispositivo cliente. Deve ser um dos seguintes: SDK_SERVICE ou SDK_LIBRARY.