คู่มือระบบรักษาความปลอดภัยในบ้านอัจฉริยะ

action.devices.types.SECURITYSYSTEM - เปิดและปิดระบบรักษาความปลอดภัยได้ โดยสามารถเปิดใช้ได้ในระดับความปลอดภัยหลายระดับ (เช่น อยู่บ้านและไม่อยู่บ้าน) และสามารถรายงานข้อมูลเกี่ยวกับเซ็นเซอร์บางอย่าง เช่น เซ็นเซอร์ที่ตรวจจับการเคลื่อนไหวหรือหน้าต่างที่เปิดอยู่

ประเภทนี้บ่งบอกว่าอุปกรณ์จะได้รับไอคอนระบบรักษาความปลอดภัย รวมถึงคำพ้องความหมายและนามแฝงที่เกี่ยวข้องบางส่วน

ความสามารถของอุปกรณ์

โปรดดูรายละเอียดการใช้งานในเอกสารประกอบลักษณะที่เกี่ยวข้อง เช่น แอตทริบิวต์และสถานะที่บริการของคุณควรสนับสนุน รวมถึงวิธีสร้างการตอบกลับ EXECUTE และ QUERY

ลักษณะที่จำเป็น

คุณต้องระบุลักษณะและคำสั่งเหล่านี้หากอุปกรณ์ของคุณรองรับ หากอุปกรณ์ไม่รองรับลักษณะเหล่านี้ ให้ป้อนรหัสข้อผิดพลาดของ functionNotSupported ในการตอบกลับ QUERY หรือ EXECUTE ดูข้อมูลเพิ่มเติมได้ที่ ข้อผิดพลาดและข้อยกเว้น

ขอแนะนำให้ใช้ลักษณะเหล่านี้หากอุปกรณ์ของคุณรองรับ อย่างไรก็ตาม คุณสามารถผสมและจับคู่ลักษณะจากลักษณะทั้งหมดที่มีอยู่เพื่อให้ตรงกับฟังก์ชันการทำงานของผลิตภัณฑ์ที่มีอยู่มากที่สุด

ตัวอย่างอุปกรณ์: ระบบรักษาความปลอดภัยแบบง่าย

ส่วนนี้มีตัวอย่างเพย์โหลดของความตั้งใจที่แสดงถึง "ระบบรักษาความปลอดภัย" ทั่วไป ตามประเภทอุปกรณ์และลักษณะข้างต้น หากคุณเพิ่มหรือนำลักษณะในข้อมูลการใช้งานออก ให้แก้ไขการตอบกลับตามนั้นเพื่อให้สอดคล้องกับการเปลี่ยนแปลงเหล่านั้น

ตัวอย่างการตอบสนองการซิงค์

คำขอ
{
  "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ได้ คุณรายงานข้อยกเว้นได้ว่าเป็นการบล็อกหรือไม่บล็อก

  • ข้อยกเว้นที่ไม่บล็อกที่รายงานด้วยสถานะ "SUCCESS" แสดงว่า ข้อยกเว้นไม่ได้ป้องกันการติดอาวุธหรือปลดอาวุธ
  • ข้อยกเว้นการบล็อกที่รายงานด้วยสถานะ "EXCEPTIONS" แสดงว่าระบบหยุดการติดอาวุธ หรือปลดอาวุธเนื่องจากข้อยกเว้นเหล่านี้

รหัสข้อยกเว้นที่มักเชื่อมโยงกับระบบรักษาความปลอดภัย ได้แก่

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

การป้องกันด้วยการตรวจสอบสิทธิ์แบบ 2 ปัจจัย

หากขั้นตอนการติดอาวุธกำหนดให้ผู้ใช้ป้อน PIN ผ่านกล่องโต้ตอบการตรวจสอบสิทธิ์แบบ 2 ปัจจัย คุณต้องแจ้งให้ผู้ใช้ทราบว่าต้องการติดอาวุธระบบต่อไปหรือไม่เมื่อมีข้อยกเว้นที่ใช้งานอยู่ (เช่น เมื่อหน้าต่างหรือประตูเปิดอยู่)

สถานการณ์นี้อาจต้องใช้ทั้ง PIN หรือรหัสผ่าน ตามด้วยการรับทราบ

ตัวอย่าง: การยืนยันด้วยการรับทราบ

ตัวอย่างนี้แสดงผู้ใช้ที่พยายามเปิดระบบรักษาความปลอดภัย แต่ตรวจพบว่า ประตูหน้าเปิดอยู่ ผู้ใช้รับทราบว่าควรเปิดระบบรักษาความปลอดภัยแม้ว่าจะเปิดประตูหน้าก็ตาม

ผู้ใช้ เปิดระบบรักษาความปลอดภัย
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
          }
        }
      ]
    }
  }

ตัวอย่าง: ความท้าทายด้าน PIN และการรับทราบ

ตัวอย่างนี้แสดงผู้ใช้ที่พยายามเปิดระบบรักษาความปลอดภัยซึ่งต้องป้อน PIN ระบบตรวจพบว่าหน้าต่างด้านหน้าและด้านหลังเปิดอยู่ และขอให้ผู้ใช้รับทราบ ว่าควรดำเนินการติดอาวุธต่อไป

ผู้ใช้ เปิดระบบเป็นไม่อยู่บ้าน
Google Assistant PIN ของคุณคืออะไร
ผู้ใช้ 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 จะติดตามผลด้วยคำขอที่มี PIN ที่ระบุ หากต้องการรองรับ การกลับคำครั้งที่ 2 คุณควรตอบกลับด้วย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ผลลัพธ์ และไม่มี PIN ที่ระบุไว้ในรอบแรก

คำขอ 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
        }
      }
    ]
  }
}