Juraj Sadel
a5a0833318
Add a CI workflow for checking links in .rs, .md, and .toml files acc… ( #4098 )
...
* Add a CI workflow for checking links in .rs, .md, and .toml files accross esp-hal workspace
fix dead links
* exclude unpublished crate documentation's links
* Add .lycheeignore with excluded links
* play with patterns
* don't forget to remove
2025-09-12 10:48:04 +00:00
Juraj Sadel
dcdf0ba61f
remove dead link ( #4027 )
...
Co-authored-by: Scott Mabin <scott@mabez.dev>
2025-09-03 09:20:56 +00:00
Dániel Buga
60248d2c2f
Fix devguide ( #4020 )
2025-09-02 07:10:50 +00:00
Scott Mabin
6db771c80e
(re-)introduce the rt feature on esp-hal ( #3706 )
...
Adds the `rt` feature which disables `esp_hal::init` and removes
runtime symbols from the global name space.
Disabling the `rt` feature is the recommended way to use esp-hal as a
library.
2025-07-15 09:20:26 +00:00
Scott Mabin
e97de69b42
use 1.87 in CI, bump MSRV to 1.86 ( #3560 )
...
* use 1.87 in CI, bump MSRV to 1.86
* update API baseline files (rustdoc json format change)
* Add api-baseline regen guide to guidelines
2025-05-29 13:45:22 +00:00
Dániel Buga
9db968b473
Remove Peripheral/PeripheralRef ( #3305 )
...
* Rework GPIOs without Peripheral/PeripheralRef
* Completely remove Peripheral/Ref
* Remove lifetime from DMA Channel structs
* Try to document changes
* Explain reborrow
* Add lifetime to Instance traits, make them public
* Add Trace to changelog
* Remove lifetimes from Instance traits
* Rewrite section about singletons
* Remove unintended doc comment
* Remove inherent degrade
* Fix reiniting esp-wifi
* Add examples to the root-level docs
2025-04-03 10:40:07 +00:00
Björn Quentin
5efa452f1a
Clarify doc-examples in dev-guide ( #3234 )
2025-03-07 09:04:46 +00:00
Juraj Sadel
ef1b3cf794
uart: minor docs improvements ( #3216 )
...
* uart: docs improvement, re-shuffle and merge impl blocks
* Add a note into developer-guidelines
2025-03-05 17:30:20 +00:00
Dániel Buga
eb771e1652
Fix UART with_tx/rx on the Async driver ( #3212 )
2025-03-05 11:38:45 +00:00
Anthony Grondin
9c99a2ce67
Fix developer guidelines link ( #3202 )
...
- Fixes a few links being broken after the rename in
https://github.com/esp-rs/esp-hal/pull/3049
2025-03-05 09:27:40 +00:00
Juraj Sadel
e513f1ba8a
Use #[instability::unstable] where possible, cleanup and improve consistency ( #3055 )
...
* Use #[instability::unstable] where possible, cleanup and improve consistency
* De-duplicate marking SpiDma as unstable
* Remove #[unstable] from private structs, functions and inherent impl blocks, address review comments
* Don't mark uWrite as unstable
* API guidelines entry
* mark uWrite unstable again
* Make SetConfig and InterruptConfigurable consistent and add inherent set_interrupt_handler functions vol.2
* warnings
2025-01-30 16:40:14 +00:00
Björn Quentin
6c2fd59e0b
Avoid unwrap in examples ( #3050 )
...
* Avoid `.unwrap`
* Less `unwrap` in examples
* de-noise UART interrupt example code
* Weaken the precalculation recommendation a bit
2025-01-30 11:08:11 +00:00
Dániel Buga
5206436243
Rename api-guidelines and add config sturct guidelines ( #3049 )
...
* Rename api-guidelines and add config sturct guidelines
* Relax BuilderLite guideline
2025-01-30 10:08:06 +00:00
Kirill Mikhailov
398555ee73
Avoid public API changes due to config options. ( #2945 )
...
* csi_enable: from option to feature
* fix
* enable feature for example
* migration guide update
* changelog entry
* address reviews
2025-01-14 09:53:45 +00:00
Kirill Mikhailov
e62141f03f
Legalize C-QUESTION-MARK violation ( #2929 )
...
* Legalize `C-QUESTION-MARK` violation
* sure...
2025-01-10 13:44:26 +00:00
Dániel Buga
0ef00206d5
Remove all instance type params ( #2907 )
2025-01-09 11:27:48 +00:00
Scott Mabin
f83ab23f04
Avoid abbreviations in API ( #2844 )
...
* Avoid abbreviations in API
* changelog/migration
2024-12-19 14:39:40 +00:00
Dániel Buga
b8f15f0a8b
Refine API-GUIDELINES recommendations ( #2832 )
...
* Refine C-COMMON-TRAITS recommendations
* Recommend deriving Error
* Clarify that Instance, State and Info are private implementation details at this point
2024-12-19 07:08:25 +00:00
Juraj Sadel
3a03dd88c7
Prefer line comments // over block comments /* */ ( #2738 )
...
* Prefer line comments // over block comments /* */
* esp-wifi: Prefer line comments // over block comments /* */
* Mention in our API guideline that // should be prefered over /* */
2024-12-12 15:53:38 +00:00
Dániel Buga
d2f15d69d7
Fix signal fn recommendation ( #2692 )
2024-12-06 13:36:20 +00:00
Jesse Braham
b26b31f1ce
Mention that config structs should derive procmacros::BuilderLite in the API guidelines ( #2686 )
2024-12-05 13:23:09 +00:00
Dániel Buga
50387290d9
API-GUIDELINES tweaks ( #2677 )
...
* Add PeripheralGuard exception
* Add cfg! macro recommendation
2024-12-04 15:52:59 +00:00
Dániel Buga
92910bf1cb
Constructor consistency update ( #2610 )
...
* UART: only implement constructors with config, define ConfigError
* UART: only implement interrupt functions for Blocking
* I2C: fallible constructors
* Lcd/Cam
* SPI
* Update tests and examples
* Changelog
* Add note about ConfigError
* Fmt
2024-11-28 09:28:50 +00:00
Dániel Buga
b50a075449
Amend rust guidelines ( #2617 )
2024-11-27 12:41:51 +00:00
Scott Mabin
6a008bf597
note rustdoc linkage ( #2595 )
2024-11-25 14:32:01 +00:00
Scott Mabin
2fc10d684c
API guideline touchups ( #2573 )
...
* guideline touchups
* review comments
2024-11-21 07:41:26 +00:00
Dániel Buga
31d714a156
Tweak guidelines ( #2482 )
...
* Tweak guidelines
* Restore builder rule
* Address review comments
2024-11-08 11:50:52 +00:00
Dániel Buga
8a23dbe1b6
Modernize UART interrupts ( #2406 )
...
* Modernize UART interrupts
* Also derive Debug and Format for interrupt enums
* Fix changelog
* Touch up API-GUIDELINES
2024-10-28 09:07:15 +00:00
Sergio Gasquez Arcos
b5f0246129
Reordered RX-TX pairs to be consistent ( #2074 )
...
* feat: Update rx-tx order in i2s
* feat: Update rx-tx order in dma macros
* feat: Update rx-tx order in spi
* feat: Update rx-tx order in aes
* feat: Update rx-tx order in mem2mem
* feat: Update rx-tx order in twai and split methods
* feat: Update rx-tx order in twai
* feat: Update rx-tx order in twai and uart docs
* docs: Add sentence about order
* docs: Update changelog
* feat: Update rx-tx order in embassy_interrupt_spi_dma tests
* style: Rustfmt
* docs: Migrating guide
* fix: Typo
Co-authored-by: Dániel Buga <bugadani@gmail.com>
* fix: Diff
Co-authored-by: Dániel Buga <bugadani@gmail.com>
* fix: Tests rx-tx order
* fix: Update new_with_default_pins order
* feat: Update rx/tx order in hil_test::common_test_pins!
* feat: Update dma_extmem2mem example
* fix: Revert deleted input arg
* style: rustfmt
* feat: Disable test_asymmetric_dma_transfer for S2
---------
Co-authored-by: Dániel Buga <bugadani@gmail.com>
2024-09-06 09:56:10 +00:00
Dániel Buga
447411fb58
Rework hal initialization ( #1970 )
...
* Rework hal initialization
* Turn sw interrupt control into a virtual peripheral
* Return a tuple instead of a named struct
* Fix docs
* Remove SystemClockControl
* Move software interrupts under interrupt
* Re-document what's left in system
* Update time docs
* Update sw int docs
* Introduce Config
* Fix tests
* Remove redundant inits
* Doc
* Clean up examples&tests
* Update tests
* Add changelog entry
* Start migration guide
* Restore some convenience-imports
* Remove Config from prelude
2024-09-02 13:38:46 +00:00
Dániel Buga
8aa1a88a23
Prefer cfg_if ( #2003 )
2024-08-27 11:53:55 +00:00
Dániel Buga
1003ce0c0f
Clean up SHA, RSA, mandate #[must_use] on Futures ( #2000 )
...
* Janitor go brr
* Clean up SHA
* Use max CPU speed
* RSA cleanup part 1
* Clean up nonsense comments
* Mark all futures as must_use
2024-08-27 10:43:58 +00:00
Scott Mabin
361a6c58b7
make contribution docs more visible ( #1947 )
2024-08-15 07:58:06 +00:00
