ข้อผิดพลาดและข้อยกเว้น

เอกสารนี้แสดงข้อผิดพลาดและข้อยกเว้นที่สนับสนุนอย่างเป็นทางการสำหรับอุปกรณ์สมาร์ทโฮม โปรดใช้โค้ดข้อผิดพลาดและข้อยกเว้นที่ให้ไว้เหล่านี้ในการตอบสนองของ Intent หรือในการแจ้งเตือนหากได้ติดตั้งไว้ เพื่อให้ Google Assistant แจ้งเตือนผู้ใช้ปลายทางเกี่ยวกับปัญหาที่เกี่ยวข้องกับคำสั่งหรือสถานะของอุปกรณ์ที่ระบุ หากการตอบกลับมีการจัดรูปแบบที่ไม่ถูกต้องหรือ errorCode ทาง Google Assistant จะแสดงข้อความแสดงข้อผิดพลาดทั่วไปแก่ผู้ใช้ เช่น "ขออภัย อุปกรณ์ไม่พร้อมใช้งานในขณะนี้"

ข้อผิดพลาด

คุณควรแสดงรหัสข้อผิดพลาดเมื่อปัญหาทำให้คำขอที่ดำเนินการหรือคำขอล้มเหลว ตัวอย่างเช่น หากล็อกประตูติดอยู่และไม่สามารถล็อกหรือปลดล็อกได้ ผู้ใช้ควรแสดงข้อผิดพลาดเกี่ยวกับสถานะนี้

คุณแนบรหัสข้อผิดพลาดได้ที่ระดับอุปกรณ์หรือระดับส่วนกลาง ตัวอย่างเช่น หากผู้ใช้มีหลอดไฟหลายดวงจากผู้ให้บริการรายหนึ่งและอยู่ภายใต้การควบคุมของฮับ เมื่อผู้ใช้ขอให้ปิดไฟทุกดวง ผู้ให้บริการอาจแสดงข้อผิดพลาดระดับอุปกรณ์หากไฟดวงเดียวออฟไลน์อยู่ หรือข้อผิดพลาดระดับโลกหากฮับทั้งดวงออฟไลน์และไม่มีหลอดไฟที่ควบคุมได้ หากอุปกรณ์ทั้งหมดออฟไลน์อยู่ การใช้ข้อผิดพลาดระดับสากลหรือระดับอุปกรณ์ก็จะไม่แตกต่างกัน เมื่ออุปกรณ์ออฟไลน์ คุณควรรายงานสถานะ {"online": false} ใน reportState แม้ว่าจะส่งคืนรหัสข้อผิดพลาด deviceOffline ก็ตาม

สรุป:

• ข้อผิดพลาดระดับสากล: อุปกรณ์ทั้งหมดในการตอบสนองมีข้อผิดพลาดเดียวกัน
• ข้อผิดพลาดระดับท้องถิ่น: เป็นการตอบกลับแบบผสมและมีข้อผิดพลาดและกรณีที่พบความสำเร็จ

ข้อผิดพลาดระดับสากล

ข้อมูลโค้ด JSON ต่อไปนี้แสดงวิธีที่คุณแสดงข้อผิดพลาดระดับส่วนกลางในการตอบสนอง QUERY หรือ EXECUTE

ตัวอย่างข้อผิดพลาดระดับสากล deviceOffline เนื่องจากฮับออฟไลน์อยู่

{
  "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
  "payload": {
    "errorCode": "deviceOffline",
    "status" : "ERROR"
  }
}

ตัวอย่างข้อผิดพลาดระดับสากล inSoftwareUpdate เนื่องจากฮับกำลังอัปเดต

{
  "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
  "payload": {
    "errorCode": "inSoftwareUpdate",
    "status" : "ERROR"
  }
}

ข้อผิดพลาดระดับอุปกรณ์

คำตอบเกี่ยวกับ QUERY

ข้อมูลโค้ด JSON ต่อไปนี้แสดงวิธีแสดงข้อผิดพลาดระดับอุปกรณ์ในการตอบกลับของ QUERY

{
  "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
  "payload": {
    "devices": {
      "device-id-1": {
        "errorCode": "deviceOffline",
        "status" : "ERROR"
      },
      "device-id-2": {
        "errorCode": "deviceOffline",
        "status" : "ERROR"
      }
    }
  }
}

ดำเนินการตอบกลับ

ข้อมูลโค้ด JSON ต่อไปนี้แสดงวิธีแสดงข้อผิดพลาดระดับอุปกรณ์ในการตอบกลับ "EXECUTE"

{
  "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
  "payload": {
    "commands": [
      {
        "ids": [
          "device-id-1"
        ],
        "status": "ERROR",
        "errorCode": "deviceOffline"
      },
      {
        "ids": [
          "device-id-2"
        ],
        "status": "SUCCESS",
        "states": {
          "on": true,
          "online": true
        }
      }
    ]
  }
}

การแจ้งเตือนที่มีข้อผิดพลาด

การแจ้งเตือนเชิงรุก

ข้อมูลโค้ด JSON ต่อไปนี้แสดงวิธีรายงานข้อผิดพลาดระดับอุปกรณ์ในการแจ้งเตือนเชิงรุก

