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

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

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

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

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

ज़रूरी ट्रेट

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

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

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

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

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

अनुरोध
{
  "requestId": "6894439706274654512",
  "inputs": [
    {
      "intent": "action.devices.SYNC"
    }
  ]
}
Response
{
  "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"
          }
        ]
      }
    }
  ]
}
Response
{
  "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"
                }
              }
            ]
          }
        ]
      }
    }
  ]
}
Response
{
  "requestId": "6894439706274654516",
  "payload": {
    "commands": [
      {
        "ids": [
          "123"
        ],
        "status": "SUCCESS",
        "states": {
          "online": true,
          "isArmed": true,
          "currentArmLevel": "away_key"
        }
      }
    ]
  }
}

डिवाइस से जुड़ी गड़बड़ियां

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

हथियार चलाने की अनुमति से जुड़ी शर्तों के उल्लंघन की शिकायत करना

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

  • "SUCCESS" स्टेटस के साथ रिपोर्ट किए गए नॉन-ब्लॉकिंग अपवादों से पता चलता है कि अपवाद की वजह से, अलार्म चालू या बंद नहीं हुआ.
  • "EXCEPTIONS" स्टेटस के साथ रिपोर्ट किए गए ब्लॉक करने से जुड़े अपवादों से पता चलता है कि इन अपवादों की वजह से, आर्मिंग या डिसआर्मिंग बंद कर दी गई थी.

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

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

उदाहरण: नॉन-ब्लॉकिंग अपवाद

इस उदाहरण में, ऐसी स्थिति दिखाई गई है जिसमें सुरक्षा सिस्टम चालू है. हालांकि, एक खिड़की खुली होने की सूचना मिली है.

उपयोगकर्ता सुरक्षा सिस्टम को हाई सिक्योरिटी पर सेट करो.
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"
            }
          }]
        }]
      }
    }]
  }
Response
{
    "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"
            }
          }]
        }]
      }
    }]
  }
Response 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
            }
          }]
        }]
      }
    }]
  }
Response 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
            }
          }]
        }]
      }
    }]
  }
Response
{
    "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
          }
        }]
      }]
    }
  }]
}
Response
{
  "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"
          }
        }]
      }]
    }
  }]
}
Response
{
  "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 नतीजा होगा. इसमें पहली बार में दिया गया पिन शामिल नहीं होगा.

Request 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
          }
        }]
      }]
    }
  }]
}
Response
{
  "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
  "payload": {
    "commands": [
      {
        "ids": [
          "123"
        ],
        "status": "SUCCESS",
        "states": {
          "isArmed": true
        }
      }
    ]
  }
}