Frequently Asked Questions

This chapter addresses common questions and challenges that developers may encounter when working with Rust on ESP chips. Whether you’re setting up your development environment, optimizing your code, or looking to simulate your projects, you’ll find practical solutions and best practices here.

Editor/IDE

When using esp-generate, you can automatically configure recommended settings and extensions for VS Code, Helix, Neovim, and Zed editors during the generation process.

Size and Memory Optimizations

Optimizing Binary Size

• Cargo provides some default profiles; we recommend using the release profile as it optimizes and removes debug symbols.
• Cargo allows different profile settings, which can make a difference in the resulting size of the artifact.
  • See Optimizations: the speed size tradeoff of The Embedded Rust Book.
• Be careful when using external dependencies, as they can increase the size of your resulting artifact.
• Filter log messages if they are not going to be useful or read.
• More suggestions can be found in the min-sized-rust repository.

Additionally, the Embassy documentation contains some suggestions with regards to binary sizes in the Frequently Asked Questions section.

Optimizing Memory Usage

We will, again, defer to the Embassy Documentation, specifically the How can I measure resource usage (CPU, RAM, etc.)? section.

Using Crates from Git

The Cargo Book and the Embassy Documentation both contain information on how to specify dependencies from Git repositories:

• Specifying dependencies from git repositories
• The [patch] section
• How do I switch to the main branch

Can I Use mem::forget on Drivers?

The mem::forget function should be avoided, as forgetting drivers may result in unintended consequences. Peripheral drivers provide Drop implementations which return the peripheral to its default, unconfigured state, and if necessary cancel any Direct Memory Access (DMA) transactions which are current in progress. Forgetting a driver may result in erroneously configured peripherals and/or DMA transactions which run indefinitely and never complete.