Trang này được dịch bởi Cloud Translation API.

Sự kiện

Các sự kiện không đồng bộ và được Google Cloud Pub/Sub quản lý, trong một chủ đề duy nhất cho mỗi Project. Sự kiện sẽ cung cấp thông tin cập nhật cho tất cả thiết bị và cấu trúc, đồng thời đảm bảo nhận được sự kiện, miễn là người dùng không thu hồi mã truy cập và thông báo sự kiện chưa hết hạn.

Bật sự kiện

Sự kiện là một tính năng không bắt buộc của API SDM. Xem Bật sự kiện để tìm hiểu cách bật sự kiện cho Projectcủa bạn.

Google Cloud Pub/Sub

Hãy xem tài liệu về Google Cloud Pub/Sub để tìm hiểu thêm về cách hoạt động của Pub/Sub. Cụ thể:

Tìm hiểu các kiến thức cơ bản về Pub/Sub qua Hướng dẫn thực hiện của họ.
Tìm hiểu cách hoạt động của mục Xác thực.
Chọn một Thư viện ứng dụng được cung cấp hoặc tự viết và sử dụng các nền tảng API REST/HTTP hoặc gRPC.

Gói đăng ký sự kiện

Khi bật sự kiện cho Project, bạn sẽ được cung cấp một chủ đề dành riêng cho mã Project đó, ở dạng:

projects/sdm-prod/topics/enterprise-project-id

Để nhận sự kiện, hãy tạo gói thuê bao pull hoặc push vào chủ đề đó, tuỳ thuộc vào trường hợp sử dụng của bạn. Hỗ trợ nhiều gói thuê bao cho chủ đề SDM. Hãy xem phần Quản lý gói thuê bao để biết thêm thông tin.

Bắt đầu sự kiện

Để bắt đầu các sự kiện lần đầu tiên sau khi tạo gói thuê bao Pub/Sub, hãy thực hiện lệnh gọi API devices.list làm điều kiện kích hoạt một lần. Các sự kiện cho tất cả cấu trúc và thiết bị sẽ xuất bản sau lệnh gọi này.

Để biết ví dụ, hãy xem trang Uỷ quyền trong Hướng dẫn bắt đầu nhanh.

Thứ tự sự kiện

Pub/Sub không đảm bảo việc phân phối sự kiện theo thứ tự. Ngoài ra, thứ tự nhận các sự kiện có thể không tương ứng với thứ tự mà sự kiện thực sự xảy ra. Sử dụng trường timestamp để hỗ trợ điều chỉnh thứ tự của sự kiện. Các sự kiện cũng có thể xuất hiện riêng lẻ hoặc được kết hợp thành một thông báo sự kiện duy nhất.

Để biết thêm thông tin, hãy xem bài viết Thông báo đặt hàng.

Mã nhận dạng người dùng

Nếu cách triển khai của bạn dựa trên người dùng (thay vì cấu trúc hoặc thiết bị), hãy sử dụng trường userID trong tải trọng sự kiện để liên kết các tài nguyên và sự kiện. Trường này là một mã nhận dạng bị làm rối mã nguồn để đại diện cho một người dùng cụ thể.

userID cũng có trong tiêu đề phản hồi HTTP của mỗi lệnh gọi API.

Sự kiện quan hệ

Sự kiện quan hệ biểu thị một bản cập nhật quan hệ cho một tài nguyên. Ví dụ: khi một thiết bị được thêm vào một cấu trúc hoặc khi một thiết bị bị xoá khỏi một cấu trúc.

Có 3 loại sự kiện quan hệ:

TẠO
DELETED (ĐÃ XOÁ)
ĐÃ CẬP NHẬT

Tải trọng cho một sự kiện quan hệ như sau:

Dung lượng

{
  "eventId" : "167a296a-d339-4626-a360-7a43475625e9",
  "timestamp" : "2019-01-01T00:00:01Z",
  "relationUpdate" : {
    "type" : "CREATED",
    "subject" : "enterprises/project-id/structures/structure-id",
    "object" : "enterprises/project-id/devices/device-id"
  },
  "userId": "AVPHwEuBfnPOnTqzVFT4IONX2Qqhu9EJ4ubO-bNnQ-yi"
}

