Skip to content

Commit

Permalink
Recommend using cfg.toml instead of big-heap (#22)
Browse files Browse the repository at this point in the history
  • Loading branch information
bugadani authored Nov 29, 2023
1 parent fcc50ea commit 749a0cc
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 2 deletions.
1 change: 0 additions & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,6 @@ embassy-net = { version = "0.2.1", features = [
], optional = true }

esp-wifi = { git = "https://github.com/esp-rs/esp-wifi.git", features = [
"big-heap",
"phy-enable-usb",
"embedded-svc",
"wifi",
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ It comes with mbedtls precompiled to avoid the need for a complete C toolchain.

This should work together with `esp-wifi`. It currently won't work without. However it's not well tested yet besides the included examples.

See the examples for how to use it. A key thing is to enable the feature `big-heap` in esp-wifi since more heap memory is needed to get this working.
See the examples for how to use it. A key thing is to [set a bigger heap size](https://github.com/esp-rs/esp-wifi/blob/main/esp-wifi/docs/tuning.md) for esp-wifi since more heap memory is needed to get this working.

In general this is heavy in terms of heap memory used and code size. If you can, you should prefer using something like `embedded-tls`.

Expand Down
3 changes: 3 additions & 0 deletions cfg.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[esp-wifi]
heap_size = 112640 # use 110k by default
# heap_size = 73728 # uncomment this to use 72k for esp32-s2/c2

0 comments on commit 749a0cc

Please sign in to comment.