ZWaveMultiLevelSensorConverter.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.zwave.internal.converter;

import java.math.BigDecimal;
import java.math.MathContext;
import java.util.Map;

import org.openhab.binding.zwave.internal.converter.command.ZWaveCommandConverter;
import org.openhab.binding.zwave.internal.converter.state.BigDecimalDecimalTypeConverter;
import org.openhab.binding.zwave.internal.converter.state.BigDecimalOnOffTypeConverter;
import org.openhab.binding.zwave.internal.converter.state.BigDecimalOpenClosedTypeConverter;
import org.openhab.binding.zwave.internal.converter.state.ZWaveStateConverter;
import org.openhab.binding.zwave.internal.protocol.SerialMessage;
import org.openhab.binding.zwave.internal.protocol.ZWaveController;
import org.openhab.binding.zwave.internal.protocol.ZWaveNode;
import org.openhab.binding.zwave.internal.protocol.commandclass.ZWaveMultiLevelSensorCommandClass;
import org.openhab.binding.zwave.internal.protocol.commandclass.ZWaveMultiLevelSensorCommandClass.SensorType;
import org.openhab.binding.zwave.internal.protocol.commandclass.ZWaveMultiLevelSensorCommandClass.ZWaveMultiLevelSensorValueEvent;
import org.openhab.binding.zwave.internal.protocol.event.ZWaveCommandClassValueEvent;
import org.openhab.core.events.EventPublisher;
import org.openhab.core.items.Item;
import org.openhab.core.types.Command;
import org.openhab.core.types.State;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/***
 * ZWaveMultiLevelSensorConverter class. Converter for communication with the
 * {@link ZWaveMultiLevelSensorCommandClass}. Implements polling of the sensor
 * status and receiving of sensor events.
 *
 * @author Jan-Willem Spuij
 * @author Chris Jackson
 * @since 1.4.0
 */
public class ZWaveMultiLevelSensorConverter extends ZWaveCommandClassConverter<ZWaveMultiLevelSensorCommandClass> {

    private static final Logger logger = LoggerFactory.getLogger(ZWaveMultiLevelSensorConverter.class);
    private static final int REFRESH_INTERVAL = 0; // refresh interval in seconds for the multi level switch;

    private static BigDecimal ONE_POINT_EIGHT = new BigDecimal("1.8");
    private static BigDecimal THIRTY_TWO = new BigDecimal("32");

    /**
     * Constructor. Creates a new instance of the {@link ZWaveMultiLevelSensorConverter} class.
     *
     * @param controller the {@link ZWaveController} to use for sending messages.
     * @param eventPublisher the {@link EventPublisher} to use to publish events.
     */
    public ZWaveMultiLevelSensorConverter(ZWaveController controller, EventPublisher eventPublisher) {
        super(controller, eventPublisher);

        // State and commmand converters used by this converter.
        this.addStateConverter(new BigDecimalDecimalTypeConverter());
        this.addStateConverter(new BigDecimalOnOffTypeConverter());
        this.addStateConverter(new BigDecimalOpenClosedTypeConverter());
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public SerialMessage executeRefresh(ZWaveNode node, ZWaveMultiLevelSensorCommandClass commandClass, int endpointId,
            Map<String, String> arguments) {
        String sensorType = arguments.get("sensor_type");

        logger.debug("NODE {}: Generating poll message for {}, endpoint {}", node.getNodeId(),
                commandClass.getCommandClass().getLabel(), endpointId);

        if (sensorType != null) {
            return node.encapsulate(commandClass.getMessage(SensorType.getSensorType(Integer.parseInt(sensorType))),
                    commandClass, endpointId);
        } else {
            return node.encapsulate(commandClass.getValueMessage(), commandClass, endpointId);
        }
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void handleEvent(ZWaveCommandClassValueEvent event, Item item, Map<String, String> arguments) {
        ZWaveStateConverter<?, ?> converter = this.getStateConverter(item, event.getValue());
        String sensorType = arguments.get("sensor_type");
        String sensorScale = arguments.get("sensor_scale");
        ZWaveMultiLevelSensorValueEvent sensorEvent = (ZWaveMultiLevelSensorValueEvent) event;

        if (converter == null) {
            logger.warn("NODE {}: No converter found for item = {}, endpoint = {}, ignoring event.", event.getNodeId(),
                    item.getName(), event.getEndpoint());
            return;
        }

        // Don't trigger event if this item is bound to another sensor type
        if (sensorType != null
                && SensorType.getSensorType(Integer.parseInt(sensorType)) != sensorEvent.getSensorType()) {
            return;
        }

        BigDecimal val = (BigDecimal) event.getValue();
        // Perform a scale conversion if needed
        if (sensorScale != null && Integer.parseInt(sensorScale) != sensorEvent.getSensorScale()) {
            int intType = Integer.parseInt(sensorType);
            SensorType senType = SensorType.getSensorType(intType);
            if (senType == null) {
                logger.error("NODE {}: Error parsing sensor type {}", event.getNodeId(), sensorType);
            } else {
                switch (senType) {
                    case TEMPERATURE:
                        // For temperature, there are only two scales, so we simplify the conversion
                        if (sensorEvent.getSensorScale() == 0) {
                            // Scale is celsius, convert to fahrenheit
                            val = val.multiply(ONE_POINT_EIGHT).add(THIRTY_TWO);
                        } else if (sensorEvent.getSensorScale() == 1) {
                            // Scale is fahrenheit, convert to celsius
                            val = val.subtract(THIRTY_TWO).divide(ONE_POINT_EIGHT, MathContext.DECIMAL32);
                        }
                        break;
                    default:
                        break;
                }
            }

            logger.debug("NODE {}: Sensor is reporting scale {}, requiring conversion to {}. Value is now {}.",
                    event.getNodeId(), sensorEvent.getSensorScale(), sensorScale, val);
        }

        State state = converter.convertFromValueToState(val);
        this.getEventPublisher().postUpdate(item.getName(), state);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void receiveCommand(Item item, Command command, ZWaveNode node,
            ZWaveMultiLevelSensorCommandClass commandClass, int endpointId, Map<String, String> arguments) {
        ZWaveCommandConverter<?, ?> converter = this.getCommandConverter(command.getClass());

        if (converter == null) {
            logger.warn("No converter found for item = {}, node = {} endpoint = {}, ignoring command.", item.getName(),
                    node.getNodeId(), endpointId);
            return;
        }
    }

    /**
     * {@inheritDoc}
     */
    @Override
    int getRefreshInterval() {
        return REFRESH_INTERVAL;
    }
}