ZWaveIndicatorCommandClass.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.protocol.commandclass;

import java.util.ArrayList;
import java.util.Collection;

import org.openhab.binding.zwave.internal.config.ZWaveDbCommandClass;
import org.openhab.binding.zwave.internal.protocol.SerialMessage;
import org.openhab.binding.zwave.internal.protocol.SerialMessage.SerialMessageClass;
import org.openhab.binding.zwave.internal.protocol.SerialMessage.SerialMessagePriority;
import org.openhab.binding.zwave.internal.protocol.SerialMessage.SerialMessageType;
import org.openhab.binding.zwave.internal.protocol.ZWaveController;
import org.openhab.binding.zwave.internal.protocol.ZWaveEndpoint;
import org.openhab.binding.zwave.internal.protocol.ZWaveNode;
import org.openhab.binding.zwave.internal.protocol.event.ZWaveIndicatorCommandClassChangeEvent;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.thoughtworks.xstream.annotations.XStreamAlias;
import com.thoughtworks.xstream.annotations.XStreamOmitField;

/**
 * Handles the Indicator command class.
 * The indicator command class operates the indicator on the physical device if available.
 * This can be used to identify a device or use the indicator for special purposes.
 * Example is the Evolve LCD panel that uses the Indicator class to toggle the labels
 * displayed on the LCD. The Indicator class is also used to sync multiple panels' labels
 *
 * @author Pedro Paixao
 * @since 1.8.0
 */

@XStreamAlias("indicatorCommandClass")
public class ZWaveIndicatorCommandClass extends ZWaveCommandClass
        implements ZWaveGetCommands, ZWaveSetCommands, ZWaveCommandClassDynamicState {

    @XStreamOmitField
    private static final Logger logger = LoggerFactory.getLogger(ZWaveIndicatorCommandClass.class);

    private static final int INDICATOR_SET = 0x01;
    private static final int INDICATOR_GET = 0x02;
    private static final int INDICATOR_REPORT = 0x03;

    private int indicator;

    @XStreamOmitField
    private boolean dynamicDone = false;

    private boolean isGetSupported = true;

    /**
     * Creates a new instance of the ZWaveIndicatorCommandClass class.
     *
     * @param node the node this command class belongs to
     * @param controller the controller to use
     * @param endpoint the endpoint this Command class belongs to
     */
    public ZWaveIndicatorCommandClass(ZWaveNode node, ZWaveController controller, ZWaveEndpoint endpoint) {
        super(node, controller, endpoint);
        indicator = 0;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public CommandClass getCommandClass() {
        return CommandClass.INDICATOR;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void handleApplicationCommandRequest(SerialMessage serialMessage, int offset, int endpoint) {
        logger.debug("NODE {}: Received Indicator Request", this.getNode().getNodeId());
        int command = serialMessage.getMessagePayloadByte(offset);
        switch (command) {
            case INDICATOR_SET:
                logger.debug("NODE {}: Indicator Set sent to the controller will be processed as Indicator Report",
                        this.getNode().getNodeId());

                // Process this as if it was a value report.
                processIndicatorReport(serialMessage, offset, endpoint);
                break;
            case INDICATOR_GET:
                logger.warn(String.format("Command 0x%02X not implemented.", command));
                return;
            case INDICATOR_REPORT:
                logger.trace("NODE {}: Process Indicator Report", this.getNode().getNodeId());
                processIndicatorReport(serialMessage, offset, endpoint);
                break;
            default:
                logger.warn(String.format("Unsupported Command 0x%02X for command class %s (0x%02X).", command,
                        this.getCommandClass().getLabel(), this.getCommandClass().getKey()));
        }
    }

    /**
     * Processes a INDICATOR_REPORT / INDICATOR_SET message.
     *
     * @param serialMessage the incoming message to process.
     * @param offset the offset position from which to start message processing.
     * @param endpoint the endpoint or instance number this message is meant for.
     */
    protected void processIndicatorReport(SerialMessage serialMessage, int offset, int endpoint) {
        int newIndicator = serialMessage.getMessagePayloadByte(offset + 1);

        logger.debug(
                String.format("NODE %d: Indicator report, value = 0x%02X", this.getNode().getNodeId(), newIndicator));

        ZWaveIndicatorCommandClassChangeEvent zEvent = new ZWaveIndicatorCommandClassChangeEvent(
                this.getNode().getNodeId(), endpoint, this.getCommandClass(), newIndicator, indicator);

        indicator = newIndicator;
        this.getController().notifyEventListeners(zEvent);
    }

    /**
     * Gets a SerialMessage with the INDICATOR GET command
     *
     * @return the serial message
     */
    @Override
    public SerialMessage getValueMessage() {
        if (isGetSupported == false) {
            logger.debug("NODE {}: Node doesn't support get requests", this.getNode().getNodeId());
            return null;
        }

        logger.debug("NODE {}: Creating new message for application command INDICATOR_GET", this.getNode().getNodeId());
        SerialMessage result = new SerialMessage(this.getNode().getNodeId(), SerialMessageClass.SendData,
                SerialMessageType.Request, SerialMessageClass.ApplicationCommandHandler, SerialMessagePriority.Get);
        byte[] newPayload = { (byte) this.getNode().getNodeId(), 2, (byte) getCommandClass().getKey(),
                (byte) INDICATOR_GET };
        result.setMessagePayload(newPayload);
        return result;
    }

    @Override
    public boolean setOptions(ZWaveDbCommandClass options) {
        if (options.isGetSupported != null) {
            isGetSupported = options.isGetSupported;
        }

        return true;
    }

    /**
     * Gets a SerialMessage with the INDICATOR SET command
     *
     * @param the level to set.
     * @return the serial message
     */
    @Override
    public SerialMessage setValueMessage(int newIndicator) {
        logger.debug("NODE {}: Creating new message for application command INDICATOR_SET", this.getNode().getNodeId());
        SerialMessage result = new SerialMessage(this.getNode().getNodeId(), SerialMessageClass.SendData,
                SerialMessageType.Request, SerialMessageClass.SendData, SerialMessagePriority.Set);
        byte[] newPayload = { (byte) this.getNode().getNodeId(), 3, (byte) getCommandClass().getKey(),
                (byte) INDICATOR_SET, (byte) newIndicator };
        result.setMessagePayload(newPayload);
        return result;
    }

    /**
     * Get current indicator value
     *
     * @return indicator
     */
    public int getValue() {
        return indicator;
    }

    @Override
    public Collection<SerialMessage> getDynamicValues(boolean refresh) {
        if (refresh == true) {
            dynamicDone = false;
        }

        if (dynamicDone == true) {
            return null;
        }

        ArrayList<SerialMessage> result = new ArrayList<SerialMessage>();
        result.add(getValueMessage());
        return result;
    }
}