Skip to content

Conversation

leonardocavagnis
Copy link
Contributor

Main changes:

  • Fixing bugs in adc.begin() function to allow properly working on Portenta H7
  • Adding error checking in adc.begin() function
  • Updating README.md according to the Arduino library guideline
  • Restyling and updating docs/readme.md

The PR is based on the ArduinoCore-mbed patch related to arduino/mbed-os PR#34.

Please,
@iabdalkader take a look to adc.begin() modifies
@karlsoderby check if docs/readme.md sounds good for you

Copy link

Memory usage change @ 123f0c1

Board flash % RAM for global variables %
arduino:mbed_giga:giga ❔ -16 - +264 -0.0 - +0.01 💚 -16 - -8 -0.0 - -0.0
Click for full report table
Board examples/Advanced/ADC_Multi
flash
% examples/Advanced/ADC_Multi
RAM for global variables
% examples/Advanced/ADC_Multi_Channel
flash
% examples/Advanced/ADC_Multi_Channel
RAM for global variables
% examples/Advanced/ADC_Multi_Channel_Dynamic
flash
% examples/Advanced/ADC_Multi_Channel_Dynamic
RAM for global variables
% examples/Advanced/ADC_Multi_To_DAC
flash
% examples/Advanced/ADC_Multi_To_DAC
RAM for global variables
% examples/Advanced/ADC_Serial_Plotter
flash
% examples/Advanced/ADC_Serial_Plotter
RAM for global variables
% examples/Advanced/ADC_To_DAC
flash
% examples/Advanced/ADC_To_DAC
RAM for global variables
% examples/Advanced/DAC_One_Channel
flash
% examples/Advanced/DAC_One_Channel
RAM for global variables
% examples/Advanced/DAC_Sine_wave
flash
% examples/Advanced/DAC_Sine_wave
RAM for global variables
% examples/Advanced/DAC_Two_Channels
flash
% examples/Advanced/DAC_Two_Channels
RAM for global variables
% examples/Beginner/Audio_Playback
flash
% examples/Beginner/Audio_Playback
RAM for global variables
% examples/Beginner/Waveform_Generator
flash
% examples/Beginner/Waveform_Generator
RAM for global variables
%
arduino:mbed_giga:giga 200 0.01 -8 -0.0 200 0.01 -8 -0.0 192 0.01 -8 -0.0 264 0.01 -8 -0.0 200 0.01 -8 -0.0 200 0.01 -8 -0.0 -8 -0.0 -8 -0.0 -8 -0.0 -8 -0.0 -8 -0.0 -8 -0.0 -8 -0.0 -8 -0.0 -16 -0.0 -16 -0.0
Click for full report CSV
Board,examples/Advanced/ADC_Multi<br>flash,%,examples/Advanced/ADC_Multi<br>RAM for global variables,%,examples/Advanced/ADC_Multi_Channel<br>flash,%,examples/Advanced/ADC_Multi_Channel<br>RAM for global variables,%,examples/Advanced/ADC_Multi_Channel_Dynamic<br>flash,%,examples/Advanced/ADC_Multi_Channel_Dynamic<br>RAM for global variables,%,examples/Advanced/ADC_Multi_To_DAC<br>flash,%,examples/Advanced/ADC_Multi_To_DAC<br>RAM for global variables,%,examples/Advanced/ADC_Serial_Plotter<br>flash,%,examples/Advanced/ADC_Serial_Plotter<br>RAM for global variables,%,examples/Advanced/ADC_To_DAC<br>flash,%,examples/Advanced/ADC_To_DAC<br>RAM for global variables,%,examples/Advanced/DAC_One_Channel<br>flash,%,examples/Advanced/DAC_One_Channel<br>RAM for global variables,%,examples/Advanced/DAC_Sine_wave<br>flash,%,examples/Advanced/DAC_Sine_wave<br>RAM for global variables,%,examples/Advanced/DAC_Two_Channels<br>flash,%,examples/Advanced/DAC_Two_Channels<br>RAM for global variables,%,examples/Beginner/Audio_Playback<br>flash,%,examples/Beginner/Audio_Playback<br>RAM for global variables,%,examples/Beginner/Waveform_Generator<br>flash,%,examples/Beginner/Waveform_Generator<br>RAM for global variables,%
arduino:mbed_giga:giga,200,0.01,-8,-0.0,200,0.01,-8,-0.0,192,0.01,-8,-0.0,264,0.01,-8,-0.0,200,0.01,-8,-0.0,200,0.01,-8,-0.0,-8,-0.0,-8,-0.0,-8,-0.0,-8,-0.0,-8,-0.0,-8,-0.0,-8,-0.0,-8,-0.0,-16,-0.0,-16,-0.0

Copy link
Contributor

