ZWaveDoorLockConverter.java

/**
 * Copyright (c) 2010-2015, openHAB.org and others.
 *
 * 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.util.Map;

import org.openhab.binding.zwave.internal.converter.command.BinaryOnOffCommandConverter;
import org.openhab.binding.zwave.internal.converter.command.ZWaveCommandConverter;
import org.openhab.binding.zwave.internal.converter.state.IntegerOnOffTypeConverter;
import org.openhab.binding.zwave.internal.converter.state.IntegerOpenClosedTypeConverter;
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.ZWaveDoorLockCommandClass;
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;

/**
 * ZWaveDoorLockConverter class. Converter for communication with the
 * {@link ZWaveDoorLockCommandClass}. Implements polling of the door lock
 * status and receiving of door lock events.
 *
 * @author Dave Badia
 * @since TODO
 */
public class ZWaveDoorLockConverter extends ZWaveCommandClassConverter<ZWaveDoorLockCommandClass> {

    private static final Logger logger = LoggerFactory.getLogger(ZWaveDoorLockConverter.class);
    private static final int REFRESH_INTERVAL = 0;

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

        // State and commmand converters used by this converter.
        this.addStateConverter(new IntegerOnOffTypeConverter());
        // For door locks, 0xFF=secured and 0x00=unsecured. Override the default
        // IntegerOpenClosedTypeConverter behavior so secured=closed and open=unsecured
        this.addStateConverter(new IntegerOpenClosedTypeConverter(0xFF));
        this.addCommandConverter(new BinaryOnOffCommandConverter());
    }

    /**
     * {@inheritDoc}
     *
     * @return
     */
    @Override
    public SerialMessage executeRefresh(ZWaveNode node, ZWaveDoorLockCommandClass commandClass, int endpointId,
            Map<String, String> arguments) {
        logger.debug("NODE {}: Generating poll message for {}, endpoint {}", node.getNodeId(),
                commandClass.getCommandClass().getLabel(), endpointId);
        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());
        logger.debug("NODE {}: Converter for for item = {}, event value = {}", event.getNodeId(), item.getName(),
                event.getValue());
        if (converter == null) {
            logger.warn("NODE {}: No converter found for item = {}, endpoint = {}, ignoring event.", event.getNodeId(),
                    item.getName(), event.getEndpoint());
            return;
        }
        State state = converter.convertFromValueToState(event.getValue());
        this.getEventPublisher().postUpdate(item.getName(), state);
    }

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

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

        SerialMessage serialMessage = node.encapsulate(
                commandClass.setValueMessage((Integer) converter.convertFromCommandToValue(item, command)),
                commandClass, endpointId);

        if (serialMessage == null) {
            logger.warn("Generating message failed for command class = {}, node = {}, endpoint = {}",
                    commandClass.getCommandClass().getLabel(), node.getNodeId(), endpointId);
            return;
        }

        this.getController().sendData(serialMessage);

        if (command instanceof State) {
            this.getEventPublisher().postUpdate(item.getName(), (State) command);
        }

        // Queue a status message since we just sent a door lock command
        serialMessage = node.encapsulate(commandClass.getValueMessage(), commandClass, endpointId);
        this.getController().sendData(serialMessage);
    }

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