מדריך בנושא סוככים לבית חכם

action.devices.types.AWNING - סוככים מתקפלים ואפשר לפתוח ולסגור אותם. אפשר להתקין אותם בתוך מבנים או בחוץ.

סוג זה מציין שהמכשיר מקבל את סמל הסוכך וכמה מילים נרדפות וכינויים קשורים.

היכולות של המכשיר

עיינו במסמכי התיעוד של התכונה המתאימה לקבלת פרטים על ההטמעה, כמו המאפיינים והמצבים שבהם השירות צריך לתמוך, והסבר על בניית תשובות EXECUTE ו-QUERY.

התכונות הנדרשות

המאפיינים והפקודות האלה נדרשים, אם הם רלוונטיים למכשיר שלכם. אם המכשיר לא תומך בתכונות האלה, מזינים את קוד השגיאה functionNotSupported בתשובה QUERY או EXECUTE. מידע נוסף זמין במאמר שגיאות וחריגים.

דרישות איכות

  • זמן האחזור: הערך חייב להיות פחות מ-2,500 אלפיות השנייה.
  • אמינות: חייבת להיות שווה ל-97%.

מכשיר לדוגמה: סוככים פשוטים

בקטע הזה מופיעים מטענים ייעודיים (payload) עם כוונות שמייצגים "גג"" נפוץ על סמך סוג המכשיר והתכונות שלמעלה. אם מוסיפים או מסירים תכונות, משנים את התשובות בהתאם בהתאם לשינויים.

דוגמה לתגובת SYNC

בקשה
{
  "requestId": "6894439706274654512",
  "inputs": [
    {
      "intent": "action.devices.SYNC"
    }
  ]
}
תשובה
{
  "requestId": "6894439706274654512",
  "payload": {
    "agentUserId": "user123",
    "devices": [
      {
        "id": "123",
        "type": "action.devices.types.AWNING",
        "traits": [
          "action.devices.traits.OpenClose"
        ],
        "name": {
          "name": "Simple awning"
        },
        "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
      }
    }
  }
}

פקודות EXECUTE לדוגמה

פתיחה וסגירה

למידע נוסף על הפרמטרים של הפקודות, אפשר לעיין במאמר action.devices.traits.OpenClose.

בקשה
{
  "requestId": "6894439706274654516",
  "inputs": [
    {
      "intent": "action.devices.EXECUTE",
      "payload": {
        "commands": [
          {
            "devices": [
              {
                "id": "123"
              }
            ],
            "execution": [
              {
                "command": "action.devices.commands.OpenClose",
                "params": {
                  "openPercent": 100
                }
              }
            ]
          }
        ]
      }
    }
  ]
}
תשובה
{
  "requestId": "6894439706274654516",
  "payload": {
    "commands": [
      {
        "ids": [
          "123"
        ],
        "status": "SUCCESS",
        "states": {
          "online": true,
          "openPercent": 100
        }
      }
    ]
  }
}

ERRORS מכשיר

לצפייה ברשימה המלאה של השגיאות והחריגים