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

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

ข้อผิดพลาด

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

อาจแนบรหัสข้อผิดพลาดที่ระดับอุปกรณ์หรือที่ระดับส่วนกลาง ตัวอย่างเช่น หากผู้ใช้มีไฟหลายดวงจากผู้ให้บริการ 1 ราย และพวกเขาควบคุมโดยฮับ เมื่อผู้ใช้ขอปิดไฟทุกดวง ผู้ให้บริการอาจแสดงข้อผิดพลาดระดับอุปกรณ์หากไฟดวงเดียวออฟไลน์ หรือข้อผิดพลาดระดับสากล หากไฟทั้งดวงออฟไลน์และไม่ได้ควบคุมหลอดไฟ หากอุปกรณ์ทั้งหมดออฟไลน์อยู่ ก็ไม่จําเป็นต้องใช้ข้อผิดพลาดระดับสากลหรืออุปกรณ์ระดับเดียวกัน เมื่ออุปกรณ์ออฟไลน์ คุณควรรายงานสถานะ {"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"
      }
    }
  }
}

การตอบสนอง EXECUTE

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

{
  "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" และควรรายงานข้อยกเว้นโดยใช้ลักษณะเฉพาะ 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"
      }
    }]
  }
}

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

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

{
  "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"
        }]
      }
    }]
  }
}

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

{
  "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 ที่เกี่ยวข้องในอุปกรณ์