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

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

गड़बड़ियां

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

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

सारांश में:

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

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

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

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

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

ऑनलाइन और ऑफ़लाइन स्थिति की रिपोर्टिंग

"requestId": "test-request-id",
  "agentUserId": "agent-user-1",
    "payload":{
      "devices": {
        "states": {
          "device-id-1": {
            "brightness": 65,
            "on": true,
            "online": true
          }
          "notifications": {},
        }
      }
    }

अपवाद

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

अगर कमांड पूरी हो गई है (status = "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"
      }
    }]
  }
}

StatusReport का इस्तेमाल करने वाले किसी दूसरे डिवाइस के बारे में नॉन-ब्लॉकिंग अपवाद (SUCCESS)

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

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

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

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