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.innogysmarthome.internal.client.entity.capability;
  14
  15 /**
  16  * Defines the {@link CapabilityState}, that holds the state of a {@link Capability}, e.g. a temperature.
  17  *
  18  * @author Oliver Kuhl - Initial contribution
  19  */
  20 public class CapabilityState {
  21
  22     public static final String STATE_VALUE_OPERATION_MODE_AUTO = "Auto";
  23     public static final String STATE_VALUE_OPERATION_MODE_MANUAL = "Manu";
  24
  25     /**
  26      * id of the {@link Capability}
  27      */
  28     private String id;
  29
  30     /**
  31      * class containing all states
  32      */
  33     private State state;
  34
  35     /**
  36      * @return the id
  37      */
  38     public String getId() {
  39         return id;
  40     }
  41
  42     /**
  43      * @param id the id to set
  44      */
  45     public void setId(final String id) {
  46         this.id = id;
  47     }
  48
  49     /**
  50      * @return the state
  51      */
  52     public State getState() {
  53         return state;
  54     }
  55
  56     /**
  57      * @param state the state to set
  58      */
  59     public void setState(final State state) {
  60         this.state = state;
  61     }
  62
  63     public Boolean getVariableActuatorState() {
  64         return getState().getValueState().getValue();
  65     }
  66
  67     public void setVariableActuatorState(final Boolean on) {
  68         getState().getValueState().setValue(on);
  69     }
  70
  71     public Boolean getSwitchActuatorState() {
  72         return getState().getOnState().getValue();
  73     }
  74
  75     public void setSwitchActuatorState(final Boolean on) {
  76         getState().getOnState().setValue(on);
  77     }
  78
  79     public Double getTemperatureSensorTemperatureState() {
  80         return getState().getTemperatureState().getValue();
  81     }
  82
  83     public void setTemperatureSensorTemperatureState(final Double temperature) {
  84         getState().getTemperatureState().setValue(temperature);
  85     }
  86
  87     public Boolean getTemperatureSensorFrostWarningState() {
  88         return getState().getFrostWarningState().getValue();
  89     }
  90
  91     public void setTemperatureSensorFrostWarningState(final Boolean frostWarning) {
  92         getState().getFrostWarningState().setValue(frostWarning);
  93     }
  94
  95     public Double getThermostatActuatorPointTemperatureState() {
  96         return getState().getPointTemperatureState().getValue();
  97     }
  98
  99     public void setThermostatActuatorPointTemperatureState(final Double pointTemperature) {
 100         getState().getPointTemperatureState().setValue(pointTemperature);
 101     }
 102
 103     public String getThermostatActuatorOperationModeState() {
 104         return getState().getOperationModeState().getValue();
 105     }
 106
 107     public void setThermostatActuatorOperationModeState(final String operationMode) {
 108         getState().getOperationModeState()
 109                 .setValue(STATE_VALUE_OPERATION_MODE_MANUAL.equals(operationMode) ? STATE_VALUE_OPERATION_MODE_MANUAL
 110                         : STATE_VALUE_OPERATION_MODE_AUTO);
 111     }
 112
 113     public Boolean getThermostatActuatorWindowReductionActiveState() {
 114         return getState().getWindowReductionActiveState().getValue();
 115     }
 116
 117     public void setThermostatActuatorWindowReductionActiveState(final Boolean windowReductionActive) {
 118         getState().getWindowReductionActiveState().setValue(windowReductionActive);
 119     }
 120
 121     public Double getHumiditySensorHumidityState() {
 122         return getState().getHumidityState().getValue();
 123     }
 124
 125     public void setHumiditySensorHumidityState(final Double humidity) {
 126         getState().getHumidityState().setValue(humidity);
 127     }
 128
 129     public Boolean getHumiditySensorMoldWarningState() {
 130         return getState().getMoldWarningState().getValue();
 131     }
 132
 133     public void setHumiditySensorMoldWarningState(final Boolean moldWarning) {
 134         getState().getMoldWarningState().setValue(moldWarning);
 135     }
 136
 137     public Boolean getWindowDoorSensorState() {
 138         return getState().getIsOpenState().getValue();
 139     }
 140
 141     public void setWindowDoorSensorState(final Boolean open) {
 142         getState().getIsOpenState().setValue(open);
 143     }
 144
 145     public Boolean getSmokeDetectorSensorState() {
 146         return getState().getIsSmokeAlarmState().getValue();
 147     }
 148
 149     public void setSmokeDetectorSensorState(final Boolean on) {
 150         getState().getIsSmokeAlarmState().setValue(on);
 151     }
 152
 153     public Boolean getAlarmActuatorState() {
 154         return getState().getOnState().getValue();
 155     }
 156
 157     public void setAlarmActuatorState(final Boolean on) {
 158         getState().getOnState().setValue(on);
 159     }
 160
 161     public Integer getMotionDetectionSensorState() {
 162         return getState().getMotionDetectedCountState().getValue();
 163     }
 164
 165     public void setMotionDetectionSensorState(final Integer numberOfMotions) {
 166         getState().getMotionDetectedCountState().setValue(numberOfMotions);
 167     }
 168
 169     public Double getLuminanceSensorState() {
 170         return getState().getLuminanceState().getValue();
 171     }
 172
 173     public void setLuminanceSensorState(final Double luminance) {
 174         getState().getLuminanceState().setValue(luminance);
 175     }
 176
 177     public Integer getPushButtonSensorCounterState() {
 178         return getState().getLastKeyPressCounterState().getValue();
 179     }
 180
 181     public void setPushButtonSensorCounterState(final Integer numberOfPresses) {
 182         getState().getLastKeyPressCounterState().setValue(numberOfPresses);
 183     }
 184
 185     public Integer getPushButtonSensorButtonIndexState() {
 186         return getState().getLastPressedButtonIndex().getValue();
 187     }
 188
 189     public void setPushButtonSensorButtonIndexState(final Integer buttonIndex) {
 190         getState().getLastPressedButtonIndex().setValue(buttonIndex);
 191     }
 192
 193     public String getPushButtonSensorButtonIndexType() {
 194         return getState().getLastKeyPressType().getValue();
 195     }
 196
 197     public void setPushButtonSensorButtonIndexType(String lastKeyPressType) {
 198         getState().getLastKeyPressType().setValue(lastKeyPressType);
 199     }
 200
 201     public Integer getDimmerActuatorState() {
 202         return getState().getDimLevelState().getValue();
 203     }
 204
 205     public void setDimmerActuatorState(final Integer DimLevel) {
 206         getState().getDimLevelState().setValue(DimLevel);
 207     }
 208
 209     public Integer getRollerShutterActuatorState() {
 210         return getState().getShutterLevelState().getValue();
 211     }
 212
 213     public void setRollerShutterActuatorState(final Integer rollerShutterLevel) {
 214         getState().getShutterLevelState().setValue(rollerShutterLevel);
 215     }
 216
 217     // ENERGY CONSUMPTION SENSOR
 218     public Double getEnergyConsumptionSensorEnergyConsumptionMonthKWhState() {
 219         return getState().getEnergyConsumptionMonthKWhState().getValue();
 220     }
 221
 222     public void setEnergyConsumptionSensorEnergyConsumptionMonthKWhState(final Double state) {
 223         getState().getEnergyConsumptionMonthKWhState().setValue(state);
 224     }
 225
 226     public Double getEnergyConsumptionSensorAbsoluteEnergyConsumptionState() {
 227         return getState().getAbsoluteEnergyConsumptionState().getValue();
 228     }
 229
 230     public void setEnergyConsumptionSensorAbsoluteEnergyConsumptionState(final Double state) {
 231         getState().getAbsoluteEnergyConsumptionState().setValue(state);
 232     }
 233
 234     public Double getEnergyConsumptionSensorEnergyConsumptionMonthEuroState() {
 235         return getState().getEnergyConsumptionMonthEuroState().getValue();
 236     }
 237
 238     public void setEnergyConsumptionSensorEnergyConsumptionMonthEuroState(final Double state) {
 239         getState().getEnergyConsumptionMonthEuroState().setValue(state);
 240     }
 241
 242     public Double getEnergyConsumptionSensorEnergyConsumptionDayEuroState() {
 243         return getState().getEnergyConsumptionDayEuroState().getValue();
 244     }
 245
 246     public void setEnergyConsumptionSensorEnergyConsumptionDayEuroState(final Double state) {
 247         getState().getEnergyConsumptionDayEuroState().setValue(state);
 248     }
 249
 250     public Double getEnergyConsumptionSensorEnergyConsumptionDayKWhState() {
 251         return getState().getEnergyConsumptionDayKWhState().getValue();
 252     }
 253
 254     public void setEnergyConsumptionSensorEnergyConsumptionDayKWhState(final Double state) {
 255         getState().getEnergyConsumptionDayKWhState().setValue(state);
 256     }
 257
 258     // POWER CONSUMPTION SENSOR
 259     public Double getPowerConsumptionSensorPowerConsumptionWattState() {
 260         return getState().getPowerConsumptionWattState().getValue();
 261     }
 262
 263     public void setPowerConsumptionSensorPowerConsumptionWattState(final Double state) {
 264         getState().getPowerConsumptionWattState().setValue(state);
 265     }
 266
 267     // GENERATION METER ENGERY SENSOR
 268     public Double getGenerationMeterEnergySensorEnergyPerMonthInKWhState() {
 269         return getState().getEnergyPerMonthInKWhState().getValue();
 270     }
 271
 272     public void setGenerationMeterEnergySensorEnergyPerMonthInKWhState(final Double state) {
 273         getState().getEnergyPerMonthInKWhState().setValue(state);
 274     }
 275
 276     public Double getGenerationMeterEnergySensorTotalEnergyState() {
 277         return getState().getTotalEnergyState().getValue();
 278     }
 279
 280     public void setGenerationMeterEnergySensorTotalEnergyState(final Double state) {
 281         getState().getTotalEnergyState().setValue(state);
 282     }
 283
 284     public Double getGenerationMeterEnergySensorEnergyPerMonthInEuroState() {
 285         return getState().getEnergyPerMonthInEuroState().getValue();
 286     }
 287
 288     public void setGenerationMeterEnergySensorEnergyPerMonthInEuroState(final Double state) {
 289         getState().getEnergyPerMonthInEuroState().setValue(state);
 290     }
 291
 292     public Double getGenerationMeterEnergySensorEnergyPerDayInEuroState() {
 293         return getState().getEnergyPerDayInEuroState().getValue();
 294     }
 295
 296     public void setGenerationMeterEnergySensorEnergyPerDayInEuroState(final Double state) {
 297         getState().getEnergyPerDayInEuroState().setValue(state);
 298     }
 299
 300     public Double getGenerationMeterEnergySensorEnergyPerDayInKWhState() {
 301         return getState().getEnergyPerDayInKWhState().getValue();
 302     }
 303
 304     public void setGenerationMeterEnergySensorEnergyPerDayInKWhState(final Double state) {
 305         getState().getEnergyPerDayInKWhState().setValue(state);
 306     }
 307
 308     // GENERATION METER POWER CONSUMPTION SENSOR
 309     public Double getGenerationMeterPowerConsumptionSensorPowerInWattState() {
 310         return getState().getPowerInWattState().getValue();
 311     }
 312
 313     public void setGenerationMeterPowerConsumptionSensorPowerInWattState(final Double state) {
 314         getState().getPowerInWattState().setValue(state);
 315     }
 316
 317     // TWO WAY METER ENERGY CONSUMPTION SENSOR
 318     public Double getTwoWayMeterEnergyConsumptionSensorEnergyPerMonthInKWhState() {
 319         return getState().getEnergyPerMonthInKWhState().getValue();
 320     }
 321
 322     public void setTwoWayMeterEnergyConsumptionSensorEnergyPerMonthInKWhState(final Double state) {
 323         getState().getEnergyPerMonthInKWhState().setValue(state);
 324     }
 325
 326     public Double getTwoWayMeterEnergyConsumptionSensorTotalEnergyState() {
 327         return getState().getTotalEnergyState().getValue();
 328     }
 329
 330     public void setTwoWayMeterEnergyConsumptionSensorTotalEnergyState(final Double state) {
 331         getState().getTotalEnergyState().setValue(state);
 332     }
 333
 334     public Double getTwoWayMeterEnergyConsumptionSensorEnergyPerMonthInEuroState() {
 335         return getState().getEnergyPerMonthInEuroState().getValue();
 336     }
 337
 338     public void setTwoWayMeterEnergyConsumptionSensorEnergyPerMonthInEuroState(final Double state) {
 339         getState().getEnergyPerMonthInEuroState().setValue(state);
 340     }
 341
 342     public Double getTwoWayMeterEnergyConsumptionSensorEnergyPerDayInEuroState() {
 343         return getState().getEnergyPerDayInEuroState().getValue();
 344     }
 345
 346     public void setTwoWayMeterEnergyConsumptionSensorEnergyPerDayInEuroState(final Double state) {
 347         getState().getEnergyPerDayInEuroState().setValue(state);
 348     }
 349
 350     public Double getTwoWayMeterEnergyConsumptionSensorEnergyPerDayInKWhState() {
 351         return getState().getEnergyPerDayInKWhState().getValue();
 352     }
 353
 354     public void setTwoWayMeterEnergyConsumptionSensorEnergyPerDayInKWhState(final Double state) {
 355         getState().getEnergyPerDayInKWhState().setValue(state);
 356     }
 357
 358     // TWO WAY METER ENERGY FEED SENSOR
 359     public Double getTwoWayMeterEnergyFeedSensorEnergyPerMonthInKWhState() {
 360         return getState().getEnergyPerMonthInKWhState().getValue();
 361     }
 362
 363     public void setTwoWayMeterEnergyFeedSensorEnergyPerMonthInKWhState(final Double state) {
 364         getState().getEnergyPerMonthInKWhState().setValue(state);
 365     }
 366
 367     public Double getTwoWayMeterEnergyFeedSensorTotalEnergyState() {
 368         return getState().getTotalEnergyState().getValue();
 369     }
 370
 371     public void setTwoWayMeterEnergyFeedSensorTotalEnergyState(final Double state) {
 372         getState().getTotalEnergyState().setValue(state);
 373     }
 374
 375     public Double getTwoWayMeterEnergyFeedSensorEnergyPerMonthInEuroState() {
 376         return getState().getEnergyPerMonthInEuroState().getValue();
 377     }
 378
 379     public void setTwoWayMeterEnergyFeedSensorEnergyPerMonthInEuroState(final Double state) {
 380         getState().getEnergyPerMonthInEuroState().setValue(state);
 381     }
 382
 383     public Double getTwoWayMeterEnergyFeedSensorEnergyPerDayInEuroState() {
 384         return getState().getEnergyPerDayInEuroState().getValue();
 385     }
 386
 387     public void setTwoWayMeterEnergyFeedSensorEnergyPerDayInEuroState(final Double state) {
 388         getState().getEnergyPerDayInEuroState().setValue(state);
 389     }
 390
 391     public Double getTwoWayMeterEnergyFeedSensorEnergyPerDayInKWhState() {
 392         return getState().getEnergyPerDayInKWhState().getValue();
 393     }
 394
 395     public void setTwoWayMeterEnergyFeedSensorEnergyPerDayInKWhState(final Double state) {
 396         getState().getEnergyPerDayInKWhState().setValue(state);
 397     }
 398
 399     // TWO WAY METER POWER CONSUMPTION SENSOR
 400     public Double getTwoWayMeterPowerConsumptionSensorPowerInWattState() {
 401         return getState().getPowerInWattState().getValue();
 402     }
 403
 404     public void setTwoWayMeterPowerConsumptionSensorPowerInWattState(final Double state) {
 405         getState().getPowerInWattState().setValue(state);
 406     }
 407 }