New implementation

Author: zambrovski

.gitignore

@@ -1,4 +1,4 @@
-/target/
+target/
 .classpath
 .project
-.settings
+.settings/

README.md

@@ -1,8 +1,83 @@
 # MQTT Tinkerforge Bridge
 
-This project allows to bind Tinker Forge sensors and actuators using MQTT to a central broker. 
+This project allows to bind TinkerForge sensors and actuators using MQTT to a central broker. 
 The application is built using Spring Boot and is currently in a playground phase.
 
 ## Installation and usage
 
-Makre sure to correct the `application.properties` and build with Apache Maven using `mvn clean install`.
+### Installation 
+
+In order to build the software, please run `mvn clean package` from command line (you will require Apache Maven).
+
+### Configuration
+
+For configuration, make sure to copy the `application.properties` from `docs` folder and adjust the configuration.
+
+#### General configuration
+
+In order to connect to the TinkerForge MasterBrick, the connection needs to be specified.
+Please use the following two values to configure the connection (the specified values are default):
+
+    #
+    # TF connection
+    # 
+    tinkerforge.host=localhost
+    tinkerforge.port=4223
+    
+The sensor values are delivered to a MQTT broker, which has to be configured.
+
+    #
+    # MQTT connection
+    #
+    mqtt.broker=tcp://localhost:1883
+    mqtt.client.id=localtest
+    mqtt.qos=2
+
+#### Configuring MQTT delivery
+
+The MQTT protocol allows to create topics in a special way, so MQTT selectors (# and +) can be applied. In doing so, every MQTT sensor setup has a naming scheme which can be applied to the devices delivering the events. Usually this naming scheme is establishing a topology (physical or logical). The configuration is divided in three parts:
+
+- Topic prefix of the entire application
+- Topic segment for device
+- Topic segment for measurement
+
+The resulting topic is created by a concatenation of all three segments. The application topic prefix is configured by the property `mqtt.topic.prefix`. The device topic segment is configured using properties of scheme `<uid>.topic=cellar` where the `<uid>` is denoting the device UID of the bricklet. It is possible to configure multiple devices to point to the same topic. e.G.:
+
+    mqtt.topic.prefix=testsetup/
+    aDc.topic=cellar
+    hgY.topic=cellar
+    dfH.topic=cellar
+    
+In this setup, the three devices with given UIDs are located in cellar and deliver measurements to the same topic `testsetup/cellar`. The measurement topic is configured usgin the device specific setting (see next section).
+
+#### Device configuration
+
+Currently, the following sensor types are supported:
+ - Ambient light
+ - Barometer
+ - Distance Infra-Red
+ - Distance Ultra-Sound
+ - Hygrometer
+ - LCD 20x4 Buttons
+ - Scale
+ - Thermometer
+ - Thermometer Infra-Red
+ - Voltmeter
+ 
+In addition, the following actuators are implemented:
+ - LCD 20x4 Text and Backlight
+
+In general, you can configure every value sensor and set its value read timeout (`callbackperiod`) and the target topic (`topic`).
+
+    #
+    # Example ambient light
+    # 
+    tinkerforge.ambilight.topic=illuminance
+    tinkerforge.ambilight.callbackperiod=10000
+
+This will configure the ambient light to be checked every 10 seconds and deliver the value to `testsetup/cellar/illuminance`.
+
+
+### Run
+
+To run the software just run `java -jar <mqtt-tinkerforge-boot-version.jar>

docs/application.properties

@@ -1,19 +1,14 @@
+#
+# MQTT Part
+#
+mqtt.broker=tcp://localhost:1883
+mqtt.client.id=localtest
+mqtt.qos=2
+mqtt.topic.prefix=homebase/
+
+#
+# TF Part
+# 
 tinkerforge.host=localhost
 tinkerforge.port=4223
-tinkerforge.master.uid=6wxw1h
-
-tinkerforge.bricklet.barometer.uid=k61
-tinkerforge.bricklet.barometer.callbackperiod=20000
-tinkerforge.bricklet.thermometer.uid=nnA
-tinkerforge.bricklet.thermometer.callbackperiod=20000
-tinkerforge.bricklet.hygrometer.uid=kfp
-tinkerforge.bricklet.hygrometer.callbackperiod=20000
-tinkerforge.bricklet.lcd.uid=qor
 
-
-
-mqtt.broker=tcp://localhost:1883
-#mqtt.broker=tcp://rlx-v88.ham.dlh.de:1883
-mqtt.qos=2
-mqtt.topic.prefix=tis/fridge/
-mqtt.client.id=MQTT Sensor Client

docs/realm.properties

@@ -0,0 +1,10 @@
+mcy.topic=room1
+kqN.topic=room1
+
+qor.topic=cellar
+nnA.topic=cellar
+kfp.topic=cellar
+k61.topic=cellar
+
+
+

pom.xml

@@ -3,14 +3,15 @@
 	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 	<modelVersion>4.0.0</modelVersion>
 	<groupId>de.techjava</groupId>
-	<artifactId>mqtt-tinkerforge</artifactId>
+	<artifactId>mqtt-tinkerforge-bridge</artifactId>
 	<packaging>jar</packaging>
 	<name>TinkerForge MQTT Bridge</name>
+	<description>Spring Boot application providing TinkerForge to MQTT bridge.</description>
 
 	<parent>
 		<groupId>org.springframework.boot</groupId>
 		<artifactId>spring-boot-starter-parent</artifactId>
-		<version>1.2.4.RELEASE</version>
+		<version>1.3.1.RELEASE</version>
 		<relativePath />
 	</parent>
 
@@ -26,7 +27,7 @@
 			<dependency>
 				<groupId>org.springframework.boot</groupId>
 				<artifactId>spring-boot-dependencies</artifactId>
-				<version>1.2.4.RELEASE</version>
+				<version>1.3.1.RELEASE</version>
 				<type>pom</type>
 				<scope>import</scope>
 			</dependency>

src/main/java/de/techjava/mqtt/tf/Starter.java

@@ -1,26 +1,10 @@
 package de.techjava.mqtt.tf;
 
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 import org.springframework.boot.SpringApplication;
-import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
-import org.springframework.context.ConfigurableApplicationContext;
-import org.springframework.context.annotation.ComponentScan;
-import org.springframework.context.annotation.Configuration;
-import org.springframework.context.annotation.EnableAspectJAutoProxy;
 
-@Configuration
-@EnableAutoConfiguration
-@EnableAspectJAutoProxy(proxyTargetClass = true)
-@ComponentScan
 public class Starter {
 
-	static final Logger logger = LoggerFactory.getLogger(Starter.class);
-
 	public static void main(final String[] args) {
-		final ConfigurableApplicationContext applicationContext = SpringApplication.run(Starter.class, args);
-		applicationContext.addApplicationListener((event) -> {
-
-		});
+		SpringApplication.run(StarterConfiguration.class, args);
 	}
 }

src/main/java/de/techjava/mqtt/tf/StarterConfiguration.java

@@ -0,0 +1,25 @@
+package de.techjava.mqtt.tf;
+
+import javax.annotation.PostConstruct;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
+import org.springframework.boot.context.properties.EnableConfigurationProperties;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.Import;
+
+import de.techjava.mqtt.tf.comm.MqttConfiguration;
+import de.techjava.mqtt.tf.core.TinkerForgeConfiguration;
+
+@Configuration
+@Import({ MqttConfiguration.class, TinkerForgeConfiguration.class })
+public class StarterConfiguration {
+
+	private static final Logger logger = LoggerFactory.getLogger(StarterConfiguration.class);
+
+	@PostConstruct
+	public void postConstruct() {
+		logger.info("Configuration loaded.");
+	}
+}