-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update docs/readme.md Update docs/readme.md Update docs/readme.md Update docs/readme.md update docs/readme.md: add multichannel description doc: update README.md doc: update doc/readme.md Co-Authored-By: Karl Söderby <[email protected]>
- Loading branch information
1 parent
f1808b2
commit 0bf0e0a
Showing
2 changed files
with
168 additions
and
38 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,39 +1,7 @@ | ||
| <img src="https://content.arduino.cc/website/Arduino_logo_teal.svg" height="100" align="right" /> | ||
|
|
||
| `Arduino_AdvancedAnalog` 〰 | ||
| =========================== | ||
| [](https://github.com/arduino-libraries/Arduino_AdvancedAnalog/actions/workflows/compile-examples.yml) | ||
| [](https://github.com/arduino-libraries/Arduino_AdvancedAnalog/actions/workflows/spell-check.yml) | ||
| [](https://github.com/arduino-libraries/Arduino_AdvancedAnalog/actions/workflows/sync-labels.yml) | ||
| [](https://github.com/arduino-libraries/Arduino_AdvancedAnalog/actions?workflow=Arduino+Lint) | ||
| # 〰️ Arduino AdvancedAnalog Library | ||
|
|
||
| Advanced Analog Library for Arduino Giga. | ||
| The Arduino AdvancedAnalog library is designed to offer high performance DAC/ADC applications on boards based on the STM32H7 microcontroller. | ||
|
|
||
| ## :mag_right: Resources | ||
|
|
||
| * [How to install a library](https://www.arduino.cc/en/guide/libraries) | ||
| * [Help Center](https://support.arduino.cc/) | ||
| * [Forum](https://forum.arduino.cc) | ||
|
|
||
| ## :bug: Bugs & Issues | ||
|
|
||
| If you want to report an issue with this library, you can submit it to the [issue tracker](https://github.com/arduino-libraries/Arduino_AdvancedAnalog/issues) of this repository. Remember to include as much detail as you can about your hardware set-up, code and steps for reproducing the issue. Make sure you're using an original Arduino board. | ||
|
|
||
| ## :technologist: Development | ||
|
|
||
| There are many ways to contribute: | ||
|
|
||
| * Improve documentation and examples | ||
| * Fix a bug | ||
| * Test open Pull Requests | ||
| * Implement a new feature | ||
| * Discuss potential ways to improve this library | ||
|
|
||
| You can submit your patches directly to this repository as Pull Requests. Please provide a detailed description of the problem you're trying to solve and make sure you test on real hardware. | ||
|
|
||
| ## :yellow_heart: Donations | ||
|
|
||
| This open-source code is maintained by Arduino with the help of the community. We invest a considerable amount of time in testing code, optimizing it and introducing new features. Please consider [donating](https://www.arduino.cc/en/donate/) or [sponsoring](https://github.com/sponsors/arduino) to support our work, as well as [buying original Arduino boards](https://store.arduino.cc/) which is the best way to make sure our effort can continue in the long term. | ||
|
|
||
| ## Known issues | ||
| * ADC is running at the slowest possible clock (PCLK), should probably set up a PLL and change the clock source. | ||
| 📖 For more information about this library please read the documentation [here](./docs/). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,12 +1,174 @@ | ||
| # Arduino_AdvancedAnalog library | ||
|
|
||
| The **Arduino_AdvancedAnalog** library is designed for high performance DAC/ADC applications on boards based on the STM32H747XI microcontroller: | ||
| [](../LICENSE) | ||
|
|
||
| The **Arduino_AdvancedAnalog** library is designed to offer high performance DAC/ADC applications on boards based on the STM32H747XI microcontroller: | ||
| - [Arduino GIGA R1 WiFi](https://store.arduino.cc/products/giga-r1-wifi) | ||
| - [Arduino Portenta H7](https://store.arduino.cc/products/portenta-h7) | ||
|
|
||
| To use this library: | ||
| ## Features | ||
|
|
||
| - ADC/DAC parameters fine tuning: resolution, channel number, queue number and size | ||
| - ADC acquisition with DMA in double buffering mode | ||
| - ADC Multichannel acquisition | ||
| - DAC Multichannel writing | ||
| - Storing ADC samples history in multiple queues | ||
| ## Guides | ||
|
|
||
| To learn more about using the DAC & ADC on the GIGA R1 WiFi, check out the [GIGA Advanced DAC/ADC Guide](https://docs.arduino.cc/tutorials/giga-r1-wifi/giga-audio). | ||
|
|
||
| This includes examples such as audio playback from USB storage, generate sine waves and more. | ||
| ## Usage | ||
|
|
||
| ### ADC | ||
|
|
||
| To use this library for ADC applications, you must have a supported Arduino board and include the AdvancedAnalog library in your Arduino sketch. Here is a minimal example: | ||
|
|
||
| ```cpp | ||
| #include <Arduino_AdvancedAnalog.h> | ||
|
|
||
| AdvancedADC adc1(A0); | ||
|
|
||
| void setup() { | ||
| Serial.begin(9600); | ||
|
|
||
| // Initialize ADC with: resolution, sample rate, number of samples per channel, queue depth | ||
| if (!adc1.begin(AN_RESOLUTION_16, 16000, 32, 64)) { | ||
| Serial.println("Failed to start ADC!"); | ||
| while (1); | ||
| } | ||
| } | ||
|
|
||
| void loop() { | ||
| // Check if an ADC measurement is ready | ||
| if (adc1.available()) { | ||
| // Get read buffer | ||
| SampleBuffer buf = adc1.read(); | ||
|
|
||
| // Print sample from read buffer | ||
| Serial.println(buf[0]); | ||
|
|
||
| // Release read buffer | ||
| buf.release(); | ||
| } | ||
| } | ||
| ``` | ||
| #### ADC Multichannel (GIGA R1 WiFi) | ||
| This library supports concurrent usage of up to **three** ADCs (_ADC1_, _ADC2_ and _ADC3_). | ||
| Each ADC instance can handle up to **five** channels. | ||
| **Note:** It's important to be aware that certain pins cannot be used across multiple ADCs or cannot share the same ADC. | ||
| *Please ensure that you refer to tables below when configuring your project to avoid conflicts in pin assignments.* | ||
| Below is a table illustrating the pin mapping for each ADC in **Arduino Giga R1 WiFi**: | ||
| | Pin | ADC1 | ADC2 | ADC3 | | ||
| |-------|-------|-------|-------| | ||
| | A0 | X | X | | | ||
| | A1 | X | X | | | ||
| | A2 | X | X | | | ||
| | A3 | X | X | | | ||
| | A4 | X | X | | | ||
| | A5 | X | X | X | | ||
| | A6 | X | X | X | | ||
| | A7 | X | | | | ||
| | A8 | | | X | | ||
| | A9 | | | X | | ||
| | A10 | X | X | | | ||
| | A11 | X | X | | | ||
| Here is a example for the Arduino GIGA R1 WiFi: | ||
| ```cpp | ||
| #include <Arduino_AdvancedAnalog.h> | ||
| AdvancedADC adc_a(A0, A1); | ||
| /* Mapped to ADC1 */ | ||
| AdvancedADC adc_b(A2); | ||
| /* Mapped to ADC2, because ADC1 is occupied by A0 and A1 */ | ||
| void setup() { | ||
| ... | ||
| ``` | ||
|
|
||
| #### ADC Multichannel (Portenta H7) | ||
|
|
||
| Below is a table illustrating the pin mapping for each ADC in **Portenta H7**: | ||
|
|
||
| | Pin | ADC1 | ADC2 | ADC3 | | ||
| |-------|-------|-------|-------| | ||
| | A0 | X | X | | | ||
| | A1 | X | X | | | ||
| | A2 | | | X | | ||
| | A3 | | | X | | ||
| | A4 | X | X | X | | ||
| | A5 | X | X | | | ||
| | A6 | X | X | | | ||
| | A7 | X | X | | | ||
|
|
||
| Here is an example for the Portenta H7: | ||
|
|
||
| ```cpp | ||
| #include <Arduino_AdvancedAnalog.h> | ||
|
|
||
| AdvancedADC adc_c(A2, A3, A4); | ||
| /* Mapped to ADC3 */ | ||
|
|
||
| AdvancedADC adc_d(A5); | ||
| /* Mapped to ADC1 */ | ||
|
|
||
| void setup() { | ||
| ... | ||
| ``` | ||
| ### DAC | ||
| To use this library for DAC application, you must have a supported Arduino board and include the AdvancedAnalog library in your Arduino sketch. Here is a minimal example for the Arduino GIGA R1 WiFi: | ||
| ```cpp | ||
| #include <Arduino_AdvancedAnalog.h> | ||
| AdvancedDAC dac1(A12); | ||
| void setup() { | ||
| Serial.begin(9600); | ||
| // Initialize DAC with: resolution, sample rate, number of samples per channel, queue depth | ||
| if (!dac1.begin(AN_RESOLUTION_12, 8000, 32, 64)) { | ||
| Serial.println("Failed to start DAC!"); | ||
| while (1); | ||
| } | ||
| } | ||
| void loop() { | ||
| if (dac1.available()) { | ||
| // Get a free buffer for writing | ||
| SampleBuffer buf = dac1.dequeue(); | ||
| // Write data to buffer (Even position: 0, Odd position: 0xFFF) | ||
| for (int i=0; i<buf.size(); i++) { | ||
| buf.data()[i] = (i % 2 == 0) ? 0: 0xFFF; | ||
| } | ||
| // Write the buffer to DAC | ||
| dac1.write(buf); | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ## Examples | ||
| - **[Advanced](../examples/Advanced):** This folder contains examples showing how to configure ADC/DAC to read/write data. | ||
| - **[Beginner](../examples/Beginner):** This folder contains examples showing how to generate waveforms with DAC. | ||
|
|
||
| ## API | ||
|
|
||
| The API documentation can be found [here](./api.md). | ||
|
|
||
| ## License | ||
|
|
||
| This library is released under the [LGPLv2.1 license](../LICENSE). | ||
|
|