Schémas de modèles d'appareils et d'instances

Modèle de l'appareil

Le modèle de l'appareil est défini par les champs de cette section.

Les champs de modèle d'appareil ne peuvent contenir que des lettres, des chiffres et les symboles suivants: point (.), trait d'union (-), trait de soulignement (_), espace ( ) et plus (+). Le premier caractère d'un champ doit être une lettre ou un chiffre.

Exemple
{
  "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"]
}
Schéma
{
  "project_id": string,
  "device_model_id": string,
  "manifest": {
    "manufacturer": string,
    "product_name": string,
    "device_description": string
  },
  "device_type": string,
  "traits": [ string ]
}
  • project_id : (chaîne) obligatoire. L'ID du projet Google Cloud Platform du projet de la console Actions à associer à ce modèle d'appareil. Un projet peut contenir plusieurs modèles d'appareils.
  • device_model_id : (chaîne) obligatoire. Identifiant unique global pour ce modèle d'appareil. Utilisez le préfixe project_id pour éviter les conflits sur la plage de tous les projets. Utilisé dans les métriques et lors de l'enregistrement de l'appareil.
  • manifest : (objet(fichier manifeste)) obligatoire. Des métadonnées qui décrivent le modèle et le fabricant de l'appareil. Vous pouvez le voir dans la SDK Console (à venir), dans les tableaux de bord des métriques et dans d'autres interfaces visuelles associées.
    • manifest.manufacturer : (chaîne) obligatoire. Nom du fabricant de l'appareil.
    • manifest.product_name : (chaîne) obligatoire. Nom de produit visible par les utilisateurs pour ce modèle d'appareil.
    • manifest.device_description : (chaîne) facultatif. Description de ce modèle d'appareil.
  • device_type : (chaîne) obligatoire. Type de matériel de l'appareil. Sélectionnez l'une des options suivantes :
    • 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>) facultatif. Liste des caractéristiques prises en charge par l'appareil. Les traits incluent les commandes, les attributs et les états de l'appareil. Vous n'avez pas besoin de définir un package Action pour utiliser les caractéristiques intégrées caractéristiques intégrées.

Instance d'appareil

L'instance d'appareil est définie par les champs de cette section.

Les champs des instances d'appareils doivent commencer par une lettre ou un chiffre. L'ID de l'appareil ne peut contenir que des lettres, des chiffres et les symboles suivants: point (.), trait d'union (-), trait de soulignement (_) et plus (+). Le pseudo de l'appareil ne peut contenir que des chiffres, des lettres et le symbole d'espace ( ).

Exemple
  {
    "id": "my_led_1",
    "model_id": "my-devices-project-prototype-light-v1",
    "nickname": "My Assistant Light",
    "client_type": "SDK_LIBRARY"
  }
Schéma
  {
    "id": string,
    "model_id": string,
    "nickname": string,
    "client_type": string
  }
  • id : (chaîne) obligatoire. Identifiant de l'appareil de test. Il doit être unique sur tous les appareils enregistrés dans le même projet Google Developer.
  • model_id : (chaîne) obligatoire. Identifiant du modèle de l'appareil. Il doit être identique au device_model_id associé à cet appareil de test. Le modèle d'appareil doit avoir été enregistré précédemment.
  • nickname : (chaîne) facultatif. Pseudo de l'appareil. Ce nom permettra de faire référence à l'appareil dans les interfaces visuelles telles que les paramètres de l'Assistant.
  • client_type : (chaîne) obligatoire. Type d'appareil client. Doit être l'un des éléments suivants: SDK_SERVICE ou SDK_LIBRARY.