स्मार्ट होम सिक्योरिटी सिस्टम गाइड

action.devices.types.SECURITYSYSTEM - सुरक्षा सिस्टम को चालू और बंद किया जा सकता है. उन्हें कई सुरक्षा लेवल (उदाहरण के लिए, होम और अवे मोड) पर चालू किया जा सकता है. साथ ही, वे कुछ सेंसर के बारे में जानकारी रिपोर्ट कर सकते हैं, जैसे कि वह सेंसर जो हलचल या खुली हुई खिड़की का पता लगाता है.

इस टाइप से पता चलता है कि डिवाइस को सुरक्षा सिस्टम का आइकॉन और इससे जुड़े कुछ समानार्थी शब्द और उपनाम मिलते हैं.

डिवाइस की क्षमताएं

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

ज़रूरी traits

अगर आपके डिवाइस पर लागू हो, तो ये विशेषताएं और निर्देश ज़रूरी हैं. अगर आपके डिवाइस में ये विशेषताएं काम नहीं करती हैं, तो QUERY या EXECUTE जवाब में functionNotSupported का गड़बड़ी कोड डालें. ज़्यादा जानकारी के लिए गड़बड़ियां और अपवाद देखें.

अगर आपके डिवाइस पर लागू हो, तो इन विशेषताओं के इस्तेमाल का सुझाव दिया जाता है. हालांकि, अपने मौजूदा प्रॉडक्ट की सुविधाओं को अपने हिसाब से बनाने के लिए, आपको सभी उपलब्ध विशेषताओं को एक साथ मिलाने की सुविधा मिलती है.

क्वालिटी के लिए ज़रूरी शर्तें

  • इंतज़ार का समय: 2,000 मि॰से॰ या उससे कम होना चाहिए.
  • भरोसेमंद: 97% से ज़्यादा या इसके बराबर होना चाहिए.

डिवाइस का उदाहरण: आसान सुरक्षा सिस्टम

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

सिंक के जवाब का उदाहरण

अनुरोध करें
{
  "requestId": "6894439706274654512",
  "inputs": [
    {
      "intent": "action.devices.SYNC"
    }
  ]
}
जवाब
{
  "requestId": "6894439706274654512",
  "payload": {
    "agentUserId": "user123",
    "devices": [
      {
        "id": "123",
        "type": "action.devices.types.SECURITYSYSTEM",
        "traits": [
          "action.devices.traits.StatusReport",
          "action.devices.traits.ArmDisarm"
        ],
        "name": {
          "name": "Simple security system"
        },
        "willReportState": true,
        "attributes": {
          "availableArmLevels": {
            "levels": [
              {
                "level_name": "home_key",
                "level_values": [
                  {
                    "level_synonym": [
                      "Home and Guarding",
                      "level 1",
                      "home",
                      "SL1"
                    ],
                    "lang": "en"
                  }
                ]
              },
              {
                "level_name": "away_key",
                "level_values": [
                  {
                    "level_synonym": [
                      "Away and Guarding",
                      "level 2",
                      "away",
                      "SL2"
                    ],
                    "lang": "en"
                  }
                ]
              }
            ],
            "ordered": true
          }
        },
        "deviceInfo": {
          "manufacturer": "smart-home-inc",
          "model": "hs1234",
          "hwVersion": "3.2",
          "swVersion": "11.4"
        }
      }
    ]
  }
}

क्वेरी के जवाब का उदाहरण

अनुरोध करें
{
  "requestId": "6894439706274654514",
  "inputs": [
    {
      "intent": "action.devices.QUERY",
      "payload": {
        "devices": [
          {
            "id": "123"
          }
        ]
      }
    }
  ]
}
जवाब
{
  "requestId": "6894439706274654514",
  "payload": {
    "devices": {
      "123": {
        "status": "SUCCESS",
        "online": true,
        "isArmed": true,
        "currentArmLevel": "home_key",
        "currentStatusReport": [
          {
            "blocking": false,
            "deviceTarget": "123",
            "priority": 0,
            "statusCode": "lowBattery"
          }
        ]
      }
    }
  }
}

EXECUTE के निर्देशों के उदाहरण

ArmDisarm

कमांड पैरामीटर के बारे में ज़्यादा जानकारी के लिए, action.devices.traits.ArmDisarm रेफ़रंस देखें.

अनुरोध करें
{
  "requestId": "6894439706274654516",
  "inputs": [
    {
      "intent": "action.devices.EXECUTE",
      "payload": {
        "commands": [
          {
            "devices": [
              {
                "id": "123"
              }
            ],
            "execution": [
              {
                "command": "action.devices.commands.ArmDisarm",
                "params": {
                  "arm": true,
                  "armLevel": "away_key"
                }
              }
            ]
          }
        ]
      }
    }
  ]
}
जवाब
{
  "requestId": "6894439706274654516",
  "payload": {
    "commands": [
      {
        "ids": [
          "123"
        ],
        "status": "SUCCESS",
        "states": {
          "online": true,
          "isArmed": true,
          "currentArmLevel": "away_key"
        }
      }
    ]
  }
}