@karlsoderby karlsoderby left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @leonardocavagnis I've reviewed the documentation part and it looks great. Left some small suggestions :)

Copy link

Memory usage change @ 7a21328

Board flash % RAM for global variables %
arduino:mbed_giga:giga ❔ -16 - +264 -0.0 - +0.01 💚 -16 - -8 -0.0 - -0.0
Click for full report table
Board examples/Advanced/ADC_Multi
flash
% examples/Advanced/ADC_Multi
RAM for global variables
% examples/Advanced/ADC_Multi_Channel
flash
% examples/Advanced/ADC_Multi_Channel
RAM for global variables
% examples/Advanced/ADC_Multi_Channel_Dynamic
flash
% examples/Advanced/ADC_Multi_Channel_Dynamic
RAM for global variables
% examples/Advanced/ADC_Multi_To_DAC
flash
% examples/Advanced/ADC_Multi_To_DAC
RAM for global variables
% examples/Advanced/ADC_Serial_Plotter
flash
% examples/Advanced/ADC_Serial_Plotter
RAM for global variables
% examples/Advanced/ADC_To_DAC
flash
% examples/Advanced/ADC_To_DAC
RAM for global variables
% examples/Advanced/DAC_One_Channel
flash
% examples/Advanced/DAC_One_Channel
RAM for global variables
% examples/Advanced/DAC_Sine_wave
flash
% examples/Advanced/DAC_Sine_wave
RAM for global variables
% examples/Advanced/DAC_Two_Channels
flash
% examples/Advanced/DAC_Two_Channels
RAM for global variables
% examples/Beginner/Audio_Playback
flash
% examples/Beginner/Audio_Playback
RAM for global variables
% examples/Beginner/Waveform_Generator
flash
% examples/Beginner/Waveform_Generator
RAM for global variables
%
arduino:mbed_giga:giga 200 0.01 -8 -0.0 200 0.01 -8 -0.0 192 0.01 -8 -0.0 264 0.01 -8 -0.0 200 0.01 -8 -0.0 200 0.01 -8 -0.0 -8 -0.0 -8 -0.0 -8 -0.0 -8 -0.0 -8 -0.0 -8 -0.0 -8 -0.0 -8 -0.0 -16 -0.0 -16 -0.0
Click for full report CSV
Board,examples/Advanced/ADC_Multi<br>flash,%,examples/Advanced/ADC_Multi<br>RAM for global variables,%,examples/Advanced/ADC_Multi_Channel<br>flash,%,examples/Advanced/ADC_Multi_Channel<br>RAM for global variables,%,examples/Advanced/ADC_Multi_Channel_Dynamic<br>flash,%,examples/Advanced/ADC_Multi_Channel_Dynamic<br>RAM for global variables,%,examples/Advanced/ADC_Multi_To_DAC<br>flash,%,examples/Advanced/ADC_Multi_To_DAC<br>RAM for global variables,%,examples/Advanced/ADC_Serial_Plotter<br>flash,%,examples/Advanced/ADC_Serial_Plotter<br>RAM for global variables,%,examples/Advanced/ADC_To_DAC<br>flash,%,examples/Advanced/ADC_To_DAC<br>RAM for global variables,%,examples/Advanced/DAC_One_Channel<br>flash,%,examples/Advanced/DAC_One_Channel<br>RAM for global variables,%,examples/Advanced/DAC_Sine_wave<br>flash,%,examples/Advanced/DAC_Sine_wave<br>RAM for global variables,%,examples/Advanced/DAC_Two_Channels<br>flash,%,examples/Advanced/DAC_Two_Channels<br>RAM for global variables,%,examples/Beginner/Audio_Playback<br>flash,%,examples/Beginner/Audio_Playback<br>RAM for global variables,%,examples/Beginner/Waveform_Generator<br>flash,%,examples/Beginner/Waveform_Generator<br>RAM for global variables,%
arduino:mbed_giga:giga,200,0.01,-8,-0.0,200,0.01,-8,-0.0,192,0.01,-8,-0.0,264,0.01,-8,-0.0,200,0.01,-8,-0.0,200,0.01,-8,-0.0,-8,-0.0,-8,-0.0,-8,-0.0,-8,-0.0,-8,-0.0,-8,-0.0,-8,-0.0,-8,-0.0,-16,-0.0,-16,-0.0

@iabdalkader
Copy link
Collaborator

Hi @leonardocavagnis can you please squash all of the docs update commits into one commit ?

leonardocavagnis and others added 2 commits December 5, 2023 13:09
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 <35461661+karlsoderby@users.noreply.github.com>
Copy link

github-actions bot commented Dec 5, 2023

Memory usage change @ 0bf0e0a

