Commit graph

242 commits

Author SHA1 Message Date
Lotte Steenbrink 3d44417a08 respond to comments 2020-12-21 17:31:40 +01:00
Lotte Steenbrink d35f8e24cf move tool installation out of tooling check, clarify cd tools 2020-12-21 11:56:13 +01:00
Lotte Steenbrink 98d34a5554 hardware.md: fix concave->convex wording and a typo 2020-10-05 11:19:20 +02:00
Lotte Steenbrink 3dd0b2e0af troubleshoot-usb-dongle.md: clarify language 2020-09-21 14:02:14 +02:00
Dave Hylands 172dbc17cd Update cross compilation target
Use the target actually mentioned in the .cargo/config file.

Updated the output in the troubleshooting page and
also updated the target for the board/dongle.
2020-09-16 17:45:40 -07:00
Sebastian Ziebell 3cd3211368
Update entry on building program in workbook
This change updates the information on "Building an Embedded Program". There is a mismatch between the described target `thumbv7em-none-eabi` compared to the set target in file `beginner/apps/.cargo/config` that contains target entry `thumbv7em-none-eabihf`.
2020-09-08 12:28:26 +02:00
Jonas Schievink 4ac3e7970c
Merge pull request #100 from ferrous-systems/update-probe-run
move to thumbv7em-none-eabi**hf** now that probe-run supports it
2020-08-24 12:35:45 +02:00
Lotte Steenbrink 303f09bbf8 setup-stage.md: add values for DEVIC descriptor, clarify instructions 2020-08-24 12:28:29 +02:00
Lotte Steenbrink 07b7402953 move to thumbv7em-none-eabihf now that probe-run supports it 2020-08-24 11:59:10 +02:00
Lotte Steenbrink 529f5ea34c use probe-run instead of dk-run 2020-08-17 14:34:07 +02:00
James Munns 7134ab798e
Merge pull request #94 from gdetrez/patch-1
Fix typos in beginner-next-steps.md
2020-08-04 23:42:48 +02:00
James Munns 175aa52dcc
Merge pull request #91 from ferrous-systems/add_advanced_slides
references-resources.md: add advanced training slides
2020-08-04 23:42:06 +02:00
James Munns 461a0ef205
Merge pull request #87 from Hoverbear-Consulting/hardware-image
hardware: Add labelled image of device nRF52840-DK
2020-08-04 23:41:24 +02:00
Grégoire Détrez c72a79eb26 Fix typos in beginner-next-steps.md 2020-08-04 08:49:30 +02:00
Lotte Steenbrink 7b1c18b2f9 references-resources.md: add advanced training slides 2020-07-24 20:13:02 +02:00
Jorge Aparicio 8ada5dc5d8
Merge pull request #90 from ferrous-systems/sw10_position
fix SW10 position description
2020-07-24 09:32:17 +00:00
Lotte Steenbrink f415ea66ba hardware.md: move kapton tape to SW7 2020-07-24 10:42:13 +02:00
Lotte Steenbrink d9351bf4d3 hardware.md: driveby: add note on how to orient the board 2020-07-24 10:00:38 +02:00
Lotte Steenbrink 087dd32875 hardware.md: fix position descriptpon of SW10 2020-07-24 09:58:15 +02:00
Ana Hobden a1078ccaaa (Windows) Note about Dongle and Zadig
Signed-off-by: Ana Hobden <operator@hoverbear.org>
2020-07-23 07:01:12 -07:00
Ana Hobden f1bfec3e38 Add labelled image of device nRF52840
Signed-off-by: Ana Hobden <operator@hoverbear.org>
2020-07-21 21:45:29 -07:00
Ana Hobden 75eeca45bf vscode links
Signed-off-by: Ana Hobden <operator@hoverbear.org>
2020-07-21 20:45:59 -07:00
Ana Hobden 6892d63296 More links!
Signed-off-by: Ana Hobden <operator@hoverbear.org>
2020-07-21 20:43:56 -07:00
Ana Hobden 55062bbb46 Add links for Rustup and C++ build tools
Signed-off-by: Ana Hobden <operator@hoverbear.org>
2020-07-21 20:33:29 -07:00
Lotte Steenbrink 1a766cbe69 radio-puzzle-help.md: add hint re: log buffer 2020-07-20 18:21:21 +02:00
Lotte Steenbrink c0d17388a4 add Table 9-4 field values to mdbook as well 2020-07-20 14:29:27 +02:00
Lotte Steenbrink 8fca19aa14
Merge pull request #79 from siedentop/clarify-blinking-and-logging
Book: Time & Logging
2020-07-20 09:36:01 +02:00
Christoph Siedentop 836aafc075 Book: Add note about how fast cycle periods can lead to excessive
logging.
2020-07-19 16:59:46 -07:00
Mo Mirza 0f0e66a118
Update beginner-next-steps.md 2020-07-19 19:02:55 +01:00
Mo Mirza 787528aff7
Add link to nRF52840 product spec 2020-07-19 19:01:52 +01:00
Yatekii 379a0f70cb
Update flashing-program.md
The debug interface present on the nRF52 devices is actually SWD and not JTAG.
2020-07-17 01:05:16 +02:00
Jorge Aparicio 1bb84dfed1 add note about bLength and bDescriptorType 2020-07-16 18:05:01 +02:00
Mirabellensaft 4a9159e800 fix broken links 2020-07-16 17:50:38 +02:00
Jorge Aparicio 443525788f add alt text 2020-07-16 16:29:06 +02:00
Jorge Aparicio 6f4b7a922d split long section 2020-07-16 16:29:06 +02:00
Jorge Aparicio 138cb1909f add USB diagrams 2020-07-16 16:29:06 +02:00
Jorge Aparicio c482a40217 fix path in src/SUMMARY.md 2020-07-16 15:14:47 +02:00
Jorge Aparicio 64573a8009
Merge pull request #69 from ferrous-systems/adv-edits
misc edits to the advanced material
2020-07-16 12:25:05 +00:00
Jorge Aparicio e2306a973a
Merge pull request #67 from ferrous-systems/group_rust_installs
installation.md: move rust deps up again
2020-07-16 12:16:56 +00:00
Jorge Aparicio 505f4572a1
Merge pull request #65 from ferrous-systems/tell_your_friends
Add "Tell your friends" section
2020-07-16 12:13:55 +00:00
Jorge Aparicio 1310e1aa6d tell folks to keep the USB cable connected 2020-07-16 14:07:17 +02:00
Mirabellensaft 3a43bf9c13 add keep cable plugged recommendation 2020-07-16 14:00:40 +02:00
Jorge Aparicio 5fe1cd7a0e extend cargo run troubleshooting section
with the Linux variant of the error
2020-07-16 14:00:18 +02:00
Jorge Aparicio c44b1d8c91 note that DMA section is optional
and elaborate on the relationship between endpoint buffer and the DMA
2020-07-16 13:51:11 +02:00
Lotte Steenbrink e5b46e34e6 installation.md: reorder, group 2020-07-16 13:44:27 +02:00
Lotte Steenbrink 2e56221221 installation.md: move rust deps up again 2020-07-16 13:16:00 +02:00
Lotte Steenbrink 1cca7b2bfd referneces-resources.md: add tell your freinds section 2020-07-16 13:07:34 +02:00
Mirabellensaft 0ea86f204e last batch of didactic changes 2020-07-16 12:56:20 +02:00
Mirabellensaft d71095251d add access denied error to troubleshooting 2020-07-16 12:41:02 +02:00
Lotte Steenbrink 0abc0c4d2b preparations.md: add link to installation instructions 2020-07-16 11:38:56 +02:00
Mirabellensaft d75b61af56 Merge branch 'main' of github.com:ferrous-systems/embedded-trainings-2020 into edit-book 2020-07-16 10:33:19 +02:00
Tanks Transfeld 579b81c33f
Merge pull request #57 from ferrous-systems/add-intros
add intro text to the beginner workshop
2020-07-16 10:30:52 +02:00
Jorge Aparicio 473bb3edc7
Merge pull request #60 from ferrous-systems/fix-rtic
correct the expansion of the RTIC acronym
2020-07-16 08:10:25 +00:00
Jorge Aparicio 674a71ad9b
Merge pull request #59 from ferrous-systems/time-assignment
add assignment to beginner/time section
2020-07-16 08:09:59 +00:00
Mirabellensaft 1b01180e44 more didactic changes 2020-07-15 18:53:31 +02:00
Jorge Aparicio 0930ccd3f5 correct the expansion of the RTIC acronym 2020-07-15 18:06:21 +02:00
Jorge Aparicio 9c9545f942 put the assignment last 2020-07-15 18:01:00 +02:00
Jorge Aparicio b1977573c4 add assignment to beginner/time section 2020-07-15 17:59:30 +02:00
Jorge Aparicio d00e69f461 do not mention tools; instead link back 2020-07-15 17:51:23 +02:00
Jorge Aparicio d5b561ab0f remove duplicated text 2020-07-15 17:05:38 +02:00
Jorge Aparicio db0b11902a replace some cargo-runs 2020-07-15 17:05:37 +02:00
Jorge Aparicio 845b2d4835 then remove the now redundant install instructions 2020-07-15 17:04:56 +02:00
Jorge Aparicio 236c85956b start off with tool check 2020-07-15 17:03:40 +02:00
Jorge Aparicio 0308868702
Merge pull request #54 from ferrous-systems/link
link the repo to the book website
2020-07-15 14:47:35 +00:00
Jorge Aparicio 5c3056d3e3 add intro text to the beginner workshop
and align the advanced workshop's to it
2020-07-15 16:40:14 +02:00
Mirabellensaft 3d8d121f23 Merge branch 'master' of github.com:ferrous-systems/embedded-trainings-2020 into edit-book 2020-07-15 16:30:20 +02:00
Mirabellensaft 7318f993a4 didactic changes in advanced material 2020-07-15 16:28:37 +02:00
Lotte Steenbrink 27ba908eb8 radio-puzzle-help.md: add more hints to hapless constants 2020-07-15 15:16:38 +02:00
Mirabellensaft 2f805453fb Merge branch 'edit-book' of github.com:ferrous-systems/embedded-trainings-2020 into edit-book 2020-07-15 15:00:07 +02:00
Mirabellensaft 6460862243 add note about help chapter 2020-07-15 14:59:59 +02:00
Jorge Aparicio bd4ceef619 link the repo to the book website
and vice versa
2020-07-15 14:56:48 +02:00
Tanks Transfeld d01829bad8
Update embedded-workshop-book/src/SUMMARY.md
Co-authored-by: Jorge Aparicio <jorge.aparicio@ferrous-systems.com>
2020-07-15 14:51:03 +02:00
Mirabellensaft 0f0ed9647c Merge branch 'master' of github.com:ferrous-systems/embedded-trainings-2020 into edit-book 2020-07-15 14:25:43 +02:00
Jorge Aparicio c8bfc24eae
Merge pull request #50 from ferrous-systems/no-usb-dongle
add no-USB variants of the Dongle programs
2020-07-15 12:22:02 +00:00
Mirabellensaft 07e30f80db Merge branch 'edit-book' of github.com:ferrous-systems/embedded-trainings-2020 into edit-book 2020-07-15 14:17:25 +02:00
Lotte Steenbrink d0752da10a embedded-workshop-book: fix links to book sections/chapters 2020-07-15 14:15:51 +02:00
Jorge Aparicio e6dda1b037 move usb issues into the troubleshooting chapter 2020-07-15 14:09:26 +02:00
Jorge Aparicio 05a2c8c3d9 more control flow 2020-07-15 14:09:26 +02:00
Jorge Aparicio 9f7bfe3384 add no-USB variants of the Dongle programs
these are for the case where USB functionality fails and compromises the radio
functionality
2020-07-15 14:09:25 +02:00
Mirabellensaft 68db545d8a separate puzzle and solving strategies 2020-07-15 13:53:22 +02:00
Jorge Aparicio 60095a2f69 add more switch info 2020-07-15 13:35:55 +02:00
Mirabellensaft c88ede8e48 add set_channel and reminder to radio-recv.rs 2020-07-15 13:03:51 +02:00
Jorge Aparicio 17e9f5f7f8
Update embedded-workshop-book/src/dongle.md 2020-07-15 09:53:07 +00:00
Mirabellensaft c6aba97a3a radio-indidactic changes 2020-07-14 19:24:07 +02:00
Mirabellensaft 7826673a27 separate radio-out into several pages 2020-07-14 19:15:07 +02:00
Mirabellensaft 1350b44e79 Merge branch 'master' of github.com:ferrous-systems/embedded-trainings-2020 into edit-book 2020-07-14 17:51:58 +02:00
Mirabellensaft 92788c250c save 2020-07-14 17:49:55 +02:00
Jorge Aparicio bf35327e7e
Merge pull request #47 from ferrous-systems/fix_40
fix #40: remove duplicate GET_DESCRIPTOR Configuration instruction
2020-07-14 15:15:32 +00:00
Lotte Steenbrink 666b6752e8 fix #40: remove duplicate GET_DESCRIPTOR Configuration instruction 2020-07-14 17:05:19 +02:00
Jorge Aparicio 2127ac2960
Merge pull request #43 from ferrous-systems/rename-usb-sols
rename USB parser solutions
2020-07-14 14:49:42 +00:00
Jorge Aparicio a73440ceb8 preserve trailing spaces 2020-07-14 16:38:00 +02:00
Jorge Aparicio a1ba8d8dd7
Merge pull request #44 from ferrous-systems/linux-logs
include Linux logs as text files
2020-07-14 14:31:09 +00:00
Jorge Aparicio a227a84fc2
Merge pull request #42 from ferrous-systems/radio-puzzle-heapless-docs
Radio puzzle heapless docs
2020-07-14 12:02:06 +00:00
Lotte Steenbrink 366eab426f radio-puzzle.md: fix reminder, add rest of text 2020-07-14 14:00:20 +02:00
Jorge Aparicio 3e985820c1 include Linux logs as text files
for completeness. Also fix the location of the files in the text.
2020-07-14 13:59:48 +02:00
Mirabellensaft 74031fc1b7 Merge branch 'master' of github.com:ferrous-systems/embedded-trainings-2020 into edit-book 2020-07-14 13:53:53 +02:00
Mirabellensaft 947c957eac moved big parts of the readme to workbook 2020-07-14 13:52:30 +02:00
Mirabellensaft 6839418768 didactic changes 2020-07-14 13:51:11 +02:00
Mirabellensaft d28f6a97f8 turned intro into preparations chapter 2020-07-14 13:50:19 +02:00
Jorge Aparicio 48e2ef512f rename USB parser solutions
also put them outside the `src` directory so people don't think they are modules
2020-07-14 13:28:23 +02:00
Jorge Aparicio 9cab8bb24e
Merge pull request #39 from ferrous-systems/tie-loose-ends
remove empty sections; add open-ended exercises
2020-07-14 11:11:09 +00:00
Jorge Aparicio 9964d7c6a2 more meaningful link 2020-07-14 13:10:52 +02:00
Lotte Steenbrink 6ae874307a radio-puzzle.md: add IndexMap / Vec doc links, short exmaple 2020-07-14 12:50:14 +02:00
Lotte Steenbrink ff31d66fd4 radio-puzzle.md: link to IndexMap docs for examples 2020-07-14 12:32:46 +02:00
Jorge Aparicio 32a5d458b8 address review comments 2020-07-14 12:08:44 +02:00
Jorge Aparicio 554a75595e
Update embedded-workshop-book/src/beginner-next-steps.md
Co-authored-by: Lotte Steenbrink <lotte@zombietetris.de>
2020-07-14 10:01:33 +00:00
Jorge Aparicio a7051bd4e3
Apply suggestions from code review
Co-authored-by: Lotte Steenbrink <lotte@zombietetris.de>
2020-07-14 09:59:32 +00:00
Jorge Aparicio a85e1f1152 show a single way to flash the program
this is the recommended way
2020-07-14 11:15:22 +02:00
Jorge Aparicio a61f676b9d
Merge branch 'master' into tie-loose-ends 2020-07-14 09:07:08 +00:00
Lotte Steenbrink 0c19f76a85
Merge pull request #38 from ferrous-systems/skade-patch-5
Fix unclarity in USB-3
2020-07-14 11:05:34 +02:00
Jorge Aparicio b1132b3cff
Merge pull request #36 from ferrous-systems/troubleshooting
add troubleshooting section
2020-07-14 09:00:14 +00:00
Jorge Aparicio 92662a658c
Merge pull request #35 from ferrous-systems/edit-book
didactic layout and structure changes
2020-07-14 08:58:49 +00:00
Jorge Aparicio cf2b5db798
Update embedded-workshop-book/src/troubleshoot-cargo-build.md
Co-authored-by: James Munns <james.munns@ferrous-systems.com>
2020-07-14 08:52:37 +00:00
Jorge Aparicio 3a02ed7284
Merge branch 'master' into change-channel 2020-07-14 08:51:18 +00:00
Jorge Aparicio 57f373d7a8 remove empty sections; add open-ended exercises
participants can try these after the workshop e.g. during the impl days
2020-07-13 19:18:52 +02:00
Florian Gilcher 21bf89090a
Fix unclarity in USB-3
USB-2 already implements GET_DESCRIPTOR, make clear that it must be extended
2020-07-13 19:02:12 +02:00
Mirabellensaft ad734d6530 rm note 2020-07-13 17:56:57 +02:00
Jorge Aparicio 43619ea87f
Update embedded-workshop-book/src/troubleshoot-rust-analyzer.md
Co-authored-by: Jonas Schievink <jonasschievink@gmail.com>
2020-07-13 15:54:00 +00:00
Jorge Aparicio 3fffebd4a6
Merge pull request #34 from ferrous-systems/fixes2
Assorted fixes to the beginner material
2020-07-13 15:47:08 +00:00
Jorge Aparicio e554c2756a
Apply suggestions from code review
Co-authored-by: Jonas Schievink <jonasschievink@gmail.com>
2020-07-13 15:45:59 +00:00
Jorge Aparicio 1ca2b4db16 add troubleshooting section 2020-07-13 17:41:37 +02:00
Mirabellensaft 0e51a0a052 didactic changes 2020-07-13 17:20:20 +02:00
Jonas Schievink e011e08566 "Do packet loss" => "Does packet loss" 2020-07-13 17:18:59 +02:00
Jonas Schievink 259e688293 Add a comma 2020-07-13 17:16:44 +02:00
Jorge Aparicio 657ecc9a9a document change-channel 2020-07-13 17:12:01 +02:00
Lotte Steenbrink 811402a423 getting-device-configured.md: SET_CONFIGURATION fields -> prose; fix typo 2020-07-13 17:08:07 +02:00
Jonas Schievink ac3a6644a9 Fix loopback program output 2020-07-13 17:07:24 +02:00
Jonas Schievink 586591f8de Fix grammar "pins have been configured" 2020-07-13 17:06:35 +02:00
Lotte Steenbrink 38d6500879 set-address.md: SET_ADDRESS Configuration -> prose 2020-07-13 17:02:13 +02:00
Mirabellensaft 0ccfbc0183 make binary size its own chapter 2020-07-13 16:48:13 +02:00
Lotte Steenbrink 678f1e5314 advanced/README.md: GET_DESCRIPTOR Configuration -> prose 2020-07-13 16:47:02 +02:00
Lotte Steenbrink 57214ec7fa advanced/README.md: 9.4.3 usb -> prose 2020-07-13 16:46:00 +02:00
Lotte Steenbrink efc0a17237 advanced/README.md: 9.4.7 usb -> prose 2020-07-13 16:44:11 +02:00
Lotte Steenbrink e1a71c93e6 README.md: driveby: rm non-matching page numbers 2020-07-13 16:42:34 +02:00
Lotte Steenbrink 84dcc9e907 usb-2: remove the need for 6.35.13.* PS tables 2020-07-13 16:41:42 +02:00
Mirabellensaft f27c4d7295 delete generic chapter file and add empty chapters 2020-07-13 15:25:38 +02:00
Mirabellensaft 54f6c4d356 rename files 2020-07-13 14:30:01 +02:00
Mirabellensaft 0ad7a5e119 Merge branch 'master' of github.com:ferrous-systems/embedded-trainings-2020 into edit-book 2020-07-13 14:27:34 +02:00
Mirabellensaft 10798b5bb1 adding changes from commits to README.md 2020-07-13 13:57:49 +02:00
Mirabellensaft e9d7d00ac8 add advanced material 2020-07-13 13:48:24 +02:00
Mirabellensaft bcd5df0035 Merge branch 'edit-beginner-book' of github.com:ferrous-systems/embedded-trainings-2020 into edit-book 2020-07-09 12:18:59 +02:00
Mirabellensaft bf2a5951f1 rename folder, add comments 2020-07-09 12:16:32 +02:00