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 "Modèle de l'appareil" ne peuvent contenir que des lettres, des chiffres et les éléments suivants : Symboles: point (.), tiret (-), trait de soulignement (_), espace ( ) et plus (+). Le premier caractère d'un champ doit être une lettre ou un chiffre.

{
  "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 : (chaîne) obligatoire. 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. utiliser project_id comme un préfixe pour éviter les conflits sur la plage de tous les projets. Utilisé dans les métriques et lors de l'enregistrement des appareils.
• manifest : (object(Manifest)) obligatoire. Métadonnées qui décrivent le modèle et le fabricant de l'appareil. Cela peut s'afficher dans le SDK (à venir) la console, les tableaux de bord des métriques et d'autres interfaces visuelles connexes.
  • manifest.manufacturer : (chaîne) obligatoire. Nom de l'appareil fabricant.
  • manifest.product_name : (chaîne) obligatoire. En contact avec les clients nom de produit 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électionner parmi les éléments suivants: <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 : (tableau<String>) facultatif. Liste des caractéristiques de l'appareil compatibles. Les traits comprennent les commandes, les attributs et les états appareil. Il n'est pas nécessaire de définir un package d'actions à utiliser caractéristiques intégrées.

Instance d'appareil

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

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

  {
    "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 : (chaîne) obligatoire. Identifiant de l'appareil de test. Doit être unique parmi tous les appareils enregistrés sous le même compte Projet de développement.
• model_id : (chaîne) obligatoire. Identifiant du modèle de l'appareil. doit être identique à device_model_id associées à cet appareil de test. Le modèle de l'appareil doit avoir été enregistré précédemment.
• nickname : (chaîne) facultatif. Pseudo de l'appareil. Ce nom sera utilisé pour désigner l'appareil dans des interfaces visuelles telles que Paramètres de l'Assistant.
• client_type : (chaîne) obligatoire. Type d'appareil client. Doit être l'une des valeurs suivantes: SDK_SERVICE ou SDK_LIBRARY.