Skip to content

Commit

Permalink
Recommend using cfg.toml instead of big-heap
Browse files Browse the repository at this point in the history
  • Loading branch information
bugadani committed Nov 29, 2023
1 parent ea41ee7 commit 89d0964
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 1 deletion.
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 using 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 89d0964

Please sign in to comment.