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.

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

Ambiguous wording in analogReadResolution note re: setting higher resolution than supported #779

Open
TimMathias opened this issue Sep 17, 2020 · 3 comments
Assignees

Comments

@TimMathias
Copy link

In the section "Notes and Warnings" there is ambiguous wording:

For example: using the Due with analogReadResolution(16) will give you an approximated 16-bit number with the first 12 bits containing the real ADC reading and the last 4 bits padded with zeros.

Consider revising it to:

For example: using the Due with analogReadResolution(16) will give you an approximated 16-bit number with the most significant 12 bits containing the real ADC reading and the least significant 4 bits padded with zeros.

This would make it consistent with the wording of the following paragraph:

If you set the analogReadResolution() value to a value lower than your board’s capabilities, the extra least significant bits read from the ADC will be discarded.

@kengdahl kengdahl self-assigned this Sep 23, 2020
@kengdahl
Copy link
Member

@dcuartielles I agree with him. Shall I make the changes?

@TimMathias
Copy link
Author

@kengdahl and @dcuartielles, yes, go on, what are you waiting for?

@kengdahl
Copy link
Member

kengdahl commented Oct 8, 2020

@TimMathias I was asking @dcuartielles about this. As soon as I get the ok from him I'll gladly make the changes.

@per1234 per1234 changed the title reference-en/Language/Functions/Zero, Due, MKR Family/analogReadResolution.adoc Ambiguous wording in analogReadResolution note re: setting higher resolution than supported Feb 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants