Hướng dẫn về nhà để xe dành cho nhà thông minh

action.devices.types.GARAGE – Cửa nhà xe có thể mở, đóng và phát hiện trạng thái mở. Chúng cũng có thể cho biết liệu có vật cản trở đường đi của cửa khi đóng hay không hoặc cửa bị khóa và do đó không thể kiểm soát được.

Loại này cho biết thiết bị có biểu tượng Nhà để xe và một số từ đồng nghĩa và bí danh.

Khả năng của thiết bị

Tham khảo tài liệu về đặc điểm tương ứng cho thông tin chi tiết về việc triển khai, chẳng hạn như các thuộc tính và trạng thái mà dịch vụ của bạn sẽ hỗ trợ cũng như cách tạo các phản hồi EXECUTE và QUERY.

Đặc điểm bắt buộc

Đây là những đặc điểm và lệnh bắt buộc, nếu phù hợp với thiết bị. Nếu thiết bị của bạn không hỗ trợ những đặc điểm này, hãy nhập mã lỗi của functionNotSupported trong phản hồi QUERY hoặc EXECUTE. Xem Lỗi và ngoại lệ để biết thêm thông tin.

Bạn nên dùng những đặc điểm này (nếu phù hợp với thiết bị của mình). Tuy nhiên, bạn có thể thoải mái kết hợp tất cả các đặc điểm có sẵn để phù hợp nhất với hiện tại của mình chức năng của sản phẩm.

Yêu cầu về chất lượng

  • Độ trễ: phải nhỏ hơn hoặc bằng 2000 mili giây.
  • Độ tin cậy: phải lớn hơn hoặc bằng 97%.

Thiết bị ví dụ: Nhà để xe đơn giản

Phần này chứa các tải trọng ý định mẫu đại diện cho một "Garage" chung dựa trên loại thiết bị và đặc điểm nêu trên. Nếu bạn thêm hoặc xoá các đặc điểm trong quá trình triển khai, sửa đổi câu trả lời của bạn sao cho phù hợp để phản ánh những thay đổi đó.

Phản hồi SYNC mẫu

Yêu cầu
{
  "requestId": "6894439706274654512",
  "inputs": [
    {
      "intent": "action.devices.SYNC"
    }
  ]
}
Câu trả lời
{
  "requestId": "6894439706274654512",
  "payload": {
    "agentUserId": "user123",
    "devices": [
      {
        "id": "123",
        "type": "action.devices.types.GARAGE",
        "traits": [
          "action.devices.traits.OpenClose",
          "action.devices.traits.LockUnlock"
        ],
        "name": {
          "name": "Simple garage"
        },
        "willReportState": true,
        "deviceInfo": {
          "manufacturer": "smart-home-inc",
          "model": "hs1234",
          "hwVersion": "3.2",
          "swVersion": "11.4"
        }
      }
    ]
  }
}

Phản hồi QUERY mẫu

Yêu cầu
{
  "requestId": "6894439706274654514",
  "inputs": [
    {
      "intent": "action.devices.QUERY",
      "payload": {
        "devices": [
          {
            "id": "123"
          }
        ]
      }
    }
  ]
}
Câu trả lời
{
  "requestId": "6894439706274654514",
  "payload": {
    "devices": {
      "123": {
        "status": "SUCCESS",
        "online": true,
        "openPercent": 50,
        "isLocked": false,
        "isJammed": false
      }
    }
  }
}

Lệnh EXECUTE mẫu

OpenClose

Để biết thêm thông tin chi tiết về các tham số lệnh, hãy xem action.devices.traits.OpenClose tham chiếu.

Yêu cầu
{
  "requestId": "6894439706274654518",
  "inputs": [
    {
      "intent": "action.devices.EXECUTE",
      "payload": {
        "commands": [
          {
            "devices": [
              {
                "id": "123"
              }
            ],
            "execution": [
              {
                "command": "action.devices.commands.OpenClose",
                "params": {
                  "openPercent": 100
                }
              }
            ]
          }
        ]
      }
    }
  ]
}
Câu trả lời
{
  "requestId": "6894439706274654518",
  "payload": {
    "commands": [
      {
        "ids": [
          "123"
        ],
        "status": "SUCCESS",
        "states": {
          "online": true,
          "openPercent": 100
        }
      }
    ]
  }
}

LockUnlock

Để biết thêm thông tin chi tiết về các tham số lệnh, hãy xem action.devices.traits.LockUnlock tham chiếu.

Yêu cầu
{
  "requestId": "6894439706274654516",
  "inputs": [
    {
      "intent": "action.devices.EXECUTE",
      "payload": {
        "commands": [
          {
            "devices": [
              {
                "id": "123"
              }
            ],
            "execution": [
              {
                "command": "action.devices.commands.LockUnlock",
                "params": {
                  "lock": true
                }
              }
            ]
          }
        ]
      }
    }
  ]
}
Câu trả lời
{
  "requestId": "6894439706274654516",
  "payload": {
    "commands": [
      {
        "ids": [
          "123"
        ],
        "status": "SUCCESS",
        "states": {
          "online": true,
          "isLocked": true,
          "isJammed": false
        }
      }
    ]
  }
}

Thiết bị ERRORS

Xem toàn bộ danh sách lỗi và ngoại lệ.
  • obstructionDetected – Người dùng đã cố đóng cửa nhà xe nhưng có một vật cản trở cửa.
  • lockedState – Người dùng đã cố gắng kiểm soát cửa nhà xe nhưng cửa bị khoá không cho phép nó di chuyển.