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

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

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

गड़बड़ी सूची

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

अपवाद

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

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

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

अगर अपवादों की वजह से निर्देश काम करना बंद कर देता है, तो स्थिति "EXCEPTIONS" होनी चाहिए. साथ ही, अपवादों को 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"
      }
    }]
  }
}

स्थिति रिपोर्ट का इस्तेमाल करके, किसी ऐसे दूसरे डिवाइस (जैसे कि डिवाइस को ब्लॉक करना जिस पर कार्रवाई की जा सके) का सफल होना ज़रूरी है. इस अपवाद को ब्लॉक नहीं किया गया है

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

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

अपवाद सूची

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