गड़बड़ियां और अपवाद

यह दस्तावेज़ स्मार्ट होम डिवाइस. कृपया इंटेंट में इन गड़बड़ियों और अपवाद कोड का इस्तेमाल करें जवाब या सूचनाओं में अगर आपने इसे लागू किया है, तो 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 स्निपेट दिखाता है कि आप जवाब भेजा जा सकता है.

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

गड़बड़ी सूची

नीचे दी गई गड़बड़ियों की वजह से, डिवाइस पर उससे जुड़े टीटीएस बन जाएंगे.

अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है

अपवाद

अगर कोई समस्या या चेतावनी, आदेश. आदेश सफल या विफल हो सकता है.

अगर निर्देश सफल रहा (स्थिति = "सफल"), रिपोर्ट के अपवाद StatusReport Trait का इस्तेमाल करके (टारगेट के अलावा, दूसरे डिवाइसों के लिए), या फिर, टारगेट किए गए डिवाइस के लिए सही exceptionCode लौटाकर.

उदाहरण के लिए, अगर ड्रायर की लिंट स्क्रीन पूरी भर गई है, तब भी उपयोगकर्ता ड्रायर, लेकिन हो सकता है कि आप उन्हें इस स्थिति के बारे में चेतावनी देना चाहें. इसी तरह, जब किसी डिवाइस की बैटरी कम है और यह खाली नहीं है, तब भी आप कोई निर्देश दे सकते हैं उन्हें पता होना चाहिए कि डिवाइस की बैटरी कम है.

अगर अपवादों की वजह से निर्देश काम नहीं करता, तो स्थिति "EXCEPTIONS" होनी चाहिए, और अपवादों को StatusReport Trait का इस्तेमाल करके रिपोर्ट किया जाना चाहिए.

टारगेट डिवाइस से जुड़ा, ब्लॉक न करने वाला अपवाद (सफल)

इस उदाहरण में, दरवाज़ा लॉक करने का तरीका बताया गया है:

सामने के दरवाज़े की बैटरी कम है. सामने का दरवाज़ा बंद कर रही हूँ.

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

स्टेटस रिपोर्ट का इस्तेमाल करके किसी दूसरे डिवाइस के बारे में, ब्लॉक न करने का अपवाद (सफल)

यह उदाहरण सुरक्षा सिस्टम को चालू करने के लिए है: ठीक है, सुरक्षा सिस्टम को चालू कर रही हूँ. सामने की खिड़की खुली है.

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

अपवाद की सूची

नीचे दिए गए अपवादों के आधार पर, डिवाइस पर उससे जुड़े टीटीएस जनरेट होंगे.

अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है