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

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

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

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

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

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

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

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

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

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

रिपोर्टिंग के लिए, ट्रिगर करने से जुड़े अपवाद

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

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

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

  • 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"
            }
          }]
        }]
      }
    }]
  }
दूसरा जवाब
{
    "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
            }
          }]
        }]
      }
    }]
  }
दूसरा जवाब
{
    "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
        }
      }
    ]
  }
}