mirror of
https://github.com/DarkFlippers/unleashed-firmware.git
synced 2024-12-25 06:13:14 +03:00
ed385594a3
* faploader: more subsystem headers in API table; not counting header entries for SDK version change * subghz: removed dead function * Adjusted API version * hal: removed furi_hal_power_get_system_voltage * lib: mbedtls: additional flags for .fap linkage * fbt: rebuilding assets when git commit id changes * fbt: removed assets rebuild on git commit id change; added explicit dependency for SDK source on compiled assets parts; removed unneeded sdk regeneration runs * fbt: changed stock plugins to EXTERNAL apps; restored building app as a PLUGIN as a part of main fw as well as a .fap; readme fixes * fbt: restored certain apps to PLUGIN type * fbt: app manifests: renamed version->fap_version, added extra fields * fbt: fixed version processing after rename Co-authored-by: あく <alleteam@gmail.com>
83 lines
5.0 KiB
Markdown
83 lines
5.0 KiB
Markdown
# Flipper Application Manifests (.fam)
|
|
|
|
All components of Flipper Zero firmware — services, user applications, system settings — are developed independently. Each component has a build system manifest file, named `application.fam`, which defines basic properties of that component and its relations to other parts of the system.
|
|
|
|
When building firmware, **`fbt`** collects all application manifests and processes their dependencies. Then it builds only those components that are referenced in the current build configuration. See [fbt docs](./fbt.md#firmware-application-set) for details on build configurations.
|
|
|
|
## Application definition
|
|
|
|
Properties of a firmware component are declared in a form of a Python code snippet, forming a call to App() function with various parameters.
|
|
|
|
Only 2 parameters are mandatory: ***appid*** and ***apptype***, others are optional and may only be meaningful for certain application types.
|
|
|
|
### Parameters
|
|
|
|
* **appid**: string, application id within the build system. Used for specifying which applications to include in build configuration and to resolve dependencies and conflicts.
|
|
|
|
* **apptype**: member of FlipperAppType.* enumeration. Valid values are:
|
|
|
|
| Enum member | Firmware component type |
|
|
|--------------|--------------------------|
|
|
| SERVICE | System service, created at early startup |
|
|
| SYSTEM | Application not being shown in any menus. Can be started by other apps or from CLI |
|
|
| APP | Regular application for main menu |
|
|
| PLUGIN | Application to be built as a part of firmware an to be placed in Plugins menu |
|
|
| DEBUG | Application only visible in Debug menu with debug mode enabled |
|
|
| ARCHIVE | One and only Archive app |
|
|
| SETTINGS | Application to be placed in System settings menu |
|
|
| STARTUP | Callback function to run at system startup. Does not define a separate app |
|
|
| EXTERNAL | Application to be built as .fap plugin |
|
|
| METAPACKAGE | Does not define any code to be run, used for declaring dependencies and application bundles |
|
|
|
|
* **name**: Name that is displayed in menus.
|
|
* **entry_point**: C function to be used as application's entry point.
|
|
* **flags**: Internal flags for system apps. Do not use.
|
|
* **cdefines**: C preprocessor definitions to declare globally for other apps when current application is included in active build configuration.
|
|
* **requires**: List of application IDs to also include in build configuration, when current application is referenced in list of applications to build.
|
|
* **conflicts**: List of application IDs that current application conflicts with. If any of them is found in constructed application list, **`fbt`** will abort firmware build process.
|
|
* **provides**: Functionally identical to ***requires*** field.
|
|
* **stack_size**: Stack size, in bytes, to allocate for application on its startup. Note that allocating a stack that is too small for an app to run will cause system crash due to stack overflow, and allocating too much stack space will reduce usable heap memory size for apps to process data. *Note: you can use `ps` and `free` CLI commands to profile your app's memory usage.*
|
|
* **icon**: Animated icon name from built-in assets to be used when building app as a part of firmware.
|
|
* **order**: Order of an application within its group when sorting entries in it. The lower the order is, the closer to the start of the list the item is placed. *Used for ordering startup hooks and menu entries.*
|
|
* **sdk_headers**: List of C header files from this app's code to include in API definitions for external applications.
|
|
|
|
The following parameters are used only for [FAPs](./AppsOnSDCard.md):
|
|
|
|
* **sources**: list of file name masks, used for gathering sources within app folder. Default value of ["\*.c\*"] includes C and CPP source files.
|
|
* **fap_version**: string, 2 numbers in form of "x.y": application version to be embedded within .fap file.
|
|
* **fap_icon**: name of a .png file, 1-bit color depth, 10x10px, to be embedded within .fap file.
|
|
* **fap_libs**: list of extra libraries to link application against. Provides access to extra functions that are not exported as a part of main firmware at expense of increased .fap file size and RAM consumption.
|
|
* **fap_category**: string, may be empty. App subcategory, also works as path of FAP within apps folder in the file system.
|
|
* **fap_description**: string, may be empty. Short application descriotion.
|
|
* **fap_author**: string, may be empty. Application's author.
|
|
* **fap_weburl**: string, may be empty. Application's homepage.
|
|
|
|
|
|
## .fam file contents
|
|
|
|
.fam file contains one or more Application definitions. For example, here's a part of `applications/service/bt/application.fam`:
|
|
|
|
```python
|
|
App(
|
|
appid="bt_start",
|
|
apptype=FlipperAppType.STARTUP,
|
|
entry_point="bt_on_system_start",
|
|
order=70,
|
|
)
|
|
|
|
App(
|
|
appid="bt_settings",
|
|
name="Bluetooth",
|
|
apptype=FlipperAppType.SETTINGS,
|
|
entry_point="bt_settings_app",
|
|
stack_size=1 * 1024,
|
|
requires=[
|
|
"bt",
|
|
"gui",
|
|
],
|
|
order=10,
|
|
)
|
|
```
|
|
|
|
For more examples, see .fam files from various firmware parts.
|