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

   1 /**
   2  * Copyright (c) 2010-2021 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.avmfritz.internal.dto;
  14
  15 import java.math.BigDecimal;
  16
  17 import javax.xml.bind.annotation.XmlAttribute;
  18 import javax.xml.bind.annotation.XmlElement;
  19
  20 /**
  21  * See {@link DeviceListModel}.
  22  *
  23  * In the functionbitmask element value the following bits are used:
  24  *
  25  * <ol>
  26  * <li>Bit 0: HAN-FUN Gerät</li>
  27  * <li>Bit 3: HAN-FUN Button - undocumented</li>
  28  * <li>Bit 4: Alarm-Sensor</li>
  29  * <li>Bit 5: AVM-Button</li>
  30  * <li>Bit 6: Comet DECT, Heizkörperregler</li>
  31  * <li>Bit 7: Energie Messgerät</li>
  32  * <li>Bit 8: Temperatursensor</li>
  33  * <li>Bit 9: Schaltsteckdose</li>
  34  * <li>Bit 10: AVM DECT Repeater</li>
  35  * <li>Bit 11: Mikrofon</li>
  36  * <li>Bit 13: HAN-FUN Unit</li>
  37  * </ol>
  38  *
  39  * @author Robert Bausdorf - Initial contribution
  40  * @author Christoph Weitkamp - Added support for AVM FRITZ!DECT 300 and Comet DECT
  41  * @author Christoph Weitkamp - Added support for groups
  42  * @author Ulrich Mertin - Added support for HAN-FUN blinds
  43  */
  44 public abstract class AVMFritzBaseModel implements BatteryModel {
  45     protected static final int HAN_FUN_DEVICE_BIT = 1; // Bit 0
  46     protected static final int HAN_FUN_BUTTON_BIT = 1 << 3; // Bit 3 - undocumented
  47     protected static final int HAN_FUN_ALARM_SENSOR_BIT = 1 << 4; // Bit 4
  48     protected static final int BUTTON_BIT = 1 << 5; // Bit 5
  49     protected static final int HEATING_THERMOSTAT_BIT = 1 << 6; // Bit 6
  50     protected static final int POWERMETER_BIT = 1 << 7; // Bit 7
  51     protected static final int TEMPERATURE_SENSOR_BIT = 1 << 8; // Bit 8
  52     protected static final int OUTLET_BIT = 1 << 9; // Bit 9
  53     protected static final int DECT_REPEATER_BIT = 1 << 10; // Bit 10
  54     protected static final int MICROPHONE_BIT = 1 << 11; // Bit 11
  55     protected static final int HAN_FUN_UNIT_BIT = 1 << 13; // Bit 13
  56     protected static final int HAN_FUN_BLINDS_BIT = 1 << 18; // Bit 18
  57     protected static final int HUMIDITY_SENSOR_BIT = 1 << 20; // Bit 20 - undocumented
  58
  59     @XmlAttribute(name = "identifier")
  60     private String ident;
  61
  62     @XmlAttribute(name = "id")
  63     private String deviceId;
  64
  65     @XmlAttribute(name = "functionbitmask")
  66     private int bitmask;
  67
  68     @XmlAttribute(name = "fwversion")
  69     private String firmwareVersion;
  70
  71     @XmlAttribute(name = "manufacturer")
  72     private String deviceManufacturer;
  73
  74     @XmlAttribute(name = "productname")
  75     private String productName;
  76
  77     @XmlElement(name = "present")
  78     private Integer present;
  79
  80     @XmlElement(name = "name")
  81     private String name;
  82
  83     @XmlElement(name = "battery")
  84     private BigDecimal battery;
  85
  86     @XmlElement(name = "batterylow")
  87     private BigDecimal batterylow;
  88
  89     @XmlElement(name = "switch")
  90     private SwitchModel switchModel;
  91
  92     @XmlElement(name = "powermeter")
  93     private PowerMeterModel powermeterModel;
  94
  95     @XmlElement(name = "hkr")
  96     private HeatingModel heatingModel;
  97
  98     public PowerMeterModel getPowermeter() {
  99         return powermeterModel;
 100     }
 101
 102     public void setPowermeter(PowerMeterModel powermeter) {
 103         this.powermeterModel = powermeter;
 104     }
 105
 106     public HeatingModel getHkr() {
 107         return heatingModel;
 108     }
 109
 110     public void setHkr(HeatingModel heatingModel) {
 111         this.heatingModel = heatingModel;
 112     }
 113
 114     public SwitchModel getSwitch() {
 115         return switchModel;
 116     }
 117
 118     public void setSwitch(SwitchModel switchModel) {
 119         this.switchModel = switchModel;
 120     }
 121
 122     public String getIdentifier() {
 123         return ident != null ? ident.replace(" ", "") : null;
 124     }
 125
 126     public void setIdentifier(String identifier) {
 127         this.ident = identifier;
 128     }
 129
 130     public String getDeviceId() {
 131         return deviceId;
 132     }
 133
 134     public boolean isHANFUNDevice() {
 135         return (bitmask & HAN_FUN_DEVICE_BIT) > 0;
 136     }
 137
 138     public boolean isHANFUNButton() {
 139         return (bitmask & HAN_FUN_BUTTON_BIT) > 0;
 140     }
 141
 142     public boolean isHANFUNAlarmSensor() {
 143         return (bitmask & HAN_FUN_ALARM_SENSOR_BIT) > 0;
 144     }
 145
 146     public boolean isButton() {
 147         return (bitmask & BUTTON_BIT) > 0;
 148     }
 149
 150     public boolean isSwitchableOutlet() {
 151         return (bitmask & OUTLET_BIT) > 0;
 152     }
 153
 154     public boolean isTempSensor() {
 155         return (bitmask & TEMPERATURE_SENSOR_BIT) > 0;
 156     }
 157
 158     public boolean isHumiditySensor() {
 159         return (bitmask & HUMIDITY_SENSOR_BIT) > 0;
 160     }
 161
 162     public boolean isPowermeter() {
 163         return (bitmask & POWERMETER_BIT) > 0;
 164     }
 165
 166     public boolean isDectRepeater() {
 167         return (bitmask & DECT_REPEATER_BIT) > 0;
 168     }
 169
 170     public boolean isHeatingThermostat() {
 171         return (bitmask & HEATING_THERMOSTAT_BIT) > 0;
 172     }
 173
 174     public boolean isMicrophone() {
 175         return (bitmask & MICROPHONE_BIT) > 0;
 176     }
 177
 178     public boolean isHANFUNUnit() {
 179         return (bitmask & HAN_FUN_UNIT_BIT) > 0;
 180     }
 181
 182     public boolean isHANFUNBlinds() {
 183         return (bitmask & HAN_FUN_BLINDS_BIT) > 0;
 184     }
 185
 186     public String getFirmwareVersion() {
 187         return firmwareVersion;
 188     }
 189
 190     public String getManufacturer() {
 191         return deviceManufacturer;
 192     }
 193
 194     public String getProductName() {
 195         return productName;
 196     }
 197
 198     public int getPresent() {
 199         return present;
 200     }
 201
 202     public String getName() {
 203         return name;
 204     }
 205
 206     @Override
 207     public BigDecimal getBattery() {
 208         return battery;
 209     }
 210
 211     @Override
 212     public BigDecimal getBatterylow() {
 213         return batterylow;
 214     }
 215
 216     @Override
 217     public String toString() {
 218         return new StringBuilder().append("[ain=").append(ident).append(",bitmask=").append(bitmask)
 219                 .append(",isHANFUNDevice=").append(isHANFUNDevice()).append(",isHANFUNButton=").append(isHANFUNButton())
 220                 .append(",isHANFUNAlarmSensor=").append(isHANFUNAlarmSensor()).append(",isButton=").append(isButton())
 221                 .append(",isSwitchableOutlet=").append(isSwitchableOutlet()).append(",isTempSensor=")
 222                 .append(isTempSensor()).append(",isHumiditySensor=").append(isHumiditySensor()).append(",isPowermeter=")
 223                 .append(isPowermeter()).append(",isDectRepeater=").append(isDectRepeater())
 224                 .append(",isHeatingThermostat=").append(isHeatingThermostat()).append(",isMicrophone=")
 225                 .append(isMicrophone()).append(",isHANFUNUnit=").append(isHANFUNUnit()).append(",isHANFUNBlind=")
 226                 .append(isHANFUNBlinds()).append(",id=").append(deviceId).append(",manufacturer=")
 227                 .append(deviceManufacturer).append(",productname=").append(productName).append(",fwversion=")
 228                 .append(firmwareVersion).append(",present=").append(present).append(",name=").append(name)
 229                 .append(",battery=").append(getBattery()).append(",batterylow=").append(getBatterylow()).append(",")
 230                 .append(getSwitch()).append(",").append(getPowermeter()).append(",").append(getHkr()).append(",")
 231                 .toString();
 232     }
 233 }