智慧型住宅車庫指南

action.devices.types.GARAGE - 車庫門可以開啟、關閉及偵測開放式狀態。也能指明物件是否在關閉時擋住車門的路徑，或是否因門上鎖而無法控制。

這種類型表示裝置會取得「車庫」圖示，以及一些相關的同義詞和別名。

裝置功能

請參閱對應的特性說明文件，瞭解服務應支援的屬性和狀態，以及如何建構 EXECUTE 和 QUERY 回應。

必修特色

這些特性和指令 (如果適用於您的裝置)。

action.devices.traits.OpenClose

品質規定

延遲時間：必須小於或等於 2000 毫秒。
可靠性：必須大於或等於 97%。

範例裝置：簡單的車庫

本節包含代表上述裝置類型和特徵的常見意圖酬載的示例酬載。如果您在實作中新增或移除特性，請配合這些異動修改回應。

同步處理回應範例

請求

{
  "requestId": "6894439706274654512",
  "inputs": [
    {
      "intent": "action.devices.SYNC"
    }
  ]
}

回應

{
  "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"
        }
      }
    ]
  }
}

QUERY 回應範例

請求

{
  "requestId": "6894439706274654514",
  "inputs": [
    {
      "intent": "action.devices.QUERY",
      "payload": {
        "devices": [
          {
            "id": "123"
          }
        ]
      }
    }
  ]
}

回應

{
  "requestId": "6894439706274654514",
  "payload": {
    "devices": {
      "123": {
        "status": "SUCCESS",
        "online": true,
        "openPercent": 50,
        "isLocked": false,
        "isJammed": false
      }
    }
  }
}

EXECUTE 指令範例

OpenClose

如要進一步瞭解指令參數，請參閱 action.devices.traits.OpenClose 參考資料。

請求

{
  "requestId": "6894439706274654518",
  "inputs": [
    {
      "intent": "action.devices.EXECUTE",
      "payload": {
        "commands": [
          {
            "devices": [
              {
                "id": "123"
              }
            ],
            "execution": [
              {
                "command": "action.devices.commands.OpenClose",
                "params": {
                  "openPercent": 100
                }
              }
            ]
          }
        ]
      }
    }
  ]
}

回應

{
  "requestId": "6894439706274654518",
  "payload": {
    "commands": [
      {
        "ids": [
          "123"
        ],
        "status": "SUCCESS",
        "states": {
          "online": true,
          "openPercent": 100
        }
      }
    ]
  }
}

LockLock

如要進一步瞭解指令參數，請參閱 action.devices.traits.LockUnlock 參考資料。

請求

{
  "requestId": "6894439706274654516",
  "inputs": [
    {
      "intent": "action.devices.EXECUTE",
      "payload": {
        "commands": [
          {
            "devices": [
              {
                "id": "123"
              }
            ],
            "execution": [
              {
                "command": "action.devices.commands.LockUnlock",
                "params": {
                  "lock": true
                }
              }
            ]
          }
        ]
      }
    }
  ]
}

回應

{
  "requestId": "6894439706274654516",
  "payload": {
    "commands": [
      {
        "ids": [
          "123"
        ],
        "status": "SUCCESS",
        "states": {
          "online": true,
          "isLocked": true,
          "isJammed": false
        }
      }
    ]
  }
}

裝置錯誤：ERRORS

請參閱錯誤和例外狀況的完整清單。

obstructionDetected - 使用者嘗試關閉車庫門，但有物體擋住門。
lockedState - 使用者嘗試控制車庫門，但裝置處於鎖定狀態，且無法移動。