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

इस दस्तावेज़ में स्मार्ट होम डिवाइसों पर आधिकारिक तौर पर स्वीकार की गई गड़बड़ियों और अपवादों की सूची दी गई है. कृपया जवाब में, दी गई गड़बड़ियों और अपवाद के कोड का इस्तेमाल जवाब के तौर पर करें. अगर आपने इसे लागू किया है, तो सूचनाओं में भी इसका इस्तेमाल करें. इससे Google Assistant असली उपयोगकर्ताओं को किसी दिए गए निर्देश या डिवाइस की स्थिति से जुड़ी समस्याओं के बारे में चेतावनी देगी. अगर जवाब में गलत फ़ॉर्मैट या errorCode शामिल है, तो Google Assistant उपयोगकर्ताओं को गड़बड़ी का सामान्य मैसेज देती है. उदाहरण के लिए, "माफ़ करें, डिवाइस अभी उपलब्ध नहीं है".

गड़बड़ियां

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

गड़बड़ी के कोड, डिवाइस के लेवल या ग्लोबल लेवल पर अटैच किए जा सकते हैं. उदाहरण के लिए, अगर किसी उपयोगकर्ता के पास सेवा देने वाली एक कंपनी की कई लाइटें हैं और उसे हब से कंट्रोल किया जाता है, तो जब वह उपयोगकर्ता सभी लाइटें बंद करने के लिए कहता है, तो वह एक लाइट के ऑफ़लाइन होने पर डिवाइस-लेवल की गड़बड़ी दिखा सकता है. अगर उनका पूरा हब ऑफ़लाइन है और कोई भी लाइट कंट्रोल नहीं की जा सकती, तो वह डिवाइस-लेवल की गड़बड़ी दिखा सकता है. अगर सभी डिवाइस ऑफ़लाइन हैं, तो ग्लोबल-लेवल या डिवाइस-लेवल की गड़बड़ियों का इस्तेमाल करने में कोई फ़र्क़ नहीं है. जब कोई डिवाइस ऑफ़लाइन हो, तो आपको reportState में {"online": false} की स्थिति रिपोर्ट करनी चाहिए, भले ही आपने 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"
            }
          }
        }
      }
    }
  }
}

गड़बड़ी सूची

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

अपवाद

अगर किसी निर्देश से जुड़ी कोई समस्या या चेतावनी हो, तो आपको अपवाद के तौर पर एक कार्रवाई करनी चाहिए. निर्देश कामयाब या असफल हो सकता है.

अगर निर्देश कामयाब रहा है (स्थिति = "SUCCESS"), 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"
          }
        ]
      }
    }
  }
}

अपवाद की सूची

इन अपवादों से डिवाइस पर संबंधित टीटीएस की जानकारी जनरेट होगी.