Zoul: cleaned headers, doxygen tags and uncrustified

This commit is contained in:
Antonio Lignan 2016-09-01 16:08:01 +02:00
parent 3227360b92
commit e25a62997d
24 changed files with 122 additions and 91 deletions

View file

@ -481,7 +481,6 @@ PROCESS_THREAD(at_test_process, ev, data)
}
/*---------------------------------------------------------------------------*/
/**
* @}
* @}
* @}
*/

View file

@ -29,7 +29,7 @@
*/
/*---------------------------------------------------------------------------*/
/**
* \addtogroup remote-examples
* \addtogroup zoul-examples
* @{
*
* \defgroup zoul-AT-master-test
@ -63,5 +63,8 @@
#define NETSTACK_CONF_RDC nullrdc_driver
#endif /* PROJECT_CONF_H_ */
/** @} */
/*---------------------------------------------------------------------------*/
/**
* @}
* @}
*/

View file

@ -40,6 +40,7 @@
* \author
* Antonio Lignan <alinan@zolertia.com>
*/
/*---------------------------------------------------------------------------*/
#include "contiki.h"
#include "cpu.h"
#include "sys/etimer.h"

View file

@ -43,6 +43,7 @@
* \author
* Antonio Lignan <alinan@zolertia.com>
*/
/*---------------------------------------------------------------------------*/
#ifndef PROJECT_CONF_H_
#define PROJECT_CONF_H_

View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2012, Texas Instruments Incorporated - http://www.ti.com/
* Copyright (c) 2016, Zolertia - http://www.zolertia.com
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
@ -28,13 +28,15 @@
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
* OF THE POSSIBILITY OF SUCH DAMAGE.
*/
/*---------------------------------------------------------------------------*/
/**
* \addtogroup remote-examples
* \addtogroup zoul-examples
* @{
*
* \file
* Project specific configuration defines for the basic RE-Mote examples
*/
/*---------------------------------------------------------------------------*/
#ifndef PROJECT_CONF_H_
#define PROJECT_CONF_H_

View file

@ -0,0 +1 @@
TARGET = zoul

View file

@ -0,0 +1 @@
TARGET = zoul

View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2012, Texas Instruments Incorporated - http://www.ti.com/
* Copyright (c) 2015, Zolertia <http://www.zolertia.com>
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
@ -28,18 +28,28 @@
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
* OF THE POSSIBILITY OF SUCH DAMAGE.
*/
/*---------------------------------------------------------------------------*/
/**
* \addtogroup remote-examples
* \addtogroup zoul-examples
* @{
*
* \defgroup remote-rtcc-test RE-Mote on-board RTCC test application
*
* Test the Real-Time-Clock-Calendar built in the RE-Motes revision A and B
* @{
*
* \file
* Project specific configuration defines for the basic RE-Mote examples
* Project specific configuration defines for the RTCC RE-Mote example
*/
/*---------------------------------------------------------------------------*/
#ifndef PROJECT_CONF_H_
#define PROJECT_CONF_H_
#define NETSTACK_CONF_RDC nullrdc_driver
#endif /* PROJECT_CONF_H_ */
/** @} */
/*---------------------------------------------------------------------------*/
/**
* @}
* @}
*/

View file

@ -1,5 +1,6 @@
/*
* Copyright (c) 2015, Zolertia - http://www.zolertia.com
* Copyright (c) 2015, Zolertia <http://www.zolertia.com>
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
@ -29,10 +30,8 @@
*/
/*---------------------------------------------------------------------------*/
/**
* \addtogroup remote-examples
* \addtogroup remote-rtcc-test
* @{
* \defgroup remote-rtcc-test RE-Mote on-board RTCC test application
*
* Example project to show the on-board RTCC configuration and operation
* Retrieves the current time and date from the system, then sets an alarm to
@ -43,9 +42,7 @@
*
* \file
* RE-Mote on-board RTCC test application
*
* \author
*
* Antonio Lignan <alinan@zolertia.com>
* Aitor Mejias <amejias@zolertia.com>
* Toni Lozano <tlozano@zolertia.com>
@ -178,4 +175,3 @@ PROCESS_THREAD(test_remote_rtcc_process, ev, data)
* @}
* @}
*/

View file

