Gerätemodell und Instanzschemas

Gerätemodell

Das Gerätemodell wird durch die Felder in diesem Abschnitt definiert.

Felder für Gerätemodelle dürfen nur Buchstaben, Ziffern und Folgendes enthalten: Symbole: Punkt (.), Bindestrich (-), Unterstrich (_), Leerzeichen ( ) und Plus (+). Das erste Zeichen eines Felds muss ein Buchstabe oder eine Ziffer sein.

{
  "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: (String) Erforderlich. ID des Google Cloud Platform-Projekts des Actions Console-Projekts, das mit diesem Gerätemodell verknüpft werden soll. Ein Projekt kann mehrere Gerätemodelle enthalten.
• device_model_id: (String) Erforderlich. Global eindeutige Kennung für dieses Gerätemodell: project_id verwenden als ein Präfix, um Kollisionen über den Bereich aller Projekte zu vermeiden. Gebraucht und bei der Geräteregistrierung.
• manifest: (object(Manifest)) Erforderlich. Metadaten, die beschreiben, Gerätemodell und Hersteller. Dies wird möglicherweise im (zukünftigen) SDK angezeigt und andere verwandte visuelle Oberflächen.
  • manifest.manufacturer: (String) Erforderlich. Name des Geräts Hersteller.
  • manifest.product_name: (String) Erforderlich. Für Nutzer Produktname dieses Gerätemodells.
  • manifest.device_description: (String) Optional. Beschreibung dieses Gerätemodells.
• device_type: (String) Erforderlich. Die Art der Gerätehardware. Auswählen aus: <ph type="x-smartling-placeholder">
  </ph>
  • 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>) Optional. Liste der Traits des Geräts unterstützt. Zu diesen Merkmalen gehören die Befehle, Attribute und Status der . Sie müssen kein Aktionspaket definieren zu verwenden integrierten Traits nutzen.

Geräteinstanz

Die Geräteinstanz wird durch die Felder in diesem Abschnitt definiert.

Die Felder für die Geräteinstanz müssen mit einem Buchstaben oder einer Ziffer beginnen. Geräte-ID dürfen nur Buchstaben, Ziffern und die folgenden Symbole enthalten: Punkt (.), Bindestriche (-), Unterstriche (_) und Pluszeichen (+). Der Gerätealias kann nur Ziffern, Buchstaben und das Leerzeichen ( ) enthalten.

  {
    "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: (String) Erforderlich. ID für das Testgerät. Muss sein eindeutig innerhalb aller unter demselben Google-Konto registrierten Entwicklerprojekt
• model_id: (String) Erforderlich. Kennzeichnung des Gerätemodells muss mit device_model_id identisch sein die mit diesem Testgerät verknüpft sind. Das Gerätemodell muss registriert sein .
• nickname: (String) Optional. Alias für das Gerät. Dieser Name wird in visuellen Benutzeroberflächen wie dem Assistant-Einstellungen.
• client_type: (String) Erforderlich. Der Typ des Clientgeräts. Muss sein entweder SDK_SERVICE oder SDK_LIBRARY.