--no commit message

Imanol-Mikel Barba Sabariego
1 parent e4e0d6d3
Showing 3 changed files with 28 additions and 1 deletions
Project/applications/smartcities/doc/doxygen/Doxyfile
Project/applications/smartcities/doc/modularsense.png
Project/applications/smartcities/mainpage.dox
@@ -47,7 +47,7 @@ PROJECT_BRIEF          = &quot;Remote sensing made easy&quot;
 # exceed 55 pixels and the maximum width should not exceed 200 pixels.
 # Doxygen will copy the logo to the output directory.
  
-PROJECT_LOGO           =
+PROJECT_LOGO           = ../modularsense.png
  
 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
 # base path where the generated documentation will be put.
+/*!
+* \mainpage Main Page
+* 
+* This is the documentation for the Wi-Sense <a href="http://lewis.upc.es/modularsense/wordpress/?page_id=11">Wi-Sense</a> software.
+* 
+* This software is based on the WiSmart library (libwismart) and STM32 Periph library.
+*
+* <br>
+* \section outline Product Outline
+
+* The software consists in a first \ref boot and a \ref loop.
+
+* \subsection boot Boot Stage
+* At the boot stage, it tries to connect to the default or previously configured (if applicable) Wi-Fi network. If this succeeds, it starts the \ref loop, but should it not work, then it will set up an AP called "modularsense" in which a web server is configured, allowing the user to set up the new parameters.
+
+* \subsection loop Main Loop
+* At the main loop, it initially scans for sensors and registers them in the SENTILO-compatible platform already configured on the device. Then, it collects data every 5 minutes, allocating memory for each iteration in which data is retrieved. After 30 minutes have passed, it sends the data to the platform if an Internet connection is available, if not, it will store it up until connectivity is reestablished.
+* This loop repeats until power runs out or until it runs out of memory, if that happens, it stops collecting data and tries to send the stored data until it is successful, then it frees the memory and resumes the cycle.
+
+* \subsection data Data Collection
+* Data collection is achieved using the internal I2C bus. Scanning is performed first to enumerate all the sensors available in the bus, then, data is fetched from them in a timely fashion.
+* The sound sensor uses one of the internal ADC to sample the sound pressure level. The internal battery level sensor also uses another ADC.
+
+* \author Imanol Barba Sabariego
+* \date 07/06/2013
+*/
+