Trong một sự kiện quan hệ, object là tài nguyên đã kích hoạt sự kiện đó và subject là tài nguyên mà object hiện có mối quan hệ. Trong ví dụ trên, một user đã cấp quyền truy cập vào thiết bị cụ thể này cho một developervà thiết bị được uỷ quyền của usernay liên quan đến cấu trúc được uỷ quyền, vốn là cấu trúc kích hoạt sự kiện đó.

subject chỉ có thể là một căn phòng hoặc một nhà. Nếu a developer không có quyền xem cấu trúc của userthì subject sẽ luôn trống.

Trường

Kỹ thuật	Nội dung mô tả	Loại dữ liệu
`eventId`	Giá trị nhận dạng duy nhất của sự kiện.	`string` Ví dụ: "effe1a42-5d9a-4b5b-a424-cc6bd145a977"
`timestamp`	Thời gian khi sự kiện xảy ra.	`string` Ví dụ: "2019-01-01T00:00:01Z"
`relationUpdate`	Đối tượng cung cấp thông tin chi tiết về việc cập nhật mối quan hệ.	`object`
`userId`	Một giá trị nhận dạng duy nhất, bị làm rối mã nguồn đại diện cho người dùng.	`string` Ví dụ: "AVPHwEuBfnPOnTqzVFT4IONX2Qqhu9EJ4ubO-bNnQ-yi"

Hãy xem bài viết Sự kiện để biết thêm thông tin về các loại sự kiện khác nhau và cách thức hoạt động của những sự kiện này.

Ví dụ

Đối với từng loại sự kiện quan hệ, các tải trọng sự kiện sẽ khác nhau:

ĐÃ TẠO

Đã tạo cấu trúc

"relationUpdate" : {
  "type" : "CREATED",
  "subject" : "",
  "object" : "enterprises/project-id/structures/structure-id"
}

Đã tạo thiết bị

"relationUpdate" : {
  "type" : "CREATED",
  "subject" : "enterprises/project-id/structures/structure-id",
  "object" : "enterprises/project-id/devices/device-id"
}

Đã tạo thiết bị

"relationUpdate" : {
  "type" : "CREATED",
  "subject" : "enterprises/project-id/structures/structure-id/rooms/room-id",
  "object" : "enterprises/project-id/devices/device-id"
}

ĐÃ CẬP NHẬT

Đã di chuyển thiết bị

"relationUpdate" : {
  "type" : "UPDATED",
  "subject" : "enterprises/project-id/structures/structure-id/rooms/room-id",
  "object" : "enterprises/project-id/devices/device-id"
}

DELETED (ĐÃ XOÁ)

Đã xoá nhà

"relationUpdate" : {
  "type" : "DELETED",
  "subject" : "",
  "object" : "enterprises/project-id/structures/structure-id"
}

Đã xoá thiết bị

"relationUpdate" : {
  "type" : "DELETED",
  "subject" : "enterprises/project-id/structures/structure-id",
  "object" : "enterprises/project-id/devices/device-id"
}

Đã xoá thiết bị

"relationUpdate" : {
  "type" : "DELETED",
  "subject" : "enterprises/project-id/structures/structure-id/rooms/room-id",
  "object" : "enterprises/project-id/devices/device-id"
}

Sự kiện quan hệ sẽ không được gửi khi:

Đã xoá một phòng

Sự kiện tài nguyên

Sự kiện tài nguyên biểu thị một bản cập nhật dành riêng cho một tài nguyên. Trạng thái này có thể phản hồi khi có thay đổi về giá trị của trường trait, chẳng hạn như thay đổi chế độ của máy điều nhiệt. Nó cũng có thể biểu thị một hành động trên thiết bị không thay đổi trường đặc điểm, chẳng hạn như nhấn vào nút trên thiết bị.