@ -28,20 +28,22 @@
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
* OF THE POSSIBILITY OF SUCH DAMAGE.
*/
/*
/**
* \addtogroup zoul-examples
* @{
*
* \defgroup zoul-aac-sensor-test Test AAC sensor
*
* Demonstrates the operation of the current AAC analog sensor
* @{
*
* \file
* Example demonstrating the Zoul module on the RE-Mote & AAC sensor 0-5V 50Amps AC
* Example demonstrating the RE-Mote & AAC sensor 0-5V 50Amps AC
*
* \author
* Javier Sánchez <asanchez@zolertia.com>
*/
/*---------------------------------------------------------------------------*/
#include "contiki.h"
#include "sys/etimer.h"
#include "sys/rtimer.h"
@ -100,3 +102,4 @@ PROCESS_THREAD(test_aac_sensor_process, ev, data)
* @}
* @}
*/

View file

@ -100,3 +100,4 @@ PROCESS_THREAD(remote_ac_dimmer_process, ev, data)
* @}
* @}
*/

View file

@ -38,7 +38,7 @@
* @{
*
* \file
* Test file for the BMP085/BMP180 digital pressure and temperature sensor
* Test file for the BMP085/BMP180 digital pressure and temp sensor
*
* \author
* Antonio Lignan <alinan@zolertia.com>

View file

@ -29,9 +29,10 @@
*/
/*---------------------------------------------------------------------------*/
/**
* \addtogroup remote-examples
* \addtogroup zoul-examples
* @{
* \defgroup remote-iaq-test
*
* \defgroup zoul-iaq-test
*
* RE-Mote external IAQ test application
* Example of iAQ-Core implementation and simple operation reading the value
@ -96,8 +97,7 @@ PROCESS_THREAD(test_remote_iaq_process, ev, data)
printf("CO2 current value is: %d ppm\n", iaq.value(IAQ_VOC_VALUE));
printf("TIAQ current value is: %d ppb\n", iaq.value(IAQ_CO2_VALUE));
printf("Status is: 0x%0X\n", iaq.value(IAQ_STATUS));
}
else {
} else {
printf("iAQ-Core Error: 0x%02X\n", status);
}
}

View file

@ -100,3 +100,4 @@ PROCESS_THREAD(test_presence_sensor, ev, data)
* @}
* @}
*/

View file

@ -31,6 +31,7 @@
/**
* \addtogroup zoul-examples
* @{
*
* \defgroup zoul-pm10-sensor-test Test PM10 sensor
*
* Demonstrates the operation of the Sharp PM10 analog sensor
@ -93,3 +94,4 @@ PROCESS_THREAD(test_pm10_sensor_process, ev, data)
* @}
* @}
*/

View file

@ -87,3 +87,4 @@ PROCESS_THREAD(remote_relay_process, ev, data)
* @}
* @}
*/

View file

@ -105,3 +105,4 @@ PROCESS_THREAD(servo_test_process, ev, data)
* @}
* @}
*/

View file

@ -28,20 +28,23 @@
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
* OF THE POSSIBILITY OF SUCH DAMAGE.
*/
/*
/*---------------------------------------------------------------------------*/
/**
* \addtogroup zoul-examples
* @{
*
* \defgroup zoul-vac-sensor-test Test VAC sensor
*
* Demonstrates the operation of the voltage VAC analog sensor
* @{
*
* \file
* Example demonstrating the Zoul module on the RE-Mote & VAC sensor 0-5V 250V AC
* Example demonstrating the RE-Mote & VAC sensor 0-5V 250V AC
*
* \author
* Javier Sánchez <asanchez@zolertia.com>
*/
/*---------------------------------------------------------------------------*/
#include "contiki.h"
#include "sys/etimer.h"
#include "sys/rtimer.h"
@ -102,3 +105,4 @@ PROCESS_THREAD(test_vac_sensor_process, ev, data)
* @}
* @}
*/

View file

@ -153,7 +153,7 @@ PROCESS_THREAD(test_weather_meter_sensors, ev, data)
}
/*---------------------------------------------------------------------------*/
/**
* @}
* @}
* @}
*/

View file

@ -29,8 +29,9 @@
*/
/*---------------------------------------------------------------------------*/
/**
* \addtogroup remote-examples
* \addtogroup zoul-examples
* @{
*
* \defgroup remote-zonik-test Zolertia Zonik sonometer test application
*
* Example of Zonik board implementation and simple operation: Infinite loop

View file

@ -29,6 +29,7 @@
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
* OF THE POSSIBILITY OF SUCH DAMAGE.
*/
/*---------------------------------------------------------------------------*/
/**
* \addtogroup zoul
* @{
@ -62,6 +63,7 @@
* \file
* Example demonstrating the Zoul module on the RE-Mote & Firefly platforms
*/
/*---------------------------------------------------------------------------*/
#include "contiki.h"
#include "cpu.h"
#include "sys/etimer.h"
@ -194,3 +196,4 @@ PROCESS_THREAD(zoul_demo_process, ev, data)
* @}
* @}
*/