2 * Copyright (c) 2010-2024 Contributors to the openHAB project
4 * See the NOTICE file(s) distributed with this work for additional
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
11 * SPDX-License-Identifier: EPL-2.0
13 package org.openhab.binding.livisismarthome.internal.client.api.entity.capability;
16 * Defines the {@link CapabilityStateDTO}, that holds the state of a {@link CapabilityDTO}, e.g. a temperature.
18 * @author Oliver Kuhl - Initial contribution
20 public class CapabilityStateDTO {
22 public static final String STATE_VALUE_OPERATION_MODE_AUTO = "Auto";
23 public static final String STATE_VALUE_OPERATION_MODE_MANUAL = "Manu";
26 * id of the {@link CapabilityDTO}
31 * class containing all states
33 private StateDTO state;
35 public CapabilityStateDTO() {
36 state = new StateDTO();
42 public String getId() {
47 * @param id the id to set
49 public void setId(final String id) {
56 public StateDTO getState() {
61 * @param state the state to set
63 public void setState(final StateDTO state) {
67 public Boolean getVariableActuatorState() {
68 return getState().getValueState().getValue();
71 public void setVariableActuatorState(final Boolean on) {
72 getState().getValueState().setValue(on);
75 public Boolean getSwitchActuatorState() {
76 return getState().getOnState().getValue();
79 public void setSwitchActuatorState(final Boolean on) {
80 getState().getOnState().setValue(on);
83 public Double getTemperatureSensorTemperatureState() {
84 return getState().getTemperatureState().getValue();
87 public void setTemperatureSensorTemperatureState(final Double temperature) {
88 getState().getTemperatureState().setValue(temperature);
91 public Boolean getTemperatureSensorFrostWarningState() {
92 return getState().getFrostWarningState().getValue();
95 public void setTemperatureSensorFrostWarningState(final Boolean frostWarning) {
96 getState().getFrostWarningState().setValue(frostWarning);
99 public Double getThermostatActuatorPointTemperatureState() {
100 return getState().getPointTemperatureState().getValue();
103 public void setThermostatActuatorPointTemperatureState(final Double pointTemperature) {
104 getState().getPointTemperatureState().setValue(pointTemperature);
107 public String getThermostatActuatorOperationModeState() {
108 return getState().getOperationModeState().getValue();
111 public void setThermostatActuatorOperationModeState(final String operationMode) {
112 if (STATE_VALUE_OPERATION_MODE_MANUAL.equals(operationMode)) {
113 getState().getOperationModeState().setValue(STATE_VALUE_OPERATION_MODE_MANUAL);
115 getState().getOperationModeState().setValue(STATE_VALUE_OPERATION_MODE_AUTO);
119 public Boolean getThermostatActuatorWindowReductionActiveState() {
120 return getState().getWindowReductionActiveState().getValue();
123 public void setThermostatActuatorWindowReductionActiveState(final Boolean windowReductionActive) {
124 getState().getWindowReductionActiveState().setValue(windowReductionActive);
127 public Double getHumiditySensorHumidityState() {
128 return getState().getHumidityState().getValue();
131 public void setHumiditySensorHumidityState(final Double humidity) {
132 getState().getHumidityState().setValue(humidity);
135 public Boolean getHumiditySensorMoldWarningState() {
136 return getState().getMoldWarningState().getValue();
139 public void setHumiditySensorMoldWarningState(final Boolean moldWarning) {
140 getState().getMoldWarningState().setValue(moldWarning);
143 public Boolean getWindowDoorSensorState() {
144 return getState().getIsOpenState().getValue();
147 public void setWindowDoorSensorState(final Boolean open) {
148 getState().getIsOpenState().setValue(open);
151 public Boolean getSmokeDetectorSensorState() {
152 return getState().getIsSmokeAlarmState().getValue();
155 public void setSmokeDetectorSensorState(final Boolean on) {
156 getState().getIsSmokeAlarmState().setValue(on);
159 public Boolean getAlarmActuatorState() {
160 return getState().getOnState().getValue();
163 public void setAlarmActuatorState(final Boolean on) {
164 getState().getOnState().setValue(on);
167 public Integer getMotionDetectionSensorState() {
168 return getState().getMotionDetectedCountState().getValue();
171 public void setMotionDetectionSensorState(final Integer numberOfMotions) {
172 getState().getMotionDetectedCountState().setValue(numberOfMotions);
175 public Double getLuminanceSensorState() {
176 return getState().getLuminanceState().getValue();
179 public void setLuminanceSensorState(final Double luminance) {
180 getState().getLuminanceState().setValue(luminance);
183 public Integer getPushButtonSensorCounterState() {
184 return getState().getLastKeyPressCounterState().getValue();
187 public void setPushButtonSensorCounterState(final Integer numberOfPresses) {
188 getState().getLastKeyPressCounterState().setValue(numberOfPresses);
191 public Integer getPushButtonSensorButtonIndexState() {
192 return getState().getLastPressedButtonIndex().getValue();
195 public void setPushButtonSensorButtonIndexState(final Integer buttonIndex) {
196 getState().getLastPressedButtonIndex().setValue(buttonIndex);
199 public String getPushButtonSensorButtonIndexType() {
200 return getState().getLastKeyPressType().getValue();
203 public void setPushButtonSensorButtonIndexType(String lastKeyPressType) {
204 getState().getLastKeyPressType().setValue(lastKeyPressType);
207 public Integer getDimmerActuatorState() {
208 return getState().getDimLevelState().getValue();
211 public void setDimmerActuatorState(final Integer DimLevel) {
212 getState().getDimLevelState().setValue(DimLevel);
215 public Integer getRollerShutterActuatorState() {
216 return getState().getShutterLevelState().getValue();
219 public void setRollerShutterActuatorState(final Integer rollerShutterLevel) {
220 getState().getShutterLevelState().setValue(rollerShutterLevel);
223 // ENERGY CONSUMPTION SENSOR
224 public Double getEnergyConsumptionSensorEnergyConsumptionMonthKWhState() {
225 return getState().getEnergyConsumptionMonthKWhState().getValue();
228 public void setEnergyConsumptionSensorEnergyConsumptionMonthKWhState(final Double state) {
229 getState().getEnergyConsumptionMonthKWhState().setValue(state);
232 public Double getEnergyConsumptionSensorAbsoluteEnergyConsumptionState() {
233 return getState().getAbsoluteEnergyConsumptionState().getValue();
236 public void setEnergyConsumptionSensorAbsoluteEnergyConsumptionState(final Double state) {
237 getState().getAbsoluteEnergyConsumptionState().setValue(state);
240 public Double getEnergyConsumptionSensorEnergyConsumptionMonthEuroState() {
241 return getState().getEnergyConsumptionMonthEuroState().getValue();
244 public void setEnergyConsumptionSensorEnergyConsumptionMonthEuroState(final Double state) {
245 getState().getEnergyConsumptionMonthEuroState().setValue(state);
248 public Double getEnergyConsumptionSensorEnergyConsumptionDayEuroState() {
249 return getState().getEnergyConsumptionDayEuroState().getValue();
252 public void setEnergyConsumptionSensorEnergyConsumptionDayEuroState(final Double state) {
253 getState().getEnergyConsumptionDayEuroState().setValue(state);
256 public Double getEnergyConsumptionSensorEnergyConsumptionDayKWhState() {
257 return getState().getEnergyConsumptionDayKWhState().getValue();
260 public void setEnergyConsumptionSensorEnergyConsumptionDayKWhState(final Double state) {
261 getState().getEnergyConsumptionDayKWhState().setValue(state);
264 // POWER CONSUMPTION SENSOR
265 public Double getPowerConsumptionSensorPowerConsumptionWattState() {
266 return getState().getPowerConsumptionWattState().getValue();
269 public void setPowerConsumptionSensorPowerConsumptionWattState(final Double state) {
270 getState().getPowerConsumptionWattState().setValue(state);
273 // GENERATION METER ENGERY SENSOR
274 public Double getGenerationMeterEnergySensorEnergyPerMonthInKWhState() {
275 return getState().getEnergyPerMonthInKWhState().getValue();
278 public void setGenerationMeterEnergySensorEnergyPerMonthInKWhState(final Double state) {
279 getState().getEnergyPerMonthInKWhState().setValue(state);
282 public Double getGenerationMeterEnergySensorTotalEnergyState() {
283 return getState().getTotalEnergyState().getValue();
286 public void setGenerationMeterEnergySensorTotalEnergyState(final Double state) {
287 getState().getTotalEnergyState().setValue(state);
290 public Double getGenerationMeterEnergySensorEnergyPerMonthInEuroState() {
291 return getState().getEnergyPerMonthInEuroState().getValue();
294 public void setGenerationMeterEnergySensorEnergyPerMonthInEuroState(final Double state) {
295 getState().getEnergyPerMonthInEuroState().setValue(state);
298 public Double getGenerationMeterEnergySensorEnergyPerDayInEuroState() {
299 return getState().getEnergyPerDayInEuroState().getValue();
302 public void setGenerationMeterEnergySensorEnergyPerDayInEuroState(final Double state) {
303 getState().getEnergyPerDayInEuroState().setValue(state);
306 public Double getGenerationMeterEnergySensorEnergyPerDayInKWhState() {
307 return getState().getEnergyPerDayInKWhState().getValue();
310 public void setGenerationMeterEnergySensorEnergyPerDayInKWhState(final Double state) {
311 getState().getEnergyPerDayInKWhState().setValue(state);
314 // GENERATION METER POWER CONSUMPTION SENSOR
315 public Double getGenerationMeterPowerConsumptionSensorPowerInWattState() {
316 return getState().getPowerInWattState().getValue();
319 public void setGenerationMeterPowerConsumptionSensorPowerInWattState(final Double state) {
320 getState().getPowerInWattState().setValue(state);
323 // TWO WAY METER ENERGY CONSUMPTION SENSOR
324 public Double getTwoWayMeterEnergyConsumptionSensorEnergyPerMonthInKWhState() {
325 return getState().getEnergyPerMonthInKWhState().getValue();
328 public void setTwoWayMeterEnergyConsumptionSensorEnergyPerMonthInKWhState(final Double state) {
329 getState().getEnergyPerMonthInKWhState().setValue(state);
332 public Double getTwoWayMeterEnergyConsumptionSensorTotalEnergyState() {
333 return getState().getTotalEnergyState().getValue();
336 public void setTwoWayMeterEnergyConsumptionSensorTotalEnergyState(final Double state) {
337 getState().getTotalEnergyState().setValue(state);
340 public Double getTwoWayMeterEnergyConsumptionSensorEnergyPerMonthInEuroState() {
341 return getState().getEnergyPerMonthInEuroState().getValue();
344 public void setTwoWayMeterEnergyConsumptionSensorEnergyPerMonthInEuroState(final Double state) {
345 getState().getEnergyPerMonthInEuroState().setValue(state);
348 public Double getTwoWayMeterEnergyConsumptionSensorEnergyPerDayInEuroState() {
349 return getState().getEnergyPerDayInEuroState().getValue();
352 public void setTwoWayMeterEnergyConsumptionSensorEnergyPerDayInEuroState(final Double state) {
353 getState().getEnergyPerDayInEuroState().setValue(state);
356 public Double getTwoWayMeterEnergyConsumptionSensorEnergyPerDayInKWhState() {
357 return getState().getEnergyPerDayInKWhState().getValue();
360 public void setTwoWayMeterEnergyConsumptionSensorEnergyPerDayInKWhState(final Double state) {
361 getState().getEnergyPerDayInKWhState().setValue(state);
364 // TWO WAY METER ENERGY FEED SENSOR
365 public Double getTwoWayMeterEnergyFeedSensorEnergyPerMonthInKWhState() {
366 return getState().getEnergyPerMonthInKWhState().getValue();
369 public void setTwoWayMeterEnergyFeedSensorEnergyPerMonthInKWhState(final Double state) {
370 getState().getEnergyPerMonthInKWhState().setValue(state);
373 public Double getTwoWayMeterEnergyFeedSensorTotalEnergyState() {
374 return getState().getTotalEnergyState().getValue();
377 public void setTwoWayMeterEnergyFeedSensorTotalEnergyState(final Double state) {
378 getState().getTotalEnergyState().setValue(state);
381 public Double getTwoWayMeterEnergyFeedSensorEnergyPerMonthInEuroState() {
382 return getState().getEnergyPerMonthInEuroState().getValue();
385 public void setTwoWayMeterEnergyFeedSensorEnergyPerMonthInEuroState(final Double state) {
386 getState().getEnergyPerMonthInEuroState().setValue(state);
389 public Double getTwoWayMeterEnergyFeedSensorEnergyPerDayInEuroState() {
390 return getState().getEnergyPerDayInEuroState().getValue();
393 public void setTwoWayMeterEnergyFeedSensorEnergyPerDayInEuroState(final Double state) {
394 getState().getEnergyPerDayInEuroState().setValue(state);
397 public Double getTwoWayMeterEnergyFeedSensorEnergyPerDayInKWhState() {
398 return getState().getEnergyPerDayInKWhState().getValue();
401 public void setTwoWayMeterEnergyFeedSensorEnergyPerDayInKWhState(final Double state) {
402 getState().getEnergyPerDayInKWhState().setValue(state);
405 // TWO WAY METER POWER CONSUMPTION SENSOR
406 public Double getTwoWayMeterPowerConsumptionSensorPowerInWattState() {
407 return getState().getPowerInWattState().getValue();
410 public void setTwoWayMeterPowerConsumptionSensorPowerInWattState(final Double state) {
411 getState().getPowerInWattState().setValue(state);