Merge pull request #18 from PaulThbt/main

Chirp project improvements and Initial weather station project

Author: fanfare-ff

README.md

@@ -72,7 +72,7 @@ In the `projects/` directory, you will find several complete projects designed f
 * **Chirp Signal Generation**
 * **FMCW Radar** (in progress)
 * **Ultrasonic FSK Communication** *(coming soon)*
-* **Weather Station** *(coming soon)*
+* **Weather Station** (in progress)
 * **WiFi MATLAB Communication** *(coming soon)*
 
 Detailed explanations for each project are available in the "Projects" section of the <a href="https://shiegechan.github.io/SensEdu/projects/" target="_blank">Documentation</a>.
@@ -83,7 +83,28 @@ Detailed explanations for each project are available in the "Projects" section o
 If you would like to contribute, please open a pull request!
 You can also suggest improvements or check already opened <a href="https://github.com/ShiegeChan/SensEdu/issues" target="_blank">issues</a> to help fix bugs or add new features.
 
+## Acknowledgments
+
+SensEdu was made possible thanks to these freely available tools:
+
+* [Arduino] and [Arduino IDE 2.x]
+* [XENSIV™ Digital Pressure Sensor Arduino Library]
+* [STM32H747 Documentation] and [STM32CubeMX]
+* [Jekyll] and [Just the Docs] template
+* [KiCAD]
+
 
 ## License
 
 * [**GPL-3.0 license**](https://github.com/ShiegeChan/SensEdu/blob/main/LICENSE)
+
+[Arduino IDE 2.x]: https://github.com/arduino/arduino-ide
+[Arduino]: https://www.arduino.cc/
+[XENSIV™ Digital Pressure Sensor Arduino Library]: https://github.com/Infineon/arduino-xensiv-dps3xx
+[STM32H747 Documentation]: https://www.st.com/en/microcontrollers-microprocessors/stm32h747-757/documentation.html
+[STM32CubeMX]: https://www.st.com/en/development-tools/stm32cubemx.html
+[Jekyll]: https://jekyllrb.com/
+[Just the Docs]: https://github.com/just-the-docs/just-the-docs/tree/main
+[STM32H747]: https://www.st.com/en/microcontrollers-microprocessors/stm32h747-757.html
+[Arduino GIGA R1 WiFi]: https://docs.arduino.cc/hardware/giga-r1-wifi/
+[KiCad]: https://www.kicad.org/

docs/Library/DAC.md

@@ -29,20 +29,20 @@ Each of the methods are useful for different applications.
 
 ## Errors
 
-Main DAC error code is `0x30xx`. Find the way to display errors in your Arduino sketch [here]({% link Library/index.md %}#error-handling).
+Main DAC error code is `0x40xx`. Find the way to display errors in your Arduino sketch [here]({% link Library/index.md %}#error-handling).
 
 An overview of possible errors for DAC:
 
-* `0x3000`: No Errors
-* `0x3001`: DAC was initialized before initialization
-* `0x3002`: Passed DAC channel is not either `DAC_CH1` nor `DAC_CH2`
-* `0x3003`: Selected sampling frequency is too high. Maximum is around 15MHz
-* `0x3004`: Unexpected address or memory size for DMA
-* `0x3005`: In `SENSEDU_DAC_MODE_BURST_WAVE` expected `burst_num` is at least 1
+* `0x4000`: No Errors
+* `0x4001`: DAC was initialized before initialization
+* `0x4002`: Passed DAC channel is not either `DAC_CH1` nor `DAC_CH2`
+* `0x4003`: Selected sampling frequency is too high. Maximum is around 15MHz
+* `0x4004`: Unexpected address or memory size for DMA
+* `0x4005`: In `SENSEDU_DAC_MODE_BURST_WAVE` expected `burst_num` is at least 1
 
 An overview of critical errors. They shouldn’t happen in normal user case and indicate some problems in library code:
 
-* `0x30A0`: DMA Underrun interrupt flag was raised: currently selected trigger is driving DAC channel conversion at a frequency higher than the DMA service capability rate (read more in section 27.4.8 of [Reference Manual])
+* `0x40A0`: DMA Underrun interrupt flag was raised: currently selected trigger is driving DAC channel conversion at a frequency higher than the DMA service capability rate (read more in section 27.4.8 of [Reference Manual])
 
 ## Structs
 

docs/Projects/Chirp.md

@@ -137,9 +137,6 @@ Keep in mind this sampling frequency will also be the DAC's output frequency in
 
 The `samples_int` is an integer representing the amount of samples for one period of the chirp signal. This value also represents the memory size in the `SENSEDU_DAC_BUFFER` and `SensEdu_DAC_Settings` functions.
 
-{: .IMPORTANT }
-In this implementation, the size of the chirp array cannot exceed 7688 (array size = `samples_int` for sawtooth modulation & `samples_int*2` for triangular modulation).
-
 The values of the chirp are printed in the serial monitor.
 ```c
 // Print the chirp signal LUT

docs/Projects/FMCWRadar.md

@@ -107,7 +107,7 @@ $$y_{mix}$$ is the product of $$T_x$$ and $$R_x$$
 
 ### Distance Resolution & Max Range 
 
-Distance resolution and max range are two critical parameters regarding radar performance. Distance resolution defines the smallest distance at which a radar can separate two objects. The distance resolution $$\Delta d$$ is defined by
+Distance resolution and max range are two critical parameters regarding radar performance. Distance resolution defines the smallest distance between two objects that the radar can detect as distinct targets. The distance resolution $$\Delta d$$ is defined by
 
 <div id="eq5" class="fs-5 text-center">
   $$\fcolorbox{red}{}{$\displaystyle \Delta d = \frac{c}{2B}$} \tag{5}$$

docs/index.md

@@ -57,6 +57,7 @@ Each part is thoroughly documented in this wiki, allowing you to modify both sof
 SensEdu was made possible thanks to these freely available tools:
 {: .mb-1}
 * [Arduino] and [Arduino IDE 2.x]
+* [XENSIV™ Digital Pressure Sensor Arduino Library]
 * [STM32H747 Documentation] and [STM32CubeMX]
 * [Jekyll] and [Just the Docs] template
 * [KiCAD]
@@ -74,6 +75,7 @@ Thank You to All Contributors!
 
 [Arduino IDE 2.x]: https://github.com/arduino/arduino-ide
 [Arduino]: https://www.arduino.cc/
+[XENSIV™ Digital Pressure Sensor Arduino Library]: https://github.com/Infineon/arduino-xensiv-dps3xx
 [STM32H747 Documentation]: https://www.st.com/en/microcontrollers-microprocessors/stm32h747-757/documentation.html
 [STM32CubeMX]: https://www.st.com/en/development-tools/stm32cubemx.html
 [Jekyll]: https://jekyllrb.com/

libraries/XENSIV_Digital_Pressure_Sensor/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Infineon Technologies AG
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

libraries/XENSIV_Digital_Pressure_Sensor/README.md

@@ -0,0 +1,48 @@
+# XENSIV™ Digital Pressure Sensor Arduino Library
+
+Arduino library of Infineon's [**XENSIV™ Digital Pressure Sensors (DPS3xx)**](https://www.infineon.com/cms/en/product/sensor/pressure-sensors/pressure-sensors-for-iot/).
+
+<img src="https://www.infineon.com/export/sites/default/media/products/Small_Signal_Discretes/lowres-DPS368_VLGA-8-2_Combi.tif.png_1864837327.png" width=200>
+
+## Supported Products
+
+<table>
+    <tr>
+        <td rowspan=2>Products</td>
+        <td><img src="docs/img/dps310.png" height="80"></td>
+        <td><img src="docs/img/dps368.png" height="80"></td>
+    </tr>
+    <tr>
+        <td style="test-align : center"><a href="https://www.infineon.com/cms/de/product/sensor/pressure-sensors/pressure-sensors-for-iot/dps310/">XENSIV™ DPS310</a></td>
+        <td style="test-align : center"><a href="https://www.infineon.com/cms/de/product/sensor/pressure-sensors/pressure-sensors-for-iot/dps368/">XENSIV™ DPS368</a></td>
+    </tr>
+    <tr>
+        <td rowspan=2>Shield2Go</td>
+        <td><img src="docs/img/dps310-shield2go.png" height="80"></td>
+        <td><img src="docs/img/dps368-shield2go.png" height="80"></td>
+    </tr>
+    <tr>
+        <td style="test-align : center"><a href="https://www.infineon.com/cms/en/product/evaluation-boards/s2go-pressure-dps310/">XENSIV™ DPS310 Shield2Go</a></td>
+        <td style="test-align : center"><a href="https://www.infineon.com/cms/en/product/evaluation-boards/s2go-pressure-dps368/">XENSIV™ DPS368 Shield2Go</a></td>
+    </tr>
+    <tr>
+       <td rowspan=2>Kit 2Go</td>
+        <td><img src="docs/img/dps310-kit2go.png" height="80"></td>
+        <td><img src="docs/img/dps368-kit2go.png" height="80"></td>
+    </tr>
+    <tr>
+        <td style="test-align : center"><a href="https://www.infineon.com/cms/en/product/evaluation-boards/kit_dps310_2go/">XENSIV™ DPS310 Kit 2Go</a></td>
+        <td style="test-align : center"><a href="https://www.infineon.com/cms/en/product/evaluation-boards/kit_dps368_2go/">XENSIV™ DPS368 Kit 2Go</a></td>
+    </tr>
+</table>
+
+## Getting Started
+
+### Installation
+To install this library in the Arduino IDE, please go to **Sketch** > **Include Library** > **Manage Libraries...** and search for the `XENSIV Digital Pressure Sensor` library by `Infineon Technologies` in the Arduino library manager.
+
+### Usage
+Please see the example sketches in the `/examples` directory in this repository to learn more about the usage of the library. Especially, take care of the respective SPI and I²C configuration of the sensor. You can find more information in the [Wiki](https://github.com/Infineon/arduino-xensiv-dps3xx/wiki).
+
+## License
+See the [LICENSE](LICENSE.md) file for more details.