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.regoheatpump.internal.rego6xx;
  14
  15 import static org.openhab.binding.regoheatpump.internal.RegoHeatPumpBindingConstants.*;
  16
  17 import java.util.HashMap;
  18 import java.util.Map;
  19
  20 import javax.measure.Unit;
  21
  22 import org.eclipse.jdt.annotation.NonNullByDefault;
  23 import org.eclipse.jdt.annotation.Nullable;
  24 import org.openhab.core.library.unit.SIUnits;
  25 import org.openhab.core.library.unit.Units;
  26
  27 /**
  28  * The {@link RegoRegisterMapper} is responsible for mapping rego 6xx registers into channels.
  29  *
  30  * @author Boris Krivonog - Initial contribution
  31  */
  32 @NonNullByDefault
  33 public class RegoRegisterMapper {
  34     public static final RegoRegisterMapper REGO600;
  35
  36     public static interface Channel {
  37         public short address();
  38
  39         public double scaleFactor();
  40
  41         public @Nullable Unit<?> unit();
  42
  43         public int convertValue(short value);
  44     }
  45
  46     private static class ChannelFactory {
  47         private static class ChannelImpl implements Channel {
  48             private final short address;
  49             private final double scaleFactor;
  50             private @Nullable final Unit<?> unit;
  51
  52             private ChannelImpl(short address, double scaleFactor, @Nullable Unit<?> unit) {
  53                 this.address = address;
  54                 this.scaleFactor = scaleFactor;
  55                 this.unit = unit;
  56             }
  57
  58             @Override
  59             public short address() {
  60                 return address;
  61             }
  62
  63             @Override
  64             public double scaleFactor() {
  65                 return scaleFactor;
  66             }
  67
  68             @Override
  69             public @Nullable Unit<?> unit() {
  70                 return unit;
  71             }
  72
  73             @Override
  74             public int convertValue(short value) {
  75                 return value;
  76             }
  77         }
  78
  79         private ChannelFactory() {
  80         }
  81
  82         static Channel temperature(short address) {
  83             return new ChannelImpl(address, 0.1, SIUnits.CELSIUS);
  84         }
  85
  86         static Channel hours(short address) {
  87             return new ChannelImpl(address, 1, Units.HOUR) {
  88                 @Override
  89                 public int convertValue(short value) {
  90                     return Short.toUnsignedInt(value);
  91                 }
  92             };
  93         }
  94
  95         static Channel percent(short address) {
  96             return new ChannelImpl(address, 0.1, Units.PERCENT);
  97         }
  98
  99         static Channel unitless(short address, double scaleFactor) {
 100             return new ChannelImpl(address, scaleFactor, null);
 101         }
 102     }
 103
 104     private final Map<String, Channel> mappings;
 105
 106     private RegoRegisterMapper(Map<String, Channel> mappings) {
 107         this.mappings = mappings;
 108     }
 109
 110     public @Nullable Channel map(String channelIID) {
 111         return mappings.get(channelIID);
 112     }
 113
 114     static {
 115         final Map<String, Channel> mappings = new HashMap<>();
 116         {
 117             // Sensor values
 118             mappings.put(CHANNEL_GROUP_SENSOR_VALUES + "radiatorReturn", ChannelFactory.temperature((short) 521));
 119             mappings.put(CHANNEL_GROUP_SENSOR_VALUES + "outdoor", ChannelFactory.temperature((short) 522));
 120             mappings.put(CHANNEL_GROUP_SENSOR_VALUES + "hotWater", ChannelFactory.temperature((short) 523));
 121             mappings.put(CHANNEL_GROUP_SENSOR_VALUES + "radiatorForward", ChannelFactory.temperature((short) 524));
 122             mappings.put(CHANNEL_GROUP_SENSOR_VALUES + "indoor", ChannelFactory.temperature((short) 525));
 123             mappings.put(CHANNEL_GROUP_SENSOR_VALUES + "compressor", ChannelFactory.temperature((short) 526));
 124             mappings.put(CHANNEL_GROUP_SENSOR_VALUES + "heatFluidOut", ChannelFactory.temperature((short) 527));
 125             mappings.put(CHANNEL_GROUP_SENSOR_VALUES + "heatFluidIn", ChannelFactory.temperature((short) 528));
 126             mappings.put(CHANNEL_GROUP_SENSOR_VALUES + "coldFluidIn", ChannelFactory.temperature((short) 529));
 127             mappings.put(CHANNEL_GROUP_SENSOR_VALUES + "coldFluidOut", ChannelFactory.temperature((short) 530));
 128             mappings.put(CHANNEL_GROUP_SENSOR_VALUES + "externalHotWater", ChannelFactory.temperature((short) 531));
 129
 130             // Control data
 131             mappings.put(CHANNEL_GROUP_CONTROL_DATA + "radiatorReturnTarget", ChannelFactory.temperature((short) 110));
 132             mappings.put(CHANNEL_GROUP_CONTROL_DATA + "radiatorReturnOn", ChannelFactory.temperature((short) 111));
 133             mappings.put(CHANNEL_GROUP_CONTROL_DATA + "radiatorReturnOff", ChannelFactory.temperature((short) 112));
 134             mappings.put(CHANNEL_GROUP_CONTROL_DATA + "hotWaterOn", ChannelFactory.temperature((short) 115));
 135             mappings.put(CHANNEL_GROUP_CONTROL_DATA + "hotWaterOff", ChannelFactory.temperature((short) 116));
 136             mappings.put(CHANNEL_GROUP_CONTROL_DATA + "radiatorForwardTarget", ChannelFactory.temperature((short) 109));
 137             mappings.put(CHANNEL_GROUP_CONTROL_DATA + "addHeatPowerPercent", ChannelFactory.percent((short) 108));
 138
 139             // Device values
 140             mappings.put(CHANNEL_GROUP_DEVICE_VALUES + "coldFluidPump", ChannelFactory.unitless((short) 509, 1));
 141             mappings.put(CHANNEL_GROUP_DEVICE_VALUES + "compressor", ChannelFactory.unitless((short) 510, 1));
 142             mappings.put(CHANNEL_GROUP_DEVICE_VALUES + "additionalHeat3kW", ChannelFactory.unitless((short) 511, 1));
 143             mappings.put(CHANNEL_GROUP_DEVICE_VALUES + "additionalHeat6kW", ChannelFactory.unitless((short) 512, 1));
 144             mappings.put(CHANNEL_GROUP_DEVICE_VALUES + "radiatorPump", ChannelFactory.unitless((short) 515, 1));
 145             mappings.put(CHANNEL_GROUP_DEVICE_VALUES + "heatFluidPump", ChannelFactory.unitless((short) 516, 1));
 146             mappings.put(CHANNEL_GROUP_DEVICE_VALUES + "switchValve", ChannelFactory.unitless((short) 517, 1));
 147             mappings.put(CHANNEL_GROUP_DEVICE_VALUES + "alarm", ChannelFactory.unitless((short) 518, 1));
 148
 149             // Settings
 150             mappings.put(CHANNEL_GROUP_SETTINGS + "heatCurve", ChannelFactory.unitless((short) 0x0000, 0.1));
 151             mappings.put(CHANNEL_GROUP_SETTINGS + "heatCurveFineAdj", ChannelFactory.temperature((short) 0x0001));
 152             mappings.put(CHANNEL_GROUP_SETTINGS + "heatCurveCouplingDiff", ChannelFactory.temperature((short) 0x0002));
 153             mappings.put(CHANNEL_GROUP_SETTINGS + "heatCurve2", ChannelFactory.unitless((short) 0x0003, 0.1));
 154             mappings.put(CHANNEL_GROUP_SETTINGS + "heatCurve2FineAdj", ChannelFactory.temperature((short) 0x0004));
 155             mappings.put(CHANNEL_GROUP_SETTINGS + "adjCurveAt20", ChannelFactory.temperature((short) 0x001e));
 156             mappings.put(CHANNEL_GROUP_SETTINGS + "adjCurveAt15", ChannelFactory.temperature((short) 0x001c));
 157             mappings.put(CHANNEL_GROUP_SETTINGS + "adjCurveAt10", ChannelFactory.temperature((short) 0x001a));
 158             mappings.put(CHANNEL_GROUP_SETTINGS + "adjCurveAt5", ChannelFactory.temperature((short) 0x0018));
 159             mappings.put(CHANNEL_GROUP_SETTINGS + "adjCurveAt0", ChannelFactory.temperature((short) 0x0016));
 160             mappings.put(CHANNEL_GROUP_SETTINGS + "adjCurveAtMinus5", ChannelFactory.temperature((short) 0x0014));
 161             mappings.put(CHANNEL_GROUP_SETTINGS + "adjCurveAtMinus10", ChannelFactory.temperature((short) 0x0012));
 162             mappings.put(CHANNEL_GROUP_SETTINGS + "adjCurveAtMinus15", ChannelFactory.temperature((short) 0x0010));
 163             mappings.put(CHANNEL_GROUP_SETTINGS + "adjCurveAtMinus20", ChannelFactory.temperature((short) 0x000e));
 164             mappings.put(CHANNEL_GROUP_SETTINGS + "adjCurveAtMinus25", ChannelFactory.temperature((short) 0x000c));
 165             mappings.put(CHANNEL_GROUP_SETTINGS + "adjCurveAtMinus30", ChannelFactory.temperature((short) 0x000a));
 166             mappings.put(CHANNEL_GROUP_SETTINGS + "adjCurveAtMinus35", ChannelFactory.temperature((short) 0x0008));
 167             mappings.put(CHANNEL_GROUP_SETTINGS + "indoorTempSetting", ChannelFactory.temperature((short) 0x0021));
 168             mappings.put(CHANNEL_GROUP_SETTINGS + "curveInflByInTemp", ChannelFactory.unitless((short) 0x0022, 0.1));
 169             mappings.put(CHANNEL_GROUP_SETTINGS + "summerDisconnection", ChannelFactory.temperature((short) 0x0024));
 170             mappings.put(CHANNEL_GROUP_SETTINGS + "hotWaterTarget", ChannelFactory.temperature((short) 0x002b));
 171             mappings.put(CHANNEL_GROUP_SETTINGS + "hotWaterTargetHysteresis",
 172                     ChannelFactory.temperature((short) 0x002c));
 173
 174             // Operating times
 175             mappings.put(CHANNEL_GROUP_OPERATING_TIMES + "heatPumpInOperationRAD", ChannelFactory.hours((short) 72));
 176             mappings.put(CHANNEL_GROUP_OPERATING_TIMES + "heatPumpInOperationDHW", ChannelFactory.hours((short) 74));
 177             mappings.put(CHANNEL_GROUP_OPERATING_TIMES + "addHeatInOperationRAD", ChannelFactory.hours((short) 76));
 178             mappings.put(CHANNEL_GROUP_OPERATING_TIMES + "addHeatInOperationDHW", ChannelFactory.hours((short) 78));
 179         }
 180
 181         REGO600 = new RegoRegisterMapper(mappings);
 182     }
 183 }