RPiRcSwitchGenericBindingProvider.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.rpircswitch.internal;

import java.util.BitSet;

import org.apache.commons.lang.StringUtils;
import org.openhab.binding.rpircswitch.RPiRcSwitchBindingProvider;
import org.openhab.core.items.Item;
import org.openhab.core.library.items.SwitchItem;
import org.openhab.model.item.binding.AbstractGenericBindingProvider;
import org.openhab.model.item.binding.BindingConfigParseException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import de.pi3g.pi.rcswitch.RCSwitch;

/**
 * <p>
 * This class can parse information from the generic binding format and provides
 * Raspberry Pi RC Switch device binding information from it.
 *
 * <p>
 * The syntax of the binding configuration strings accepted is the following:
 * <p>
 * <code>
 * 	rpircswitch="<group-address>:<device-address>"
 * </code>
 *
 * <p>
 * Examples for valid binding configuration strings:
 *
 * <ul>
 * <li><code>rpircswitch="10101:4"</code></li>
 * </ul>
 *
 * @author Matthias Röckl
 * @since 1.8.0
 */
public class RPiRcSwitchGenericBindingProvider extends AbstractGenericBindingProvider
        implements RPiRcSwitchBindingProvider {

    static final Logger LOGGER = LoggerFactory.getLogger(RPiRcSwitchGenericBindingProvider.class);

    /*
     * (non-Javadoc)
     * 
     * @see org.openhab.model.item.binding.BindingConfigReader#getBindingType()
     */
    @Override
    public String getBindingType() {
        return "rpircswitch";
    }

    /*
     * (non-Javadoc)
     * 
     * @see
     * org.openhab.model.item.binding.BindingConfigReader#validateItemType(org
     * .openhab.core.items.Item, java.lang.String)
     */
    @Override
    public void validateItemType(Item item, String bindingConfig) throws BindingConfigParseException {
        if (!(item instanceof SwitchItem)) {
            throw new BindingConfigParseException(
                    "item '" + item.getName() + "' is of type '" + item.getClass().getSimpleName()
                            + "', only SwitchItem is allowed - please check your *.items configuration");
        }
    }

    /*
     * (non-Javadoc)
     * 
     * @see org.openhab.model.item.binding.AbstractGenericBindingProvider#
     * processBindingConfiguration(java.lang.String,
     * org.openhab.core.items.Item, java.lang.String)
     */
    @Override
    public void processBindingConfiguration(String context, Item item, String bindingConfig)
            throws BindingConfigParseException {
        super.processBindingConfiguration(context, item, bindingConfig);

        if (item instanceof SwitchItem) {
            // Group address
            String groupAddressString = StringUtils.substringBefore(bindingConfig, ":");
            // Device address
            String deviceAddressString = StringUtils.substringAfter(bindingConfig, ":");
            if (deviceAddressString == null || deviceAddressString.isEmpty() || groupAddressString == null
                    || groupAddressString.isEmpty()) {
                LOGGER.error("The item configuration '" + bindingConfig
                        + "' is invalid. Valid format is <group-address>:<device-address>.");
                return;
            }
            // Store the configuration
            try {
                BitSet groupAddress = RCSwitch.getSwitchGroupAddress(groupAddressString);
                int deviceAddress = Integer.parseInt(deviceAddressString);
                RPiRcSwitchBindingConfig config = new RPiRcSwitchBindingConfig(groupAddress, deviceAddress);
                this.addBindingConfig(item, config);
            } catch (IndexOutOfBoundsException e) {
                LOGGER.error("The group address '" + groupAddressString
                        + "' is invalid. The group address must have 5 bits, e.g. 10101.");
            } catch (NumberFormatException e) {
                LOGGER.error("The device address '" + deviceAddressString
                        + "' is invalid. The device address must be an Integer value, e.g. 4.");
            }
        }
    }

    @Override
    public RPiRcSwitchBindingConfig getItemConfig(String itemName) {
        return (RPiRcSwitchBindingConfig) bindingConfigs.get(itemName);
    }

}