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

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

गड़बड़ियां

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

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

सारांश में:

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

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

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

अपवाद

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

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

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

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

अपवाद सूची

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