Momentum-Apps

Flipper Zero: Application Template

How to use this template

1. Setup the repository by clicking the Use this template button on the top of the repository. Fill in the data if needed.
2. Update README.md's upstream url with your repository's url.
3. Add LICENSE file with your own license.
4. Update application.fam with your application's information.

Build Status

• Latest Release: Download
• Latest Nightly: Download (GitHub Login Required)

Nightly Build	Release Build

Setup Build environment

Build Instruction

1. Install ufbt:

   pip3 install ufbt
   

2. Clone this repository and enter the repository root.

3. Run ufbt update to update the SDK for your flipper

   • If you are using custom firmware, You should switch SDK. Here is the example for unleashed firmware:

     ufbt update --index-url=https://up.unleashedflip.com/directory.json
     

   • If you want to use different release channel, You can run update to that channel too. Here is the example for dev channel (dev, rc, release are supported):

     ufbt update --channel=dev
     

4. Run ufbt in the repository root:

   ufbt
   

5. Compiled binary is now available at ./dist/ directory.

Setup Visual Studio Code

[!WARNING] This command will overwrite your .vscode directory and .gitignore on your root directory. Make sure to backup your changes before running this command.

1. Suppose your build environment is ready.
2. Run ufbt vscode_dist to generate Visual Studio Code config.

Developer Resources

Here are the resources for developing applications for Flipper Zero:

• Flipper Zero Firmware Docs
  • struct list (index)
• Flipper Zero code examples
• Lopaka, Graphics Editor for Embedded Devices
  Note that Flipper Zero has screen dimension of 128x64.
  
  

How to use SceneManager with this project?

This template implements SceneManager, A "Scene" based framework for programming flipper zero GUIs.

Here is how you can add/modify scenes in this repository:

1. Goto ./src/scenes/list.h.
   
2. Add your own scene by using macro: SCENE_ACTION. (e.g. If you want to make new scene called Store, You should type SCENE_ACTION(Store))
3. Implement _on_enter, _on_event, _on_exit, _get_view, _alloc, _free accordingly. Refer to ./src/scenes/home/main.c for more info.
   (F0 doesn't make sure the precendence of _on_exit and _free. Please make sure those two are independent by checking each other's free'd state)
4. Add headers to export those functions.
5. Include your header in ./src/scenes/import.h.