V43 Release Candidate Changes (#183)

Author: github-actions[bot]

.github/workflow_data/release.md

@@ -1,9 +1,9 @@
 ## ⬇️ Download
->### [📦 Zipped Archive (.zip)](https://github.com/ClaraCrazy/Flipper-Xtreme/releases/download/{release_tag}/{release_tag}.zip) [recommended]
+>### [🖥️ Web Updater (chrome)](https://lab.flipper.net/?url={webupdater_url}&channel=XFW-Updater&version={release_tag}) [recommended]
 
 >### [🐬 qFlipper Package (.tgz)](https://github.com/ClaraCrazy/Flipper-Xtreme/releases/download/{release_tag}/{release_tag}.tgz)
 
->### [🖥️ Web Updater (chrome)](https://lab.flipper.net/?url={webupdater_url}&channel=XFW-Updater&version={release_tag}) [not recommended]
+>### [📦 Zipped Archive (.zip)](https://github.com/ClaraCrazy/Flipper-Xtreme/releases/download/{release_tag}/{release_tag}.zip)
 
 **Remember to delete your `apps` folders before updating!**\
 **Check the [install guide](https://github.com/ClaraCrazy/Flipper-Xtreme#install) if you're not sure, or [join our Discord](https://discord.gg/flipper-xtreme) if you have questions or encounter issues!**

.github/workflows/release.yml

@@ -32,22 +32,11 @@ jobs:
           repository: ${{ github.event.pull_request.head.repo.full_name }}
           ref: ${{ github.event.pull_request.head.ref }}
 
-      - name: "Update version number"
+      - name: "Read version number"
         run: |
-          VERSION="$(python -c "print('%04d' % int('${{ github.event.pull_request.title }}'.removeprefix('V').removesuffix(' Release Candidate Changes')), end='')")"
-          DATE="$(python -c "from datetime import date;print(date.today().strftime('%d%m%Y'), end='')")"
-          RELEASE_NAME="XFW-${VERSION}"
-          RELEASE_TAG="${RELEASE_NAME}_${DATE}"
+          RELEASE_TAG="$(grep -o "DIST_SUFFIX = .*" fbt_options.py | cut -d'"' -f2)"
           echo "RELEASE_TAG=${RELEASE_TAG}" >> $GITHUB_ENV
 
-          sed "s/VERSION = \"XFW-[[:digit:]]\{4\}\"/VERSION = \"${RELEASE_NAME}\"/g" ./scripts/version.py > ./scripts/version.py.new
-          rm ./scripts/version.py
-          mv ./scripts/version.py.new ./scripts/version.py
-
-          sed "s/DIST_SUFFIX = \"XFW-[[:digit:]]\{4\}_[[:digit:]]\{8\}\"/DIST_SUFFIX = \"${RELEASE_TAG}\"/g" ./fbt_options.py > ./fbt_options.py.new
-          rm ./fbt_options.py
-          mv ./fbt_options.py.new ./fbt_options.py
-
       - name: 'Build the firmware'
         run: |
           set -e
@@ -58,14 +47,12 @@ jobs:
 
       - name: "Make tgz, zip and webupdater"
         run: |
-          cd ./dist/${DEFAULT_TARGET}-*
-          mv flipper-z-${DEFAULT_TARGET}-update-*.tgz ${RELEASE_TAG}.tgz
-          cd ./${DEFAULT_TARGET}-update-*
-          7z a ../${RELEASE_TAG}.zip .
-          cd ..
-          mv ${RELEASE_TAG}.tgz ..
-          mv ${RELEASE_TAG}.zip ..
-          cd ..
+          cd dist/${DEFAULT_TARGET}-*
+          mv ${DEFAULT_TARGET}-update-* ${RELEASE_TAG}
+          tar --format=ustar -czvf ../${RELEASE_TAG}.tgz ${RELEASE_TAG}
+          cd ${RELEASE_TAG}
+          7z a ../../${RELEASE_TAG}.zip .
+          cd ../..
           python -m pip install pyncclient
           WEBUPDATER_URL="$(python -c "import nextcloud_client as n;c = n.Client('https://cloud.cynthialabs.net/');c.login('${{ secrets.NC_USER }}', '${{ secrets.NC_PASS }}');c.put_file('XFW-Updater/${RELEASE_TAG}.tgz', '${RELEASE_TAG}.tgz');print(c.share_file_with_link('XFW-Updater/${RELEASE_TAG}.tgz').get_link().rstrip('/') + '/download/${RELEASE_TAG}.tgz', end='')")"
           echo "WEBUPDATER_URL=${WEBUPDATER_URL}" >> $GITHUB_ENV
@@ -74,13 +61,6 @@ jobs:
         run: |
           python -c "import json, os;f = '.github/workflow_data/release.md';c = json.load(open(os.environ['GITHUB_EVENT_PATH']))['pull_request']['body'];f_ = open(f);n = f_.read().format(release_tag='${RELEASE_TAG}', webupdater_url='${WEBUPDATER_URL}', changelog=c);f_.close();f_ = open(f, 'w');f_.write(n);f_.close()"
 
-      - name: "Commit new version number"
-        uses: EndBug/add-and-commit@v9
-        with:
-          default_author: github_actions
-          message: Update version number
-          add: './fbt_options.py ./scripts/version.py'
-
       - name: "Merge pull request"
         uses: "pascalgn/automerge-action@v0.15.6"
         env:
@@ -98,4 +78,4 @@ jobs:
             dist/${{ env.RELEASE_TAG }}.zip
           name: "${{ env.RELEASE_TAG }}"
           tag_name: "${{ env.RELEASE_TAG }}"
-          target_commitish: main
+          target_commitish: ${{ github.event.pull_request.base.ref }}

.gitignore

@@ -1,3 +1,4 @@
+*~
 *.swp
 *.swo
 *.gdb_history

.gitmodules

@@ -28,9 +28,9 @@
 [submodule "lib/cxxheaderparser"]
 	path = lib/cxxheaderparser
 	url = https://github.com/robotpy/cxxheaderparser.git
-[submodule "applications/plugins/subbrute"]
-	path = applications/plugins/subbrute
-	url = https://github.com/derskythe/flipperzero-subbrute.git
-[submodule "applications/plugins/dap_link/lib/free-dap"]
-	path = applications/plugins/dap_link/lib/free-dap
+[submodule "applications/external/dap_link/lib/free-dap"]
+	path = applications/external/dap_link/lib/free-dap
 	url = https://github.com/ataradov/free-dap.git
+[submodule "lib/heatshrink"]
+	path = lib/heatshrink
+	url = https://github.com/flipperdevices/heatshrink.git

.pvsoptions

@@ -1 +1 @@
---ignore-ccache -C gccarm --rules-config .pvsconfig -e lib/fatfs -e lib/fnv1a-hash -e lib/FreeRTOS-Kernel -e lib/heatshrink -e lib/libusb_stm32 -e lib/littlefs -e lib/mbedtls -e lib/micro-ecc -e lib/microtar -e lib/mlib -e lib/qrcode -e lib/ST25RFAL002 -e lib/STM32CubeWB -e lib/u8g2 -e lib/nanopb -e */arm-none-eabi/* -e applications/plugins/dap_link/lib/free-dap
+--ignore-ccache -C gccarm --rules-config .pvsconfig -e lib/fatfs -e lib/fnv1a-hash -e lib/FreeRTOS-Kernel -e lib/heatshrink -e lib/libusb_stm32 -e lib/littlefs -e lib/mbedtls -e lib/micro-ecc -e lib/microtar -e lib/mlib -e lib/qrcode -e lib/ST25RFAL002 -e lib/STM32CubeWB -e lib/u8g2 -e lib/nanopb -e */arm-none-eabi/* -e applications/external/dap_link/lib/free-dap

ReadMe.md

@@ -23,6 +23,8 @@ The goal of this Firmware is to regularly bring out amazing updates based on wha
 - <h4>Stable: Many hours have been spent rewriting core parts of the Flippers firmware as well as some of its apps to ensure stability. A task that was long needed on all Firmware, so we tackled it right away.</h4>
 
 - <h4>Customizable: Dont like the Animations, want to turn on/off the Home screen icons (battery, SD card etc), change the flippers name or anything like that? You absolutely can. No need to mess with code or deal with weird manifest files. Its all done with an App.</h4>
+<br><br>
+Note, the below mentioned changes are only a few things we did. For a full list click [here](https://github.com/ClaraCrazy/Flipper-Xtreme/wiki/Customization)
 
 -----
 <br>
@@ -157,20 +159,37 @@ Note: This repo is always updated with OFW & Unleashed. No need to mention all t
 ----
 <br>
 <h2 align="center">Install:</h2>
+<br>
 
-**This is the recommended install procedure. Please follow these steps EXACTLY and CAREFULLY to ensure you install correctly.**
-**This process will NOT delete any saved files and simply ensures the install goes smoothly.**
-<br><br>
+There are 3 methods to install Xtreme, we recommend you use the **Web Updater**, but choose whichever one you prefer:
 
-- Download the latest release (.zip) from [The releases tab](https://github.com/ClaraCrazy/Flipper-Xtreme/releases/latest)
-- Extract the archive. This is now your new Firmware folder
-- Open [qFlipper](https://flipperzero.one/update), head to `SD/Update` and simply move the firmware folder there
-- On the Flipper, hit the `Arrow Down` button, this will get you to the file menu. In there simply search for your updates folder
-- Inside that folder, select the Firmware you just moved onto it, and run the file thats simply called `Update`
+<br>
+
+> <details><summary><code>Web Updater (Chrome)</code></summary><ul>
+>   <li>Open the <a href="https://github.com/ClaraCrazy/Flipper-Xtreme/releases/latest">latest release page</a> and click on the <code>Web Updater</code> link</li>
+>   <li>Make sure qFlipper is closed</li>
+>   <li>Click <code>Connect</code> and select your Flipper from the list</li>
+>   <li>Click <code>Install</code> and wait for the update to complete</li>
+> </ul></details>
+
+> <details><summary><code>qFlipper Package (.tgz)</code></summary><ul>
+>   <li>Download the qFlipper package (.tgz) from the <a href="https://github.com/ClaraCrazy/Flipper-Xtreme/releases/latest">latest release page</a></li>
+>   <li>Open <a href="https://flipperzero.one/update">qFlipper</a> and connect your Flipper</li>
+>   <li>Click <code>Install from file</code></li>
+>   <li>Select the .tgz you downloaded and wait for the update to complete</li>
+> </ul></details>
+
+> <details><summary><code>Zipped Archive (.zip)</code></summary><ul>
+>   <li>Download the zipped archive (.zip) from the <a href="https://github.com/ClaraCrazy/Flipper-Xtreme/releases/latest">latest release page</a></li>
+>   <li>Extract the archive. This is now your new Firmware folder</li>
+>   <li>Open <a href="https://flipperzero.one/update">qFlipper</a>, head to <code>SD/Update</code> and simply move the firmware folder there</li>
+>   <li>On the Flipper, hit the <code>Arrow Down</code> button, this will get you to the file menu. In there simply search for your updates folder</li>
+>   <li>Inside that folder, select the Firmware you just moved onto it, and run the file thats simply called <code>Update</code></li>
+> </ul></details>
 
-- Enjoy!
+<br>
 
-**If you have issues or crashes with that process, you can try to use `Settings > Storage > Factory Reset` then retry the install.**
+**If you have issues or crashes with the install process, you can try to use `Settings > Storage > Factory Reset` then retry the install.**
 **Doing that will NOT remove your saved files, it will only forget some settings and paired devices.**
 
 ----
@@ -203,7 +222,7 @@ $ ./fbt resources icons dolphin_ext
 ----
 <h2 align="center">Contributors</h2>
 
-[![Contributors](https://user-images.githubusercontent.com/55334727/212134625-21383102-02f3-453f-b1d7-8a9c65b27612.svg)](https://github.com/ClaraCrazy/Flipper-Xtreme/graphs/contributors)
+[![Contributors](https://user-images.githubusercontent.com/49810075/228231815-8f0a267d-ac1a-494c-9cd0-1cd57568fc79.svg)](https://github.com/ClaraCrazy/Flipper-Xtreme/graphs/contributors)
 
 
 ----

SConstruct

@@ -139,34 +139,33 @@ if GetOption("fullenv") or any(
 basic_dist = distenv.DistCommand("fw_dist", distenv["DIST_DEPENDS"])
 distenv.Default(basic_dist)
 
-dist_dir = distenv.GetProjectDirName()
+dist_dir_name = distenv.GetProjectDirName()
+dist_dir = distenv.Dir(f"#/dist/{dist_dir_name}")
+external_apps_artifacts = firmware_env["FW_EXTAPPS"]
+external_app_list = external_apps_artifacts.application_map.values()
+
 fap_dist = [
     distenv.Install(
-        distenv.Dir(f"#/dist/{dist_dir}/apps/debug_elf"),
-        list(
-            app_artifact.debug
-            for app_artifact in firmware_env["FW_EXTAPPS"].applications.values()
-        ),
+        dist_dir.Dir("debug_elf"),
+        list(app_artifact.debug for app_artifact in external_app_list),
     ),
     *(
         distenv.Install(
-            f"#/dist/{dist_dir}/apps/{app_artifact.app.fap_category}",
-            app_artifact.compact[0],
+            dist_dir.File(dist_entry[1]).dir,
+            app_artifact.compact,
         )
-        for app_artifact in firmware_env["FW_EXTAPPS"].applications.values()
+        for app_artifact in external_app_list
+        for dist_entry in app_artifact.dist_entries
     ),
 ]
 Depends(
     fap_dist,
-    list(
-        app_artifact.validator
-        for app_artifact in firmware_env["FW_EXTAPPS"].applications.values()
-    ),
+    list(app_artifact.validator for app_artifact in external_app_list),
 )
 Alias("fap_dist", fap_dist)
 # distenv.Default(fap_dist)
 
-distenv.Depends(firmware_env["FW_RESOURCES"], firmware_env["FW_EXTAPPS"].resources_dist)
+distenv.Depends(firmware_env["FW_RESOURCES"], external_apps_artifacts.resources_dist)
 
 # Copy all faps to device
 

applications/ReadMe.md

@@ -36,15 +36,20 @@ Applications for main Flipper menu.
 - `u2f`                 - U2F Application
 
 
-## plugins
+## External
 
-Extra apps for Plugins & App Loader menus.
+External applications deployed to SD Card
 
-- `bt_hid_app`          - BT Remote controller
+- `clock`               - Clock application
+- `dap_link`            - DAP Link OnChip debugger
+- `hid_app`             - USB/BT Remote controller
 - `music_player`        - Music player app (demo)
-- `picopass`            - Picopass tool
+- `nfc_magic`           - NFC MFC Magic card application
+- `picopass`            - Picopass reader / writer
+- `signal_generator`    - Signal generator app: PWM and clock generator
 - `snake_game`          - Snake game application
-
+- `spi_mem_manager`     - SPI Memory reader / flasher
+- `weather_station`     - SubGHz weather station
 
 ## services
 

applications/debug/uart_echo/application.fam

@@ -1,7 +1,7 @@
 App(
     appid="UART_Echo",
     name="[GPIO] UART Echo",
-    apptype=FlipperAppType.PLUGIN,
+    apptype=FlipperAppType.EXTERNAL,
     entry_point="uart_echo_app",
     cdefines=["APP_UART_ECHO"],
     requires=["gui"],

applications/debug/unit_tests/storage/storage_test.c

@@ -362,8 +362,8 @@ static size_t storage_test_apps_count = COUNT_OF(storage_test_apps);
 static int32_t storage_test_app(void* arg) {
     UNUSED(arg);
     Storage* storage = furi_record_open(RECORD_STORAGE);
-    storage_common_remove(storage, "/app/test");
-    int32_t ret = storage_file_create(storage, "/app/test", "test");
+    storage_common_remove(storage, "/data/test");
+    int32_t ret = storage_file_create(storage, "/data/test", "test");
     furi_record_close(RECORD_STORAGE);
     return ret;
 }
@@ -401,7 +401,7 @@ MU_TEST(test_storage_data_path) {
     Storage* storage = furi_record_open(RECORD_STORAGE);
 
     File* file = storage_file_alloc(storage);
-    mu_check(storage_dir_open(file, "/app"));
+    mu_check(storage_dir_open(file, "/data"));
     mu_check(storage_dir_close(file));
     storage_file_free(file);