flipperzero-template🚀

A template for kick-starting a Rust + FlipperZero project using flipperzero-rs 🐬❤️🦀.

Usage

Initial setup

1. Install rustup by following the instructions on rustup.rs.
2. Install the nightly build tool-chain to support thedifferent-binary-name feature:

   rustup toolchain install nightly
   

3. Install cargo-generate:

   cargo install cargo-generate
   

4. Use rustup to install the thumbv7em-none-eabihf target to the nightly build:

   rustup target add --toolchain nightly thumbv7em-none-eabihf
   

Generate the project

1. Use cargo generate to clone this template:

   cargo generate --git https://github.com/flipperzero-rs/flipperzero-template.git --name my-project
   

2. Switch into the local directory:

   cd my-project
   

Build with cargo build

cargo build

Copy the binary to your Flipper Zero

Important

This requires the storage command from flipperzero-tools (cargo install --locked flipperzero-tools) or storage.py from the official SDK.

The resulting .fap binary can be found in target/thumbv7em-none-eabihf/debug.

storage send target/thumbv7em-none-eabihf/release/my-project.fap /ext/apps/Examples/my-project.fap

Build and run on change

Important

This requires the run-fap command from flipperzero-tools (cargo install --locked flipperzero-tools) or runfap.py from the official SDK.

You can automatically build and run your binary using cargo-watch and the run-fap tool.

cargo watch -s 'cargo build --release && run-fap target/thumbv7em-none-eabihf/release/my-project.fap'

License

This template is licensed under the MIT License.