RFXComThermostat1Message.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.ContactItem;
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.OpenClosedType;
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 thermostat1 message.
 * Digimax 210 Thermostat RF sensor operational
 *
 * @author Les Ashworth
 * @since 1.4.0
 */
public class RFXComThermostat1Message extends RFXComBaseMessage {

    public enum SubType {
        DIGIMAX_TLX7506(0),
        DIGIMAX_SHORT_FORMAT(1),

        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;
        }
    }

    /* Added item for ContactTypes */
    public enum Status {
        NO_STATUS(0),
        DEMAND(1),
        NO_DEMAND(2),
        INITIALIZING(3),

        UNKNOWN(255);

        private final int contact;

        Status(int contact) {
            this.contact = contact;
        }

        Status(byte contact) {
            this.contact = contact;
        }

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

        public static Status fromByte(int input) {
            for (Status contact : Status.values()) {
                if (contact.contact == input) {
                    return contact;
                }
            }

            return Status.UNKNOWN;
        }
    }

    /* Operating mode */
    public enum Mode {
        HEATING(0),
        COOLING(1),

        UNKNOWN(255);

        private final int mode;

        Mode(int mode) {
            this.mode = mode;
        }

        Mode(byte mode) {
            this.mode = mode;
        }

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

        public static Mode fromByte(int input) {
            for (Mode mode : Mode.values()) {
                if (mode.mode == input) {
                    return mode;
                }
            }

            return Mode.UNKNOWN;
        }
    }

    private final static List<RFXComValueSelector> supportedValueSelectors = Arrays.asList(RFXComValueSelector.RAW_DATA,
            RFXComValueSelector.SIGNAL_LEVEL, RFXComValueSelector.BATTERY_LEVEL, RFXComValueSelector.TEMPERATURE,
            RFXComValueSelector.SET_POINT, RFXComValueSelector.CONTACT);

    public SubType subType = SubType.UNKNOWN;
    public int sensorId = 0;
    public byte temperature = 0;
    public byte set = 0;
    public Mode mode = Mode.UNKNOWN;
    public Status status = Status.UNKNOWN;
    public byte signalLevel = 0;

    public RFXComThermostat1Message() {
        packetType = PacketType.THERMOSTAT1;
    }

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

    @Override
    public String toString() {
        String str = "";

        str += super.toString();
        str += "\n - Sub type = " + subType;
        str += "\n - Id = " + sensorId;
        str += "\n - Temperature = " + temperature;
        str += "\n - Set = " + set;
        str += "\n - Mode = " + mode;
        str += "\n - Status = " + status;
        str += "\n - Signal level = " + signalLevel;

        return str;
    }

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

        super.encodeMessage(data);

        subType = SubType.fromByte(super.subType);
        sensorId = (data[4] & 0xFF) << 8 | (data[5] & 0xFF);
        temperature = data[6];
        set = data[7];
        mode = Mode.fromByte(data[8] >> 7);
        status = Status.fromByte(data[8] & 0x03);
        signalLevel = (byte) ((data[9] & 0xF0) >> 4);
    }

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

        data[0] = (byte) (data.length - 1);
        data[1] = RFXComBaseMessage.PacketType.THERMOSTAT1.toByte();
        data[2] = subType.toByte();
        data[3] = seqNbr;
        data[4] = (byte) ((sensorId & 0xFF00) >> 8);
        data[5] = (byte) (sensorId & 0x00FF);
        data[6] = (temperature);
        data[7] = (set);
        data[8] = (byte) ((mode.toByte() << 7) | (status.toByte() & 0xFF));
        data[9] = (byte) (signalLevel << 4);

        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.TEMPERATURE) {

                state = new DecimalType(temperature);

            } else if (valueSelector == RFXComValueSelector.SET_POINT) {

                state = new DecimalType(set);

            } else {
                throw new NumberFormatException("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 NumberFormatException("Can't convert " + valueSelector + " to StringItem");
            }

        } else if (valueSelector.getItemClass() == ContactItem.class) {
            if (valueSelector == RFXComValueSelector.CONTACT) {
                switch (status) {
                    case DEMAND:
                        state = OpenClosedType.CLOSED;
                        break;
                    case NO_DEMAND:
                        state = OpenClosedType.OPEN;
                        break;
                    default:
                        break;
                }
            }
        }

        else {
            throw new NumberFormatException("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;
    }

}