Một sự kiện được tạo để phản hồi thay đổi về giá trị của trường trait chứa đối tượng traits, tương tự như lệnh gọi GET của thiết bị:

Dung lượng

{
  "eventId" : "b3f6755c-17e1-4b33-b5cc-32251142e7d6",
  "timestamp" : "2019-01-01T00:00:01Z",
  "resourceUpdate" : {
    "name" : "enterprises/project-id/devices/device-id",
    "traits" : {
      "sdm.devices.traits.ThermostatMode" : {
        "mode" : "COOL"
      }
    }
  },
  "userId": "AVPHwEuBfnPOnTqzVFT4IONX2Qqhu9EJ4ubO-bNnQ-yi",
  "resourceGroup" : [
    "enterprises/project-id/devices/device-id"
  ]
}

Hãy sử dụng tài liệu về từng đặc điểm để hiểu định dạng tải trọng cho mọi sự kiện tài nguyên thay đổi trường trait.

Một sự kiện được tạo để phản hồi một hành động trên thiết bị không thay đổi trường trait cũng có tải trọng với đối tượng resourceUpdate, nhưng có đối tượng events thay vì đối tượng traits:

Dung lượng

{
  "eventId" : "f67af755-e432-4b9a-9045-69e986896b3f",
  "timestamp" : "2019-01-01T00:00:01Z",
  "resourceUpdate" : {
    "name" : "enterprises/project-id/devices/device-id",
    "events" : {
      "sdm.devices.events.CameraMotion.Motion" : {
        "eventSessionId" : "CjY5Y3VKaTZwR3o4Y19YbTVfMF...",
        "eventId" : "UNRMB1-mV7fXP4ncSo9E4B5Pbd...",
      }
    }
  }
  "userId" : "AVPHwEuBfnPOnTqzVFT4IONX2Qqhu9EJ4ubO-bNnQ-yi",
  "eventThreadId" : "d67cd3f7-86a7-425e-8bb3-462f92ec9f59",
  "eventThreadState" : "STARTED",
  "resourceGroup" : [
    "enterprises/project-id/devices/device-id"
  ]
}

Những loại sự kiện tài nguyên này được xác định theo các đặc điểm cụ thể. Ví dụ: Sự kiện chuyển động được xác định trong tính năng CameraMotion . Hãy xem tài liệu về từng đặc điểm để nắm được định dạng tải trọng cho các loại sự kiện tài nguyên này.

Trường

Kỹ thuật	Nội dung mô tả	Loại dữ liệu
`eventId`	Giá trị nhận dạng duy nhất của sự kiện.	`string` Ví dụ: "f67af755-e432-4b9a-9045-69e986896b3f"
`timestamp`	Thời gian khi sự kiện xảy ra.	`string` Ví dụ: "2019-01-01T00:00:01Z"
`resourceUpdate`	Đối tượng nêu chi tiết thông tin về việc cập nhật tài nguyên.	`object`
`userId`	Một giá trị nhận dạng duy nhất, bị làm rối mã nguồn đại diện cho người dùng.	`string` Ví dụ: "AVPHwEuBfnPOnTqzVFT4IONX2Qqhu9EJ4ubO-bNnQ-yi"
`eventThreadId`	Giá trị nhận dạng duy nhất của chuỗi sự kiện.	`string` Ví dụ: "d67cd3f7-86a7-425e-8bb3-462f92ec9f59"
`eventThreadState`	Trạng thái của chuỗi sự kiện.	`string` Giá trị: "BẮT ĐẦU", "ĐÃ CẬP NHẬT", "ĐÃ KẾT THÚC"
`resourceGroup`	Một đối tượng cho biết những tài nguyên có thể có nội dung cập nhật tương tự như sự kiện này. Tài nguyên của chính sự kiện đó (từ đối tượng `resourceUpdate`) sẽ luôn hiện diện trong đối tượng này.	`object`

Hãy xem bài viết Sự kiện để biết thêm thông tin về các loại sự kiện khác nhau và cách thức hoạt động của những sự kiện này.

Thông báo có thể cập nhật

