notBrad/flipper-zero-tutorials
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

clarify this is viewport

Browse Source
This commit is contained in:
Derek Jamison
2024-01-28 11:27:45 -06:00
parent 97a19a32f6
commit dca8b03b8a
3 changed files with 47 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
plugins/basic/README.md
View File

@@ -1,31 +1,39 @@
# BASIC DEMO
## Introduction
This is a basic application for the Flipper Zero. The goal of this project is to use it as a starting point for other applications.
## Introduction
This is a basic ViewPort application for the Flipper Zero. The goal of this project is to use it as a starting point for other applications. When creating a UI for the Flipper Zero, you can choose from three techniques:
- "ViewPort" (single view that does all the rendering & input handling)
- "ViewDispatcher" (multiple views, single back button is handled for you)
- "SceneManager" (multiple views, back button history is handled for you)
## Installation Directions
This project is intended to be overlayed on top of an existing firmware repo.
- Clone, Build & Deploy an existing flipper zero firmware repo. See this [tutorial](/firmware/updating/README.md) for updating firmware.
- Clone, Build & Deploy an existing flipper zero firmware repo. See this [tutorial](/firmware/updating/README.md) for updating firmware.
- Copy the "basic_demo" [folder](..) to the \applications\plugins\basic_demo folder in your firmware.
- Build & deploy the firmware. See this [tutorial](/firmware/updating/README.md) for updating firmware.
- Build & deploy the firmware. See this [tutorial](/firmware/updating/README.md) for updating firmware.
- NOTE: You can also extract the basic_demo.FAP from resources.tar file and use qFlipper to copy the file to the SD Card/apps/Misc folder.
## Running the updated firmware
These directions assume you are starting at the flipper desktop. If not, please press the back button until you are at the desktop.
These directions assume you are starting at the flipper desktop. If not, please press the back button until you are at the desktop.
- Press the OK button on the flipper to pull up the main menu.
- Choose "Applications" from the menu.
- Choose "Misc" from the sub-menu.
- Choose "Basic Demo"
- Choose "Basic Viewport Demo"
- The flipper should say "Basic Demo".
- The flipper should say "Basic Viewport Demo".
- Press the BACK button to exit.
## How it works
- application.fam
- specifies the name of our application.
- specifies the entry point for our application.
- specifies we use the GUI.
@@ -33,6 +41,7 @@ These directions assume you are starting at the flipper desktop. If not, please
- specifies our application can be found in the "Misc" category.
- basic_demo.png
- The icon for our application.
- basic_demo_app.c
@@ -45,7 +54,7 @@ These directions assume you are starting at the flipper desktop. If not, please
- We create a basic_demo_render_callback(...) method that does the screen rendering.
- We acquire the mutex, so that no other thread can modify the data.
- If unsuccessful, we don't render anything this frame.
- We select the Primary font. We render the text "Basic Demo".
- We select the Primary font. We render the text "Basic Demo".
- We release the mutex, so other threads may modify the data.
- We create the entrypoint basic_demo_app(...) method
- We configure our initial data state
@@ -60,4 +69,3 @@ These directions assume you are starting at the flipper desktop. If not, please
- The message loop continues until processing is false.
- We release our application resources.
- We exit the program.