Commit Graph

75 Commits

Author SHA1 Message Date
Barnaby Walters
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
Barnaby Walters
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
Scott Mabin
334900752a update release version in examples and other crates 2023-12-04 13:15:10 +00:00
Dario Nieuwenhuis
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
Tshepang Mbambo
33cfef871d
no_std and no_main can be used on stable 2023-12-01 11:56:35 +02:00
Tshepang Mbambo
270504d87d
runtime.adoc: typo 2023-12-01 08:45:20 +02:00
Dario Nieuwenhuis
c6989dfbca Remove nightly and unstable-traits features in preparation for 1.75. 2023-11-29 17:26:33 +01:00
Dániel Buga
a3c99f0324 Add multiple dependency error faq 2023-11-28 08:12:23 +01:00
James Munns
74a6855f01
Update docs/modules/ROOT/pages/faq.adoc 2023-11-27 21:43:05 +01:00
James Munns
f88aa9ce48
(FAQ): Add time driver note 2023-11-27 21:42:10 +01:00
AdinAck
02305451b1
need be -> needed
Co-authored-by: Dániel Buga <bugadani@gmail.com>
2023-11-27 10:51:20 -08:00
AdinAck
a42aef7759
it's -> its
Co-authored-by: Dániel Buga <bugadani@gmail.com>
2023-11-27 10:51:05 -08:00
Adin Ackerman
142f42fe90 ... 2023-11-27 10:44:47 -08:00
Adin Ackerman
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
Ulf Lilleengen
bd2e6b0422
Update faq.adoc 2023-11-21 16:01:46 +01:00
Dániel Buga
c211d51c06 Add note for Xtensa 2023-11-21 15:53:30 +01:00
James Munns
aedd41eac4 Add FAQ with one question from chat 2023-11-21 15:38:33 +01:00
Ted Feng
10f08445e4
Update basic_application.adoc
typo: change "embassy::main" to "embassy_executor::main"
2023-10-18 14:53:49 +13:00
Adam Greig
7559f9e583
time: Update documentation to use new after_x convenience methods 2023-10-15 00:47:56 +01:00
Dániel Buga
02d2c06b23 Release embassy-time 0.1.4 2023-10-12 18:14:33 +02:00
Ulf Lilleengen
80a740bc72 docs: minor doc improvements and cleanup 2023-10-03 21:35:31 +02:00
xoviat
537e2f3b44 update docs 2023-09-16 08:19:49 -05:00
Dániel Buga
a2c718f61c Bump executor crate version to 0.3.0 2023-08-23 20:34:37 +02:00
Dario Nieuwenhuis
558918651e stm32: update stm32-metapac. 2023-06-19 03:22:12 +02:00
Dario Nieuwenhuis
42a5b14724 Remove unneeded default-features=false. 2023-05-29 22:50:30 +02:00
Dirk Stolle
0584312ef0 Fix some typos 2023-05-08 23:25:01 +02:00
Ulf Lilleengen
42a8f1671d Bump versions preparing for -macros and -executor release 2023-04-27 11:54:22 +02:00
Dario Nieuwenhuis
d3c4e4a20a executor: add Pender, rework Cargo features.
This introduces a `Pender` struct with enum cases for thread-mode, interrupt-mode and
custom callback executors. This avoids calls through function pointers when using only
the thread or interrupt executors. Faster, and friendlier to `cargo-call-stack`.

`embassy-executor` now has `arch-xxx` Cargo features to select the arch and to enable
the builtin executors (thread and interrupt).
2023-04-03 03:09:11 +02:00
Dario Nieuwenhuis
0b49b588a2 stm32: use stm32-metapac from crates.io, remove stm32-data submodule. 2023-03-20 02:38:12 +01:00
huntc
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
Dominik Boehi
0a27b6cedb Rename examples/nrf to examples/nrf52840 2023-01-09 22:30:02 +01:00
Ulf Lilleengen
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
Johannes Neyer
9505a6f752 [doc] Remove obsolete code sample 2022-11-15 10:10:36 +01:00
Johannes Neyer
ea61c19280 [doc] Fix some grammar 2022-11-15 10:10:36 +01:00
Johannes Neyer
bcec55464f [doc] Fix line indices of basic example 2022-11-15 10:10:33 +01:00
Ulf Lilleengen
de103a5f4f Add missing files and features for basic example 2022-10-20 16:12:59 +02:00
Ulf Lilleengen
4da6320e63 Add note on partition sizes to bootloader docs
See #1007
2022-10-11 10:20:31 +02:00
chrysn
6718ca3a94 all Cargo.toml: Add license to all crate Cargo.toml files
Closes: https://github.com/embassy-rs/embassy/issues/1002
2022-10-07 12:41:56 +02:00
Daniel Bevenius
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
Dario Nieuwenhuis
5daa173ce4 Split embassy-time from embassy-executor. 2022-08-18 01:22:30 +02:00
Dario Nieuwenhuis
fc6e1e06b3 Remove HAL initialization from #[embassy::main] macro. 2022-08-17 22:16:46 +02:00
Ulf Lilleengen
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
Ulf Lilleengen
b4ab39c6fa Use special ROOT component for embassy docs 2022-08-15 19:37:48 +02:00
Dario Nieuwenhuis
a0f1b0ee01 Split embassy crate into embassy-executor, embassy-util. 2022-07-29 23:40:36 +02:00
Jake Swensen
a38f9e03fa fix: doc: use master branch for basic example link 2022-07-12 20:58:19 -05:00
Dario Nieuwenhuis
dd99356062 Add env DEFMT_LOG=trace to all examples. 2022-06-18 01:59:12 +02:00
Dario Nieuwenhuis
a8703b7598 Run rustfmt. 2022-06-12 22:22:31 +02:00
Matous Hybl
8a80ae5685 Update list of families with bootloader support 2022-05-06 21:57:15 +02:00
Ulf Lilleengen
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