RFXComWindMessage.java

/**
 * Copyright (c) 2010-2016 by the respective copyright holders.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 */
package org.openhab.binding.rfxcom.internal.messages;

import java.util.Arrays;
import java.util.List;

import javax.xml.bind.DatatypeConverter;

import org.openhab.binding.rfxcom.RFXComValueSelector;
import org.openhab.binding.rfxcom.internal.RFXComException;
import org.openhab.core.library.items.NumberItem;
import org.openhab.core.library.items.StringItem;
import org.openhab.core.library.types.DecimalType;
import org.openhab.core.library.types.StringType;
import org.openhab.core.types.State;
import org.openhab.core.types.Type;
import org.openhab.core.types.UnDefType;

/**
 * RFXCOM data class for temperature and humidity message.
 *
 * @author Marc SAUVEUR
 * @since 1.4.0
 */
public class RFXComWindMessage extends RFXComBaseMessage {

    public enum SubType {
        WTGR800(1),
        WGR800(2),
        STR918_WGR918_WGR928(3),
        TFA(4),
        UPM_WDS500(5),
        WS2300(6),
        WS4500_ET_AL(7),

        UNKNOWN(255);

        private final int subType;

        SubType(int subType) {
            this.subType = subType;
        }

        SubType(byte subType) {
            this.subType = subType;
        }

        public byte toByte() {
            return (byte) subType;
        }

        public static SubType fromByte(int input) {
            for (SubType c : SubType.values()) {
                if (c.subType == input) {
                    return c;
                }
            }

            return SubType.UNKNOWN;
        }
    }

    private final static List<RFXComValueSelector> supportedValueSelectors = Arrays.asList(RFXComValueSelector.RAW_DATA,
            RFXComValueSelector.SIGNAL_LEVEL, RFXComValueSelector.BATTERY_LEVEL, RFXComValueSelector.WIND_DIRECTION,
            RFXComValueSelector.WIND_AVSPEED, RFXComValueSelector.WIND_SPEED, RFXComValueSelector.TEMPERATURE,
            RFXComValueSelector.CHILL_FACTOR);

    public SubType subType = SubType.UNKNOWN;
    public int sensorId = 0;
    public double windDirection = 0;
    public double windSpeed = 0;
    public double windAvSpeed = 0;
    public double temperature = 0; // TFA type only
    public double chillFactor = 0; // TFA type only
    public byte signalLevel = 0;
    public byte batteryLevel = 0;

    public RFXComWindMessage() {
        packetType = PacketType.WIND;
    }

    public RFXComWindMessage(byte[] data) {
        encodeMessage(data);
    }

    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder(super.toString());
        sb.append("\n - Sub type = ").append(subType);
        sb.append("\n - Id = ").append(sensorId);
        sb.append("\n - Wind direction = ").append(windDirection);
        sb.append("\n - Wind speed = ").append(windSpeed);
        sb.append("\n - Average Wind speed = ").append(windAvSpeed);

        if (subType == SubType.TFA) {
            sb.append("\n - Temperature = ").append(temperature);
            sb.append("\n - Chill Factor = ").append(chillFactor);
        }
        sb.append("\n - Signal level = ").append(signalLevel);
        sb.append("\n - Battery level = ").append(batteryLevel);

