סכימת מעריצים
sdm.devices.traits.Fan
המאפיין הזה נמצא בכל מכשיר שיש בו אפשרות לשלוט במאוורר.
שדות
| שדה | תיאור | סוג הנתונים |
|---|---|---|
timerMode |
מצב הטיימר הנוכחי. | stringערכים: "ON", "OFF" |
timerTimeout |
חותמת זמן בפורמט RFC 3339, שבה מצב הטיימר ישתנה ל'מושבת'. | stringדוגמה: "2019-05-10T03:22:54Z" |
דוגמה לבקשת GET ותשובה
בקשה
GET /enterprises/project-id/devices/device-id
תשובה
{
"name" : "enterprises/project-id/devices/device-id",
"traits" : {
"sdm.devices.traits.Fan" : {
"timerMode" : "ON",
"timerTimeout" : "2019-05-10T03:22:54Z"
}
}
}פקודות
SetTimer
לשנות את הטיימר של המאוורר.
בקשה ותגובה של SetTimer
בקשה
POST /enterprises/project-id/devices/device-id:executeCommand
{
"command" : "sdm.devices.commands.Fan.SetTimer",
"params" : {
"timerMode" : "ON",
"duration" : "3600s"
}
}
תשובה
{}
שדות בבקשה שנשלחת מפקודת SetTimer
| שדה | תיאור | סוג הנתונים |
|---|---|---|
timerMode |
המצב להגדרת הטיימר של המאוורר. | stringערכים: "ON", "OFF" |
duration |
אופציונלי. המדיניות הזו קובעת את משך הזמן בשניות שהטיימר מוגדר לפעול. | stringהטווח: 1s עד 43200s ברירת מחדל: 900s |
שגיאות
יכול להיות שהמערכת תחזיר את קודי השגיאה הבאים שקשורים למאפיין הזה:
| הודעת השגיאה | RPC | פתרון בעיות |
|---|---|---|
| המאוורר של התרמוסטט לא זמין. | FAILED_PRECONDITION |
לתרמוסטט אין אפשרות להפעלת מאוורר. אי אפשר להשתמש במכשיר הזה במאפיינים ובפקודות שקשורים למעריצים. |
רשימה מלאה של קודי השגיאה של ה-API מפורטת בדף קודי השגיאה.