diff --git a/examples/external_led/Makefile b/examples/blinking/Makefile similarity index 100% rename from examples/external_led/Makefile rename to examples/blinking/Makefile diff --git a/examples/external_led/README.md b/examples/blinking/README.md similarity index 100% rename from examples/external_led/README.md rename to examples/blinking/README.md diff --git a/examples/external_led/doc.txt b/examples/blinking/doc.txt similarity index 75% rename from examples/external_led/doc.txt rename to examples/blinking/doc.txt index ff5fb532d..cfec665a3 100644 --- a/examples/external_led/doc.txt +++ b/examples/blinking/doc.txt @@ -7,20 +7,20 @@ */ /** - * @defgroup external-led External-led blink + * @defgroup examples_blinking Blinking * @ingroup examples - * @brief This is a external led blink example to known about gpio/periph.h + * @brief This is a led blink example to known about gpio/periph.h * @author xkevin190 \section led External Led Blink -## Table of Contents {#external_led_blink_toc} +## Table of Contents {#blinking_toc} -1. [Hardware](#external_led_blink_hardware) -2. [Getting Started](#external_led_blink_basic) -3. [Flashing the Device](#external_led_blink_flashing) +1. [Hardware](#blinking_hardware) +2. [Getting Started](#blinking_basic) +3. [Flashing the Device](#blinking_flashing) -## Hardware {#external_led_blink_hardware} +## Hardware {#blinking_hardware} This section shows, which pin is used in this example. @@ -30,7 +30,7 @@ Function | GPIOs | Remarks | LED_PIN | GPIO(PA , 19)| Pin to blink control of led | -## Getting Started {#external_led_blink_basic} +## Getting Started {#blinking_basic} To understand how to make a gpio_pin use digital Output. Import the periph/gpio.h library. You could use two functions to set digital output 1 or 0. @@ -51,12 +51,12 @@ changes the value of current state. (means if is HIGH, when applied this functio another aspect to be take into account is add the xtimer and ztimer headers files, to use temporizers in our code. -## Flashing {#external_led_blink_flashing} +## Flashing {#blinking_flashing} If you want to upload the example to your board, needs to compile first, additional to this you could initialize the terminal and watch the results ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -make -C examples/esp32-wroom-32/external_led flash term +make -C examples/blinking flash term ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -[Back to table of contents](#external_led_blink_toc) +[Back to table of contents](#blinking_toc) */ diff --git a/examples/external_led/main.c b/examples/blinking/main.c similarity index 96% rename from examples/external_led/main.c rename to examples/blinking/main.c index 23bcf110a..1caf3608c 100644 --- a/examples/external_led/main.c +++ b/examples/blinking/main.c @@ -15,7 +15,7 @@ */ /** - * @ingroup examples_esp32-wrover + * @ingroup examples_blinking * * @file * @brief this is an example of external_led_blink diff --git a/examples/doc.txt b/examples/doc.txt index b47f2413a..8ebbec264 100644 --- a/examples/doc.txt +++ b/examples/doc.txt @@ -1,5 +1,5 @@ /** -@defgroup examples Mesh4all Examples +@defgroup examples Sample applications running on Mesh4all-boards ## This is example-doc diff --git a/examples/ds18b20/Makefile b/examples/ds18/Makefile similarity index 100% rename from examples/ds18b20/Makefile rename to examples/ds18/Makefile diff --git a/examples/ds18b20/README.md b/examples/ds18/README.md similarity index 100% rename from examples/ds18b20/README.md rename to examples/ds18/README.md diff --git a/examples/ds18b20/doc.txt b/examples/ds18/doc.txt similarity index 58% rename from examples/ds18b20/doc.txt rename to examples/ds18/doc.txt index c8861200c..c8cb3ce49 100644 --- a/examples/ds18b20/doc.txt +++ b/examples/ds18/doc.txt @@ -7,19 +7,19 @@ */ /** - * @defgroup ds18b20 Ds18b20 + * @defgroup examples_ds18 Sample application of Ds18 sensor * @ingroup examples - * @brief ds18b20 sensor example to use with m4a-wroom board + * @brief Sample application using a ds18 temperature sensor * @author Eduardo Azócar -\section ds18b20 -## Table of Contents {#m4a_ds18b20_toc} +\section ds18 +## Table of Contents {#m4a_ds18_toc} -1. [Hardware](#m4a_ds18b20_hardware) -2. [Basic and Default configuration](#m4a_ds18b20_basic_conf) -3. [Flashing the Device](#m4a_ds18b20_flashing) +1. [Hardware](#m4a_ds18_hardware) +2. [Basic and Default configuration](#m4a_ds18_basic_conf) +3. [Flashing the Device](#m4a_ds18_flashing) -## Hardware {#m4a_ds18b20_hardware} +## Hardware {#m4a_ds18_hardware} This section shows, which pin is used to receive the sensor data. @@ -30,16 +30,16 @@ DS18B20_PIN | GPIO_PIN(PA, 5)| This is data pin to receive the reads. -You could change the ds18b20 params to get another gpio controller. +You could change the ds18 params to get another gpio controller. -## Basic and Default configuration {#m4a_ds18b20_basic_conf} +## Basic and Default configuration {#m4a_ds18_basic_conf} -## Flashing {#m4a_ds18b20_flashing} +## Flashing {#m4a_ds18_flashing} If you want to upload the example to your board, needs to compile first, additional to this you could initialize the terminal and watch the results ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -make -C examples/esp32-wroom-32/test_ds18b20 flash term +make -C examples/ds18 flash term ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -[Back to table of contents](#m4a_ds18b20_toc) +[Back to table of contents](#m4a_ds18_toc) */ diff --git a/examples/ds18b20/main.c b/examples/ds18/main.c similarity index 97% rename from examples/ds18b20/main.c rename to examples/ds18/main.c index 827be0925..77fd5fd71 100644 --- a/examples/ds18b20/main.c +++ b/examples/ds18/main.c @@ -15,7 +15,7 @@ */ /** - * @ingroup ds18b20 + * @ingroup examples_ds18 * * @brief This is a example to understand how tu works the ds18b20 * diff --git a/examples/mesh4all_rpl_dag/Makefile b/examples/mesh4all_rpl_dag/Makefile index 2ce9aac0f..32d583179 100644 --- a/examples/mesh4all_rpl_dag/Makefile +++ b/examples/mesh4all_rpl_dag/Makefile @@ -30,7 +30,6 @@ USEMODULE += ps USEMODULE += rpl_protocol USEMODULE += radio USEMODULE += gnrc_icmpv6_echo -USEMODULE += at_client EXTERNAL_MODULE_DIRS += $(CURDIR)/../../firmware/peripherals EXTERNAL_MODULE_DIRS += $(CURDIR)/../../firmware/network diff --git a/examples/mesh4all_rpl_dag/doc.txt b/examples/mesh4all_rpl_dag/doc.txt new file mode 100644 index 000000000..6851c6ee8 --- /dev/null +++ b/examples/mesh4all_rpl_dag/doc.txt @@ -0,0 +1,63 @@ +/* + * Copyright (C) 2022 Mesh4all + * + * This file is subject to the terms and conditions of the GNU Lesser + * General Public License v2.1. See the file LICENSE in the top level + * directory for more details. + */ + +/** + * @defgroup examples_rpl_dag Application to run a Rpl DAG node + * @ingroup examples + * @brief This is an example of a node in DAG mode under RPL protocol + * @author eduazocar + +\section sect1_RPL_dag RPL DAG + +## Table of Contents {#rpl_dag_toc} + +1. [Requirements](#rpl_dag_requirements) +2. [Flashing the Device](#rpl_dag_flashing) +3. [Getting Started](#rpl_dag_basic) + + +## Requirements {#rpl_dag_requirements} + +TO run RPL protocol you need a board with radio module incorporated. because +rpl runs to all Zigbee and IEEE802.15.4 devices. +- Use 2 radio devices to stablish connections. +- the second board must has the `mesh4all_rpl_dodag` example flashed + +## Build and flashing {#rpl_dag_flashing} +Starts flashing the board and see the building process to be completed. +``` +make -C examples/mesh4all_rpl_dag flash term +``` + +## Getting Started {#rpl_dag_basic} + +First start building and flashing this example in a m4a-24g Board. (if you have connected the secondary board +running in `DODAG` mode, disconnect it, until to last step). +The DAG mode in rpl is a passive node that should receive an ipv6 address when it's connected +in the radio network. So when your run `ifconfig` command of the shell. you could see that +you don´t has an ipv6 global address until the secondary board it's active in rpl `DODAG` mode. + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.sh} +2022-07-21 12:41:39,960 # ifconfig +2022-07-21 12:41:39,967 # Iface 4 HWaddr: 48:FC Channel: 11 Page: 0 NID: 0x23 PHY: O-QPSK +2022-07-21 12:41:39,968 # +2022-07-21 12:41:39,972 # Long HWaddr: 00:04:25:19:18:01:C8:FC +2022-07-21 12:41:39,980 # TX-Power: 0dBm State: IDLE max. Retrans.: 3 CSMA Retries: 4 +2022-07-21 12:41:39,987 # AUTOACK ACK_REQ CSMA L2-PDU:102 MTU:1280 HL:64 RTR +2022-07-21 12:41:39,989 # 6LO IPHC +2022-07-21 12:41:39,992 # Source address length: 8 +2022-07-21 12:41:39,995 # Link type: wireless +2022-07-21 12:41:40,001 # inet6 addr: fe80::204:2519:1801:c8fc scope: link VAL +2022-07-21 12:41:40,003 # inet6 group: ff02::2 +2022-07-21 12:41:40,006 # inet6 group: ff02::1 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- Now, connect your DODAG board and see how the device will be inside the radio network + +[Back to table of contents](#rpl_dag_toc) + */ diff --git a/examples/moisture_sensor_hw390/doc.txt b/examples/moisture_sensor_hw390/doc.txt index e9bf1df5c..3d4e8ea80 100644 --- a/examples/moisture_sensor_hw390/doc.txt +++ b/examples/moisture_sensor_hw390/doc.txt @@ -7,7 +7,7 @@ */ /** - * @defgroup moisture_sensor_example Analog capacitive moisture sensor + * @defgroup examples_moisture_sensor Sample Application using an Analog capacitive moisture sensor * @ingroup examples * @brief Example dedicated to use the analog soil moisture sensor * @author xkevin190 diff --git a/examples/moisture_sensor_hw390/main.c b/examples/moisture_sensor_hw390/main.c index e71ae80f1..d6e112701 100644 --- a/examples/moisture_sensor_hw390/main.c +++ b/examples/moisture_sensor_hw390/main.c @@ -15,7 +15,7 @@ */ /** - * @ingroup moisture_sensor + * @ingroup examples_moisture_sensor * * @file * @brief Moisture sensor test diff --git a/examples/slipdev/doc.txt b/examples/slipdev/doc.txt index b962d6147..ef7f234e3 100644 --- a/examples/slipdev/doc.txt +++ b/examples/slipdev/doc.txt @@ -7,7 +7,7 @@ */ /** - @defgroup slipdev Slipdev + @defgroup examples_slipdev Sample Application to provide a internet via UART (SLIP) @ingroup examples @brief Slipdev example to use with m4a-wroom board @@ -70,7 +70,7 @@ USEMODULE += netstats_ipv6 If you want to upload the example to your board, needs to compile first, additional to this you could initialize the terminal to open directly the shell and make a ping or check de interface ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -make -C examples/esp32-wroom-32/slipdev flash term +make -C examples/slipdev flash term ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ [Back to table of contents](#m4a_slipdev_toc) diff --git a/examples/slipdev/main.c b/examples/slipdev/main.c index 47d563533..88cc433f9 100644 --- a/examples/slipdev/main.c +++ b/examples/slipdev/main.c @@ -15,7 +15,7 @@ */ /** - * @ingroup slipdev + * @ingroup examples_slipdev * * @brief A basic demo how works the slipdev * diff --git a/examples/system_example/readme.md b/examples/system_example/README.md similarity index 100% rename from examples/system_example/readme.md rename to examples/system_example/README.md diff --git a/examples/uart_hc-06/Makefile b/examples/uart_hc-06/Makefile deleted file mode 100644 index aad08e505..000000000 --- a/examples/uart_hc-06/Makefile +++ /dev/null @@ -1,24 +0,0 @@ -APPLICATION = uart_HC-06 - -include ../Makefile.common - -USEMODULE += saul_default -USEMODULE += shell -USEMODULE += shell_commands -USEMODULE += xtimer -USEMODULE += at -USEMODULE += at_urc_isr_medium - -FEATURES_REQUIRED = periph_adc -USEMODULE += ztimer -USEMODULE += ztimer_msec -USEMODULE += printf_float - -DEVHELP ?= 1 -QUIET ?= 1 - -# Disable warnings when a parameter is not used -CFLAGS += -Wno-unused-parameter -CFLAGS += -Wno-unused-variable - -include $(RIOTBASE)/Makefile.include diff --git a/examples/uart_hc-06/README.md b/examples/uart_hc-06/README.md deleted file mode 100644 index f5fc7e222..000000000 --- a/examples/uart_hc-06/README.md +++ /dev/null @@ -1,20 +0,0 @@ -@ingroup tmp_uart - -### Uart example - -this is an uart example for this example i used esp32-wrover-kit and one bluetooth device hc-06 - -to configure the bluetooth device write in the shell: - -1) AT for inter at mode -2) AT+RESET for reset the device -3) AT+PIN password for change password -4) AT+NAME name for change name - -to send messages through uart to the bluetooth device write `send message` since the shell - -to compile this example: - -```sh -make -C examples/tpm_uart BOARD=your_board PORT=/dev/your_port flash term -``` \ No newline at end of file diff --git a/examples/uart_hc-06/doc.txt b/examples/uart_hc-06/doc.txt deleted file mode 100644 index 5275d22e7..000000000 --- a/examples/uart_hc-06/doc.txt +++ /dev/null @@ -1,48 +0,0 @@ -/* - * Copyright (C) 2022 Mesh4all - * - * This file is subject to the terms and conditions of the GNU Lesser - * General Public License v2.1. See the file LICENSE in the top level - * directory for more details. - */ - -/** - * @defgroup tmp_uart Uart - * @ingroup examples - * @brief Use the UART peripherals to connect and start Serial communication - * @author xkevin190 - -\section m4a Tmp-UART - -## Table of Contents {#tmp_uart_toc} - -1. [Hardware](#tmp_uart_hardware) -2. [Basic and Default configuration](#tmp_uart_basic_conf) -3. [Flashing the Device](#tmp_uart_flashing) - -## Hardware {#tmp_uart_hardware} - -This section shows, which pin are used to connect with UART device. in this case to hc-06 to share the UART with -bluetooth connections. - -
-Function | GPIOs | Remarks | -:---------------|:-------|:--------| -UART_DEV(1)_TXD| GPIO21 | Serial transmitter data port | -UART_DEV(1)_RXD| GPIO22 | Serial receiver data port | -
- -## Basics {#tmp_uart_basic_conf} - -When you are running this example, open your terminal and put "send message" until your shell. -Follow the instructions AT to configure you bluetooth in your m4a-wrover board and start the communications. - -## Flashing {#tmp_uart_flashing} - -If you want to upload the example to your board, needs to compile first, additional to this you could initialize the terminal and watch the results -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -make -C examples/tmp_uart flash term -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -[Back to table of contents](#tmp_uart_toc) - */ diff --git a/examples/uart_hc-06/main.c b/examples/uart_hc-06/main.c deleted file mode 100644 index 88a54bea8..000000000 --- a/examples/uart_hc-06/main.c +++ /dev/null @@ -1,132 +0,0 @@ -/* - * Copyright (c) 2021 Mesh4all - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -/** - * @ingroup tmp_uart - * - * @file - * @brief this is an example of uart - * @author xkevin190 - * @author eduazocar - */ - -#include -#include -#include -#include -#include - -#include "board.h" -#include "shell.h" -#include "periph/uart.h" -#include "msg.h" -#include "ringbuffer.h" -#include "xtimer.h" -#include "ztimer.h" -#include "at.h" -#include "periph/adc.h" -#include "log.h" - -#define POWEROFF_DELAY (250U * US_PER_MS) -#define RES ADC_RES_10BIT -#define DELAY_MS 5000U - -#define UART_BLE UART_DEV(1) - -#define UART_BAUDRATE 9600 -#define MAX_SENTENCE_SIZE 128 -#define MAIN_QUEUE_SIZE (8) -#define UART_BUFSIZE (128U) -msg_t _main_msg_queue[MAIN_QUEUE_SIZE]; - -size_t count = 0; -char uart_buff[MAX_SENTENCE_SIZE] = {0}; - -typedef struct { - char rx_mem[UART_BUFSIZE]; - ringbuffer_t rx_buf; -} uart_ctx_t; -static uart_ctx_t ctx[UART_NUMOF]; - -void init_adc(void) { - if (adc_init(0) < 0) { - printf("Initialization of ADC_LINE failed\n"); - } else { - printf("Successfully initialized ADC_LINE\n"); - } - while (1) { - int sample = adc_sample(0, RES); - double voltage = ((sample * 1100) / 1024) / 10; - if (sample < 0) { - printf("ADC_LINE: selected resolution not applicable\n"); - } else { - LOG_INFO("sample %i \n", sample); - LOG_INFO("voltage %i \n", (int)voltage); - } - ztimer_sleep(ZTIMER_MSEC, DELAY_MS); - } -} - -int init_at_mode(int argc, char **argv) { - const char test_string[] = "AT"; - uart_write(UART_BLE, (uint8_t *)test_string, sizeof(test_string)); - return 0; -} - -int send_uart_reset(int argc, char **argv) { - const char test_string[] = "AT+RESET"; - uart_write(UART_BLE, (uint8_t *)test_string, sizeof(test_string)); - return 0; -} - -int send_uart_message(int argc, char **argv) { - uart_write(UART_BLE, (uint8_t *)argv[1], strlen((char *)argv[1])); - return 0; -} - -int send_uart_password(int argc, char **argv) { - uart_write(UART_BLE, (uint8_t *)argv[1], strlen((char *)argv[1])); - return 0; -} - -static const shell_command_t shell_commands[] = { - {"send", "send packets since uart", send_uart_message}, - {"init", "init at mode", init_at_mode}, - {"reset", "reset hc-06", send_uart_reset}, - {"password", "add password", send_uart_password}, - {NULL, NULL, NULL}}; - -static void uart_rx_cb(void *arg, uint8_t c) { - if (c != 10) { - uart_buff[count] = (char)c; - count += 1; - } else { - printf("%s\n", (char *)uart_buff); - memset(uart_buff, 0, sizeof(uart_buff)); - count = 0; - } -} - -int main(void) { - if (uart_init(UART_BLE, UART_BAUDRATE, uart_rx_cb, NULL) < 0) { - printf("ERROR uart \n"); - } else { - printf("Success: Initialized UART_DEV(%i) at BAUD %i\n", UART_BLE, UART_BAUDRATE); - } - init_adc(); - char line_buf[SHELL_DEFAULT_BUFSIZE]; - shell_run(shell_commands, line_buf, SHELL_DEFAULT_BUFSIZE); -} diff --git a/tests/at_client_test/doc.txt b/tests/at_client_test/doc.txt index 7fbc35930..295c67149 100644 --- a/tests/at_client_test/doc.txt +++ b/tests/at_client_test/doc.txt @@ -15,10 +15,10 @@ */ /** - * @defgroup test_at_client at_client test module - * @ingroup test_group + * @defgroup tests_at_client Send and receive AT commands via UART + * @ingroup tests -## Test AT_CLIENT +## Test AT CLIENT This unit tests are performed on the at_client module. To perform a successful test when a command at is sent correctly diff --git a/tests/border_router/doc.txt b/tests/border_router/doc.txt index 4f9ff3eba..5333c3040 100644 --- a/tests/border_router/doc.txt +++ b/tests/border_router/doc.txt @@ -1,5 +1,6 @@ -@defgroup border_router_test border router test module -@ingroup test_group +/** +@defgroup tests_border_router Application to test the border router initialization +@ingroup tests @{ ## Test Border Router module diff --git a/tests/chamos_test/doc.txt b/tests/chamos_test/doc.txt index f40fd2a0a..0dde96250 100644 --- a/tests/chamos_test/doc.txt +++ b/tests/chamos_test/doc.txt @@ -1,5 +1,5 @@ -@defgroup chamos_test chamos test module -@ingroup test_group +@defgroup tests_chamos Starts a Chamos and Chamoc Communication. +@ingroup tests @{ ## Test Chamos module diff --git a/tests/doc.txt b/tests/doc.txt index 6dc3f52ac..21578659e 100644 --- a/tests/doc.txt +++ b/tests/doc.txt @@ -1,5 +1,5 @@ /** -@defgroup test_group Test +@defgroup tests Application tests to each Module and driver ## Test documentation diff --git a/tests/driver_bme280/doc.txt b/tests/driver_bme280/doc.txt index 65efecb71..53714f1f3 100644 --- a/tests/driver_bme280/doc.txt +++ b/tests/driver_bme280/doc.txt @@ -1,7 +1,10 @@ /** -* @defgroup test_group_driver_bme280 Application test for bme280 -* @ingroup test_group +* @defgroup tests_driver_bme280 Application test for bme280 +* @ingroup tests +* * @{ * * ## Test bme driver -* \ No newline at end of file +* +* @} +*/ \ No newline at end of file diff --git a/tests/ds18/doc.txt b/tests/ds18/doc.txt index 82479ff6a..3efbd7874 100644 --- a/tests/ds18/doc.txt +++ b/tests/ds18/doc.txt @@ -1,6 +1,6 @@ /** -@defgroup ds18_test Ds18 sensor test module -@ingroup test_group +@defgroup tests_ds18 Gets Temperature values from Ds18 sensor +@ingroup tests @{ @@ -9,16 +9,17 @@ Here unit tests are performed on the ds18_sensor module. To perform a successful test you must connect the ds18 temperature sensor to your board. -you must also add the gpio where your board will be connected in the test init function in the main.c file +you must also add the gpio where your board will be connected in the test init. Run first menuconfig and add the pin number +where is connected the sensor. +``` +make menuconfig all +``` +You take a look in the main.c ```c -void test_init_ds18(void) { - int err = init_temperature_sensor(your_gpio); - - TEST_ASSERT_EQUAL_INT(0, error); -} +int err = init_temperature_sensor(CONFIG_PIN_TEMP_SENSOR); ``` - +You could see that the CONFIG_PIN_TEMP_SENSOR is a reference to the configurate pin set in the menuconfig. To test the code in automatic mode: ```c diff --git a/tests/periph_adc/doc.txt b/tests/periph_adc/doc.txt index a067c4d64..cd0edb355 100644 --- a/tests/periph_adc/doc.txt +++ b/tests/periph_adc/doc.txt @@ -1,6 +1,7 @@ /** -@defgroup periph_adc Read values using ADC peripheral +@defgroup tests_periph_adc Read values using ADC peripheral @ingroup tests + @{ ## Test the [A]nalog to [D]igital [C]onverter peripheral diff --git a/tests/periph_i2c/doc.txt b/tests/periph_i2c/doc.txt index 7e2ece122..b89cde428 100644 --- a/tests/periph_i2c/doc.txt +++ b/tests/periph_i2c/doc.txt @@ -1,6 +1,6 @@ /** -* @defgroup test_group_periph_i2c Get I2C available ports and scan for devices -* @ingroup test_group +* @defgroup tests_periph_i2c Gets I2C available ports and scan for devices. +* @ingroup tests * @{ * * ## Low level test for I2C peripherals diff --git a/tests/radio/doc.txt b/tests/radio/doc.txt index e6f5d16da..e099262b7 100644 --- a/tests/radio/doc.txt +++ b/tests/radio/doc.txt @@ -1,5 +1,8 @@ -@defgroup Radio_test Radio test module -@ingroup test_group +/** + +@defgroup tests_radio Application test to set parameters of a radio interface. +@ingroup tests + @{ ## Test Radio module diff --git a/tests/rpl/doc.txt b/tests/rpl/doc.txt new file mode 100644 index 000000000..3995c327d --- /dev/null +++ b/tests/rpl/doc.txt @@ -0,0 +1,27 @@ + +/** +@defgroup tests_rpl Routing protocol interaction in a radio network +@ingroup tests + +@{ + +## Test Rpl + +Here the unit tests are carried out on the RPL module. + +To test the code in automatic mode: + +```c +make flash test + +``` + +To test the code in interactive mode: + +```c +make flash term + +``` + +@} +*/ \ No newline at end of file diff --git a/tests/serialization/doc.txt b/tests/serialization/doc.txt index a3df3f801..3ba536327 100644 --- a/tests/serialization/doc.txt +++ b/tests/serialization/doc.txt @@ -1,7 +1,8 @@ /** -@defgroup serialization18_test Serialization test module -@ingroup test_group +@defgroup tests_serialization Encode and decode via CBOR format. +@ingroup tests + @{ ## Test Serialization sensor diff --git a/tests/storage/doc.txt b/tests/storage/doc.txt new file mode 100644 index 000000000..ed7746b45 --- /dev/null +++ b/tests/storage/doc.txt @@ -0,0 +1,27 @@ + +/** +@defgroup tests_storage Save and Load Data from the Flash memory +@ingroup tests + +@{ + +## Test Storage + +Here the unit tests are carried out on the Storage module. + +To test the code in automatic mode: + +```c +make flash test + +``` + +To test the code in interactive mode: + +```c +make flash term + +``` + +@} +*/ \ No newline at end of file diff --git a/tests/template/doc.txt b/tests/template/doc.txt index 14175b5e6..244e3c6ee 100644 --- a/tests/template/doc.txt +++ b/tests/template/doc.txt @@ -15,8 +15,8 @@ */ /** - * @defgroup test_template Test template - * @ingroup test_group + * @defgroup tests_template Test template + * @ingroup tests * @brief A simple guide to build a test from a Template # Test Template diff --git a/tests/udp_client/doc.txt b/tests/udp_client/doc.txt index 2d6c343de..114c52ca5 100644 --- a/tests/udp_client/doc.txt +++ b/tests/udp_client/doc.txt @@ -1,6 +1,7 @@ /** -@defgroup udp_client_test UDP client test -@ingroup test_group +@defgroup test_udp_client Send UDP messages to an UDP server +@ingroup tests + @{ ## Test documentation diff --git a/tests/udp_server/doc.txt b/tests/udp_server/doc.txt index 03720f0cc..39a1bb704 100644 --- a/tests/udp_server/doc.txt +++ b/tests/udp_server/doc.txt @@ -1,6 +1,7 @@ /** -@defgroup udp_server_test UDP server test -@ingroup test_group +@defgroup tests_udp_server Wait and listen to UDP message +@ingroup tests + @{ ## Test documentation diff --git a/tests/uniqueid/doc.txt b/tests/uniqueid/doc.txt new file mode 100644 index 000000000..ac63d2a73 --- /dev/null +++ b/tests/uniqueid/doc.txt @@ -0,0 +1,35 @@ + +/** +@defgroup tests_uniqueid Generate an ipv6 address statically, randomly or manually +@ingroup tests + +@{ + +## Test Unique id + +Here the unit tests are carried out on the Uniqueid module. + +Before to flash and start you need to set the uniqueid parameters, these define +is the uniqueid runs in `static`, `random` or `manual` mode. + +Main Setup +``` +make menuconfig all +``` + +To test the code in automatic mode: + +```c +make flash test + +``` + +To test the code in interactive mode: + +```c +make flash term + +``` + +@} +*/ \ No newline at end of file diff --git a/tests/uniqueid/unique_random.h b/tests/uniqueid/unique_random.h index ef556db2d..6801bf8e3 100644 --- a/tests/uniqueid/unique_random.h +++ b/tests/uniqueid/unique_random.h @@ -15,7 +15,7 @@ */ /** - * @ingroup tests + * @ingroup tests_uniqueid * @{ * * @file @@ -33,7 +33,7 @@ extern "C" { #endif /** - * @brief Random Generator to gets a block of random values + * @brief Random to gets a block of random values * * @param bit_ref this is a reference to create a matrix of the reads * e.g bit_ref = 9 -> 9x9 (This mean that could obtain 9 measures of 9