Commit Graph

72 Commits

Author SHA1 Message Date
876faa5685 docs: more docs in embassy-boot crate documentation 2023-12-13 19:00:26 +01:00
3ef18ec133 Merge pull request #2263 from embassy-rs/jamesmunns-patch-2
Tweak FAQ size profile suggestions
2023-12-08 20:50:00 +01:00
4e7b855b2d Merge pull request #2265 from JuliDi/docs-best-practices
[Docs] Add best practices page
2023-12-08 20:49:45 +01:00
3f30e87cb5 Merge pull request #2251 from JuliDi/faq-performance-tweaks
[FAQ] Add section about speed optimization
2023-12-08 19:35:32 +00:00
c05149e5e4 add best practices first draft 2023-12-08 13:00:21 +01:00
c94a9b8d75 Merge pull request #2260 from barnabywalters/main
Added Embassy in the wild docs page with links to some projects
2023-12-08 09:55:31 +00:00
8fa5a6b282 Tweak FAQ size profile suggestions
If we want the smallest binary, we probably want codegen-units = 1, and disable incremental builds.
2023-12-07 14:27:09 +01:00
16e31747cc Changed example project name 2023-12-07 00:54:39 +01:00
536e91d263 Added a step-by-step guide to starting a new embassy project
Based off an example, noting what to copy, what to change and why

Briefly summarizing how to require embassy crates via github

All steps tested and proven working at the time of writing
2023-12-06 23:51:13 +01:00
ecaa62aa42 Fixed merge conflict 2023-12-06 21:55:07 +01:00
7561696a57 Added lora-rs links 2023-12-06 21:47:52 +01:00
195b492158 Update docs/modules/ROOT/pages/embassy_in_the_wild.adoc
Co-authored-by: Dániel Buga <bugadani@gmail.com>
2023-12-06 21:13:56 +01:00
10c9e2e723 Added description for Card/IO 2023-12-06 21:11:34 +01:00
cd62d2cd84 Added embassy in the wild docs page with two projects 2023-12-06 21:10:16 +01:00
1f6ffdcdd2 fix Cargo.toml and config.toml keys 2023-12-05 10:10:47 +01:00
a76dd2d70f Moved content from the wiki to the docs
New: delaying_a_task.adoc, copied as-is from the wiki and placed in the
navigation until we have a better place for it (or remove/replace it)

index: Tweaked the structure, added some content from the wiki, and made
some general copy edits to improve clarity.

getting_started.adoc: Corrected various out-of-date information, added
troubleshooting tips from the wiki, added some new information, various
other small edits.

basic_application.adoc: Corrected out-of-date information, various clarifications
and edits.

After these changes, IMO most of the content on the github wiki is no longer
necessary and can be removed for clarity. The few sections I didn‘t integrate
or copy over were either out of date or unfinished.
2023-12-05 01:01:50 +01:00
bf7115cb44 remove unnecessary backtick 2023-12-04 21:20:18 +01:00
0b0ca62a95 add speed optimization 2023-12-04 20:59:08 +01:00
ce4dd67f3b Merge pull request #2236 from tshepang/patch-2
no_std and no_main can be used on stable
2023-12-01 18:10:27 +01:00
33cfef871d no_std and no_main can be used on stable 2023-12-01 11:56:35 +02:00
270504d87d runtime.adoc: typo 2023-12-01 08:45:20 +02:00
a3c99f0324 Add multiple dependency error faq 2023-11-28 08:12:23 +01:00
74a6855f01 Update docs/modules/ROOT/pages/faq.adoc 2023-11-27 21:43:05 +01:00
f88aa9ce48 (FAQ): Add time driver note 2023-11-27 21:42:10 +01:00
02305451b1 need be -> needed
Co-authored-by: Dániel Buga <bugadani@gmail.com>
2023-11-27 10:51:20 -08:00
a42aef7759 it's -> its
Co-authored-by: Dániel Buga <bugadani@gmail.com>
2023-11-27 10:51:05 -08:00
142f42fe90 ... 2023-11-27 10:44:47 -08:00
5844f5ce2d Update faq.adoc 2023-11-27 10:23:42 -08:00
jan
dec7c1a28b add faq for deploying to RP2040 using elf2uf2-rs 2023-11-24 04:10:13 +05:30
bd2e6b0422 Update faq.adoc 2023-11-21 16:01:46 +01:00
c211d51c06 Add note for Xtensa 2023-11-21 15:53:30 +01:00
aedd41eac4 Add FAQ with one question from chat 2023-11-21 15:38:33 +01:00
10f08445e4 Update basic_application.adoc
typo: change "embassy::main" to "embassy_executor::main"
2023-10-18 14:53:49 +13:00
7559f9e583 time: Update documentation to use new after_x convenience methods 2023-10-15 00:47:56 +01:00
80a740bc72 docs: minor doc improvements and cleanup 2023-10-03 21:35:31 +02:00
537e2f3b44 update docs 2023-09-16 08:19:49 -05:00
0584312ef0 Fix some typos 2023-05-08 23:25:01 +02:00
868d01889b Documentation on verifying firmware
The documentation has been enhanced to describe the verification of firmware with the firmware updater. Examples have also been provided that describe how keys can be generated and how firmware can be signed.
2023-01-14 17:36:22 +11:00
0a27b6cedb Rename examples/nrf to examples/nrf52840 2023-01-09 22:30:02 +01:00
bb89a2341c feat: embassy-boot for rp2040
Add embassy-boot support for RP2040, with examples for the Raspberry Pi
Pico.

Co-authored-by: Mathias Koch <mk@blackbird.online>
2022-12-02 11:28:33 +01:00
9505a6f752 [doc] Remove obsolete code sample 2022-11-15 10:10:36 +01:00
ea61c19280 [doc] Fix some grammar 2022-11-15 10:10:36 +01:00
bcec55464f [doc] Fix line indices of basic example 2022-11-15 10:10:33 +01:00
4da6320e63 Add note on partition sizes to bootloader docs
See #1007
2022-10-11 10:20:31 +02:00
506e5a4493 Use embassy_executor::main in runtime.adoc
This commit replaces embassy::main with embassy_executor::main in the
runtime documentation page.

Refs: https://embassy.dev/dev/runtime.html
2022-09-03 15:09:36 +02:00
d769e562c0 Rewrite documentation using correct module names
* Remove traits section now that we have embedded-hal-async and refer to
  it.
* Explanation that embassy is multiple things.
* Bootloader description image
2022-08-16 11:27:57 +02:00
a38f9e03fa fix: doc: use master branch for basic example link 2022-07-12 20:58:19 -05:00
8a80ae5685 Update list of families with bootloader support 2022-05-06 21:57:15 +02:00
bd237a1f96 Allow using separate page sizes for state and dfu
* Less generics on bootloader. Keep PAGE_SIZE as a common multiple of
DFU and ACTIVE page sizes.
* Document restriction
* Add unit tests for different page sizes
2022-04-28 10:38:25 +02:00
484e0acc63 Add stm32 flash + bootloader support
* Add flash drivers for L0, L1, L4, WB and WL. Not tested for WB, but
should be similar to WL.
* Add embassy-boot-stm32 for bootloading on STM32.
* Add flash examples and bootloader examples
* Update stm32-data
2022-04-27 15:17:18 +02:00