คู่มือระบบรักษาความปลอดภัยสมาร์ทโฮม

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

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

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

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

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

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

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

ข้อกำหนดด้านคุณภาพ

  • เวลาในการตอบสนอง: ต้องน้อยกว่าหรือเท่ากับ 2,000 มิลลิวินาที
  • ความเสถียร: ต้องมากกว่าหรือเท่ากับ 97%

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

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

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

คำขอ
{
  "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

ระบบปิดระบบ

ดูรายละเอียดเพิ่มเติมเกี่ยวกับพารามิเตอร์คำสั่งได้ที่ข้อมูลอ้างอิง 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 สามารถรายงานข้อยกเว้นว่าเป็นการบล็อกหรือแบบไม่บล็อกก็ได้

  • ข้อยกเว้นแบบไม่บล็อกที่รายงานที่มีสถานะ "สำเร็จ" ระบุว่าข้อยกเว้นไม่ได้ป้องกันการเปิดระบบหรือปิดระบบ
  • ข้อยกเว้นการบล็อกที่รายงานที่มีสถานะ "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": "SUCCESS",
        "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
        }
      }
    ]
  }
}