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

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

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

डिवाइस की सुविधाएं

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

ज़रूरी विशेषताएं

अगर आपके डिवाइस पर ये लक्षण और निर्देश ज़रूरी हैं, तो ज़रूरी है. अगर आपके डिवाइस पर ये लक्षण काम नहीं करते हैं, तो 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"
        }
      }
    ]
  }
}

QUERY उत्तर का नमूना

अनुरोध करें
{
  "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": "EXCEPTIONS",
          "states": {
            "online": true,
            "isArmed": false,
            "currentArmLevel": "L2",
            "currentStatusReport": [
              {
                "blocking": true,
                "priority": 0,
                "statusCode": "windowOpen",
                "deviceTarget": "sensor_id1"
              }
            ]
          }
        }
      ]
    }
  }

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

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

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

उदाहरण: स्वीकार करने का चैलेंज

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

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

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

पहला अनुरोध
{
    "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 का नतीजा शामिल होगा.

दूसरा अनुरोध
{
    "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 से जुड़े स्टैंडर्ड चैलेंज का जवाब देना होगा.

पहला अनुरोध
{
  "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 चैलेंज का जवाब देना होगा. इसमें टारगेट ग्रुप का लेवल और ब्लॉक किए जा रहे अपवादों को शामिल करके, मौजूदा स्टेटस रिपोर्ट शामिल है.

दूसरा अनुरोध
{
  "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 नतीजा शामिल होगा. इसमें वह पिन नहीं दिया जाएगा जो पहली बार में दिया गया है.

तीसरा अनुरोध
{
  "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
        }
      }
    ]
  }
}