add notes to bsc exercise

This commit is contained in:
Mirabellensaft 2023-02-14 19:04:36 +01:00
parent e98ddd23e5
commit 028a850596

View file

@ -1,16 +1,19 @@
# BSC Exercise
In this exercise you will learn how to write a board support crate.
The bsc template will already contain the led and timer implementation.
The radio and USB/Power implementations will be deleted, because that just takes up unnecessary space and adds to confusion.
## Learning goals
* implement buttons functionality
* uarte implementation
* impl blocks, associated functions, methods
* generate docs!
## Steps
### Write a button implementation
* add field in the board struct
* add struct for all buttons
* add struct for the single button
@ -21,6 +24,14 @@ In this exercise you will learn how to write a board support crate.
* add doc lines every where!
* add methods in impl block:
* detect button push
* add another... look at knurling book for inspiration
* debounce button function? like in knurling session, requires implementation of a second timer, just for this?
### Write Uarte implementation
* add field to the board struct
* add struct for the instance, how to figure out what the type of the inner field is
* create instance in init, add baudrate, parity etc.
* add to instantiation of board struct
* impl fmt::Write for the Uarte struct, simple write does not work because of dma
* example code with button is not a good idea for the simple button implementation.
I think this is plenty for an hour.