-
Notifications
You must be signed in to change notification settings - Fork 434
README.md: Add samd51, accelerometer crate, micromath crate #182
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
README.md: Add samd51, accelerometer crate, micromath crate #182
Conversation
- Adds a link to `samd51` in addition to `samd21`, and updates the project's location - Adds a new "Component abstraction crates" section and lists the `accelerometer` crate - Adds the `micromath` crate to the "no-std crates" section
rust-highfive
commented
May 4, 2019
(rust_highfive has picked a reviewer for you, use r? to override)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@rust-embedded/resources
Any opinions on adding this new category? Probably worth discussing if we want the crate's contents it in embedded-hal itself.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I spoke with @japaric (and I think also briefly with @jamesmunns) about this at OxidizeConf. My understanding is embedded-hal is intended to be lower level than these sort of "component HALs" and, at least for now, it's best to keep them in their own crates (there's always the option of merging them in the future), and they recommended creating a new section for them.
Happy to discuss what the section should be named though... that's the best i could come up with.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah, thanks for the context, makes sense. In this case, I just tried to think of what other stuff would eventually fall into this category in the future. I think other typical (Smartphone) SoC sensors are likely candidates, e.g. temperature, barometer, gyro, ambient light, and so on.
Would sensor as a category make sense? Or can you think of an example that would fit here that is not a sensor?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some other stuff I think would probably make sense to put under this category:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I updated this section to add smart-leds-rs and embedded-graphics (moving them from the no_std crates section). I think this section from the smart-leds-rs docs gets the idea of this category of "component HAL" crate across:
Use various [component category] in rust. As their protocol greatly differs and for some [...] there are various methods, this crate doesn't implement any specific drivers by itself. It has to be coupled with a device driver that implements the [trait]
...the idea being these crates provide abstraction traits and types those traits are defined in terms of, to provide generic abstractions for a component category, but don't do anything in and of themselves, but need to be combined with a driver crate that implements the trait(s) supplied by these crates.
Note: also added info about the atsamd-hal as well as some board support crates for Adafruit SAMD51 boards: metro_m4, pyportal, trellis_m4
LGTM but I'll happily leave the final decision to @andre-richter
I'm fine with this for now.
Still wondering where hardware (abstraction layers) stop and component (abstraction layers) start ;)
bors r+
👎 Rejected by too few approved reviews
bors r+
182: README.md: Add samd51, accelerometer crate, micromath crate r=andre-richter a=tarcieri - Adds a link to `samd51` in addition to `samd21`, and updates the project's location - Adds a new "Component abstraction crates" section and lists the `accelerometer` crate - Adds the `micromath` crate to the "no-std crates" section Co-authored-by: Tony Arcieri <bascule@gmail.com>
samd51in addition tosamd21, and updates the project's locationaccelerometercratemicromathcrate to the "no-std crates" section