SerialApiGetCapabilitiesMessageClass.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.serialmessage;

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.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * This class processes a serial message from the zwave controller
 *
 * @author Chris Jackson
 * @since 1.5.0
 */
public class SerialApiGetCapabilitiesMessageClass extends ZWaveCommandProcessor {
    private static final Logger logger = LoggerFactory.getLogger(SerialApiGetCapabilitiesMessageClass.class);

    private String serialAPIVersion = "Unknown";
    private int manufactureId = 0;
    private int deviceType = 0;
    private int deviceId = 0;

    public SerialMessage doRequest() {
        return new SerialMessage(SerialMessageClass.SerialApiGetCapabilities, SerialMessageType.Request,
                SerialMessageClass.SerialApiGetCapabilities, SerialMessagePriority.High);
    }

    @Override
    public boolean handleResponse(ZWaveController zController, SerialMessage lastSentMessage,
            SerialMessage incomingMessage) {
        logger.trace("Handle Message Serial API Get Capabilities - Length {}",
                incomingMessage.getMessagePayload().length);

        serialAPIVersion = String.format("%d.%d", incomingMessage.getMessagePayloadByte(0),
                incomingMessage.getMessagePayloadByte(1));
        manufactureId = ((incomingMessage.getMessagePayloadByte(2)) << 8) | (incomingMessage.getMessagePayloadByte(3));
        deviceType = ((incomingMessage.getMessagePayloadByte(4)) << 8) | (incomingMessage.getMessagePayloadByte(5));
        deviceId = (((incomingMessage.getMessagePayloadByte(6)) << 8) | (incomingMessage.getMessagePayloadByte(7)));

        logger.debug(String.format("API Version = %s", serialAPIVersion));
        logger.debug(String.format("Manufacture ID = 0x%x", manufactureId));
        logger.debug(String.format("Device Type = 0x%x", deviceType));
        logger.debug(String.format("Device ID = 0x%x", deviceId));

        // Print the list of messages supported by this controller
        for (int by = 8; by < incomingMessage.getMessagePayload().length; by++) {
            for (int bi = 0; bi < 8; bi++) {
                if ((incomingMessage.getMessagePayloadByte(by) & (0x01 << bi)) != 0) {
                    SerialMessage.SerialMessageClass msgClass = SerialMessage.SerialMessageClass
                            .getMessageClass(((by - 8) << 3) + bi + 1);
                    if (msgClass == null) {
                        logger.debug(String.format("Supports: Unknown Class 0x%02x", ((by - 8) << 3) + bi + 1));
                    } else {
                        logger.debug("Supports: {}", msgClass.getLabel());
                    }
                }
            }
        }

        checkTransactionComplete(lastSentMessage, incomingMessage);

        return true;
    }

    public String getSerialAPIVersion() {
        return serialAPIVersion;
    }

    public int getManufactureId() {
        return manufactureId;
    }

    public int getDeviceType() {
        return deviceType;
    }

    public int getDeviceId() {
        return deviceId;
    }
}