Trạng thái báo cáo

Report State là một tính năng quan trọng cho phép Hành động Google Home chủ động báo cáo trạng thái mới nhất của thiết bị của người dùng trở lại Google Home Graph thay vì chờ ý định QUERY.

Report State báo cáo cho Google trạng thái của thiết bị người dùng với agentUserId được chỉ định liên kết với các thiết bị đó (được gửi trong yêu cầu SYNC ban đầu). Khi Google Assistant muốn thực hiện một hành động yêu cầu hiểu rõ trạng thái hiện tại của thiết bị, nó chỉ cần tra cứu thông tin trạng thái trong Home Graph thay vì đưa ra ý định QUERY cho nhiều đám mây của bên thứ ba trước khi đưa ra ý định EXECUTE.

Nếu không có Report State, với các đèn từ nhiều nhà cung cấp trong phòng khách, lệnh Ok Google, làm sáng phòng khách của tôi yêu cầu phân giải nhiều ý định QUERY được gửi đến nhiều đám mây, thay vì chỉ tra cứu các giá trị độ sáng hiện tại dựa trên những gì đã được báo cáo trước đó. Để mang lại trải nghiệm tốt nhất cho người dùng, Assistant cần có trạng thái hiện tại của thiết bị mà không yêu cầu phải thực hiện một hành trình khứ hồi đến thiết bị.

Sau SYNC ban đầu cho một thiết bị, nền tảng sẽ gửi một ý định QUERY để thu thập trạng thái của thiết bị nhằm điền sẵn Home Graph. Sau thời điểm đó, Home Graph chỉ lưu trữ trạng thái được gửi bằng Report State.

Khi gọi Report State, hãy nhớ cung cấp dữ liệu trạng thái đầy đủ cho một đặc điểm nhất định. Home Graph cập nhật trạng thái trên cơ sở từng đặc điểm và ghi đè tất cả dữ liệu cho đặc điểm đó khi thực hiện lệnh gọi Report State. Ví dụ: nếu bạn đang báo cáo trạng thái cho đặc điểm StartStop, thì tải trọng cần bao gồm giá trị cho cả isRunning và isPaused.

Bắt đầu

Để triển khai Report State, hãy làm theo các bước sau:

• Bật API Google HomeGraph
• Tạo khoá tài khoản dịch vụ
• Gọi API

Bật API Google HomeGraph

1. Trong Google Cloud Console, hãy chuyển đến trang HomeGraph API.

   Chuyển đến trang HomeGraph API
2. Chọn dự án khớp với mã dự án smart home.
3. Nhấp vào BẬT.

Tạo khoá tài khoản dịch vụ

Làm theo hướng dẫn sau để tạo khoá tài khoản dịch vụ từ Google Cloud Console:

1. Trong Google Cloud Console, hãy chuyển đến trang Tài khoản dịch vụ.

   Chuyển đến trang Tài khoản dịch vụ.

   Bạn có thể cần chọn một dự án trước khi được chuyển đến trang Tài khoản dịch vụ.

2. Nhấp vào addTạo tài khoản dịch vụ.

3. Trong trường Tên tài khoản dịch vụ, hãy nhập tên.

4. Trong trường Mã tài khoản dịch vụ, hãy nhập một mã nhận dạng.

5. Trong trường Mô tả tài khoản dịch vụ, hãy nhập nội dung mô tả.

6. Nhấp vào Tạo và tiếp tục.

7. Trong trình đơn thả xuống Vai trò, hãy chọn Tài khoản dịch vụ > Trình tạo mã thông báo nhận dạng OpenID Connect của tài khoản dịch vụ.

8. Nhấp vào Tiếp tục.

9. Nhấp vào Xong.

10. Chọn tài khoản dịch vụ bạn vừa tạo trong danh sách tài khoản dịch vụ rồi chọn Quản lý khoá trong trình đơn more_vert Thao tác.

11. Chọn Thêm khoá > Tạo khoá mới.

12. Đối với Loại khoá, hãy chọn JSON.

13. Nhấp vào Tạo. Tệp JSON chứa khoá của bạn sẽ tải xuống máy tính.

Gọi API

Chọn một tuỳ chọn trong các thẻ bên dưới:

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);
}
    

Trạng thái báo cáo kiểm thử

Để tích hợp Cloud-to-cloud sẵn sàng cho việc chứng nhận, bạn cần kiểm thử Report State.

Để làm việc này, bạn nên sử dụng công cụ Trình xem Home Graph. Đây là một ứng dụng web độc lập không yêu cầu tải xuống hoặc triển khai.

Trang tổng quan Report State vẫn hoạt động nhưng không còn được dùng nữa và không còn được hỗ trợ.

Trang tổng quan về trạng thái báo cáo

Điều kiện tiên quyết

Trước khi có thể kiểm thử tính năng tích hợp Cloud-to-cloud, bạn cần có Khoá tài khoản dịch vụ và agentUserId. Nếu bạn đã có Khoá tài khoản dịch vụ và agentUserId, hãy xem phần Triển khai Trang tổng quan Report State.

Triển khai trang tổng quan Trạng thái báo cáo

Sau khi bạn có Khoá tài khoản dịch vụ và Mã nhận dạng người dùng của tác nhân cho dự án, hãy tải xuống và triển khai phiên bản mới nhất từ trang tổng quan Report State. Sau khi tải phiên bản mới nhất xuống, hãy làm theo hướng dẫn trong tệp README.MD đi kèm.

Sau khi bạn triển khai trang tổng quan Report State, hãy truy cập vào trang tổng quan đó qua URL sau (thay thế your_project_id bằng mã dự án của bạn):

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

Trên trang tổng quan, hãy làm như sau:

• Chọn Tệp khoá tài khoản
• Thêm agentUserId

Sau đó, hãy nhấp vào Danh sách.

Tất cả thiết bị của bạn đều được liệt kê. Sau khi danh sách được điền sẵn, bạn có thể sử dụng nút Làm mới để cập nhật trạng thái thiết bị. Nếu có thay đổi về trạng thái thiết bị, hàng đó sẽ được đánh dấu màu xanh lục.

Báo cáo sự chênh lệch về trạng thái

Độ chính xác của trạng thái báo cáo dựa trên truy vấn đo lường mức độ khớp giữa trạng thái báo cáo mới nhất của một thiết bị với trạng thái của thiết bị đó khi người dùng truy vấn thiết bị. Giá trị này dự kiến sẽ là 99,5%.

Phản hồi lỗi

Bạn có thể nhận được một trong các phản hồi lỗi sau đây khi gọi Report State. Các phản hồi này có dạng mã trạng thái HTTP.

• 400 Bad Request – Máy chủ không thể xử lý yêu cầu do ứng dụng gửi do cú pháp không hợp lệ. Các nguyên nhân thường gặp bao gồm JSON có định dạng không chính xác hoặc sử dụng null thay vì "" cho giá trị chuỗi.
• 404 Not Found – Không tìm thấy tài nguyên đã yêu cầu nhưng có thể sẽ có trong tương lai. Thông thường, điều này có nghĩa là chúng tôi không tìm thấy thiết bị được yêu cầu. Điều này cũng có thể có nghĩa là tài khoản người dùng không được liên kết với Google hoặc chúng tôi nhận được một agentUserId không hợp lệ. Đảm bảo rằng agentUserId khớp với giá trị được cung cấp trong phản hồi SYNC và bạn đang xử lý đúng cách các ý định DISCONNECT.

Báo cáo trạng thái trực tuyến và ngoại tuyến

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