Board flash % RAM for global variables %
arduino:mbed_giga:giga ❔ -16 - +264 -0.0 - +0.01 💚 -16 - -8 -0.0 - -0.0
Click for full report table
Board examples/Advanced/ADC_Multi
flash
% examples/Advanced/ADC_Multi
RAM for global variables
% examples/Advanced/ADC_Multi_Channel
flash
% examples/Advanced/ADC_Multi_Channel
RAM for global variables
% examples/Advanced/ADC_Multi_Channel_Dynamic
flash
% examples/Advanced/ADC_Multi_Channel_Dynamic
RAM for global variables
% examples/Advanced/ADC_Multi_To_DAC
flash
% examples/Advanced/ADC_Multi_To_DAC
RAM for global variables
% examples/Advanced/ADC_Serial_Plotter
flash
% examples/Advanced/ADC_Serial_Plotter
RAM for global variables
% examples/Advanced/ADC_To_DAC
flash
% examples/Advanced/ADC_To_DAC
RAM for global variables
% examples/Advanced/DAC_One_Channel
flash
% examples/Advanced/DAC_One_Channel
RAM for global variables
% examples/Advanced/DAC_Sine_wave
flash
% examples/Advanced/DAC_Sine_wave
RAM for global variables
% examples/Advanced/DAC_Two_Channels
flash
% examples/Advanced/DAC_Two_Channels
RAM for global variables
% examples/Beginner/Audio_Playback
flash
% examples/Beginner/Audio_Playback
RAM for global variables
% examples/Beginner/Waveform_Generator
flash
% examples/Beginner/Waveform_Generator
RAM for global variables
%
arduino:mbed_giga:giga 200 0.01 -8 -0.0 200 0.01 -8 -0.0 192 0.01 -8 -0.0 264 0.01 -8 -0.0 200 0.01 -8 -0.0 200 0.01 -8 -0.0 -8 -0.0 -8 -0.0 -8 -0.0 -8 -0.0 -8 -0.0 -8 -0.0 -8 -0.0 -8 -0.0 -16 -0.0 -16 -0.0
Click for full report CSV
Board,examples/Advanced/ADC_Multi<br>flash,%,examples/Advanced/ADC_Multi<br>RAM for global variables,%,examples/Advanced/ADC_Multi_Channel<br>flash,%,examples/Advanced/ADC_Multi_Channel<br>RAM for global variables,%,examples/Advanced/ADC_Multi_Channel_Dynamic<br>flash,%,examples/Advanced/ADC_Multi_Channel_Dynamic<br>RAM for global variables,%,examples/Advanced/ADC_Multi_To_DAC<br>flash,%,examples/Advanced/ADC_Multi_To_DAC<br>RAM for global variables,%,examples/Advanced/ADC_Serial_Plotter<br>flash,%,examples/Advanced/ADC_Serial_Plotter<br>RAM for global variables,%,examples/Advanced/ADC_To_DAC<br>flash,%,examples/Advanced/ADC_To_DAC<br>RAM for global variables,%,examples/Advanced/DAC_One_Channel<br>flash,%,examples/Advanced/DAC_One_Channel<br>RAM for global variables,%,examples/Advanced/DAC_Sine_wave<br>flash,%,examples/Advanced/DAC_Sine_wave<br>RAM for global variables,%,examples/Advanced/DAC_Two_Channels<br>flash,%,examples/Advanced/DAC_Two_Channels<br>RAM for global variables,%,examples/Beginner/Audio_Playback<br>flash,%,examples/Beginner/Audio_Playback<br>RAM for global variables,%,examples/Beginner/Waveform_Generator<br>flash,%,examples/Beginner/Waveform_Generator<br>RAM for global variables,%
arduino:mbed_giga:giga,200,0.01,-8,-0.0,200,0.01,-8,-0.0,192,0.01,-8,-0.0,264,0.01,-8,-0.0,200,0.01,-8,-0.0,200,0.01,-8,-0.0,-8,-0.0,-8,-0.0,-8,-0.0,-8,-0.0,-8,-0.0,-8,-0.0,-8,-0.0,-8,-0.0,-16,-0.0,-16,-0.0

@iabdalkader
Copy link
Collaborator

@karlsoderby @leonardocavagnis Why are we removing most of the README.md file ?

@leonardocavagnis
Copy link
Contributor Author

leonardocavagnis commented Dec 5, 2023

@karlsoderby @leonardocavagnis Why are we removing most of the README.md file ?

I removed it according to the Arduino Library guideline. Most of the information has been moved in the docs/README.md

Update src/AdvancedADC.cpp

Update src/AdvancedADC.cpp

Update src/AdvancedADC.cpp

Update src/AdvancedADC.cpp

Update src/AdvancedADC.cpp

Update src/AdvancedADC.cpp

Update src/AdvancedADC.cpp

Update src/AdvancedADC.cpp

Update src/HALConfig.cpp

Update src/AdvancedADC.cpp