डिवाइस ERRORS

गड़बड़ियों और अपवादों की पूरी सूची देखें.

रिपोर्ट को चालू करने से जुड़े अपवाद

सिस्टम को चालू या बंद करते समय, आपके पास अपवाद के कोड की मदद से ज़्यादा जानकारी देने का विकल्प होता है. इन्हें StatusReport trait की मदद से रिपोर्ट किया जाता है. अपवादों को ब्लॉक करने या ब्लॉक न करने वाले के रूप में रिपोर्ट किया जा सकता है.

  • ब्लॉक न किए जाने वाले अपवादों को "सफल" स्थिति के साथ रिपोर्ट किया जाता है. इससे पता चलता है कि अपवाद ने चालू या बंद करने से नहीं रोका.
  • ब्लॉक करने के अपवादों जिन्हें "अपवाद" स्थिति के साथ रिपोर्ट किया गया है, यह बताता है कि इन अपवादों की वजह से, डिवाइस को चालू या बंद करना बंद कर दिया गया था.

आम तौर पर सुरक्षा सिस्टम से जुड़े अपवाद कोड में ये शामिल हैं:

  • doorOpen: दरवाज़ा खुला है.
  • windowOpen: एक विंडो खुली है.
  • isOpen: सेंसर को किसी चीज़ के खुले होने का पता चलता है, लेकिन यह पता नहीं चलता कि यह दरवाज़ा या खिड़की है या नहीं.

उदाहरण: ब्लॉक न करने वाला अपवाद

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

उपयोगकर्ता सुरक्षा सिस्टम को उच्च सुरक्षा पर सेट करें.
Google Assistant ठीक है, सामने की खिड़की खुली है. सुरक्षा सिस्टम को हाई सिक्योरिटी पर चालू कर रही हूँ.
अनुरोध करें
{
  "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
  "inputs": [{
    "intent": "action.devices.EXECUTE",
    "payload": {
      "commands": [{
        "devices": [{
          "id": "123"
        }],
        "execution": [{
          "command": "action.devices.commands.ArmDisarm",
          "params": {
            "arm": true,
            "armLevel": "L2"
          }
        }]
      }]
    }
  }]
}
जवाब
{
  "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
  "payload": {
    "commands": [
      {
        "ids": [
          "123"
        ],
        "status": "SUCCESS",
        "states": {
          "online": true,
          "isArmed": true,
          "currentArmLevel": "L2",
          "currentStatusReport": [
            {
              "blocking": false,
              "priority": 0,
              "statusCode": "windowOpen",
              "deviceTarget": "sensor_id1"
            }
          ]
        }
      }
    ]
  }
}

उदाहरण: ब्लॉक करने का अपवाद

उपयोगकर्ता सुरक्षा सिस्टम को उच्च सुरक्षा पर सेट करें.
Google Assistant सुरक्षा सिस्टम को नियंत्रित करने में कोई गड़बड़ी हुई. सामने की खिड़की खुली है.
अनुरोध करें
{
  "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
  "inputs": [{
    "intent": "action.devices.EXECUTE",
    "payload": {
      "commands": [{
        "devices": [{
          "id": "123"
        }],
        "execution": [{
          "command": "action.devices.commands.ArmDisarm",
          "params": {
            "arm": true,
            "armLevel": "L2"
          }
        }]
      }]
    }
  }]
}
जवाब 2
{
  "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
  "payload": {
    "commands": [
      {
        "ids": [
          "123"
        ],
        "status": "SUCCESS",
        "states": {
          "online": true,
          "isArmed": false,
          "currentArmLevel": "L2",
          "currentStatusReport": [
            {
              "blocking": true,
              "priority": 0,
              "statusCode": "windowOpen",
              "deviceTarget": "sensor_id1"
            }
          ]
        }
      }
    ]
  }
}

दो तरीकों से पुष्टि करने की सुविधा चालू की जा रही है

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

इस स्थिति में, दोनों पिन या लंबे पासवर्ड से पुष्टि करने की ज़रूरत पड़ सकती है.

उदाहरण: स्वीकार करने की चुनौती

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

उपयोगकर्ता सुरक्षा सिस्टम को चालू करें.
Google Assistant सामने का दरवाज़ा खुला है। क्या आप वाकई सुरक्षा सिस्टम को चालू करना चाहते हैं?
उपयोगकर्ता हां.
Google Assistant ठीक है, सुरक्षा सिस्टम चालू कर रही हूँ.

