docs/library: Add machine.DAC documentation. #18027
Open
+54
−0
Conversation
This file contains hidden or 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
Signed-off-by: Matt Trentini <[email protected]>
robert-hh
reviewed
Sep 2, 2025
| Constructors | ||
| ------------ | ||
|
|
||
| .. class:: DAC(pin) |
Contributor
There was a problem hiding this comment.
At the SAMD port with fixed pins the argument of the constructor is an ID, not a Pin: 0 for SAMD21 and 0 or 1 for SAMD51. That could be changed, but maybe together with the other suggested changes.
Contributor
Author
There was a problem hiding this comment.
Ooof, ok, thanks. I can see why you did it that way but it's amazing how - across just three ports - a single method can differ so much! 😉
Contributor
|
Thank you for the effort. Minor comments:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
As described in #7915,
machinemodule needed aDACentry.This turned out to be a simple doc item but was surprisingly challenging to summarise the different DAC implementations.
Testing
Tested by building the docs locally; looks reasonable.
Trade-offs and Alternatives
It is tempting to overhaul the DAC interface to make it more complete and remove some of the differences between ports.
For example, we could settle on using, say, a 16 bit range for all ports and interpolate with however many bits are available. Something like a
DAC.bits()method could return the port-specific number of bits so the user could determine the actual resolution available. The docs would not need to call out the port-specific ranges. Also,initanddeinitare not standard, they probably should be.So, rather than overhaul the interface (and introduce breaking changes), I thought it best to document the current state and then, later, make the changes and update the docs.