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

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

{
  "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 एट्रिब्यूट (टारगेट के अलावा दूसरे डिवाइसों के लिए) का इस्तेमाल करके या सही 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"
      }
    }]
  }
}

स्थिति के हिसाब से रिपोर्ट का इस्तेमाल करने वाले दूसरे डिवाइस के बारे में अपवाद (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"
          }
        ]
      }
    }
  }
}

अपवाद सूची

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