--no commit message

Imanol-Mikel Barba Sabariego
1 parent 6c5fd3ac
Showing 13 changed files with 134 additions and 15 deletions
Project/applications/smartcities/buffer.c
Project/applications/smartcities/callbacks.c
Project/applications/smartcities/configServer.c
Project/applications/smartcities/httpClient.c
Project/applications/smartcities/i2c.c
Project/applications/smartcities/include/adc.h
Project/applications/smartcities/include/callbacks.h
Project/applications/smartcities/json.c
Project/applications/smartcities/main.c
Project/applications/smartcities/mainpage.dox
Project/applications/smartcities/ntp.c
Project/applications/smartcities/sensors.c
Project/applications/smartcities/timer-loop.c
+/**@file
+ * @brief Definitions for the memory buffer management
+ * @author Maria Jorba Brosa
+ * @date 08/06/2014
+ *
+ * This is where all the methods previously declared in buffer.h are defined.
+ */
+
 #include "buffer.h"
-#include "globals.h"
  
 char** put_message(char* info, char** buf,uint32_t *index, uint32_t *buf_len)
 {
+/**@file
+ * @brief Definitions for the network callbacks
+ * @author Imanol Barba Sabariego, Maria Jorba Brosa
+ * @date 08/06/2014
+ *
+ * This is where all the methods previously declared in callbacks.h are defined.
+ */
+
 #include "callbacks.h"
  
 void dhcp_connect_result_cb(int result)
+/**@file
+ * @brief Definitions for the configuration HTTP server
+ * @author Imanol Barba Sabariego
+ * @date 08/06/2014
+ *
+ * This is where all the methods previously declared in configServer.h are defined.
+ */
+
 #include "configServer.h"
  
+//! POST variable for Wi-Fi network name
 char arg_networkNameStr[100];
+//! POST variable for Wi-Fi network passphrase
 char arg_passphraseStr[100];
+//! POST variable for Wi-Fi network security type
 char arg_securityTypeStr[100];
+//! POST variable for RADIUS username
 char arg_radUserStr[100];
+//! POST variable for RADIUS password
 char arg_radPassStr[100];
+//! POST variable for geolocalization coordinates (i.e: 41.557255 2.096183)
 char arg_geoLocalizationStr[100];
+//! Timer for device reboot
 wismart_timer_t rebootTimer;
-
-/* This is the array that stores the http resources */
+//! This is the array that stores the http resources
 wismart_server_resource_t configServerResources[22];
  
 void configServer_start(uint8_t enableApScan)
+/**@file
+ * @brief Definitions for the HTTP client functions
+ * @author Ferràn Quer i Guerrero
+ * @date 08/06/2014
+ *
+ * This is where all the methods previously declared in httpClient.h are defined.
+ */
+
 #include "httpClient.h"
  
 /*
+/**@file
+ * @brief Definitions for the I2C functionality
+ * @author Imanol Barba Sabariego
+ * @date 08/06/2014
+ *
+ * This is where all the methods previously declared in i2c.h are defined.
+ */
+
 #include "i2c.h"
 #include "json.h"
  
@@ -2,9 +2,9 @@
 /**@file
  * @brief Declaration for the ADC functionality
  * @author Imanol Barba Sabariego
- * @date 07/06/2014
+ * @date 08/06/2014
  *
- * This is where all the methods previously declared in adc.h are defined.
+ * The functions declared in this file manage the ADC functionality of the device to use with the battery and sound sensor
  */
  
 #ifndef ADC_H
@@ -11,6 +11,7 @@
  
 #define CONNECTED_PAST		0x02
 #define CONNECTED_NOW		0x01
+#define NOT_CONNECTED		0x00
  
 void dhcp_connect_result_cb(int result);
 void wifi_connect_result_cb(int result);
+/**@file
+ * @brief Definitions for the JSON formatting functions
+ * @author Imanol Barba Sabariego
+ * @date 08/06/2014
+ *
+ * This is where all the methods previously declared in json.h are defined.
+ */
+
 #include "json.h"
  
 uint8_t register_sensor(sensor sens)
@@ -12,26 +12,46 @@
 #include "ntp.h"
 #include "sensors.h"
  
+/*! This definition is used for debugging purposes, it is a shorthand for printing debug information */
 #define DBG(fmt,...)                printf("%c[1;35mmain.c:%c[1;00m "fmt,0x1B,0x1B, ##__VA_ARGS__)
 //#define DBG(fmt,...)              printf("")
  
  
-
-uint8_t connected=0;
-uint8_t timeout=0;
-uint8_t retries=0;
-uint8_t sensors_length=0;
-uint8_t registry_opened=0;
+//! Connection state global variable
+/*! This variable stores the connection state of the device. Its possible values are defined in callbacks.h and are:
+ *  <br>NOT_CONNECTED
+ *  <br>CONNECTED_NOW
+ *  <br>CONNECTED_PAST
+ */
+uint8_t connected = NOT_CONNECTED;
+//! Connection timeout global variable
+/*! This variable tells if there's been a timeout while trying to connect to the Wi-Fi network */
+uint8_t timeout = 0;
+//! Wi-Fi connection retries
+/*! This variable holds the number of times the device has retried to connect to the Wi-Fi network */
+uint8_t retries = 0;
+//! Number of sensors
+/*! This variable is updated when the I2C scan is performed and stores how many sensors have been detected */
+uint8_t sensors_length = 0;
+//! Configuration registry status
+/*! This variable tells if the configuration registry has already been opened to avoid reopening it, which causes a software fault */
+uint8_t registry_opened = 0;
+//! Configuration registry variable
+/*! This variable is used to make R/W accesses to the configuration registry */
 wismart_registryKey_t geo;
+//! Current module information
 module mod;
  
+//! libwismart library initialization
+/*! This functions initializes the libwismart library, enabling all the functionality for posterior use */
 void initLibwismart(void)
 {
     wismart_hwif_t hwif = libwismart_GetDefaultHWIF();
     libwismart_Init(hwif);
 }
  
-
+//! NTP time update function
+/*! This function is called upon NTP update request and uses the methods declared in ntp.h to do so. */
 void update_time(unsigned long *time)
 {
     do
@@ -51,6 +71,8 @@ void update_time(unsigned long *time)
     }while(!(*time));
 }
  
