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 os seguintes símbolos: ponto (.), hífen (-), sublinhado (_), espaço ( ) e adição (+). 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 a ser associado a esse modelo de dispositivo. Um projeto pode conter vários modelos de dispositivo.
  • device_model_id: (String) obrigatório. Identificador globalmente exclusivo para esse modelo de dispositivo. Use o project_id como prefixo para evitar colisões no intervalo de todos os projetos. Usado em métricas e durante o registro de dispositivos.
  • manifest: (object(Manifest)) obrigatório. Metadados que descrevem o modelo e o fabricante do dispositivo. Isso pode ser mostrado no (futuro) console do SDK, nos painéis de métricas e em outras interfaces visuais relacionadas.
    • manifest.manufacturer: (String) obrigatório. Nome do fabricante do dispositivo.
    • manifest.product_name: (String) obrigatório. Nome do produto voltado ao consumidor para este modelo de dispositivo.
    • manifest.device_description: (String) opcional. É a descrição desse modelo de dispositivo.
  • device_type: (String) obrigatório. O tipo de hardware do dispositivo. Selecione uma destas opções:
    • 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 compatíveis com o dispositivo. As características incluem os comandos, atributos e estados do dispositivo. Não é necessário definir um pacote de ações para usar características integradas.

Instância do dispositivo

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

Os campos de instância do dispositivo precisam começar com uma letra ou um número. O ID do dispositivo só pode conter letras, números e os seguintes símbolos: ponto (.), hífen (-), sublinhado (_) e sinal de adição (+). O apelido do dispositivo pode conter apenas 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. Precisa ser exclusivo em todos os dispositivos registrados no mesmo projeto do Google Developers.
  • model_id: (String) obrigatório. Identificador do modelo do dispositivo. Precisa ser igual ao device_model_id associado ao dispositivo de teste. O modelo do dispositivo precisa ter sido registrado anteriormente.
  • nickname: (String) opcional. Apelido para o dispositivo. Esse nome vai ser usado para se referir ao dispositivo nas interfaces visuais, como as configurações do Google Assistente.
  • client_type: (String) obrigatório. O tipo de dispositivo cliente. Precisa ser um dos seguintes valores: SDK_SERVICE ou SDK_LIBRARY.