पहली बार में, आपको ackNeeded चैलेंज का जवाब देना होगा.

अनुरोध 1
{
  "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
  "inputs": [{
    "intent": "action.devices.EXECUTE",
    "payload": {
      "commands": [{
        "devices": [{
          "id": "123"
        }],
        "execution": [{
          "command": "action.devices.commands.ArmDisarm",
          "params": {
            "arm": true
          }
        }]
      }]
    }
  }]
}
जवाब 2
{
  "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
  "payload": {
    "commands": [
      {
        "ids": [
          "123"
        ],
        "status": "ERROR",
        "errorCode": "challengeNeeded",
        "challengeNeeded": {
          "type": "ackNeeded"
        },
        "states": {
          "isArmed": true,
          "currentArmLevel": "L2",
          "currentStatusReport": [
            {
              "blocking": false,
              "priority": 0,
              "statusCode": "doorOpen",
              "deviceTarget": "456"
            }
          ]
        }
      }
    ]
  }
}

Google से किए गए बाद के अनुरोध में ack नतीजा शामिल होगा.

अनुरोध 2
{
  "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
  "inputs": [{
    "intent": "action.devices.EXECUTE",
    "payload": {
      "commands": [{
        "devices": [{
          "id": "123"
        }],
        "execution": [{
          "command": "action.devices.commands.ArmDisarm",
          "params": {
            "arm": true
          },
          "challenge": {
            "ack": true
          }
        }]
      }]
    }
  }]
}
जवाब
{
  "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
  "payload": {
    "commands": [
      {
        "ids": [
          "123"
        ],
        "status": "SUCCESS",
        "states": {
          "isArmed": true
        }
      }
    ]
  }
}

उदाहरण: पिन और स्वीकार करने की चुनौती

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

उपयोगकर्ता डिवाइस को दूर से चालू करें.
Google Assistant आपका पिन क्या है?
उपयोगकर्ता 1234.
Google Assistant ऐसा लगता है कि सामने और पीछे की खिड़की खुली हुई है. क्या आपको वाकई सुरक्षा सिस्टम को बंद करना है?
उपयोगकर्ता हां.
Google Assistant ठीक है, सुरक्षा सिस्टम को बंद कर रही हूँ

पहली बार में, आपको स्टैंडर्ड pinNeeded चैलेंज का जवाब देना चाहिए.

अनुरोध 1
{
  "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
  "inputs": [{
    "intent": "action.devices.EXECUTE",
    "payload": {
      "commands": [{
        "devices": [{
          "id": "123"
        }],
        "execution": [{
          "command": "action.devices.commands.ArmDisarm",
          "params": {
            "arm": true
          }
        }]
      }]
    }
  }]
}
जवाब
{
  "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
  "payload": {
    "commands": [{
      "ids": ["456"],
      "status": "ERROR",
      "errorCode": "challengeNeeded",
      "challengeNeeded": {
        "type": "pinNeeded"
      }
    }]
  }
}

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

अनुरोध 2
{
  "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
  "inputs": [{
    "intent": "action.devices.EXECUTE",
    "payload": {
      "commands": [{
        "devices": [...],
        "execution": [{
          "command": "action.devices.commands.ArmDisarm",
          "params": {
            "arm": true,
            "armLevel": "away"
          },
          "challenge": {
            "pin": "1234"
          }
        }]
      }]
    }
  }]
}
जवाब
{
  "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
  "payload": {
    "commands": [{
      "ids": ["456"],
      "status": "ERROR",
      "states": {
        "targetArmLevel": "away",
        "currentStatusReport": [{
            "blocking": true,
            "priority": 1,
            "deviceTarget": "front_window_id",
            "statusCode": "deviceOpen"
          },
          {
            "blocking": true,
            "priority": 1,
            "deviceTarget": "back_window_id",
            "statusCode": "deviceOpen"
          }
        ]
      },
      "errorCode": "challengeNeeded",
      "challengeNeeded": {
        "type": "ackNeeded"
      }
    }]
  }
}

Google की ओर से आपको किए गए बाद के अनुरोध में सिर्फ़ ack नतीजा होगा, न कि पहले मोड़ में दिया गया पिन.

अनुरोध 3
{
  "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
  "inputs": [{
    "intent": "action.devices.EXECUTE",
    "payload": {
      "commands": [{
        "devices": [...],
        "execution": [{
          "command": "action.devices.commands.ArmDisarm",
          "params": {
            "arm": true,
            "armLevel": "away"
          },
          "challenge": {
            "ack": true
          }
        }]
      }]
    }
  }]
}
जवाब
{
  "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
  "payload": {
    "commands": [
      {
        "ids": [
          "123"
        ],
        "status": "SUCCESS",
        "states": {
          "isArmed": true
        }
      }
    ]
  }
}