/**
* Copyright (c) 2010-2014, 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.tinkerforge.internal;
import org.openhab.binding.tinkerforge.TinkerforgeBindingProvider;
import org.openhab.binding.tinkerforge.internal.config.DeviceOptions;
import org.openhab.core.binding.BindingConfig;
import org.openhab.core.items.Item;
import org.openhab.model.item.binding.AbstractGenericBindingProvider;
import org.openhab.model.item.binding.BindingConfigParseException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* <p>
* This class can parse information from the generic binding format and provides
* tinkerforge binding information from it. It registers as a
* {@link TinkerforgeBindingProvider} service as well.
* </p>
*
* <p>
* Here are some examples for valid binding configuration strings:
* <ul>
* <li><code>{ tinkerforge="uid=etd" }</code></li>
* <li><code>{ tinkerforge="uid=etd, subid=temperature"}</code></li>
* <li><code>{ tinkerforge="name=relay_coffee_machine" }</code></li>
* </ul>
*
* @author Theo Weiss
* @since 1.3.0
*/
public class TinkerforgeGenericBindingProvider extends
AbstractGenericBindingProvider implements TinkerforgeBindingProvider {
private static final Logger logger =
LoggerFactory.getLogger(TinkerforgeGenericBindingProvider.class);
private enum ConfigKey {
uid, subid, name
}
/**
* {@inheritDoc}
*/
public String getBindingType() {
return "tinkerforge";
}
/**
* @{inheritDoc
*/
@Override
public void validateItemType(Item item, String bindingConfig) throws BindingConfigParseException {
// all itemTypes are allowed for now ...
}
/**
* {@inheritDoc}
*/
@Override
public void processBindingConfiguration(String context, Item item,
String bindingConfig) throws BindingConfigParseException {
super.processBindingConfiguration(context, item, bindingConfig);
// parse bindingconfig here ...
if (bindingConfig == null) {
logger.error("got bindingConfig null for item: {}", item.getName());
} else {
TinkerforgeBindingConfig config = new TinkerforgeBindingConfig();
DeviceOptions deviceOptions = new DeviceOptions();
String[] tokens = bindingConfig.trim().split(",");
for (String token : tokens) {
token = token.trim();
logger.debug("token: {}", token);
String[] confStatement = token.split("=");
if (confStatement.length != 2) {
throw new BindingConfigParseException(
"TinkerforgeGenericBindingProvider:processBindingConfiguration: invalid format, the entry must consist of key=value pair, but value was found."
+ token);
} else {
String key = confStatement[0];
String value = confStatement[1];
if (key.equals(ConfigKey.uid.name())) {
config.setUid(value);
} else if (key.equals(ConfigKey.subid.name())) {
config.setSubId(value);
} else if (key.equals(ConfigKey.name.name())) {
config.setName(value);
} else {
deviceOptions.put(key, value);
}
}
}
config.setDeviceOptions(deviceOptions);
config.setItem(item);
addBindingConfig(item, config);
}
}
/**
* {@inheritDoc}
*/
@Override
public String getUid(String itemName) {
TinkerforgeBindingConfig config = (TinkerforgeBindingConfig) bindingConfigs.get(itemName);
return config != null ? config.getUid() : null;
}
/**
* {@inheritDoc}
*/
@Override
public String getSubId(String itemName) {
TinkerforgeBindingConfig config = (TinkerforgeBindingConfig) bindingConfigs.get(itemName);
return config != null ? config.getSubId() : null;
}
/**
* {@inheritDoc}
*/
@Override
public Item getItem(String itemName) {
TinkerforgeBindingConfig config = (TinkerforgeBindingConfig) bindingConfigs.get(itemName);
return config != null ? config.getItem() : null;
}
/**
* {@inheritDoc}
*/
@Override
public Class<? extends Item> getItemType(String itemName) {
TinkerforgeBindingConfig config = (TinkerforgeBindingConfig) bindingConfigs.get(itemName);
return config != null ? config.getItemType() : null;
}
/**
* {@inheritDoc}
*/
@Override
public String getName(String itemName) {
TinkerforgeBindingConfig config = (TinkerforgeBindingConfig) bindingConfigs.get(itemName);
return config != null ? config.getName() : null;
}
/**
* {@inheritDoc}
*/
@Override
public DeviceOptions getDeviceOptions(String itemName) {
TinkerforgeBindingConfig config = (TinkerforgeBindingConfig) bindingConfigs.get(itemName);
return config != null ? config.getDeviceOptions() : null;
}
/**
* This class represents the configuration of an Item that is binded to a
* tinkerforge device. It can hold the following information:
*
* <ul>
* <li>The uid of the tinkerforge device.</li>
* <li>The subid of the tinkerforge device.</li>
* <li>The symbolic name of the tinkerforge device.</li>
* </ul>
*
* The configuration must either declare a uid and subid (if it is a
* tinkerforge subdevice) or a symbolic device name. The symbolic name must
* refer to a name, which has to be configured in the openhab.cfg file.
*
* @author Theo Weiss
* @since 1.3.0
*/
class TinkerforgeBindingConfig implements BindingConfig {
private String uid;
private String subId;
private String name;
private Item item;
private DeviceOptions deviceOptions;
Class<? extends Item> getItemType() {
return item.getClass();
}
public Item getItem() {
return item;
}
public void setItem(Item item) {
this.item = item;
}
public String getUid() {
return uid;
}
public String getSubId() {
return subId;
}
public void setSubId(String subId) {
this.subId = subId;
}
public void setUid(String uid) {
this.uid = uid;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public DeviceOptions getDeviceOptions(){
return this.deviceOptions;
}
public void setDeviceOptions (DeviceOptions deviceOptions){
this.deviceOptions = deviceOptions;
}
}
}