有了存取權杖和初始裝置清單呼叫,您就可以開始使用 SDM API 存取及控制裝置。
列出結構和裝置
使用 curl
向 structures
端點發出簡單的 GET 呼叫:
curl -X GET 'https://smartdevicemanagement.googleapis.com/v1/enterprises/project-id/structures' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer access-token'
如果呼叫成功,會傳回Device Access 專案所連結帳戶的結構清單:
{ "structures": [ { "name": "enterprises/project-id/structures/structure-id", "traits": { "sdm.structures.traits.Info": { "customName": "structure-name" } } } ] }
如果您尚未執行此操作,請對 devices
端點發出 GET 呼叫以取得裝置清單:
curl -X GET 'https://smartdevicemanagement.googleapis.com/v1/enterprises/project-id/devices' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer access-token'
如果呼叫成功,會傳回連結至 Device Access專案的裝置清單。每部裝置都有專屬的可用特徵清單:
{ "devices": [ { "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": "device-room-name" } ] } ] }
針對每部裝置複製 device-id,其他 API 呼叫都需要用到這些項目。
取得裝置資訊
如要取得特定裝置的資訊,請對 device-id 端點發出 GET 呼叫:
curl -X GET 'https://smartdevicemanagement.googleapis.com/v1/enterprises/project-id/devices/device-id' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer access-token'
回應應與先前類似,但僅適用於特定裝置:
{ "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": "device-room-name" } ] }
執行指令
透過成功的 GET 呼叫驗證存取權後,請根據您授權的裝置類型執行指令:
溫度控制器
curl -X POST \
'https://smartdevicemanagement.googleapis.com/v1/enterprises/project-id/devices/device-id:executeCommand' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer access-token' \
--data-raw '{
"command" : "sdm.devices.commands.ThermostatMode.SetMode",
"params" : {
"mode" : "HEAT"
}
}'
相機
curl -X POST \
'https://smartdevicemanagement.googleapis.com/v1/enterprises/project-id/devices/device-id:executeCommand' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer access-token' \
--data-raw '{
"command" : "sdm.devices.commands.CameraLiveStream.GenerateRtspStream",
"params" : {}
}'
如果呼叫成功,會發生以下結果:
溫度控制器
您收到空白回應,且實體溫度控制器會將其目前的模式變更為指令參數中指定的模式。
{}
相機
你會收到直播網址和相關權杖。
{ "results" : { "streamUrls" : { "rtspUrl" : "rtsps://someurl.com/CjY5Y3VKaTZwR3o4Y19YbTVfMF...?auth=g.0.streamingToken" }, "streamExtensionToken" : "CjY5Y3VKaTZwR3o4Y19YbTVfMF...", "streamToken" : "g.0.streamingToken", "expiresAt" : "2018-01-04T18:30:00.000Z" } }
疑難排解
未經驗證
SDM API 的存取權杖只在 1 小時內有效。如果您收到 UNAUTHENTICATED 回應,表示權杖可能已過期。使用更新權杖取得新的存取權杖。
其他錯誤
如需 Device Access 錯誤代碼的完整清單,請參閱錯誤代碼參考資料。