Bạn có thể triển khai thông báo dựa trên sự kiện tài nguyên trong một ứng dụng, chẳng hạn như đối với Android hoặc iOS. Để giảm số lượng thông báo được gửi, bạn có thể triển khai một tính năng có tên là thông báo có thể cập nhật, trong đó các thông báo hiện có được cập nhật thông tin mới dựa trên các sự kiện tiếp theo trong cùng một chuỗi sự kiện.

Chọn hỗ trợ tính năng sự kiện cho thông báo có thể cập nhật và được gắn thẻ là Có thể cập nhật trong tài liệu. Những sự kiện này có thêm một trường tên là eventThreadId trong các tải trọng. Sử dụng trường này để liên kết các sự kiện riêng lẻ với nhau nhằm cập nhật một thông báo hiện có đã hiển thị cho người dùng.

Một chuỗi sự kiện không giống với một phiên sự kiện. Luồng sự kiện xác định trạng thái đã cập nhật cho một sự kiện trước đó trong cùng một luồng. Phiên sự kiện xác định các sự kiện riêng biệt có liên quan với nhau và có thể có nhiều luồng sự kiện cho một phiên sự kiện nhất định.

Nhằm mục đích thông báo, các loại sự kiện khác nhau được nhóm thành các luồng khác nhau.

Việc nhóm luồng và logic thời gian này do Google xử lý và có thể thay đổi bất cứ lúc nào. developer nên cập nhật thông báo dựa trên các phiên và chuỗi sự kiện do API SDM cung cấp.

Trạng thái luồng

Các sự kiện hỗ trợ thông báo có thể cập nhật cũng có trường eventThreadState cho biết trạng thái của chuỗi sự kiện tại thời điểm đó. Trường này có các giá trị sau:

BẮT ĐẦU — Sự kiện đầu tiên trong chuỗi sự kiện.
ĐÃ CẬP NHẬT – Một sự kiện trong chuỗi sự kiện đang diễn ra. Có thể không có hoặc có nhiều sự kiện có trạng thái này trong một chuỗi.
ĐÃ KẾT THÚC – Sự kiện cuối cùng trong một chuỗi sự kiện, có thể là bản sao của sự kiện ĐÃ CẬP NHẬT gần đây nhất, tùy thuộc vào loại chuỗi.

Bạn có thể dùng trường này để theo dõi tiến trình của một luồng sự kiện và thời điểm luồng sự kiện kết thúc.

Lọc sự kiện

Trong một số trường hợp, các sự kiện do thiết bị phát hiện có thể bị lọc ra khỏi việc phát hành lên một chủ đề SDM Pub/Sub. Hành vi này được gọi là lọc sự kiện. Mục đích của tính năng lọc sự kiện là tránh đăng quá nhiều thông báo sự kiện tương tự nhau trong một khoảng thời gian ngắn.

Ví dụ: thông báo có thể được xuất bản lên chủ đề SDM cho sự kiện Chuyển động ban đầu. Các thông báo khác cho Chuyển động sau đó sẽ bị lọc ra để không phát hành cho đến khi một khoảng thời gian nhất định trôi qua. Sau khi khoảng thời gian đó trôi qua, hệ thống có thể phát hành lại một thông báo sự kiện cho loại sự kiện đó.

Trong Ứng dụng Google Home (GHA), các sự kiện đã được lọc sẽ vẫn hiển thị trong lịch sử sự kiện của user. Tuy nhiên, các sự kiện đó không tạo ra thông báo ứng dụng (ngay cả khi loại thông báo đó được bật).

Mỗi loại sự kiện có logic lọc sự kiện riêng, do Google xác định và có thể thay đổi bất cứ lúc nào. Logic lọc sự kiện này độc lập với luồng sự kiện và logic phiên.

Tài khoản dịch vụ

Bạn nên sử dụng tài khoản dịch vụ để quản lý các gói thuê bao SDM API và thông báo sự kiện. Tài khoản dịch vụ được một ứng dụng hoặc máy ảo (chứ không phải người) sử dụng và có khoá tài khoản duy nhất của riêng nó.

