Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

boards/nucleo-l* and g*: update doc concerning Vbat #18984

Merged
merged 5 commits into from
Nov 28, 2022
Merged

boards/nucleo-l* and g*: update doc concerning Vbat #18984

merged 5 commits into from
Nov 28, 2022

Conversation

krzysztof-cabaj
Copy link
Contributor

Contribution description

In PR #18940 @maribu point out that vbat ADC channel for nucleo-l496zg has voltage divider.
I checked datasheets for other nucleo boards with configured ADC and find that this behavior is
documented only on few L and G family MCUs.

This PR improves documentation adding such information. Moreover, I moved doxygen section
from the middle of adc_config[] as it do not appear in the generated HTML documentation.

Testing procedure

make doc
xdg-open doc/doxygen/html/boards_2nucleo-l496zg_2include_2periph__conf_8h.html
xdg-open doc/doxygen/html/boards_2nucleo-l476rg_2include_2periph__conf_8h.html
xdg-open doc/doxygen/html/boards_2nucleo-l4r5zi_2include_2periph__conf_8h.html
xdg-open doc/doxygen/html/boards_2nucleo-g070rb_2include_2periph__conf_8h.html
xdg-open doc/doxygen/html/boards_2nucleo-g071rb_2include_2periph__conf_8h.html

Issues/PRs references

PR #18940

@github-actions github-actions bot added the Area: boards Area: Board ports label Nov 28, 2022
maribu
maribu approved these changes Nov 28, 2022
View reviewed changes
Copy link
Member

@maribu maribu left a comment

Choose a reason for hiding this comment

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

Thx :)

Could you directly squash in the fix for the trailing white space the CI complains a out (see inline suggestion)?

boards/nucleo-g070rb/include/periph_conf.h Outdated
* For Nucleo-G070RB this information is in board manual,
* Table 12, page 30.
*
* VBAT is connected to an internal input and voltage divider
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
* VBAT is connected to an internal input and voltage divider
* VBAT is connected to an internal input and voltage divider

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I have just do it ;)

@benpicco benpicco added the CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR label Nov 28, 2022
@riot-ci
Copy link

riot-ci commented Nov 28, 2022

Murdock results

✔️ PASSED

d7c5667 boards/nucleo-g071rb: improve ADC doc

Success Failures Total Runtime
1 0 1 01m:00s

Artifacts

@maribu maribu merged commit e6dfe75 into RIOT-OS:master Nov 28, 2022
@kaspar030 kaspar030 added this to the Release 2023.01 milestone Jan 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@maribu maribu maribu approved these changes

@aabadie aabadie Awaiting requested review from aabadie aabadie is a code owner

@fjmolinas fjmolinas Awaiting requested review from fjmolinas

Assignees
No one assigned
Labels
Area: boards Area: Board ports CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR
Projects
None yet
Milestone
Release 2023.01
Development

Successfully merging this pull request may close these issues.
5 participants
@krzysztof-cabaj @riot-ci @maribu @benpicco @kaspar030