设备型号和实例架构

设备型号

设备型号由本部分中的字段定义。

设备型号字段只能包含字母、数字和以下内容 符号：英文句号 (.)、连字符 (-)、下划线 (_)、空格 ( ) 和加号 (+)。字段的第一个字符必须是字母或数字。

{
  "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：（字符串）必需。Google Cloud Platform 项目 ID Actions 控制台项目的权限，以便与此设备模型相关联。 一个项目可以包含多个设备型号。
• device_model_id：（字符串）必需。全局唯一标识符 此设备型号将 project_id 用作 前缀，以帮助避免所有项目范围内发生冲突。已使用 。
• manifest：(object(Manifest)) 必需。描述文本的元数据 设备型号和制造商这可能会在（即将推出的）SDK 中显示 控制台、指标信息中心和其他相关的可视化界面。
  • manifest.manufacturer：（字符串）必需。设备名称 制造商。
  • manifest.product_name：（字符串）必需。面向消费者 此设备型号的产品名称。
  • manifest.device_description：（字符串）可选。说明 。
• device_type：（字符串）必需。设备硬件的类型。选择 从以下代码中选择： <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>) 可选。设备的特征列表 支持。trait 包括 设备。您无需定义 Action 软件包 使用 内置特征。

设备实例

设备实例由本部分中的字段定义。

设备实例字段必须以字母或数字开头。设备 ID 只能包含字母、数字和以下符号：句点 (.)、 连字符 (-)、下划线 (_) 和加号 (+)。设备别名只能 包含数字、字母和空格 ( ) 符号。

  {
    "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：（字符串）必需。测试设备的标识符。必须为 在同一 Google 产品下注册的所有设备中， 开发者项目。
• model_id：（字符串）必需。设备型号的标识符；必须 与 device_model_id 相同 与此测试设备相关联。设备型号必须已注册 。
• nickname：（字符串）可选。设备的别名。此名称 将在可视界面（例如 Google 助理设置。
• client_type：（字符串）必需。客户端设备的类型。必须为 以下任意一项：SDK_SERVICE 或 SDK_LIBRARY。