Commit Graph

187 Commits

Author SHA1 Message Date
Mark Tomlin
b03f23ab64
Update sharing_peripherals.adoc 2024-04-19 21:36:03 -04:00
Mark Tomlin
b2f7ce99d6
Update time_keeping.adoc 2024-04-19 21:35:25 -04:00
Oleksandr Kuksenko
0dcf034857
Update layer_by_layer.adoc
Fixed typo
2024-04-19 13:37:58 +03:00
James Munns
8988df9ac1
FAQ: Common STM32 stumbling blocks
Adds some commonly encountered issues.

Help wanted: if anyone has a working BDMA linker script setup, it would be good to add here.
2024-04-16 11:07:42 +02:00
Dario Nieuwenhuis
0e1208947e
Merge pull request #2741 from schmettow/patch-1
Added YLab project to "in the wild"
2024-04-04 21:44:40 +00:00
David Zwart
446965a903
Update faq.adoc 2024-04-03 22:33:21 +02:00
David Zwart
7aef047def
Update faq.adoc
github link
2024-04-03 22:32:28 +02:00
David Zwart
54be08afe4
Update faq.adoc with memory.x definition helping hand 2024-04-03 22:24:09 +02:00
schmettow
f10ee07a90
Update embassy_in_the_wild.adoc
corrected link to Ystudio project
2024-03-28 14:35:24 +01:00
schmettow
82046c4691
Added YLab project to "in the wild"
YLab uses Embassy
2024-03-26 22:26:44 +01:00
Andreas Schmidt
4c0d63ce61
docs: update broken reference in basic_application.adoc 2024-03-01 10:13:59 +01:00
Andreas Schmidt
e954d1716a
docs: update basic example references in basic_application.adoc 2024-02-29 20:27:35 +01:00
Barnaby Walters
d07a0148d7 Documented rp2040 probe-rs info bug, linked to new_project page 2024-02-28 15:48:37 +01:00
Barnaby Walters
2787164ea9 grammar fix 2024-02-28 15:15:43 +01:00
Barnaby Walters
990b44566c [docs] Added some failure modes to watch out for
* Linked to probe.rs website rather than the crates.io page
* Fixed some formatting errors (>:( grrr asciidoc)
* Added cargo add probe-rs failure mode
* Added pico-w vs pico blinky failure mode
2024-02-28 15:11:30 +01:00
James Munns
4a0b1cbadb
Update docs/modules/ROOT/pages/faq.adoc 2024-02-13 15:23:50 +01:00
Ralf
f9af0096bd FAQ add hint to embassy-time linker error to include HAL in linking 2024-02-13 15:04:47 +01:00
Ulf Lilleengen
fd9318f205
Merge pull request #2354 from AdinAck/docs-generation-1
Add Generation Repos to Docs
2024-02-09 19:33:16 +00:00
Priit Laes
cbdc49ef8d faq: embassy-time was split into three packages, update faq accordingly
I ran into this issue when I had to pull in embassy-nrf from git,
though cargo didn't complain about conflicting embassy-time links.
2024-02-09 10:15:53 +02:00
Priit Laes
6e2d54c40b faq: Nightly is not required anymore 2024-02-09 10:14:55 +02:00
Priit Laes
bb743420be faq: Fix typo 2024-02-09 10:14:34 +02:00
Ulf Lilleengen
7817c8b17c docs: fix bullet point indentation 2024-02-05 09:10:53 +01:00
Matous Hybl
4650a35661 docs: Embassy in the wild - add air quality monitoring system 2024-02-03 09:41:14 +01:00
James Munns
5e7876c800
Update docs/modules/ROOT/pages/faq.adoc 2024-01-30 12:41:46 +01:00
James Munns
f388074338 Add some comments from chat 2024-01-30 10:34:09 +01:00
Shane Snover
3c159205a7 Fix the backticks on the getting started page 2024-01-25 22:30:42 -07:00
James Munns
40e9fc36dc
Update faq.adoc
Don't suggest people disable debuginfo, and explain why
2024-01-23 12:06:28 +01:00
Dario Nieuwenhuis
2bc5e9523d nrf/gpio: remove generics. 2024-01-22 21:32:10 +01:00
Dario Nieuwenhuis
3387ee7238 stm32/gpio: remove generics. 2024-01-22 21:31:06 +01:00
Adin Ackerman
b825f76c28 add extra info to stable arena usage 2024-01-16 20:00:39 -08:00
Barnaby Walters
d2d9175a1d Added manual ISR FAQ 2024-01-13 02:14:56 +01:00
Dario Nieuwenhuis
22197320ff bump embassy-time 0.3, embassy-executor 0.5, embassy-net 0.4. 2024-01-11 23:01:24 +01:00
Ulf Lilleengen
ff5f5021fb cleanup docs and add channel synchronization example 2024-01-10 09:52:46 +01:00
Ulf Lilleengen
be3c70d455
Merge pull request #2417 from vasilNnikolov/mutex_rp_example
Add example of pin sharing between tasks
2024-01-10 07:25:47 +00:00
Dario Nieuwenhuis
495b8b739a Change GPIO inherent methods back to &self.
With the embedded-hal rc3 update I changed them to require `&mut self`, but
in retrospect I think `&self` is better, for extra flexibility.

This PR reverts the changes from the rc3 update to inherent methods.
2024-01-10 00:00:10 +01:00
Vasil Nikolov
781e33023e add draft doc page for peripheral sharing 2024-01-10 00:49:54 +02:00
James Munns
7dec3ccca4
[FAQ]: Link to Arena configuration docs 2024-01-02 18:44:41 +01:00
Benjamin Ward
79cb62c9b4
Expand LoRa crate notes per PR review 2024-01-01 10:23:57 -05:00
Benjamin Ward
fa9cb99cb6 Update docs to reflect current LoRa crate name/location 2023-12-30 21:30:27 -05:00
Adin Ackerman
9ea7a245e9 add some generation resources, add some feature descriptions 2023-12-24 11:51:16 -08:00
Dario Nieuwenhuis
87c03037e3
Merge pull request #2342 from embassy-rs/no-more-nightly
ci: use beta, add secondary nightly ci.
2023-12-21 14:44:56 +00:00
Dario Nieuwenhuis
8b36a32ed5 ci: use beta, add secondary nightly ci. 2023-12-21 15:03:57 +01:00
Dániel Buga
cf0e5e32ad Remove Xtensa specifier 2023-12-21 14:27:58 +01:00
Dario Nieuwenhuis
d81395fab3 Update embedded-hal to 1.0.0-rc.3 2023-12-14 16:19:32 +01:00
Ulf Lilleengen
876faa5685 docs: more docs in embassy-boot crate documentation 2023-12-13 19:00:26 +01:00
Dario Nieuwenhuis
3ef18ec133
Merge pull request #2263 from embassy-rs/jamesmunns-patch-2
Tweak FAQ size profile suggestions
2023-12-08 20:50:00 +01:00
Dario Nieuwenhuis
4e7b855b2d
Merge pull request #2265 from JuliDi/docs-best-practices
[Docs] Add best practices page
2023-12-08 20:49:45 +01:00
Dario Nieuwenhuis
3f30e87cb5
Merge pull request #2251 from JuliDi/faq-performance-tweaks
[FAQ] Add section about speed optimization
2023-12-08 19:35:32 +00:00
JuliDi
c05149e5e4
add best practices first draft 2023-12-08 13:00:21 +01:00
Ulf Lilleengen
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
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