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

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

गड़बड़ियां

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

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

जब कोई डिवाइस ऑफ़लाइन हो, तो आपको डिवाइस के व्यवहार के पांच मिनट के अंदर, स्थिति की शिकायत करने के लिए {"online": false} की शिकायत करनी चाहिए.

सारांश में:

• ग्लोबल-लेवल की गड़बड़ी: जवाब में दिए गए सभी डिवाइसों में एक ही गड़बड़ी है
• स्थानीय-लेवल की गड़बड़ी: गड़बड़ी और सफलता के उदाहरणों के साथ मिला-जुला जवाब

ग्लोबल-लेवल की गड़बड़ियां

यहां दिए गए 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"
      }
    }
  }
}

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

गड़बड़ियों की सूची

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

अपवाद

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

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

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

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

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

अपवादों की सूची

नीचे दिए गए अपवादों के लिए, डिवाइस पर टीटीएस की सुविधा का इस्तेमाल किया जाएगा.