Copmpleted prog doc

Author: lwinkler

POPSensor.ph

@@ -45,6 +45,8 @@ public:
 	void Broadcast(int x_publicationType, double x_data);
 	void Broadcast(int x_publicationType, const std::string& x_data);
 
+	// TODO: Reduce
+
 
 	/// Clear data gathered 
 	void Clear();
@@ -65,7 +67,7 @@ public:
 	bool IsConnected();
 
 	// Size of collected data
-	sync conc int GetSize();
+	sync conc int GetSize(); // TODO rename to GetDataSize
 
 
 private:

PROGRAMMING.md

@@ -1,9 +1,14 @@
+Programming manual
+==================
 
 Examples of programmation
 -------------------------
 
 TODO: Write a manual
 
+POPSensor.ph
+POPSensorData.h
+
 ### 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:
 
@@ -43,3 +48,46 @@ To compile and run this example use:
 	make
 	popcrun objects.map ./main resources.json
 
+Main parallel classes
+---------------------
+This chapter describes in more details the main classes used in this project.
+
+### POPSensor parallel class
+POPSensor is the primary class to use in a POPWin application. It allows the user to access the remote sensors. Its main methods are:
+
+- **Constructor**: specifies the name of the JSON file that describes resources and start acquiring data from the remote sensors.
+- **Gather**     : returns the data that was gathered in the form of a POPSensorData object.
+- **Broadcast**  : broadcast one message to all sensors
+
+[Full definition](POPSensor.ph). 
+
+### SensorProxy parallel class
+One POPSensor object can connect to one or many POPSensor class. This second class handles the communication with the gateway sensor. The POPSensor object will create one POPSensor for each gateway sensor connected on USB. This is transparent to the programmer so this class should not be used directly.
+
+[Full definition](SensorProxy.ph). 
+
+### POPSensorData class
+A POPSensorData object is returned by the Gather() method. It contains all the data collected by the sensors including:
+
+- Sensor id
+- Time stamp
+- Measurement type
+- Measurement unit
+
+Additionally this class provides the mothods:
+
+- **Print** : Prints the data to the standard output
+- **PrintToFile** : Outputs the data to a file in .csv format
+- **Clear** : Clears the data
+- **GetSize** : Returns the number of records
+- **Insert**: Insert new data into the structure
+- **Reduce**: Compute and returns statistics on the data (size, min, max, aver, sum, stdev)
+
+[Full definition](POPSensorData.h). 
+
+
+Limitations
+-----------
+Broadcast of messages TODO
+Different firmwares for sensors
+

README.md

@@ -5,10 +5,6 @@ POPWin
 
 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
 --------
 - EIFR
@@ -45,8 +41,40 @@ 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
 
-A more complete scheme of the network can be found [here](POPWINarchi.pdf) !
+A more complete scheme of the network:
+
+![POPWin architecture](POPWINarchi.pdf "POPWin architecture") !
+
+Resource description and messaging system
+-----------------------------------------
+To configure easily where sensors (described as resources) can be found the application uses a resource file in JSON format. This file indicates how to connect to sensors and to which data the user wants to subscribe.
+
+To set up communication between the different sensors of the low-level part and the nodes of the high-level parts of the system a messaging interface was developed. This interface allows to easily transcribe message from the publish-subscribe used in the low-level system to the POP model used on the higher level.
+
+Specifications of resource description and messaging can be found [here](SPECIFICATIONS.md). 
+
+
+Programming
+-----------
+One goal of the POPWin project is to provide an easy programming interface to the developer. This interface allows to acquire data from different sensor types in a transparent way.
+
+The full programming guide for POPWin can be found [here](PROGRAMMING.md). 
+
+### Example
+
+
+
+Quick start
+-----------
+To start the main example of POPWin:
 
+1. Install POP-C++ on your computer
+2. Connect the gateway sensor to your computer via USB (Zolertia z1 in recommended)
+3. Compile and launch POPWin main application
 
+	cd pop-win
+	make
+	popcrun objects.map ./main resources.json
 
+For details on installation and troubleshooting please look at the [development documentation](INSTALL.md). 
 

main_example.cc

@@ -68,7 +68,7 @@ int main(int argc, char** argv)
 		sleep(3);
 
 		cout<<"\nPrint the gathered data to screen"<<popcendl;
-		POPSensorData data(popSensor.Gather());
+		POPSensorData data = popSensor.Gather();
 		data.Print();
 
 		cout<<"\nTemperature average is "<<data.Reduce<double>(MSR_TEMPERATURE, POPSensorData::POPReduceF::aver)<< popcendl;