git.basschouten.com Git - openhab-addons.git/blob

   1 /**
   2  * Copyright (c) 2010-2021 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.rfxcom.internal.messages;
  14
  15 import static org.openhab.binding.rfxcom.internal.RFXComBindingConstants.*;
  16 import static org.openhab.binding.rfxcom.internal.messages.ByteEnumUtil.fromByte;
  17
  18 import org.openhab.binding.rfxcom.internal.exceptions.RFXComException;
  19 import org.openhab.binding.rfxcom.internal.exceptions.RFXComUnsupportedChannelException;
  20 import org.openhab.binding.rfxcom.internal.exceptions.RFXComUnsupportedValueException;
  21 import org.openhab.binding.rfxcom.internal.handler.DeviceState;
  22 import org.openhab.core.library.types.DecimalType;
  23 import org.openhab.core.types.State;
  24 import org.openhab.core.types.Type;
  25
  26 /**
  27  * RFXCOM data class for energy message.
  28  *
  29  * @author Unknown - Initial contribution
  30  * @author Pauli Anttila
  31  */
  32 public class RFXComEnergyMessage extends RFXComBatteryDeviceMessage<RFXComEnergyMessage.SubType> {
  33
  34     private static final double TOTAL_USAGE_CONVERSION_FACTOR = 223.666d;
  35     private static final double WATTS_TO_AMPS_CONVERSION_FACTOR = 230d;
  36
  37     public enum SubType implements ByteEnumWrapper {
  38         ELEC2(1),
  39         ELEC3(2);
  40
  41         private final int subType;
  42
  43         SubType(int subType) {
  44             this.subType = subType;
  45         }
  46
  47         @Override
  48         public byte toByte() {
  49             return (byte) subType;
  50         }
  51     }
  52
  53     public SubType subType;
  54     public int sensorId;
  55     public byte count;
  56     public double instantAmp;
  57     public double totalAmpHour;
  58     public double instantPower;
  59     public double totalUsage;
  60
  61     public RFXComEnergyMessage() {
  62         super(PacketType.ENERGY);
  63     }
  64
  65     public RFXComEnergyMessage(byte[] data) throws RFXComException {
  66         encodeMessage(data);
  67     }
  68
  69     @Override
  70     public String toString() {
  71         String str = "";
  72
  73         str += super.toString();
  74         str += ", Sub type = " + subType;
  75         str += ", Device Id = " + getDeviceId();
  76         str += ", Count = " + count;
  77         str += ", Instant Amps = " + instantAmp;
  78         str += ", Total Amp Hours = " + totalAmpHour;
  79         str += ", Signal level = " + signalLevel;
  80         str += ", Battery level = " + batteryLevel;
  81         str += ", Instant Power = " + instantPower;
  82         str += ", Total Usage = " + totalUsage;
  83
  84         return str;
  85     }
  86
  87     @Override
  88     public void encodeMessage(byte[] data) throws RFXComException {
  89         super.encodeMessage(data);
  90
  91         subType = fromByte(SubType.class, super.subType);
  92         sensorId = (data[4] & 0xFF) << 8 | (data[5] & 0xFF);
  93         count = data[6];
  94
  95         // all usage is reported in Watts based on 230V
  96         instantPower = ((data[7] & 0xFF) << 24 | (data[8] & 0xFF) << 16 | (data[9] & 0xFF) << 8 | (data[10] & 0xFF));
  97         totalUsage = ((long) (data[11] & 0xFF) << 40 | (long) (data[12] & 0xFF) << 32 | (data[13] & 0xFF) << 24
  98                 | (data[14] & 0xFF) << 16 | (data[15] & 0xFF) << 8 | (data[16] & 0xFF)) / TOTAL_USAGE_CONVERSION_FACTOR;
  99
 100         // convert to amps so external code can determine the watts based on local voltage
 101         instantAmp = instantPower / WATTS_TO_AMPS_CONVERSION_FACTOR;
 102         totalAmpHour = totalUsage / WATTS_TO_AMPS_CONVERSION_FACTOR;
 103
 104         signalLevel = (byte) ((data[17] & 0xF0) >> 4);
 105         batteryLevel = (byte) (data[17] & 0x0F);
 106     }
 107
 108     @Override
 109     public byte[] decodeMessage() {
 110         byte[] data = new byte[18];
 111
 112         data[0] = 0x11;
 113         data[1] = RFXComBaseMessage.PacketType.ENERGY.toByte();
 114         data[2] = subType.toByte();
 115         data[3] = seqNbr;
 116
 117         data[4] = (byte) ((sensorId & 0xFF00) >> 8);
 118         data[5] = (byte) (sensorId & 0x00FF);
 119         data[6] = count;
 120
 121         // convert our 'amp' values back into Watts since this is what comes back
 122         long instantUsage = (long) (instantAmp * WATTS_TO_AMPS_CONVERSION_FACTOR);
 123         long totalUsage = (long) (totalAmpHour * WATTS_TO_AMPS_CONVERSION_FACTOR * TOTAL_USAGE_CONVERSION_FACTOR);
 124
 125         data[7] = (byte) ((instantUsage >> 24) & 0xFF);
 126         data[8] = (byte) ((instantUsage >> 16) & 0xFF);
 127         data[9] = (byte) ((instantUsage >> 8) & 0xFF);
 128         data[10] = (byte) (instantUsage & 0xFF);
 129
 130         data[11] = (byte) ((totalUsage >> 40) & 0xFF);
 131         data[12] = (byte) ((totalUsage >> 32) & 0xFF);
 132         data[13] = (byte) ((totalUsage >> 24) & 0xFF);
 133         data[14] = (byte) ((totalUsage >> 16) & 0xFF);
 134         data[15] = (byte) ((totalUsage >> 8) & 0xFF);
 135         data[16] = (byte) (totalUsage & 0xFF);
 136
 137         data[17] = (byte) (((signalLevel & 0x0F) << 4) | (batteryLevel & 0x0F));
 138
 139         return data;
 140     }
 141
 142     @Override
 143     public String getDeviceId() {
 144         return String.valueOf(sensorId);
 145     }
 146
 147     @Override
 148     public State convertToState(String channelId, DeviceState deviceState) throws RFXComUnsupportedChannelException {
 149         switch (channelId) {
 150             case CHANNEL_INSTANT_POWER:
 151                 return new DecimalType(instantPower);
 152
 153             case CHANNEL_TOTAL_USAGE:
 154                 return new DecimalType(totalUsage);
 155
 156             case CHANNEL_INSTANT_AMPS:
 157                 return new DecimalType(instantAmp);
 158
 159             case CHANNEL_TOTAL_AMP_HOUR:
 160                 return new DecimalType(totalAmpHour);
 161
 162             default:
 163                 return super.convertToState(channelId, deviceState);
 164         }
 165     }
 166
 167     @Override
 168     public void setSubType(SubType subType) {
 169         throw new UnsupportedOperationException();
 170     }
 171
 172     @Override
 173     public void setDeviceId(String deviceId) {
 174         throw new UnsupportedOperationException();
 175     }
 176
 177     @Override
 178     public void convertFromState(String channelId, Type type) {
 179         throw new UnsupportedOperationException();
 180     }
 181
 182     @Override
 183     public SubType convertSubType(String subType) throws RFXComUnsupportedValueException {
 184         return ByteEnumUtil.convertSubType(SubType.class, subType);
 185     }
 186 }