        return sb.toString();
    }

    @Override
    public void encodeMessage(byte[] data) {

        super.encodeMessage(data);

        subType = SubType.fromByte(super.subType);
        sensorId = (data[4] & 0xFF) << 8 | (data[5] & 0xFF);

        windDirection = (short) ((data[6] & 0xFF) << 8 | (data[7] & 0xFF));
        windAvSpeed = (short) ((data[8] & 0xFF) << 8 | (data[9] & 0xFF)) * 0.1;
        windSpeed = (short) ((data[10] & 0xFF) << 8 | (data[11] & 0xFF)) * 0.1;

        if (subType == SubType.TFA) {
            temperature = (short) ((data[12] & 0x7F) << 8 | (data[13] & 0xFF)) * 0.1;
            if ((data[12] & 0x80) != 0) {
                temperature = -temperature;
            }
            chillFactor = (short) ((data[14] & 0x7F) << 8 | (data[15] & 0xFF)) * 0.1;
            if ((data[14] & 0x80) != 0) {
                chillFactor = -chillFactor;
            }
        } else {
            temperature = 0;
            chillFactor = 0;
        }

        signalLevel = (byte) ((data[16] & 0xF0) >> 4);
        batteryLevel = (byte) (data[16] & 0x0F);
    }

    @Override
    public byte[] decodeMessage() {
        byte[] data = new byte[17];

        data[0] = 0x10;
        data[1] = PacketType.WIND.toByte();
        data[2] = subType.toByte();
        data[3] = seqNbr;
        data[4] = (byte) ((sensorId & 0xFF00) >> 8);
        data[5] = (byte) (sensorId & 0x00FF);

        short WindD = (short) Math.abs(windDirection);
        data[6] = (byte) ((WindD >> 8) & 0xFF);
        data[7] = (byte) (WindD & 0xFF);

        int WindAS = (short) Math.abs(windAvSpeed) * 10;
        data[8] = (byte) ((WindAS >> 8) & 0xFF);
        data[9] = (byte) (WindAS & 0xFF);

        int WindS = (short) Math.abs(windSpeed) * 10;
        data[10] = (byte) ((WindS >> 8) & 0xFF);
        data[11] = (byte) (WindS & 0xFF);

        if (subType == SubType.TFA) {
            short temp = (short) Math.abs(temperature * 10);
            data[12] = (byte) ((temp >> 8) & 0xFF);
            data[13] = (byte) (temp & 0xFF);
            if (temperature < 0) {
                data[12] |= 0x80;
            }

            short chill = (short) Math.abs(chillFactor * 10);
            data[14] = (byte) ((chill >> 8) & 0xFF);
            data[15] = (byte) (chill & 0xFF);
            if (chillFactor < 0) {
                data[14] |= 0x80;
            }
        }

        data[16] = (byte) (((signalLevel & 0x0F) << 4) | (batteryLevel & 0x0F));

        return data;
    }

    @Override
    public String generateDeviceId() {
        return String.valueOf(sensorId);
    }

    @Override
    public State convertToState(RFXComValueSelector valueSelector) throws RFXComException {

        org.openhab.core.types.State state = UnDefType.UNDEF;

        if (valueSelector.getItemClass() == NumberItem.class) {

            if (valueSelector == RFXComValueSelector.SIGNAL_LEVEL) {
                state = new DecimalType(signalLevel);
            } else if (valueSelector == RFXComValueSelector.BATTERY_LEVEL) {
                state = new DecimalType(batteryLevel);
            } else if (valueSelector == RFXComValueSelector.WIND_DIRECTION) {
                state = new DecimalType(windDirection);
            } else if (valueSelector == RFXComValueSelector.WIND_SPEED) {
                state = new DecimalType(windSpeed);
            } else if (valueSelector == RFXComValueSelector.WIND_AVSPEED) {
                state = new DecimalType(windAvSpeed);
            } else if (valueSelector == RFXComValueSelector.TEMPERATURE) {
                state = new DecimalType(temperature);
            } else if (valueSelector == RFXComValueSelector.CHILL_FACTOR) {
                state = new DecimalType(chillFactor);
            } else {
                throw new RFXComException("Can't convert " + valueSelector + " to NumberItem");
            }

        } else if (valueSelector.getItemClass() == StringItem.class) {

            if (valueSelector == RFXComValueSelector.RAW_DATA) {

                state = new StringType(DatatypeConverter.printHexBinary(rawMessage));

            } else {
                throw new RFXComException("Can't convert " + valueSelector + " to StringItem");
            }
        } else {

            throw new RFXComException("Can't convert " + valueSelector + " to " + valueSelector.getItemClass());

        }

        return state;
    }

    @Override
    public void convertFromState(RFXComValueSelector valueSelector, String id, Object subType, Type type,
            byte seqNumber) throws RFXComException {

        throw new RFXComException("Not supported");
    }

    @Override
    public Object convertSubType(String subType) throws RFXComException {

        for (SubType s : SubType.values()) {
            if (s.toString().equals(subType)) {
                return s;
            }
        }

        throw new RFXComException("Unknown sub type " + subType);
    }

    @Override
    public List<RFXComValueSelector> getSupportedValueSelectors() throws RFXComException {
        return supportedValueSelectors;
    }

}