Update src/AdvancedADC.cpp

Co-Authored-By: Ibrahim Abdelkader <i.abdalkader@gmail.com>
@leonardocavagnis leonardocavagnis added type: imperfection Perceived defect in any part of project topic: documentation Related to documentation for the project topic: code Related to content of the project itself labels Dec 6, 2023
Copy link

github-actions bot commented Dec 6, 2023

Memory usage change @ 065318b

Board flash % RAM for global variables %
arduino:mbed_giga:giga ❔ -16 - +200 -0.0 - +0.01 💚 -16 - -8 -0.0 - -0.0
Click for full report table
Board examples/Advanced/ADC_Multi
flash
% examples/Advanced/ADC_Multi
RAM for global variables
% examples/Advanced/ADC_Multi_Channel
flash
% examples/Advanced/ADC_Multi_Channel
RAM for global variables
% examples/Advanced/ADC_Multi_Channel_Dynamic
flash
% examples/Advanced/ADC_Multi_Channel_Dynamic
RAM for global variables
% examples/Advanced/ADC_Multi_To_DAC
flash
% examples/Advanced/ADC_Multi_To_DAC
RAM for global variables
% examples/Advanced/ADC_Serial_Plotter
flash
% examples/Advanced/ADC_Serial_Plotter
RAM for global variables
% examples/Advanced/ADC_To_DAC
flash
% examples/Advanced/ADC_To_DAC
RAM for global variables
% examples/Advanced/DAC_One_Channel
flash
% examples/Advanced/DAC_One_Channel
RAM for global variables
% examples/Advanced/DAC_Sine_wave
flash
% examples/Advanced/DAC_Sine_wave
RAM for global variables
% examples/Advanced/DAC_Two_Channels
flash
% examples/Advanced/DAC_Two_Channels
RAM for global variables
% examples/Beginner/Audio_Playback
flash
% examples/Beginner/Audio_Playback
RAM for global variables
% examples/Beginner/Waveform_Generator
flash
% examples/Beginner/Waveform_Generator
RAM for global variables
%
arduino:mbed_giga:giga 200 0.01 -8 -0.0 200 0.01 -8 -0.0 192 0.01 -8 -0.0 200 0.01 -8 -0.0 200 0.01 -8 -0.0 200 0.01 -8 -0.0 -8 -0.0 -8 -0.0 -8 -0.0 -8 -0.0 -8 -0.0 -8 -0.0 -8 -0.0 -8 -0.0 -16 -0.0 -16 -0.0
Click for full report CSV
Board,examples/Advanced/ADC_Multi<br>flash,%,examples/Advanced/ADC_Multi<br>RAM for global variables,%,examples/Advanced/ADC_Multi_Channel<br>flash,%,examples/Advanced/ADC_Multi_Channel<br>RAM for global variables,%,examples/Advanced/ADC_Multi_Channel_Dynamic<br>flash,%,examples/Advanced/ADC_Multi_Channel_Dynamic<br>RAM for global variables,%,examples/Advanced/ADC_Multi_To_DAC<br>flash,%,examples/Advanced/ADC_Multi_To_DAC<br>RAM for global variables,%,examples/Advanced/ADC_Serial_Plotter<br>flash,%,examples/Advanced/ADC_Serial_Plotter<br>RAM for global variables,%,examples/Advanced/ADC_To_DAC<br>flash,%,examples/Advanced/ADC_To_DAC<br>RAM for global variables,%,examples/Advanced/DAC_One_Channel<br>flash,%,examples/Advanced/DAC_One_Channel<br>RAM for global variables,%,examples/Advanced/DAC_Sine_wave<br>flash,%,examples/Advanced/DAC_Sine_wave<br>RAM for global variables,%,examples/Advanced/DAC_Two_Channels<br>flash,%,examples/Advanced/DAC_Two_Channels<br>RAM for global variables,%,examples/Beginner/Audio_Playback<br>flash,%,examples/Beginner/Audio_Playback<br>RAM for global variables,%,examples/Beginner/Waveform_Generator<br>flash,%,examples/Beginner/Waveform_Generator<br>RAM for global variables,%
arduino:mbed_giga:giga,200,0.01,-8,-0.0,200,0.01,-8,-0.0,192,0.01,-8,-0.0,200,0.01,-8,-0.0,200,0.01,-8,-0.0,200,0.01,-8,-0.0,-8,-0.0,-8,-0.0,-8,-0.0,-8,-0.0,-8,-0.0,-8,-0.0,-8,-0.0,-8,-0.0,-16,-0.0,-16,-0.0

@leonardocavagnis leonardocavagnis merged commit 0fcd53e into arduino-libraries:main Dec 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: code Related to content of the project itself topic: documentation Related to documentation for the project type: imperfection Perceived defect in any part of project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants