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

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

EXECUTEการตอบสนอง

ข้อมูลโค้ด 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 ที่เกี่ยวข้องในอุปกรณ์

ข้อยกเว้น

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

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

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

หากคําสั่งทํางานไม่สําเร็จเนื่องจากมีข้อยกเว้น สถานะควรเป็น "ยกเว้น" และควรรายงานข้อยกเว้นโดยใช้ลักษณะเฉพาะของ StatusReport

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

ตัวอย่างนี้มีไว้สําหรับล็อกประตู

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

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