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