SendKeys.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.lcn.mappingtarget;

import java.util.regex.Matcher;
import java.util.regex.Pattern;

import org.openhab.binding.lcn.common.LcnAddr;
import org.openhab.binding.lcn.common.LcnDefs;
import org.openhab.binding.lcn.common.PckGenerator;
import org.openhab.binding.lcn.connection.Connection;
import org.openhab.binding.lcn.input.ModStatusBinSensors;
import org.openhab.binding.lcn.input.ModStatusKeyLocks;
import org.openhab.binding.lcn.input.ModStatusLedsAndLogicOps;
import org.openhab.binding.lcn.input.ModStatusOutput;
import org.openhab.binding.lcn.input.ModStatusRelays;
import org.openhab.binding.lcn.input.ModStatusVar;
import org.openhab.core.events.EventPublisher;
import org.openhab.core.items.Item;
import org.openhab.core.types.Command;

/**
 * Sends keys.
 * Support multiple key-tables at once.
 *
 * @author Tobias J�ttner
 */
public class SendKeys extends TargetWithLcnAddr {

    /** Pattern to parse send-keys commands. */
    private static final Pattern PATTERN_SENDKEYS = Pattern.compile(
            "(?<keys>([ABCD][12345678])*)(\\.(?<cmd>(HIT)|(MAKE)|(BREAK)))?",
            Pattern.CASE_INSENSITIVE | Pattern.UNICODE_CASE);

    /** Send-flags for the 4x8 keys. */
    private final boolean[][] keys;

    /** The command to send. */
    private final LcnDefs.SendKeyCommand cmd;

    /**
     * Constructor.
     * 
     * @param addr the target LCN address
     * @param keys the 4x8 send-flags (true = send)
     * @param cmd the command to send (hit, make, break)
     */
    SendKeys(LcnAddr addr, boolean[][] keys, LcnDefs.SendKeyCommand cmd) {
        super(addr);
        this.keys = keys;
        this.cmd = cmd;
    }

    /**
     * Tries to parse the given input text.
     * 
     * @param input the text to parse
     * @return the parsed {@link SendKeys} or null
     */
    static Target tryParseTarget(String input) {
        CmdAndAddressRet header = CmdAndAddressRet.parse(input, true);
        if (header != null) {
            Matcher matcher;
            switch (header.getCmd().toUpperCase()) {
                case "KEYS":
                    if ((matcher = PATTERN_SENDKEYS.matcher(header.getRestInput())).matches()) {
                        boolean[][] keys = new boolean[][] { new boolean[8], new boolean[8], new boolean[8],
                                new boolean[8] };
                        String s = matcher.group("keys");
                        for (int i = 0; i < s.length(); i += 2) {
                            String key = s.substring(i, i + 2).toUpperCase();
                            int tableId;
                            switch (key.charAt(0)) {
                                case 'A':
                                    tableId = 0;
                                    break;
                                case 'B':
                                    tableId = 1;
                                    break;
                                case 'C':
                                    tableId = 2;
                                    break;
                                case 'D':
                                    tableId = 3;
                                    break;
                                default:
                                    throw new Error();
                            }
                            int keyId = Integer.parseInt(key.substring(1, 2)) - 1;
                            keys[tableId][keyId] = true;
                        }
                        LcnDefs.SendKeyCommand cmd = LcnDefs.SendKeyCommand.HIT;
                        if (matcher.group("cmd") != null) { // Optional
                            switch (matcher.group("cmd").toUpperCase()) {
                                case "HIT":
                                    cmd = LcnDefs.SendKeyCommand.HIT;
                                    break;
                                case "MAKE":
                                    cmd = LcnDefs.SendKeyCommand.MAKE;
                                    break;
                                case "BREAK":
                                    cmd = LcnDefs.SendKeyCommand.BREAK;
                                    break;
                                default:
                                    throw new Error();
                            }
                        }
                        return new SendKeys(header.getAddr(), keys, cmd);
                    }
                    break;
            }
        }
        return null;
    }

    /** {@inheritDoc} */
    @Override
    public void send(Connection conn, Item item, Command cmd) {
        for (int tableId = 0; tableId < 4; ++tableId) {
            for (int keyId = 0; keyId < 8; ++keyId) {
                if (this.keys[tableId][keyId]) { // Send if at least one key should be sent
                    LcnDefs.SendKeyCommand[] cmds = new LcnDefs.SendKeyCommand[] { LcnDefs.SendKeyCommand.DONTSEND,
                            LcnDefs.SendKeyCommand.DONTSEND, LcnDefs.SendKeyCommand.DONTSEND,
                            LcnDefs.SendKeyCommand.DONTSEND };
                    cmds[tableId] = this.cmd;
                    conn.queue(this.addr, !this.addr.isGroup(), PckGenerator.sendKeys(cmds, this.keys[tableId]));
                    break;
                }
            }
        }
    }

    /** {@inheritDoc} */
    @Override
    public void register(Connection conn) {
    }

    /** {@inheritDoc} */
    @Override
    public boolean visualizationHandleOutputStatus(ModStatusOutput pchkInput, Command cmd, Item item,
            EventPublisher eventPublisher) {
        return false;
    }

    /** {@inheritDoc} */
    @Override
    public boolean visualizationHandleRelaysStatus(ModStatusRelays pchkInput, Command cmd, Item item,
            EventPublisher eventPublisher) {
        return false;
    }

    /** {@inheritDoc} */
    @Override
    public boolean visualizationBinSensorsStatus(ModStatusBinSensors pchkInput, Command cmd, Item item,
            EventPublisher eventPublisher) {
        return false;
    }

    /** {@inheritDoc} */
    @Override
    public boolean visualizationVarStatus(ModStatusVar pchkInput, Command cmd, Item item,
            EventPublisher eventPublisher) {
        return false;
    }

    /** {@inheritDoc} */
    @Override
    public boolean visualizationLedsAndLogicOpsStatus(ModStatusLedsAndLogicOps pchkInput, Command cmd, Item item,
            EventPublisher eventPublisher) {
        return false;
    }

    /** {@inheritDoc} */
    @Override
    public boolean visualizationKeyLocksStatus(ModStatusKeyLocks pchkInput, Command cmd, Item item,
            EventPublisher eventPublisher) {
        return false;
    }

}