สคีมาของรุ่นอุปกรณ์และอินสแตนซ์

รุ่นของอุปกรณ์

ช่องข้อมูลในส่วนนี้จะเป็นตัวกำหนดรุ่นอุปกรณ์

ช่องรุ่นอุปกรณ์มีได้เฉพาะตัวอักษร ตัวเลข และสัญลักษณ์ต่อไปนี้ เครื่องหมายจุด (.) เครื่องหมายขีดกลาง (-) เครื่องหมายขีดล่าง (_) การเว้นวรรค ( ) และเครื่องหมายบวก (+) โดยอักขระตัวแรกของช่องต้องเป็นตัวอักษรหรือตัวเลข

ตัวอย่าง
{
  "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 ของโปรเจ็กต์คอนโซล Actions ที่จะเชื่อมโยงกับรุ่นอุปกรณ์นี้ โปรเจ็กต์สามารถมีอุปกรณ์ได้หลายรุ่น
  • device_model_id: (สตริง) ต้องระบุ ตัวระบุที่ไม่ซ้ำกันทั่วโลกสำหรับรุ่นอุปกรณ์นี้ ใช้ project_id เป็นคำนำหน้าเพื่อหลีกเลี่ยงการชนกันในช่วงของโปรเจ็กต์ทั้งหมด ใช้ในเมตริกและระหว่างการลงทะเบียนอุปกรณ์
  • manifest: (object(ไฟล์ Manifest)) ต้องระบุ ข้อมูลเมตาที่อธิบายรุ่น และผู้ผลิตอุปกรณ์ ข้อมูลนี้อาจแสดงในคอนโซล SDK (เร็วๆ นี้) แดชบอร์ดเมตริก และอินเทอร์เฟซภาพอื่นๆ ที่เกี่ยวข้อง
    • manifest.manufacturer: (สตริง) ต้องระบุ ชื่อผู้ผลิตอุปกรณ์
    • manifest.product_name: (สตริง) ต้องระบุ ชื่อผลิตภัณฑ์ที่แสดง สำหรับผู้บริโภคสำหรับรุ่นอุปกรณ์นี้
    • manifest.device_description: (สตริง) ไม่บังคับ คำอธิบาย ของรุ่นอุปกรณ์นี้
  • device_type: (สตริง) ต้องระบุ ประเภทของฮาร์ดแวร์อุปกรณ์ เลือกจากตัวเลือกต่อไปนี้
    • 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>) ไม่บังคับ รายการลักษณะ ที่อุปกรณ์รองรับ โดยลักษณะต่างๆ ได้แก่ คำสั่ง แอตทริบิวต์ และสถานะสำหรับอุปกรณ์ คุณไม่จำเป็นต้องกำหนดแพ็กเกจการดำเนินการเพื่อใช้ ลักษณะเฉพาะในตัว

อินสแตนซ์ของอุปกรณ์

อินสแตนซ์ของอุปกรณ์จะกำหนดโดยช่องในส่วนนี้

ช่องอินสแตนซ์ของอุปกรณ์ต้องขึ้นต้นด้วยตัวอักษรหรือตัวเลข รหัสอุปกรณ์จะมีได้เฉพาะตัวอักษร ตัวเลข และสัญลักษณ์ต่อไปนี้ เครื่องหมายจุด (.) ขีดกลาง (-) ขีดล่าง (_) และเครื่องหมายบวก (+) ชื่อเล่นของอุปกรณ์มีได้เฉพาะตัวเลข ตัวอักษร และสัญลักษณ์เว้นวรรค ( )

ตัวอย่าง
  {
    "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: (สตริง) ไม่บังคับ ชื่อเล่นสำหรับอุปกรณ์ ชื่อนี้จะใช้เพื่ออ้างถึงอุปกรณ์ในอินเทอร์เฟซแบบภาพ เช่น การตั้งค่า Assistant
  • client_type: (สตริง) ต้องระบุ ประเภทของอุปกรณ์ไคลเอ็นต์ ต้องเป็น SDK_SERVICE หรือ SDK_LIBRARY