Mirrors/unleashed-firmware
2
0
Fork 0
mirror of https://github.com/DarkFlippers/unleashed-firmware synced 2024-11-10 06:54:19 +00:00
Code Issues Projects Releases Packages Wiki Activity

ReadMe: update outdated bits and pieces (#3726)

Browse source
This commit is contained in:
あく 2024-06-20 18:18:31 +01:00 committed by GitHub
parent 3859646e13
commit a0036d10fc
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 22 additions and 38 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
ReadMe.md
View file

@ -52,7 +52,8 @@ Supported development platforms:
Supported in-circuit debuggers (optional but highly recommended):
- [Flipper Zero Wi-Fi Development Board](https://shop.flipperzero.one/products/wifi-devboard)
- ST-Link
- CMSIS-DAP compatible: Raspberry Pi Debug Probe and etc...
- ST-Link (v2, v3, v3mods)
- J-Link
Flipper Build System will take care of all the other dependencies.
@ -96,18 +97,20 @@ Make sure your Flipper is on, and your firmware is functioning. Connect your Fli
- [Hardware combos and Un-bricking](/documentation/KeyCombo.md) - recovering your Flipper from the most nasty situations
- [Flipper File Formats](/documentation/file_formats) - everything about how Flipper stores your data and how you can work with it
- [Universal Remotes](/documentation/UniversalRemotes.md) - contributing your infrared remote to the universal remote database
- [Firmware Roadmap](/documentation/RoadMap.md)
- [Firmware Roadmap](https://miro.com/app/board/uXjVO_3D6xU=/)
- And much more in the [Developer Documentation](https://developer.flipper.net/flipperzero/doxygen)
# Project structure
- `applications` - applications and services used in firmware
- `assets` - assets used by applications and services
- `furi` - Furi Core: OS-level primitives and helpers
- `documentation` - documentation generation system configs and input files
- `firmware` - firmware source code
- `lib` - our and 3rd party libraries, drivers, etc.
- `scripts` - supplementary scripts and python libraries home
- `applications` - Applications and services used in firmware
- `applications_users` - Place for your additional applications and services
- `assets` - Assets used by applications and services
- `documentation` - Documentation generation system configs and input files
- `furi` - Furi Core: OS-level primitives and helpers
- `lib` - Our and 3rd party libraries, drivers, tools and etc...
- `site_scons` - Build system configuration and modules
- `scripts` - Supplementary scripts and various python libraries
- `targets` - Firmware targets: platform specific code
Also, see `ReadMe.md` files inside those directories for further details.

5
assets/ReadMe.md
View file

@ -1,10 +1,5 @@
# Firmware Assets {#firmware_assets}
## Requirements
- Python3
- Python3 packages: Pillow & heatshrink2
## Compiling
```bash

11
lib/ReadMe.md
View file

@ -1,17 +1,18 @@
# Structure
- `FreeRTOS-Kernel` - FreeRTOS kernel source code
- `FreeRTOS-glue` - Extra glue to hold together FreeRTOS kernel and flipper firmware
- `app-scened-template` - C++ app library
- `bit_lib` - library for working with bits/bytes directly
- `callback-connector` - Callback connector library
- `ble_profile` - BLE Profiles source code
- `cmsis_core` - CMSIS Core package, contain cortex-m core headers
- `cxxheaderparser` - C++ headers parser, used by SDK bundler
- `datetime` - DateTime library
- `digital_signal` - Digital signal library: used by NFC for software implemented protocols
- `drivers` - Various flipper drivers
- `fatfs` - FatFS file system driver
- `flipper_application` - Flipper application library, used for FAPs
- `flipper_format` - Flipper File Format library
- `FreeRTOS-glue` - Extra glue to hold together FreeRTOS kernel and flipper firmware
- `FreeRTOS-Kernel` - FreeRTOS kernel source code
- `heatshrink` - Heatshrink compression library
- `ibutton` - ibutton library, used by iButton application
- `infrared` - Infrared library, used by Infrared application
@ -20,7 +21,9 @@
- `littlefs` - LittleFS file system driver, used by internal storage
- `mbedtls` - MbedTLS cryptography library
- `microtar` - MicroTAR library
- `mjs` - MJs, javascript engine library
- `mlib` - M-Lib C containers library
- `music_worker` - MusicWorker library for playing midi and RTTTL files
- `nanopb` - NanoPB library, protobuf implementation for MCU
- `nfc` - NFC library, used by NFC application
- `one_wire` - OneWire library, used by iButton application
@ -33,4 +36,4 @@
- `subghz` - Subghz library, used by SubGhz application
- `toolbox` - Toolbox library, contains various things that is used by Flipper firmware
- `u8g2` - u8g2 graphics library, used by GUI subsystem
- `update_util` - update utilities library, used by updater
- `update_util` - update utilities library, used by updater

23
targets/ReadMe.md
View file

@ -1,22 +1,5 @@
# Flipper firmware
What does it do?
- [x] RTOS
- [x] FuriHAL
- [x] FuriCore
- [x] Services
- [x] Applications
# Targets
| Name | Firmware Address | Reset Combo | DFU Combo |
|-----------|-------------------|-----------------------|-----------------------|
| f7 | 0x08000000 | L+Back, release both | L+Back, release Back |
Also, there is a "hardware" ST bootloader combo available even on a bricked or empty device: L+Ok+Back, release Back, Left.
Target independent code and headers in `target/include` folders. More details in `documentation/KeyCombo.md`
# Building
Check out `documentation/fbt.md` on how to build and flash firmware.
- f18 - Not Flipper Zero
- f7 - Flipper Zero
- furi_hal_include - Global Furi HAL includes, common for all targets