Hoạt động uỷ quyền tài khoản dịch vụ cho API Pub/Sub sử dụng OAuth cấp quyền truy cập (2LO).

Trong quy trình uỷ quyền 2LO:

developer yêu cầu mã truy cập bằng khoá dịch vụ.
developer sử dụng mã truy cập với các lệnh gọi đến API.

Để tìm hiểu thêm về Google 2LO và cách thiết lập, hãy xem phần Sử dụng OAuth 2.0 cho các ứng dụng từ máy chủ đến máy chủ.

Ủy quyền

Bạn phải cho phép tài khoản dịch vụ sử dụng với API Pub/Sub:

Bật API Cloud Pub/Sub trong Google Cloud.
Tạo một tài khoản dịch vụ và khoá tài khoản dịch vụ như mô tả trong phần Tạo tài khoản dịch vụ. Bạn chỉ nên chỉ định vai trò Người đăng ký Pub/Sub. Hãy nhớ tải khoá tài khoản dịch vụ xuống máy sẽ sử dụng API Pub/Sub.
Hãy cung cấp thông tin xác thực (khoá tài khoản dịch vụ) cho mã ứng dụng bằng cách làm theo hướng dẫn ở trang trong bước trước hoặc lấy mã truy cập theo cách thủ công bằng oauth2l nếu bạn muốn kiểm thử nhanh quyền truy cập API.
Sử dụng thông tin xác thực tài khoản dịch vụ hoặc mã truy cập với API project.subscriptions Pub/Sub để kéo và xác nhận thông báo.

OAuth2l

Google oauth2l là một công cụ dòng lệnh cho OAuth được viết bằng Go. Hãy cài đặt công cụ này cho Mac hoặc Linux bằng cách sử dụng Go.

Nếu bạn chưa cài đặt Go trên hệ thống, hãy tải xuống và cài đặt ứng dụng này trước.
Sau khi cài đặt Go, hãy cài đặt oauth2l và thêm vị trí của ứng dụng đó vào biến môi trường PATH:
```
go install github.com/google/oauth2l@latest
export PATH=$PATH:~/go/bin
```

Sử dụng oauth2l để lấy mã truy cập cho API, bằng cách sử dụng(các) phạm vi OAuth thích hợp:

oauth2l fetch --credentials path-to-service-key.json --scope https://www.googleapis.com/auth/pubsub
https://www.googleapis.com/auth/cloud-platform

Ví dụ: nếu khoá dịch vụ của bạn nằm tại ~/myServiceKey-eb0a5f900ee3.json:

oauth2l fetch --credentials ~/myServiceKey-eb0a5f900ee3.json --scope https://www.googleapis.com/auth/pubsub
https://www.googleapis.com/auth/cloud-platform
ya29.c.Elo4BmHXK5...

Hãy xem phần README oauth2l để biết thêm thông tin về cách sử dụng.

Thư viện ứng dụng API của Google

Có một số thư viện ứng dụng cho các API của Google sử dụng OAuth 2.0. Xem Thư viện ứng dụng API của Google để biết thêm thông tin về ngôn ngữ bạn chọn.

Khi sử dụng các thư viện này với Pub/Sub API, hãy dùng(các) chuỗi phạm vi sau:

https://www.googleapis.com/auth/pubsub
https://www.googleapis.com/auth/cloud-platform

Lỗi

(Các) mã lỗi sau đây có thể được trả về theo hướng dẫn này:

Thông báo lỗi	RPC	Khắc phục sự cố
Hình ảnh camera không còn có sẵn để tải xuống.	`DEADLINE_EXCEEDED`	Hình ảnh sự kiện sẽ hết hạn sau 30 giây kể từ khi sự kiện được xuất bản. Đừng quên tải hình ảnh xuống trước khi hết hạn.
Mã sự kiện không thuộc về camera.	`FAILED_PRECONDITION`	Sử dụng đúng `eventID` do sự kiện máy ảnh trả về.

Hãy xem Tài liệu tham khảo về mã lỗi API để biết danh sách đầy đủ các mã lỗi API.