Added new doxygen links

jminjares4 · May 22, 2022 · 1f5e200 · 1f5e200
1 parent 1acb0e1
commit 1f5e200
Show file tree

Hide file tree

Showing 14 changed files with 52 additions and 34 deletions.
diff --git a/doc_pages/extra/additional_lab.md b/doc_pages/extra/additional_lab.md
@@ -3,9 +3,11 @@
 These are additional labs that may or may not be used in the course. The following labs consist of using `ESP22 IOT` interface with an *`http server`*.
 
 ## Labs
-- [Lab 9 WiFi and Internet of Things (IOT)](https://github.com/jminjares4/Microprocessor-2-Lab-Template/tree/main/Additional_Labs/Lab_9)
-- [Lab 10 WiFi and Internet of Things (IOT): Servo Motor Control](https://github.com/jminjares4/Microprocessor-2-Lab-Template/tree/main/Additional_Labs/Lab_10)
-- [Lab 11 WiFi and IOT: ADC MOnitor](https://github.com/jminjares4/Microprocessor-2-Lab-Template/tree/main/Additional_Labs/Lab_11)
+- [Lab 9 WiFi and Internet of Things (IOT)](lab9.md)
+- [Lab 10 WiFi and Internet of Things (IOT): Servo Motor Control](lab10.md)
+- [Lab 11 WiFi and IOT: ADC MOnitor](lab11.md)
+
+@see [GitHub Additional Labs](https://github.com/jminjares4/Microprocessor-2-Lab-Template/tree/main/Additional_Labs)
 
 ### Authors
 * [***Jesus Minjares***](https://github.com/jminjares4)

diff --git a/doc_pages/extra/lab10.md b/doc_pages/extra/lab10.md
@@ -1,4 +1,4 @@
-# LAB 10 WiFi and Internet of Things (IOT): Servo Motor Control
+# Lab 10 WiFi and Internet of Things (IOT): Servo Motor Control
 
 ### Objective
 * Using the provided code, create a soft access point. Use your last name as the ssid and your ID as password
@@ -163,4 +163,6 @@ void app_main()
     setUpPWM();
     xTaskCreate(&http_server, "http_server", 2048, NULL, 5, NULL);
 }
-~~~
+~~~
+
+@see [GitHub Lab 10](https://github.com/jminjares4/Microprocessor-2-Lab-Template/tree/main/Additional_Labs/Lab_10)
diff --git a/doc_pages/extra/lab11.md b/doc_pages/extra/lab11.md
@@ -1,4 +1,4 @@
-# LAB 11 WiFi and Internet of Things (IOT): ADC Monitor
+# Lab 11 WiFi and Internet of Things (IOT): ADC Monitor
 
 ### Goals
 * Using the provided code, create a soft access point. Use your last name as the ssid and your ID as password.
@@ -149,5 +149,7 @@ void app_main()
     wifi_init_softap();
     xTaskCreate(&http_server, "http_server", 2048, NULL, 5, NULL);
 }
+~~~
 
-~~~
+
+@see [GitHub Lab 11](https://github.com/jminjares4/Microprocessor-2-Lab-Template/tree/main/Additional_Labs/Lab_11)
diff --git a/doc_pages/extra/lab9.md b/doc_pages/extra/lab9.md
@@ -1,4 +1,4 @@
-# LAB 9 WiFi and Internet of Things (IOT)
+# Lab 9 WiFi and Internet of Things (IOT)
 
 ### Objective
 * Using the provided code, create a soft access point. Use your last name as the ssid and your ID as password
@@ -162,4 +162,6 @@ void app_main()
     wifi_init_softap();
     xTaskCreate(&http_server, "http_server", 2048, NULL, 5, NULL);
 
-~~~
+~~~
+
+@see [GitHub Lab 9](https://github.com/jminjares4/Microprocessor-2-Lab-Template/tree/main/Additional_Labs/Lab_9)
diff --git a/doc_pages/lab0.md b/doc_pages/lab0.md
@@ -1,4 +1,4 @@
-# LAB 0 LED Lightshow
+# Lab 0 LED Lightshow
 
 ## Objective:
 * Understand how to use the gpio driver library from [`Espressif`](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/peripherals/gpio.html#). The lab will consist of creating a `sweeper` and also `led chaser`. The `sweeper` will iterate over mutiple LEDs by turning from the lowest to highest bit and then turn off the most significant bit to lowest bit. While `led chaser` as the name states will haven a single led iterating from the lowest to most significant bit. For both the `sweeper` and `led chaser` use up to 6 GPIOs.
@@ -210,4 +210,4 @@ void vTaskDelay(const TickType_t xTicksToDelay);
   * **Master of Science in Computer Engineering** <br>
     [![LinkedIn](https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white&style=flat)](https://www.linkedin.com/in/erick-baca-484bbb215/) [![GitHub](https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white&style=flat)](https://github.com/eabaca2419)
 
-
+@see [GitHub Lab 0](https://github.com/jminjares4/Microprocessor-2-Lab-Template/tree/main/Lab_0)
diff --git a/doc_pages/lab1.md b/doc_pages/lab1.md
@@ -1,4 +1,4 @@
-# LAB 1 LED Controller
+# Lab 1 LED Controller
 
 ## Objective:
 * Understand how to use the gpio driver library from [`Espressif`](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/peripherals/gpio.html#). The lab will consist of using a `sweeper`, `led chaser` and any additionals led sequence that the student developed which be selected via an input. Students must have a total of three buttons. First button must start `sweeper` function which student must have complete from the previous lab. Next, the second button must start the `led chaser` function. Lastly, the third button must toggle the state of the onboard led.
@@ -248,4 +248,4 @@ esp_err_t gpio_pulldown_en(gpio_num_t gpio_num);
   * **Master of Science in Computer Engineering** <br>
     [![LinkedIn](https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white&style=flat)](https://www.linkedin.com/in/erick-baca-484bbb215/) [![GitHub](https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white&style=flat)](https://github.com/eabaca2419)
 
-
+@see [GitHub Lab 1](https://github.com/jminjares4/Microprocessor-2-Lab-Template/tree/main/Lab_1)
diff --git a/doc_pages/lab2.md b/doc_pages/lab2.md
@@ -1,4 +1,4 @@
-# LAB 2 Interrupts
+# Lab 2 Interrupts
 
 ### Objective
 * Given the program template shown in listing 1, edit it so that the code so that you replicate the functions of a microwave.
@@ -281,4 +281,5 @@ esp_err_t gpio_isr_handler_add(gpio_num_t gpio_num, gpio_isr_t isr_handler, void
   * **Master of Science in Computer Engineering** <br>
     [![LinkedIn](https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white&style=flat)](https://www.linkedin.com/in/erick-baca-484bbb215/) [![GitHub](https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white&style=flat)](https://github.com/eabaca2419)
 
+@see [GitHub Lab 2](https://github.com/jminjares4/Microprocessor-2-Lab-Template/tree/main/Lab_2)
 
diff --git a/doc_pages/lab3.md b/doc_pages/lab3.md
@@ -1,4 +1,4 @@
-# LAB 3 Introduction to FreeRTOS
+# Lab 3 Introduction to FreeRTOS
 
 ## Objective:
 * Understand how to use the FreeRTOS with [`Espressif`](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/peripherals/gpio.html#).
@@ -143,4 +143,5 @@ For this lab, the most important function call is `xTaskCreate` which is a funct
   * **Master of Science in Computer Engineering** <br>
     [![LinkedIn](https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white&style=flat)](https://www.linkedin.com/in/erick-baca-484bbb215/) [![GitHub](https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white&style=flat)](https://github.com/eabaca2419)
 
+@see [GitHub Lab 3](https://github.com/jminjares4/Microprocessor-2-Lab-Template/tree/main/Lab_3)
 
diff --git a/doc_pages/lab4.md b/doc_pages/lab4.md
@@ -1,4 +1,4 @@
-# LAB 4 FreeRTOS: Semaphores
+# Lab 4 FreeRTOS: Semaphores
 
 ## Objective:
 * Understand how to use the semaphore with [`FreeRTOS`](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/system/freertos.html). In this lab, the main focus will be using semaphores to sycnrhonize various tasks. 
@@ -224,4 +224,5 @@ Lastly, `xSemaphoreTake` is the opposite of the prior function. Therefore, it wi
   * **Master of Science in Computer Engineering** <br>
     [![LinkedIn](https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white&style=flat)](https://www.linkedin.com/in/erick-baca-484bbb215/) [![GitHub](https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white&style=flat)](https://github.com/eabaca2419)
 
+@see [GitHub Lab 4](https://github.com/jminjares4/Microprocessor-2-Lab-Template/tree/main/Lab_4)
 
diff --git a/doc_pages/lab5.md b/doc_pages/lab5.md
@@ -1,4 +1,4 @@
-# LAB 5 FreeRTOS: Queue
+# Lab 5 FreeRTOS: Queue
 
 ## Objective:
 * Understand how to use the queues with [`FreeRTOS`](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/system/freertos.html#queue-api). In this lab, the main focus will be using queues to send data among tasks. 
@@ -286,4 +286,5 @@ BaseType_t xQueueReceive(QueueHandle_txQueue, void *const pvBuffer, TickType_t x
   * **Master of Science in Computer Engineering** <br>
     [![LinkedIn](https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white&style=flat)](https://www.linkedin.com/in/erick-baca-484bbb215/) [![GitHub](https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white&style=flat)](https://github.com/eabaca2419)
 
+@see [GitHub Lab 5](https://github.com/jminjares4/Microprocessor-2-Lab-Template/tree/main/Lab_5)
 
diff --git a/doc_pages/lab6.md b/doc_pages/lab6.md
@@ -1,4 +1,4 @@
-# LAB 6 GPIO, Interrupts, and Queues
+# Lab 6 GPIO, Interrupts, and Queues
 
 ## Objective:
 * Understand how to use interrupt and send data through a queue with [`FreeRTOS Queues`](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/system/freertos.html#queue-api). In this lab, the main focus will be sending data from a interrupt to a task.
@@ -241,4 +241,5 @@ Lastly, there is an very important function was is need to fulfill this lab. We
   * **Master of Science in Computer Engineering** <br>
     [![LinkedIn](https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white&style=flat)](https://www.linkedin.com/in/erick-baca-484bbb215/) [![GitHub](https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white&style=flat)](https://github.com/eabaca2419)
 
+@see [GitHub Lab 6](https://github.com/jminjares4/Microprocessor-2-Lab-Template/tree/main/Lab_6)
 
diff --git a/doc_pages/lab7.md b/doc_pages/lab7.md
@@ -1,4 +1,4 @@
-# LAB 7 Peripherals and Queues:ADC and PWM (LEDC)
+# Lab 7 Peripherals and Queues:ADC and PWM (LEDC)
 
 ### Objective
 * The objective for this lab is to understand how use the LEDC and ADC API's of espressif. In this lab, create 2 task: one that will initiallize the peripherals and perform ADC readings every 100 millisecond. The ADC input reading should come from a 10K potentiometer and store its information into a queue. For the second task, output a PWM signal which gets it's duty cycle updated based on the queue value send from the ADC task.
@@ -279,4 +279,5 @@ Finally the last important function while using the LEDC API is a way to pause t
   * **Master of Science in Computer Engineering** <br>
     [![LinkedIn](https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white&style=flat)](https://www.linkedin.com/in/erick-baca-484bbb215/) [![GitHub](https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white&style=flat)](https://github.com/eabaca2419)
 
+@see [GitHub Lab 7](https://github.com/jminjares4/Microprocessor-2-Lab-Template/tree/main/Lab_7)
 
diff --git a/doc_pages/lab8.md b/doc_pages/lab8.md
@@ -1,4 +1,4 @@
-# LAB 8 DAC Peripheral
+# Lab 8 DAC Peripheral
 
 ### Objective
 * The objective for this lab is to use and understand the DAC driver of espressif. The ESP32 DAC has a 8-bit resolution therefore the output ranges from 0-255 bits or 0.0-3.3V. Knowing this, for this lab use GPIO 25 to generate a sine wave and in GPIO 26 generate a triangle wave. 
@@ -124,3 +124,4 @@ Finally, the last function needed in order to produce a DAC output will be `dac_
   * **Master of Science in Computer Engineering** <br>
     [![LinkedIn](https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white&style=flat)](https://www.linkedin.com/in/erick-baca-484bbb215/) [![GitHub](https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white&style=flat)](https://github.com/eabaca2419)
 
+@see [GitHub Lab 8](https://github.com/jminjares4/Microprocessor-2-Lab-Template/tree/main/Lab_8)
diff --git a/doc_pages/mainpage.md b/doc_pages/mainpage.md
@@ -6,7 +6,7 @@
   </a>
 </div>
 
-[![Doxygen Action](https://github.com/jminjares4/Microprocessor-2-Lab-Template/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/jminjares4/Microprocessor-2-Lab-Template/actions/workflows/main.yml)[![pages-build-deployment](https://github.com/jminjares4/Microprocessor-2-Lab-Template/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/jminjares4/Microprocessor-2-Lab-Template/actions/workflows/pages/pages-build-deployment)
+[![Doxygen Action](https://github.com/jminjares4/Microprocessor-2-Lab-Template/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/jminjares4/Microprocessor-2-Lab-Template/actions/workflows/main.yml) [![pages-build-deployment](https://github.com/jminjares4/Microprocessor-2-Lab-Template/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/jminjares4/Microprocessor-2-Lab-Template/actions/workflows/pages/pages-build-deployment)
 
 ## Objective
 The objective of these labs is to provide more interactive tasks for students to be engaged in Microprocessor 2. Some labs will be new, and others will be from the previous semester but with better documentation.
@@ -27,20 +27,23 @@ The objective of these labs is to provide more interactive tasks for students to
 git submodule update --init --recursive
 ```
 
+<!-- https://github.com/jminjares4/Microprocessor-2-Lab-Template/tree/main/Lab_0 -->
 ## Labs
-- [Lab 0 Lightshow](https://github.com/jminjares4/Microprocessor-2-Lab-Template/tree/main/Lab_0)
-- [Lab 1 LED Controller with Inputs](https://github.com/jminjares4/Microprocessor-2-Lab-Template/tree/main/Lab_1)
-- [Lab 2 Microwave](https://github.com/jminjares4/Microprocessor-2-Lab-Template/tree/main/Lab_2)
-- [Lab 3 Introduction to FreeRTOS](https://github.com/jminjares4/Microprocessor-2-Lab-Template/tree/main/Lab_3) 
-- [Lab 4 FreeRTOS: Semaphores](https://github.com/jminjares4/Microprocessor-2-Lab-Template/tree/main/Lab_4)
-- [Lab 5 FreeRTOS: Queue](https://github.com/jminjares4/Microprocessor-2-Lab-Template/tree/main/Lab_5)
-- [Lab 6 GPIO, Interrupts, and Queues](https://github.com/jminjares4/Microprocessor-2-Lab-Template/tree/main/Lab_6)
-- [Lab 7 Peripheral and Queues: ADC and PWM (LEDC)](https://github.com/jminjares4/Microprocessor-2-Lab-Template/tree/main/Lab_7)
-- [Lab 8 DAC Peripheral](https://github.com/jminjares4/Microprocessor-2-Lab-Template/tree/main/Lab_8)
-- [Additional Labs](https://github.com/jminjares4/Microprocessor-2-Lab-Template/tree/main/Additional_Labs)
-  - [Lab 9 WiFi and Internet of Things (IOT)](https://github.com/jminjares4/Microprocessor-2-Lab-Template/tree/main/Additional_Labs/Lab_9)
-  - [Lab 10 WiFi and Internet of Things (IOT): Servo Motor Control](https://github.com/jminjares4/Microprocessor-2-Lab-Template/tree/main/Additional_Labs/Lab_10)
-  - [Lab 11 WiFi and Internet of Things (IOT): ADC MOnitor](https://github.com/jminjares4/Microprocessor-2-Lab-Template/tree/main/Additional_Labs/Lab_11)
+- [Lab 0 Lightshow](lab0.md)
+- [Lab 1 LED Controller with Inputs](lab1.md)
+- [Lab 2 Microwave](lab2.md)
+- [Lab 3 Introduction to FreeRTOS](lab3.md) 
+- [Lab 4 FreeRTOS: Semaphores](lab4.md)
+- [Lab 5 FreeRTOS: Queue](lab5.md)
+- [Lab 6 GPIO, Interrupts, and Queues](lab6.md)
+- [Lab 7 Peripheral and Queues: ADC and PWM (LEDC)](lab7.md)
+- [Lab 8 DAC Peripheral](lab8.md)
+- [Additional Labs](extra/additional_lab.md)
+  - [Lab 9 WiFi and Internet of Things (IOT)](extra/lab9.md)
+  - [Lab 10 WiFi and Internet of Things (IOT): Servo Motor Control](extra/lab10.md)
+  - [Lab 11 WiFi and Internet of Things (IOT): ADC MOnitor](extra/lab11.md)
+
+@see [GitHub Labs](https://github.com/jminjares4/Microprocessor-2-Lab-Template)
 
 ## Development
 |Microcontroller|Software|Enviroment|Operating System|