Split the doc in different .md

Author: lwinkler

POPWINarchi.pdf

@@ -0,0 +1,45 @@
+
+Examples of programmation
+-------------------------
+
+TODO: Write a manual
+
+### main_example.cpp
+This file contains the a simple example on how to uses the different classes of the POPWin project. The main code of this examples is:
+
+	// Create a POPSensor object on the local machine with resource description
+	POPSensor popSensor("localhost", "resource.json");
+
+	// Start listening to the remote sensors
+	popSensor.StartListening();
+
+	// wait ...
+
+	// Stop listening
+	popSensor.StopListening();
+
+	// Print the gathered data
+	POPSensorData data(popSensor.Gather());
+	data.Print();
+
+	// Clear data
+	popSensor.Clear();
+
+As shown here the POPSensor object can be used in a very simple and efficient manner. For the programmer this class can be used transparently.
+
+To compile and run this example use:
+
+	cd pop-win
+	make
+	popcrun objects.map ./main_example resources.json
+
+
+### main.cpp
+This file contains a more complete use of the POPWin objects. It also instantiates a POPSensor objects and lets the user send commands via the keyboard. This example can be used to test the system.
+
+To compile and run this example use:
+
+	cd pop-win
+	make
+	popcrun objects.map ./main resources.json
+

PROGRAMMING.md

@@ -3,7 +3,11 @@ POPWin
 - **Author:** Laurent Winkler
 - **Date:**   Decembre 2014
 
-This document contains a general description of the POPWin project, specifications and examples of programmation. For a more technical documentation (installation, troubleshooting, ...) the developer documentation can be found here [here](INSTALL.md)
+This document contains a general description of the POPWin project, specifications and examples of programmation. 
+
+1. For a more technical documentation (installation, troubleshooting, ...) the developer documentation can be found here [here](INSTALL.md). 
+2. The full programming guide for POPWin can be found [here](PROGRAMMING.md). 
+3. Specifications of resource description and messaging can be found [here](SPECIFICATIONS.md). 
 
 Contacts
 --------
@@ -41,138 +45,8 @@ As explained in the documentation of the POPWin project the communication uses d
 - **High level**: the POP model is used
 - **Low level**: the publish/subscribe model is used
 
-TODO: Add UML schemes of PK
-
-Examples of programmation
--------------------------
-
-TODO: Write a manual
-
-### main_example.cpp
-This file contains the a simple example on how to uses the different classes of the POPWin project. The main code of this examples is:
-
-	// Create a POPSensor object on the local machine with resource description
-	POPSensor popSensor("localhost", "resource.json");
-
-	// Start listening to the remote sensors
-	popSensor.StartListening();
-
-	// wait ...
-
-	// Stop listening
-	popSensor.StopListening();
-
-	// Print the gathered data
-	POPSensorData data(popSensor.Gather());
-	data.Print();
-
-	// Clear data
-	popSensor.Clear();
-
-As shown here the POPSensor object can be used in a very simple and efficient manner. For the programmer this class can be used transparently.
-
-To compile and run this example use:
-
-	cd pop-win
-	make
-	popcrun objects.map ./main_example resources.json
-
-
-### main.cpp
-This file contains a more complete use of the POPWin objects. It also instantiates a POPSensor objects and lets the user send commands via the keyboard. This example can be used to test the system.
-
-To compile and run this example use:
-
-	cd pop-win
-	make
-	popcrun objects.map ./main resources.json
-
-
-Specifications
---------------
-### Resource description
-The resources (or sensors) that the programmer wants to access are specified in the **resource.json** file. It can contain the following fields:
-- **gateway**: specifies how to access the gateway sensor
-	- **url**: the machine on which the gateway sensor is connected
-	- **connection**: the connection between the machine and the gateway sensor (for now only usb is supported)
-- **nodes**: specifies the types of measurement
-	- **measurement type**: temperature, humidity, light, ... as specified in [gatewayMote/popwin_messages.h]
-	- **direction**: "IN" for sensor or "OUT" for actuators
-
-
-	{
-		"gateways":[
-			{
-				"url": "localhost",
-				"connection": "usb"
-			}
-		],
-		"wsns":{
-			"nodes":[
-				{
-					"measurementType": "temperature",
-					"direction":   "IN"
-				},
-				{
-					"measurementType": "humidity",
-					"direction":   "IN"
-				},
-				{
-					"measurementType": "light",
-					"direction":   "IN"
-				}
-			]
-		}
-	}
-
-Examples of resource files can be found [resources.json](here) and [multi_gw.json](here).
-
-
-### Messaging
-In the low-level part of the system (that uses the publish/subscribe messaging model) the following types of models are implemented: notification, publication and subscription. Please note that unsubscriptions are not implemented yet but their structure is identical to subscription messages.
-
-The messages can contain the following fields:
-- **MeasurementType**: An enum that specifies the type of measurement: temperature, vibration, humidity, ...
-- **MeasurementUnit**: An enum that specifies the measurement unit: Celsius, seconds, meters, ...
-- **PublicationType**: An enum that specifies the type of publication: e.g. led
-- **ID**             : The id of the sender
-- **DataType**       : An enum that specifies the type of the data: double, int or string
-- **data**           : A buffer of character (of size BUFFERDATASIZE=64) that contains the data. For compatibility between systems integers and floats are printed to this buffer and not stored as bit value.
-- **DataSize**       : The size of the above data in characters
-
-TODO: Add buffering functions (2 ways) + link to .h
-
-#### Notification message
-
-	struct NotifyMessage
-	{
-		enum MeasurementType measurementType;
-		enum DataType        dataType;
-		unsigned short       id;
-		enum MeasurementUnit unit;
-		size_t               dataSize;
-		char                 data[BUFFERDATASIZE];
-	};
-
-#### Publication message
-
-	struct PublishMessage
-	{
-		enum PublicationType publicationType;
-		enum DataType        dataType;
-		unsigned short       id;               // not mandatory, for convenience
-		size_t               dataSize;
-		char                 data[BUFFERDATASIZE];
-	};
-
+A more complete scheme of the network can be found [here](POPWINarchi.pdf) !
 
-#### Subscription message
 
-	struct SubscribeMessage
-	{
-		unsigned short       id;               // Id is not mandatory. Only for convenience
-		enum MeasurementType measurementType;
-		enum DataType        dataType;
-	};