Đặc điểm

Đặc điểm trong API SDM bao gồm các trường, lệnhsự kiện.

Các trường

Trường là các giá trị có các loại dữ liệu phổ biến, chẳng hạn như số hoặc chuỗi. Ví dụ: một trường có thể chứa chế độ hiện tại hoặc độ ẩm môi trường xung quanh của Google Nest Thermostat.

Bạn có thể xem các đặc điểm và trường bằng lệnh gọi GET đến điểm cuối API mong muốn:

GET /enterprises/project-id/devices/device-id
{
  "name" : "enterprises/project-id/devices/device-id",
  "type" : "sdm.devices.types.device-type",
  "traits" : { ... },
  "parentRelations" : [
    {
      "parent" : "enterprises/project-id/structures/structure-id/rooms/room-id",
      "displayName" : "Lobby"
    }
  ]
}

Loại thiết bị

Không nên dùng sdm.devices.types.device-type do API SDM trả về để suy ra hoặc suy luận chức năng của thiết bị thực tế được chỉ định. Không có gì đảm bảo rằng một loại thiết bị sẽ vẫn ổn định trên một thiết bị cụ thể vì có thêm nhiều tính năng được thêm vào API SDM. Thay vào đó, hãy sử dụng các trait được trả về cho thiết bị.

parentRelations

Đối tượng parentRelations đại diện cho tài nguyên mẹ của tài nguyên hiện tại, có thể là một cấu trúc hoặc phòng. Tên hiển thị tương ứng với trường customName củaĐặc điểm thông tin đối với các thiết bị có cấu trúc mẹ hoặctrang của RoomInfo cho mẹ.

Lệnh

Lệnh là các yêu cầu liên kết với một trait. Ví dụ: thay đổi chế độ hiện tại hoặc điểm đặt nhiệt độ trên Google Nest Thermostat.

Lệnh được gửi từ lệnh gọi API executeCommand:

POST /enterprises/project-id/devices/device-id:executeCommand
{
  "command" : "command-name",
  "params" : {
    "field" : "value"
  }
}

Hầu hết phản hồi cho một lệnh là một sự thành công hoặc thất bại đơn giản. Hãy xem hướng dẫn về từng trait để tham khảo các ví dụ cụ thể về cách sử dụng lệnh.

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 theo mã Project .

Theo mặc định, sự kiện được gửi khi bạn thay đổi giá trị của trường trait. Những thông báo này cũng có thể được gửi để phản hồi các thao tác cụ thể trên thiết bị hoặc thay đổi trong cách chỉ định tài nguyên. Hãy xem phần Sự kiện để biết thêm thông tin.

Danh mục đặc điểm

Cấu trúc

Đặc điểm
Thông tin
sdm.structures.traits.Info
Đặc điểm này thuộc bất kỳ cấu trúc nào đối với thông tin liên quan đến cấu trúc.
RoomInfo
sdm.structures.traits.RoomInfo
Trait này thuộc về bất kỳ phòng nào có thông tin liên quan đến phòng.

Thiết bị

Đặc điểm
Khả năng kết nối
sdm.devices.traits.Connectivity
Trait này thuộc về bất kỳ thiết bị nào có thông tin về khả năng kết nối.
Người hâm mộ
sdm.devices.traits.Fan
Đặc điểm này thuộc về bất kỳ thiết bị nào có tính năng hệ thống điều khiển quạt.
Độ ẩm
sdm.devices.traits.Humidity
Đặc điểm này thuộc về bất kỳ thiết bị nào có cảm biến đo độ ẩm.
Thông tin
sdm.devices.traits.Info
Đặc điểm này thuộc về mọi thiết bị có thông tin liên quan đến thiết bị.
Cài đặt
sdm.devices.traits.Settings
Trait này thuộc về mọi thiết bị có thông tin về chế độ cài đặt liên quan đến thiết bị.
Nhiệt độ
sdm.devices.traits.Temperature
Đặc điểm này thuộc về bất kỳ thiết bị nào có cảm biến đo nhiệt độ.

Máy điều nhiệt

Đặc điểm
ThermostatEco
sdm.devices.traits.ThermostatEco
Đặc điểm này thuộc các loại thiết bị của MÁY ĐIỀU NHIỆT có hỗ trợ các chế độ Tiết kiệm năng lượng.
ThermostatHvac
sdm.devices.traits.ThermostatHvac
Đặc điểm này thuộc các loại thiết bị của MÁY ĐIỀU NHIỆT có khả năng báo cáo thông tin chi tiết về hệ thống sưởi, thông gió và điều hoà.
ThermostatMode
sdm.devices.traits.ThermostatMode
Trait này thuộc các loại thiết bị của MÁY ĐIỀU NHIỆT hỗ trợ nhiều chế độ của máy điều nhiệt.
ThermostatTemperatureSetpoint
sdm.devices.traits.ThermostatTemperatureSetpoint
Đặc điểm này thuộc các loại thiết bị của MÁY ĐIỀU NHIỆT có hỗ trợ đặt nhiệt độ mục tiêu và phạm vi nhiệt độ mục tiêu.

Camera

Đặc điểm
CameraClipPreview
sdm.devices.traits.CameraClipPreview
Trait này thuộc về bất kỳ thiết bị nào có hỗ trợ việc tải bản xem trước của đoạn video xuống.
CameraEventImage
sdm.devices.traits.CameraEventImage
Đặc điểm này thuộc về bất kỳ thiết bị nào hỗ trợ việc tạo hình ảnh từ sự kiện.
CameraImage
sdm.devices.traits.CameraImage
Đặc điểm này thuộc về bất kỳ thiết bị nào có hỗ trợ tính năng chụp ảnh.
CameraLiveStream
sdm.devices.traits.CameraLiveStream
Đặc điểm này thuộc về bất kỳ thiết bị nào hỗ trợ tính năng phát trực tiếp.
CameraMotion
sdm.devices.traits.CameraMotion
Trait này thuộc về bất kỳ thiết bị nào hỗ trợ sự kiện phát hiện chuyển động.
CameraPerson
sdm.devices.traits.CameraPerson
Đặc điểm này thuộc về bất kỳ thiết bị nào hỗ trợ sự kiện phát hiện người.
CameraSound
sdm.devices.traits.CameraSound
Đặc điểm này thuộc về bất kỳ thiết bị nào hỗ trợ sự kiện phát hiện âm thanh.

Chuông cửa

Đặc điểm
DoorbellChime
sdm.devices.traits.DoorbellChime
Đặc điểm này thuộc về bất kỳ thiết bị nào hỗ trợ chuông cửa và các sự kiện nhấn có liên quan.