{
  "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
  "agentUserId": "agent-user-id-1",
  "eventId": "unique-event-id-1",
  "payload": {
    "devices": {
      "notifications": {
        "device-id-1": {
          "RunCycle": {
            "priority": 0,
            "status": "FAILURE",
            "errorCode": "deviceDoorOpen"
          }
        }
      }
    }
  }
}

การตอบกลับเพื่อติดตามผล

ข้อมูลโค้ด JSON ต่อไปนี้จะแสดงวิธีที่คุณรายงานข้อผิดพลาดระดับอุปกรณ์ในการตอบกลับติดตามผล

{
  "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
  "agentUserId": "agent-user-id-1",
  "eventId": "unique-event-id-1",
  "payload": {
    "devices": {
      "notifications": {
        "device-id-1": {
          "LockUnlock": {
            "priority": 0,
            "followUpResponse": {
              "status": "FAILURE",
              "errorCode": "deviceJammingDetected",
              "followUpToken": "PLACEHOLDER"
            }
          }
        }
      }
    }
  }
}

รายการข้อผิดพลาด

ข้อผิดพลาดต่อไปนี้จะสร้าง TTS ที่เกี่ยวข้องในอุปกรณ์

ข้อยกเว้น

คุณควรคืนข้อยกเว้นเมื่อมีปัญหาหรือการแจ้งเตือนที่เกี่ยวข้องกับคำสั่ง คำสั่งอาจสำเร็จหรือล้มเหลว

หากคำสั่งประสบความสำเร็จ (สถานะ = "สำเร็จ") ให้รายงานข้อยกเว้นโดยใช้ลักษณะ StatusReport (สำหรับอุปกรณ์อื่นที่ไม่ใช่เป้าหมาย) หรือโดยการแสดง exceptionCode ที่เหมาะสม (สำหรับอุปกรณ์เป้าหมาย)

เช่น หากหน้าจอผ้าขี้ริ้วเต็ม ผู้ใช้ยังเริ่มใช้งานเครื่องอบผ้าได้ แต่คุณอาจต้องเตือนผู้ใช้เกี่ยวกับสถานะนี้ ในทำนองเดียวกัน เมื่ออุปกรณ์มีแบตเตอรี่เหลือน้อย คุณอาจยังเรียกใช้คำสั่งได้แต่ควรแจ้งให้อุปกรณ์ทราบว่าแบตเตอรี่เหลือน้อย

หากคำสั่งล้มเหลวเนื่องจากข้อยกเว้น สถานะควรเป็น "EXCEPTIONS" และควรรายงานข้อยกเว้นโดยใช้ Trait StatusReport

ข้อยกเว้นที่ยังสามารถบล็อกได้ (สำเร็จ) เกี่ยวกับอุปกรณ์เป้าหมาย

ตัวอย่างสำหรับการล็อกประตู

ล็อกประตูหน้าเหลือแบตเตอรี่น้อย กำลังล็อกประตูหน้า

{
  "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
  "payload": {
    "commands": [{
      "ids": ["device-id-1"],
      "status": "SUCCESS",
      "states": {
        "on": true,
        "online": true,
        "isLocked": true,
        "isJammed": false,
        "exceptionCode": "lowBattery"
      }
    }]
  }
}

ข้อยกเว้นที่ยังสามารถบล็อกได้ (SUCCESS) เกี่ยวกับอุปกรณ์อีกเครื่องหนึ่งโดยใช้ StatusReport

ตัวอย่างนี้ใช้สำหรับการเปิดระบบรักษาความปลอดภัย เอาล่ะ กำลังเปิดระบบรักษาความปลอดภัย หน้าต่างด้านหน้าเปิดอยู่

{
  "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
  "payload": {
    "commands": [{
      "ids": ["device-id-1"],
      "status": "SUCCESS",
      "states": {
        "on": true,
        "online": true,
        "isArmed": true,
        "currentArmLevel": "L2",
        "currentStatusReport": [{
          "blocking": false,
          "deviceTarget": "sensor_id1",
          "priority": 0,
          "statusCode": "deviceOpen"
        }]
      }
    }]
  }
}

ข้อยกเว้นการบล็อกเกี่ยวกับอุปกรณ์อื่นโดยใช้ StatusReport

{
  "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
  "payload": {
    "devices": {
      "device-id-1": {
        "on": true,
        "online": true,
        "status": "EXCEPTIONS",
        "currentStatusReport": [{
            "blocking": true,
            "deviceTarget": "device-id-1",
            "priority": 0,
            "statusCode": "lowBattery"
          },
          {
            "blocking": true,
            "deviceTarget": "front_window_id",
            "priority": 1,
            "statusCode": "deviceOpen"
          },
          {
            "blocking": true,
            "deviceTarget": "back_window_id",
            "priority": 1,
            "statusCode": "deviceOpen"
          }
        ]
      }
    }
  }
}

รายการข้อยกเว้น

ข้อยกเว้นต่อไปนี้จะสร้าง TTS ที่เกี่ยวข้องขึ้นในอุปกรณ์