Ulf Lilleengen
d87864c6a5
Merge pull request #2261 from barnabywalters/installation
...
Added a step-by-step guide to starting a new embassy project
2023-12-08 07:09:37 +00:00
James Munns
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
Barnaby Walters
16e31747cc
Changed example project name
2023-12-07 00:54:39 +01:00
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
ecaa62aa42
Fixed merge conflict
2023-12-06 21:55:07 +01:00
Barnaby Walters
7561696a57
Added lora-rs links
2023-12-06 21:47:52 +01:00
Barnaby Walters
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
Barnaby Walters
10c9e2e723
Added description for Card/IO
2023-12-06 21:11:34 +01:00
Barnaby Walters
cd62d2cd84
Added embassy in the wild docs page with two projects
2023-12-06 21:10:16 +01:00
Jesse Braham
925f5cbc26
Update all references to embasy-executor
to the latest version
2023-12-06 12:05:47 +01:00
JuliDi
1f6ffdcdd2
fix Cargo.toml and config.toml keys
2023-12-05 10:10:47 +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
JuliDi
bf7115cb44
remove unnecessary backtick
2023-12-04 21:20:18 +01:00
JuliDi
0b0ca62a95
add speed optimization
2023-12-04 20:59:08 +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
Ulf Lilleengen
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
Liigo Zhuang
b97592248a
reword task finish and cancel
2022-04-22 15:10:59 +08:00
Liigo Zhuang
a61daa9f7f
remove description which not makes sense
2022-04-21 17:17:01 +08:00
Ulf Lilleengen
0d19dcc8e5
Update after review
2022-02-23 13:24:09 +01:00
Ulf Lilleengen
092eef3ae7
Add documentation about the different embassy abstraction layers
...
The guide demonstrates the functionality offered by each
layer in Embassy, using code examples.
2022-02-23 09:48:32 +01:00
Dario Nieuwenhuis
b9cea77ef4
Update getting_started.adoc
2022-02-21 05:02:39 +01:00
Dario Nieuwenhuis
20e14b8edb
embassy, embassy-nrf: add nightly
Cargo feature to gate nightly-only features.
2022-02-12 01:16:31 +01:00
Daniel Franklin
e15d3750ea
Document #[embassy::main(config = ...)]
...
Add an example documenting the config param based on help I got in the matrix chat.
Because the example is very short and incompatible with the other example code I just included it inline.
2022-02-11 13:00:45 -08:00
Dario Nieuwenhuis
0719b05d63
traits: migrate Delay to embedded-hal 1.0+async, remove Rng and Flash.
2022-01-27 00:08:02 +01:00
Daniel Bevenius
bd24978e88
Fix 'the the' typo and add a missing 'it'
2022-01-10 18:46:26 +01:00
Daniel Bevenius
50c8f9adb8
Fix typo in basic_application.adoc
2022-01-06 11:11:52 +01:00
Daniel Bevenius
01ec70d241
Fix typo in hal.adoc
2022-01-06 10:56:47 +01:00
Daniel Bevenius
744eafd718
Fix typo in runtime.adoc
2022-01-06 10:03:50 +01:00
Johann Tuffe
5d86228077
Update stm32.adoc
...
typo
2021-12-30 09:17:06 +08:00
Dario Nieuwenhuis
22bc1e4ae1
nrf/gpio: add infallible inherent methods, remove some duplication.
...
This implements Input and Output using FlexPin, to avoid some code duplication.
2021-12-20 00:55:18 +01:00
Ulf Lilleengen
aa0abe976a
Fix doc example compile
2021-12-10 12:58:23 +01:00
Ulf Lilleengen
e5d4d0952b
Add doc-specific example and add it to CI
2021-12-10 12:46:41 +01:00
Ulf Lilleengen
e93f2679b1
More content
2021-12-10 12:27:44 +01:00
Ulf Lilleengen
b48fcd9229
Add more content
2021-12-10 12:04:12 +01:00
Ulf Lilleengen
7568d0bb68
More on traits and notes on time
2021-12-10 10:47:34 +01:00
Ulf Lilleengen
439e317ba3
Add diagrams explaining the runtime
2021-12-10 10:22:11 +01:00
Ulf Lilleengen
d2820d5be7
Update section on async
2021-12-10 08:24:39 +01:00
Ulf Lilleengen
08e1fcd2e4
Add example snippet inclusion
2021-12-10 08:08:56 +01:00
Ulf Lilleengen
5c4a9043d1
Update docs
2021-12-09 10:40:26 +01:00
Ulf Lilleengen
c12337920f
Initial PoC of embassy book
2021-12-09 10:06:17 +01:00