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

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

ช่องต่างๆ ในส่วนนี้เป็นตัวกำหนดรุ่นของอุปกรณ์

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

ตัวอย่าง

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