สถานะรายงาน

Report State เป็นฟีเจอร์สําคัญที่ช่วยให้Google Homeการดําเนินการรายงานสถานะล่าสุดของอุปกรณ์ของผู้ใช้กลับไปยัง Google Home Graph แทนที่จะรอความตั้งใจของ QUERY

Report State จะรายงานสถานะของอุปกรณ์ผู้ใช้ที่มี agentUserId ที่ระบุไว้ซึ่งเชื่อมโยงกับอุปกรณ์ (ส่งในคำขอ SYNC ฉบับแรก) ไปยัง Google เมื่อ Google Assistant ต้องการดําเนินการซึ่งจําเป็นต้องทําความเข้าใจสถานะปัจจุบันของอุปกรณ์ ก็สามารถค้นหาข้อมูลสถานะใน Home Graph แทนที่จะส่ง Intent QUERY ไปยังระบบคลาวด์ของบุคคลที่สามต่างๆ ก่อนส่ง Intent EXECUTE

หากไม่มี Report State คำสั่ง Ok Google เปิดไฟในห้องนั่งเล่นให้สว่างขึ้นจะต้องแก้ไข Intent QUERY หลายรายการที่ส่งไปยังระบบคลาวด์หลายแห่ง แทนที่จะค้นหาค่าความสว่างปัจจุบันตามข้อมูลที่รายงานไว้ก่อนหน้านี้ เพื่อให้ผู้ใช้ได้รับประสบการณ์การใช้งานที่ดีที่สุด Assistant ต้องมีสถานะปัจจุบันของอุปกรณ์โดยไม่ต้องส่งข้อมูลไปมากับอุปกรณ์

หลังจาก SYNC แรกสำหรับอุปกรณ์แล้ว แพลตฟอร์มจะส่ง Intent QUERY ที่รวบรวมสถานะของอุปกรณ์เพื่อป้อนข้อมูล Home Graph หลังจากนั้น Home Graph จะจัดเก็บเฉพาะสถานะที่ส่งพร้อมกับ Report State

เมื่อเรียกใช้ Report State โปรดตรวจสอบว่าได้ระบุข้อมูลสถานะที่สมบูรณ์สำหรับลักษณะหนึ่งๆ Home Graph จะอัปเดตสถานะตามลักษณะและเขียนทับข้อมูลทั้งหมดสำหรับลักษณะนั้นเมื่อมีการทำ Report State ตัวอย่างเช่น หากคุณรายงานสถานะสำหรับแอตทริบิวต์ StartStop พูลข้อมูลจะต้องมีค่าสำหรับทั้ง isRunning และ isPaused

เริ่มต้นใช้งาน

หากต้องการใช้ Report State ให้ทำตามขั้นตอนต่อไปนี้

• เปิดใช้ Google HomeGraph API
• สร้างคีย์บัญชีบริการ
• เรียก API

เปิดใช้ Google HomeGraph API

1. ใน Google Cloud Console ให้ไปที่หน้า HomeGraph API

   ไปที่หน้า HomeGraph API
2. เลือกโปรเจ็กต์ที่ตรงกับรหัสโปรเจ็กต์ smart home
3. คลิกเปิดใช้

สร้างคีย์บัญชีบริการ

ทําตามวิธีการต่อไปนี้เพื่อสร้างคีย์บัญชีบริการจาก Google Cloud Console

1. ใน Google Cloud Console ให้ไปที่หน้าบัญชีบริการ

   ไปที่หน้าบัญชีบริการ

   คุณอาจต้องเลือกโปรเจ็กต์ก่อนระบบจะนำคุณไปยังหน้าบัญชีบริการ

2. คลิก addสร้างบัญชีบริการ

3. ป้อนชื่อในช่องชื่อบัญชีบริการ

4. ป้อนรหัสในช่องรหัสบัญชีบริการ

5. ป้อนคําอธิบายในช่องคําอธิบายบัญชีบริการ

6. คลิกสร้างและต่อไป

7. จากเมนูแบบเลื่อนลงบทบาท ให้เลือกบัญชีบริการ > ผู้สร้างโทเค็นข้อมูลประจำตัว OpenID Connect ของบัญชีบริการ

8. คลิกต่อไป

9. คลิกเสร็จสิ้น

10. เลือกบัญชีบริการที่คุณเพิ่งสร้างขึ้นจากรายการบัญชีบริการ แล้วเลือกจัดการคีย์จากเมนูmore_vert การดําเนินการ

11. เลือกเพิ่มคีย์ > สร้างคีย์ใหม่

12. สําหรับประเภทคีย์ ให้เลือกตัวเลือก JSON

13. คลิกสร้าง ไฟล์ JSON ที่มีคีย์ของคุณจะดาวน์โหลดลงในคอมพิวเตอร์

เรียก API

เลือกตัวเลือกจากแท็บด้านล่าง

const homegraphClient = homegraph({
  version: 'v1',
  auth: new GoogleAuth({
    scopes: 'https://www.googleapis.com/auth/homegraph'
  })
});

