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  * Represents the state of the intrusion detection system as reported by the Bosch Smart Home Controller.
  19  * <p>
  20  * Example data:
  21  *
  22  * <pre>
  23  * {
  24  *     "@type": "systemState",
  25  *     "systemAvailability": {
  26  *         "@type": "systemAvailabilityState",
  27  *         "available": true,
  28  *         "deleted": false
  29  *     },
  30  *     "armingState": {
  31  *         "@type": "armingState",
  32  *         "state": "SYSTEM_DISARMED",
  33  *         "deleted": false
  34  *     },
  35  *     "alarmState": {
  36  *         "@type": "alarmState",
  37  *         "value": "ALARM_OFF",
  38  *         "incidents": [],
  39  *         "deleted": false
  40  *     },
  41  *     "activeConfigurationProfile": {
  42  *         "@type": "activeConfigurationProfile",
  43  *         "deleted": false
  44  *     },
  45  *     "securityGapState": {
  46  *         "@type": "securityGapState",
  47  *         "securityGaps": [],
  48  *         "deleted": false
  49  *     },
  50  *     "deleted": false
  51  * }
  52  * </pre>
  53  *
  54  * @author David Pace - Initial contribution
  55  *
  56  */
  57 public class IntrusionDetectionSystemState extends BoschSHCServiceState {
  58
  59     public IntrusionDetectionSystemState() {
  60         super("systemState");
  61     }
  62
  63     public SystemAvailabilityStateData systemAvailability;
  64
  65     public ArmingStateData armingState;
  66
  67     public AlarmStateData alarmState;
  68
  69     public ActiveConfigurationProfileData activeConfigurationProfile;
  70 }