智慧型住宅門鈴指南

action.devices.types.DOORBELL - 門鈴可讓其他人知道門前有訪客。 如果裝置具備對應的功能,即可傳送通知和串流播放影片。

這個類型表示裝置會取得門鈴圖示和一些相關的同義詞和別名。

裝置功能

請參閱相應特徵說明文件,進一步瞭解實作詳細資料,例如您的服務應支援的屬性和聲明,以及如何建構 EXECUTE 和 QUERY 回應。

建議使用這些特徵 (如適用)。 不過,您也可以自由混用所有可用特質,以與現有產品功能最完美搭配。

品質規定

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

裝置範例:簡易門鈴

本節包含根據上述裝置類型和特徵所適用的常見「門鈴」範例意圖酬載,如果您在實作中新增或移除特徵,請根據變更項目修改回應。

SYNC 回應範例

要求
{
  "requestId": "6894439706274654512",
  "inputs": [
    {
      "intent": "action.devices.SYNC"
    }
  ]
}
回應
{
  "requestId": "6894439706274654512",
  "payload": {
    "agentUserId": "user123",
    "devices": [
      {
        "id": "123",
        "type": "action.devices.types.DOORBELL",
        "traits": [
          "action.devices.traits.CameraStream",
          "action.devices.traits.ObjectDetection"
        ],
        "name": {
          "name": "Simple doorbell"
        },
        "willReportState": true,
        "notificationSupportedByAgent": true,
        "attributes": {
          "cameraStreamSupportedProtocols": [
            "hls"
          ],
          "cameraStreamNeedAuthToken": 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
      }
    }
  }
}

執行指令範例

GetCameraStream

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

要求
{
  "requestId": "6894439706274654516",
  "inputs": [
    {
      "intent": "action.devices.EXECUTE",
      "payload": {
        "commands": [
          {
            "devices": [
              {
                "id": "123"
              }
            ],
            "execution": [
              {
                "command": "action.devices.commands.GetCameraStream",
                "params": {
                  "StreamToChromecast": true,
                  "SupportedStreamProtocols": [
                    "hls"
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  ]
}
回應
{
  "requestId": "6894439706274654516",
  "payload": {
    "commands": [
      {
        "ids": [
          "123"
        ],
        "status": "SUCCESS",
        "states": {
          "online": true,
          "cameraStreamAccessUrl": "https://example.com/stream.mp4",
          "cameraStreamProtocol": "hls"
        }
      }
    ]
  }
}

通知報表範例

ObjectDetection

如要進一步瞭解通知屬性,請參閱 action.devices.traits.ObjectDetection 參考資料。

要求
{
  "requestId": "6894439706274654518",
  "payload": {
    "devices": {
      "notifications": {
        "123": {
          "ObjectDetection": {
            "objects": {
              "named": [
                "Alice"
              ]
            },
            "priority": 0,
            "detectionTimestamp": 946684800000
          }
        }
      }
    }
  }
}
回應
{
  "requestId": "6894439706274654518"
}

裝置錯誤

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