const res = await homegraphClient.devices.reportStateAndNotification({
  requestBody: {
    agentUserId: 'PLACEHOLDER-USER-ID',
    requestId: 'PLACEHOLDER-REQUEST-ID',
    payload: {
      devices: {
        states: {
          "PLACEHOLDER-DEVICE-ID": {
            on: true
          }
        }
      }
    }
  }
});
    

  // Get Application Default credentials.
  GoogleCredentials credentials =
      GoogleCredentials.getApplicationDefault()
          .createScoped(List.of("https://www.googleapis.com/auth/homegraph"));

  // Create Home Graph service client.
  HomeGraphService homegraphService =
      new HomeGraphService.Builder(
              GoogleNetHttpTransport.newTrustedTransport(),
              GsonFactory.getDefaultInstance(),
              new HttpCredentialsAdapter(credentials))
          .setApplicationName("HomeGraphExample/1.0")
          .build();

  // Build device state payload.
  Map<?, ?> states = Map.of("on", true);

  // Report device state.
  ReportStateAndNotificationRequest request =
      new ReportStateAndNotificationRequest()
          .setRequestId("PLACEHOLDER-REQUEST-ID")
          .setAgentUserId("PLACEHOLDER-USER-ID")
          .setPayload(
              new StateAndNotificationPayload()
                  .setDevices(
                      new ReportStateAndNotificationDevice()
                          .setStates(Map.of("PLACEHOLDER-DEVICE-ID", states))));
  homegraphService.devices().reportStateAndNotification(request);
}
    

สถานะรายงานการทดสอบ

คุณต้องทดสอบ Report State เพื่อให้การผสานรวม Cloud-to-cloud พร้อมสำหรับการรับรอง

เราขอแนะนำให้ใช้Home Graphเครื่องมือ Viewer ซึ่งก็คือเว็บแอปแบบสแตนด์อโลนที่ไม่จําเป็นต้องดาวน์โหลดหรือติดตั้งใช้งาน

แดชบอร์ด Report State ยังใช้งานได้อยู่ แต่เลิกใช้งานแล้วและไม่มีการสนับสนุนอีกต่อไป

แดชบอร์ดสถานะรายงาน

ข้อกำหนดเบื้องต้น

คุณต้องมีคีย์บัญชีบริการและ agentUserId ก่อนจึงจะทดสอบการผสานรวม Cloud-to-cloud ได้ หากคุณมีคีย์ของบัญชีบริการและ agentUserId อยู่แล้ว ให้ดูทำให้ Report State แดชบอร์ดใช้งานได้

ติดตั้งใช้งานแดชบอร์ดสถานะรายงาน

เมื่อคุณมีคีย์บัญชีบริการและรหัสผู้ใช้ของตัวแทนสําหรับโปรเจ็กต์แล้ว ให้ดาวน์โหลดและติดตั้งใช้งานเวอร์ชันล่าสุดจากReport State หน้าแดชบอร์ด เมื่อดาวน์โหลดเวอร์ชันล่าสุดแล้ว ให้ทำตามวิธีการจากไฟล์ README.MD ที่ให้มา

หลังจากติดตั้งใช้งานแดชบอร์ด Report State แล้ว ให้เข้าถึงแดชบอร์ดจาก URL ต่อไปนี้ (แทนที่ your_project_id ด้วยรหัสโปรเจ็กต์ของคุณ)

http://<your-project-id>.appspot.com

ในหน้าแดชบอร์ด ให้ทําดังนี้

• เลือกไฟล์คีย์บัญชี
• เพิ่ม agentUserId

จากนั้นคลิกรายการ

อุปกรณ์ทั้งหมดจะแสดงอยู่ในรายการ เมื่อระบบสร้างรายการแล้ว คุณจะใช้ปุ่มรีเฟรชเพื่ออัปเดตสถานะอุปกรณ์ได้ หากมีการเปลี่ยนแปลงสถานะของอุปกรณ์ ระบบจะไฮไลต์แถวเป็นสีเขียว

ความคลาดเคลื่อนของสถานะรายงาน

ความถูกต้องของสถานะรายงานตามการค้นหาจะวัดว่าสถานะรายงานล่าสุดของอุปกรณ์ตรงกับสถานะของอุปกรณ์มากน้อยเพียงใดเมื่อผู้ใช้ค้นหา ค่านี้คาดว่าจะอยู่ที่ 99.5%

การตอบกลับข้อผิดพลาด

คุณอาจได้รับการตอบกลับข้อผิดพลาดอย่างใดอย่างหนึ่งต่อไปนี้เมื่อโทรไปที่ Report State การตอบกลับเหล่านี้อยู่ในรูปแบบรหัสสถานะ HTTP

• 400 Bad Request - เซิร์ฟเวอร์ประมวลผลคำขอที่ไคลเอ็นต์ส่งมาไม่ได้เนื่องจากไวยากรณ์ไม่ถูกต้อง สาเหตุที่พบบ่อย ได้แก่ JSON ผิดรูปแบบหรือการใช้ null แทน "" สำหรับค่าสตริง
• 404 Not Found - ไม่พบทรัพยากรที่ขอ แต่อาจพร้อมใช้งานในอนาคต ซึ่งโดยทั่วไปหมายความว่าเราไม่พบหน้าอุปกรณ์ที่ขอ หรืออาจหมายความว่าบัญชีผู้ใช้ไม่ได้ลิงก์กับ Google หรือเราได้รับ agentUserId ที่ไม่ถูกต้อง ตรวจสอบว่า agentUserId ตรงกับค่าที่ระบุในการตอบกลับ SYNC และคุณจัดการ Intent DISCONNECT อย่างเหมาะสม

การรายงานสถานะออนไลน์และออฟไลน์

"requestId": "test-request-id",
  "agentUserId": "agent-user-1",
    "payload":{
      "devices": {
        "states": {
          "device-id-1": {
            "brightness": 65,
            "on": true,
            "online": true
          }
          "notifications": {},
        }
      }
    }