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

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

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

गड़बड़ी सूची

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

अपवाद

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

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

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

अगर अपवादों की वजह से निर्देश काम नहीं करता, तो स्थिति "EXCEPTIONS" होनी चाहिए. साथ ही, अपवादों को StatusReport Trait का इस्तेमाल करके रिपोर्ट किया जाना चाहिए.

टारगेट डिवाइस से जुड़ा, ब्लॉक न करने वाला अपवाद (सफल)

इस उदाहरण में, दरवाज़ा लॉक करने का तरीका बताया गया है:

सामने के दरवाज़े की बैटरी कम है. सामने का दरवाज़ा बंद कर रही हूँ.

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

अपवाद की सूची

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