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

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

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

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

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

ज़रूरी traits

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

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

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

  • इंतज़ार का समय: 2000 मि.से. या इससे कम होना चाहिए.
  • विश्वसनीयता: 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
        }
      }
    ]
  }
}