Adam Greig
7559f9e583
time: Update documentation to use new after_x convenience methods
2023-10-15 00:47:56 +01: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
Dirk Stolle
0584312ef0
Fix some typos
2023-05-08 23:25:01 +02: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
4da6320e63
Add note on partition sizes to bootloader docs
...
See #1007
2022-10-11 10:20:31 +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
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
Jake Swensen
a38f9e03fa
fix: doc: use master branch for basic example link
2022-07-12 20:58:19 -05: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
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
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
