Add microbit v2 split crates #44
Merged
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
4fc54c0 to
a8d5fe6
Compare
therealprof
reviewed
May 10, 2021
a8d5fe6 to
7b0379d
Compare
f5037f9 to
bbdf218
Compare
This change is a major rewrite. The crate is split into a multi-crate workspace layed out in a similar way to nrf-rs/nrf-hal. - `microbit-common` almost all the code, feature flagged for the different major board versions (V1 and V2). - `microbit` the V1 board support crate - `microbit-v2` the V2 board support crate - `xtask` cargo xtask crate for running CI accross the different versions. - `examples/*` the examples now need to be crates as they may support both versions Code changes to support micro:bit V2 ------------------------------------ Add features `v1` and `v2`. Originally they were `microbit-v1` and `microbit-v2`, however having the feature name the same as the crate name requires the namespaced-features cargo feature which basically restricts us to nightly. Add microbit v2 support to display module ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ This was hard and I am not super happy with the solution. It is much more bit twiddling than I am comfortable with. The issue that made it so difficult is that on the microbit v2 the column pins are on the P0 and P1 ports so all the row wise writes have to be split accross the two ports. Get microbit v2 led examples working ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - Create a new v2 gpio module and conditionally use v1 or v2 - Move NUM_ROWS and NUM_COLS consts into gpio module so they can differ between v1 and v2 - Move degrading the LED pins into the gpio module so it can differ between v1 and v2 The code for the nonblocking display is a nightmare. The columns are split between the two GPIO ports so the cols argument to `display_row_leds` needs to be split between the two ports. This is a bit painful but doable. The bit that is really confusing me is that columns 2 and 3 seem to be swapped. CI changes ---------- I have mostly copied CI from nrf-rs/nrf-hal with some minor differences. I didn't like having to list all the examples in the CI so it derives the features and targets required for each example from the cargo manifest. Copying nrf-hal also meant getting the doc tests building as well which is nice. For the docs I've favoured complexity in the source for the sake of docs that are clearer. Examples changes ---------------- The microbit-v2 crate does not yet support serial so I have chosen to favour probe-run and defmt for all the examples except those that are specifically about serial communication (those now just run on the v1 crate). I have not ported over the examples that I could not get working (receivedcf77 and the magnetometer ones). I plan on implementing the magnetometer for both versions in the near future so examples for that will hopefully come back soon.
bbdf218 to
dbbdd1c
Compare
|
One thing not addressed is the |
therealprof
approved these changes
May 10, 2021
Don't worry about this for now. Only some numbers change. |
|
Build succeeded: |
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Relates to #27 and #41
Add support for micro:bit v2
This change is a major rewrite. The crate is split into a multi-crate workspace organised in a similar way to nrf-rs/nrf-hal.
microbit-commonalmost all the code, feature flagged for the different major board versions (V1 and V2).microbitthe V1 board support cratemicrobit-v2the V2 board support cratextaskcargo xtask crate for running CI accross the different versions.examples/*the examples now need to be crates as they may support both versionsCode changes to support micro:bit V2
Add features
v1andv2. Originally they weremicrobit-v1andmicrobit-v2, however having the feature name the same as the crate name requires the namespaced-features cargo feature which basically restricts us to nightly.Add micro:bit v2 support to display module
This was hard and I am not super happy with the solution. It is much more bit twiddling than I am comfortable with.
The issue that made it so difficult is that on the microbit v2 the column pins are on the P0 and P1 ports so all the row wise writes have to be split across the two ports.
Get microbit v2 led examples working
The code for the nonblocking display is a nightmare. The columns are split between the two GPIO ports so the cols argument to
display_row_ledsneeds to be split between the two ports. This is a bit painful but doable. The bit that is really confusing me is that columns 2 and 3 seem to be swapped.CI changes
I have mostly copied CI from nrf-rs/nrf-hal with some minor differences. I didn't like having to list all the examples in the CI so it derives the features and targets required for each example from the cargo manifest. Copying nrf-hal also meant getting the doc tests building as well which is nice. For the docs I've favoured complexity in the source for the sake of docs that are clearer.
Examples changes
The microbit-v2 crate does not yet support serial so I have chosen to favour probe-run and defmt for all the examples except those that are specifically about serial communication (those now just run on the v1 crate). I have not ported over the examples that I could not get working (receivedcf77 and the magnetometer ones). I plan on implementing the magnetometer for both versions in the near future so examples for that will hopefully come back soon.