[openhab-addons.git] /

/**
 * Copyright (c) 2010-2023 Contributors to the openHAB project
 *
 * See the NOTICE file(s) distributed with this work for additional
 * information.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0
 *
 * SPDX-License-Identifier: EPL-2.0
 */
package org.openhab.binding.plugwiseha.internal.api.model.dto;

import java.time.ZonedDateTime;
import java.util.Optional;

import com.thoughtworks.xstream.annotations.XStreamAlias;
import com.thoughtworks.xstream.annotations.XStreamImplicit;

/**
 * The {@link Appliance} class is an object model class that
 * mirrors the XML structure provided by the Plugwise Home Automation
 * controller for a Plugwise appliance.
 * It implements the {@link PlugwiseComparableDate} interface and
 * extends the abstract class {@link PlugwiseBaseModel}.
 * 
 * @author B. van Wetten - Initial contribution
 * @author Leo Siepel - finish initial contribution
 */
@XStreamAlias("appliance")
public class Appliance extends PlugwiseBaseModel implements PlugwiseComparableDate<Appliance> {

    private String name;
    private String description;
    private String type;
    private String location;

    @XStreamAlias("module")
    private Module module;

    @XStreamAlias("zig_bee_node")
    private ZigBeeNode zigbeeNode;

    @XStreamImplicit(itemFieldName = "point_log", keyFieldName = "type")
    private Logs pointLogs;

    @XStreamImplicit(itemFieldName = "actuator_functionality", keyFieldName = "type")
    private ActuatorFunctionalities actuatorFunctionalities;

    public String getName() {
        return name;
    }

    public String getDescription() {
        return description;
    }

    public String getType() {
        return type;
    }

    public String getLocation() {
        return location;
    }

    public ZigBeeNode getZigbeeNode() {
        if (zigbeeNode == null) {
            zigbeeNode = new ZigBeeNode();
        }
        return zigbeeNode;
    }

    public Module getModule() {
        if (module == null) {
            module = new Module();
        }
        return module;
    }

    public Logs getPointLogs() {
        if (pointLogs == null) {
            pointLogs = new Logs();
        }
        return pointLogs;
    }

    public ActuatorFunctionalities getActuatorFunctionalities() {
        if (actuatorFunctionalities == null) {
            actuatorFunctionalities = new ActuatorFunctionalities();
        }
        return actuatorFunctionalities;
    }

    public Optional<Double> getTemperature() {
        return this.pointLogs.getTemperature();
    }

    public Optional<String> getTemperatureUnit() {
        return this.pointLogs.getTemperatureUnit();
    }

    public Optional<Double> getSetpointTemperature() {
        return this.pointLogs.getThermostatTemperature();
    }

    public Optional<String> getSetpointTemperatureUnit() {
        return this.pointLogs.getThermostatTemperatureUnit();
    }

    public Optional<Double> getOffsetTemperature() {
        return this.pointLogs.getOffsetTemperature();
    }

    public Optional<String> getOffsetTemperatureUnit() {
        return this.pointLogs.getOffsetTemperatureUnit();
    }

    public Optional<Boolean> getRelayState() {
        return this.pointLogs.getRelayState();
    }

    public Optional<Boolean> getRelayLockState() {
        return this.actuatorFunctionalities.getRelayLockState();
    }

    public Optional<Double> getBatteryLevel() {
        return this.pointLogs.getBatteryLevel();
    }

    public Optional<Double> getPowerUsage() {
        return this.pointLogs.getPowerUsage();
    }

    public Optional<Double> getValvePosition() {
        return this.pointLogs.getValvePosition();
    }

    public Optional<Double> getWaterPressure() {
        return this.pointLogs.getWaterPressure();
    }

    public Optional<Boolean> getCHState() {
        return this.pointLogs.getCHState();
    }

    public Optional<Boolean> getCoolingState() {
        return this.pointLogs.getCoolingState();
    }

    public Optional<Double> getIntendedBoilerTemp() {
        return this.pointLogs.getIntendedBoilerTemp();
    }

    public Optional<String> getIntendedBoilerTempUnit() {
        return this.pointLogs.getIntendedBoilerTempUnit();
    }

    public Optional<Double> getReturnWaterTemp() {
        return this.pointLogs.getReturnWaterTemp();
    }

    public Optional<String> getReturnWaterTempUnit() {
        return this.pointLogs.getReturnWaterTempUnit();
    }

    public Optional<Boolean> getFlameState() {
        return this.pointLogs.getFlameState();
    }

    public Optional<Boolean> getIntendedHeatingState() {
        return this.pointLogs.getIntendedHeatingState();
    }

    public Optional<Double> getModulationLevel() {
        return this.pointLogs.getModulationLevel();
    }

    public Optional<Double> getOTAppFaultCode() {
        return this.pointLogs.getOTAppFaultCode();
    }

    public Optional<Double> getDHWTemp() {
        return this.pointLogs.getDHWTemp();
    }

    public Optional<String> getDHWTempUnit() {
        return this.pointLogs.getDHWTempUnit();
    }

    public Optional<Double> getOTOEMFaultcode() {
        return this.pointLogs.getOTOEMFaultcode();
    }

    public Optional<Double> getBoilerTemp() {
        return this.pointLogs.getBoilerTemp();
    }

    public Optional<String> getBoilerTempUnit() {
        return this.pointLogs.getBoilerTempUnit();
    }

    public Optional<Double> getDHTSetpoint() {
        return this.pointLogs.getDHTSetpoint();
    }

    public Optional<String> getDHTSetpointUnit() {
        return this.pointLogs.getDHTSetpointUnit();
    }

    public Optional<Double> getMaxBoilerTemp() {
        return this.pointLogs.getMaxBoilerTemp();
    }

    public Optional<String> getMaxBoilerTempUnit() {
        return this.pointLogs.getMaxBoilerTempUnit();
    }

    public Optional<Boolean> getDHWComfortMode() {
        return this.pointLogs.getDHWComfortMode();
    }

    public Optional<Boolean> getDHWState() {
        return this.pointLogs.getDHWState();
    }

    public boolean isZigbeeDevice() {
        return (this.zigbeeNode instanceof ZigBeeNode);
    }

    public boolean isBatteryOperated() {
        if (this.zigbeeNode instanceof ZigBeeNode) {
            return "battery".equals(this.zigbeeNode.getPowerSource()) && this.getBatteryLevel().isPresent();
        } else {
            return false;
        }
    }

    @Override
    public int compareDateWith(Appliance compareTo) {
        if (compareTo == null) {
            return -1;
        }
        ZonedDateTime compareToDate = compareTo.getModifiedDate();
        ZonedDateTime compareFromDate = this.getModifiedDate();
        if (compareFromDate == null) {
            return -1;
        } else if (compareToDate == null) {
            return 1;
        } else {
            return compareFromDate.compareTo(compareToDate);
        }
    }

    @Override
    public boolean isNewerThan(Appliance hasModifiedDate) {
        return compareDateWith(hasModifiedDate) > 0;
    }

    @Override
    public boolean isOlderThan(Appliance hasModifiedDate) {
        return compareDateWith(hasModifiedDate) < 0;
    }
}