+//! Configuration registry initialization and Wi-Fi network connection function
+/*! This function opens and reads the configuration registry and connects to the Wi-Fi network as there configured */
 void init_registry(void)
 {
     config_params_t config;
@@ -112,6 +134,8 @@ void init_registry(void)
  
 }
  
+//! Function to send data to the server
+/*! This function sends all the data in the memory to the server */
 void send_data(char** buffers[], uint32_t ind[], uint32_t sizes[], uint8_t sensors[])
 {
     int j;
@@ -124,6 +148,8 @@ void send_data(char** buffers[], uint32_t ind[], uint32_t sizes[], uint8_t senso
     }
 }
  
+//! Buffer data insertion function
+/*! This function inserts processed data in the memory */
 void put_buffers(char** buffers[],uint32_t ind[],uint32_t sizes[],char** cooked, uint8_t* sensors)
 {
     DBG("Putting data in buffers...\r\n");
@@ -139,6 +165,9 @@ void put_buffers(char** buffers[],uint32_t ind[],uint32_t sizes[],char** cooked,
     DBG("Data is now in buffer\n\r");
     chHeapFree(cooked);
 }
+
+//! Data timestamping function
+/*! This function timestamps de collected data using the methods defined in ntp.h */
 char** timestamp_datas(char* value[],unsigned long timestamp, uint8_t* sensors)
 {
     DBG("Timestamping data...\r\n");
@@ -157,6 +186,7 @@ char** timestamp_datas(char* value[],unsigned long timestamp, uint8_t* sensors)
     return cooked_data;
 }
  
+//! Wi-Fi connect function
 void wifi_connect(void)
 {
     DBG("Connecting wifi...\r\n");
@@ -174,6 +204,8 @@ void wifi_connect(void)
     timeout = 0;
 }
  
+//! Battery reporting function
+/*! This function checks the battery level and sends it to the server */
 void send_battery_level(unsigned long timestamp)
 {
     DBG("Polling battery level...\r\n");
@@ -191,6 +223,7 @@ void send_battery_level(unsigned long timestamp)
     chHeapFree(statement);
 }
  
+//! Wi-Fi Disocnnect function
 void wifi_disconnect(void)
 {
     DBG("Disconnecting wifi...\r\n");
@@ -207,6 +240,7 @@ void wifi_disconnect(void)
         DBG("Disconnecting Failed: WIFI_DISCONNECT_FAILURE\r\n");
 }
  
+//! Main loop
 int main(void)
 {
     initLibwismart();
@@ -3,7 +3,7 @@
 * 
 * This is the documentation for the <a target="_blank" 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.
+* This software is based on the WiSmart library (libwismart) and STM32 Standard Peripheral library.
 *
 * <br>
 * \section outline Product Outline
@@ -11,10 +11,10 @@
 * 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.
+* 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. More information on how to configure the web interface can be found <a target="_blank" href="http://www.modularsense.com/wp-content/uploads/2014/06/Modular-Sense-2.pdf">here</a>.
  
 * \subsection loop Main Loop
-* At the main loop, it initially scans for sensors and registers them in the <a href="http://sentilo.io" target="_blank">SENTILO</a>-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.
+* At the main loop, it initially scans for sensors and registers them in the <a href="http://sentilo.io" target="_blank">SENTILO</a> 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.
 * <br><br>This loop repeats until power runs out or until it runs out of memory. Given the case, 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
+/**@file
+ * @brief Definitions for the NTP client functionality
+ * @author Emilio Soca Herrera
+ * @date 08/06/2014
+ *
+ * This is where all the methods previously declared in ntp.h are defined.
+ */
+
 #include "ntp.h"
  
 Date getDate(unsigned long secsSince1900)
+/**@file
+ * @brief Definitions for the sensor fetching methods and sensor definitions
+ * @author Imanol Barba Sabariego
+ * @date 08/06/2014
+ *
+ * This is where all the methods previously declared in sensors.h are defined. Also, the different sensors are defined here
+ */
+
 #include "sensors.h"
  
+//! Definition for the light sensor
 sensor light_sensor         = {LIGHT_ADDR,          "Light sensor",                     "illumination",         "lux"};
+//! Definition for the distance sensor
 sensor ultrasound_sensor    = {DISTANCE_ADDR,       "Ultrasound sensor",                "distance",             "cm"};
+//! Definition for the pressure sensor
 sensor pressure_sensor      = {PRESSURE_ADDR,       "Pressure sensor",                  "pressure",             "hPa"};
+//! Definition for the humidity and temnperature sensor
 sensor humidity_temp_sensor = {HUMIDITY_TEMP_ADDR,  "Temperature and humidity sensor",  "temperature,humidity", "ºC,RH"};
+//! Definition for the sound sensor
 sensor sound_sensor         = {SOUND_ADDR,          "Sound sensor",                     "sound",                "mV"};
+//! Definition for the battery sensor battery
 sensor battery              = {BATTERY_ADDR,        "Battery Level",                    "power",                "mV"};
  
+//! Sensor definition array
 sensor* sensors[TOTAL_SENSORS+1] = {&light_sensor,&ultrasound_sensor,&pressure_sensor,&humidity_temp_sensor,&sound_sensor,&battery};
  
 void wakeup_sensors(uint8_t logic_address)
+/**@file
+ * @brief Definitions for the timing control functions
+ * @author Ferràn Quer i Guerrero
+ * @date 08/06/2014
+ *
+ * This is where all the methods previously declared in timer-loop.h are defined.
+ */
+
 #include "timer-loop.h"