git.basschouten.com Git - openhab-addons.git/blob

   1 /**
   2  * Copyright (c) 2010-2023 Contributors to the openHAB project
   3  *
   4  * See the NOTICE file(s) distributed with this work for additional
   5  * information.
   6  *
   7  * This program and the accompanying materials are made available under the
   8  * terms of the Eclipse Public License 2.0 which is available at
   9  * http://www.eclipse.org/legal/epl-2.0
  10  *
  11  * SPDX-License-Identifier: EPL-2.0
  12  */
  13 package org.openhab.binding.boschshc.internal.services.intrusion.dto;
  14
  15 import org.openhab.binding.boschshc.internal.services.dto.BoschSHCServiceState;
  16
  17 /**
  18  * A state containing information about intrusion detection events.
  19  * <p>
  20  * Example data:
  21  *
  22  * <pre>
  23  * {
  24  *   "@type": "surveillanceAlarmState",
  25  *   "incidents": [
  26  *     {
  27  *       "triggerName": "Motion Detector",
  28  *       "locationId": "hz_5",
  29  *       "location": "Living Room",
  30  *       "id": "hdm:ZigBee:000d6f0012f02342",
  31  *       "time": 1652615755336,
  32  *       "type": "INTRUSION"
  33  *     }
  34  *   ],
  35  *   "value": "ALARM_ON"
  36  * }
  37  * </pre>
  38  *
  39  * <p>
  40  * <b>Note:</b> This state is not documented in the official Bosch API docs.
  41  * The type of the incidents seems to be very similar to <code>IncidentType</code> documented for
  42  * the system state. However, the type enum seems to be slightly different (<code>INTRUSION</code> instead of
  43  * <code>INTRUSION_DETECTED</code>).
  44  * For this reason incidents are not modeled in this state object for now.
  45  *
  46  * @author David Pace - Initial contribution
  47  *
  48  */
  49 public class SurveillanceAlarmState extends BoschSHCServiceState {
  50
  51     public SurveillanceAlarmState() {
  52         super("surveillanceAlarmState");
  53     }
  54
  55     public AlarmState value;
  56 }