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