WiFi board: fixed update script on Windows (unfortunately also Mac an…

…d Linux) (#3485) * WiFi board update: windows fix * Scripts: add python\Scripts to the path * Windows: another way to call esptool * Aaaaaand once more! * logz * wifi board scripts: udev rule, dev channel * fbt: added ARGS variable for passing extra options to certain scripts; removed `devboard_flash_dev` in favor of `devboard_flash ARGS="-c dev"` * fbt: fully removed `devboard_flash_dev * scripts: wifi_board.py: cleanup * ufbt: ported ARGS for supported targets to ufbt * docs: updated for ARGS=... --------- Co-authored-by: hedger <hedger@nanode.su> Co-authored-by: hedger <hedger@users.noreply.github.com>
flipperdevices · Mar 1, 2024 · 4b7ca73 · 4b7ca73
1 parent 18ea237
commit 4b7ca73
Show file tree

Hide file tree

Showing 7 changed files with 170 additions and 71 deletions.
diff --git a/SConstruct b/SConstruct
@@ -66,6 +66,7 @@ if GetOption("fullenv") or any(
 
     # Target for self-update package
     dist_basic_arguments = [
+        "${ARGS}",
         "--bundlever",
         "${UPDATE_VERSION_STRING}",
     ]
@@ -182,6 +183,7 @@ fap_deploy = distenv.PhonyTarget(
                 "send",
                 "${SOURCE}",
                 "/ext/apps",
+                "${ARGS}",
             ]
         ]
     ),
@@ -208,7 +210,7 @@ distenv.Alias("jflash", firmware_jflash)
 
 distenv.PhonyTarget(
     "gdb_trace_all",
-    "$GDB $GDBOPTS $SOURCES $GDBFLASH",
+    [["${GDB}", "${GDBOPTS}", "${SOURCES}", "${GDBFLASH}"]],
     source=firmware_env["FW_ELF"],
     GDBOPTS="${GDBOPTS_BASE}",
     GDBREMOTE="${OPENOCD_GDB_PIPE}",
@@ -272,19 +274,35 @@ distenv.PhonyTarget(
 # Just start OpenOCD
 distenv.PhonyTarget(
     "openocd",
-    "${OPENOCDCOM}",
+    [["${OPENOCDCOM}", "${ARGS}"]],
 )
 
 # Linter
 distenv.PhonyTarget(
     "lint",
-    [["${PYTHON3}", "${FBT_SCRIPT_DIR}/lint.py", "check", "${LINT_SOURCES}"]],
+    [
+        [
+            "${PYTHON3}",
+            "${FBT_SCRIPT_DIR}/lint.py",
+            "check",
+            "${LINT_SOURCES}",
+            "${ARGS}",
+        ]
+    ],
     LINT_SOURCES=[n.srcnode() for n in firmware_env["LINT_SOURCES"]],
 )
 
 distenv.PhonyTarget(
     "format",
-    [["${PYTHON3}", "${FBT_SCRIPT_DIR}/lint.py", "format", "${LINT_SOURCES}"]],
+    [
+        [
+            "${PYTHON3}",
+            "${FBT_SCRIPT_DIR}/lint.py",
+            "format",
+            "${LINT_SOURCES}",
+            "${ARGS}",
+        ]
+    ],
     LINT_SOURCES=[n.srcnode() for n in firmware_env["LINT_SOURCES"]],
 )
 
@@ -307,7 +325,16 @@ firmware_env.Append(
 )
 
 
-black_commandline = "@${PYTHON3} -m black ${PY_BLACK_ARGS} ${PY_LINT_SOURCES}"
+black_commandline = [
+    [
+        "@${PYTHON3}",
+        "-m",
+        "black",
+        "${PY_BLACK_ARGS}",
+        "${PY_LINT_SOURCES}",
+        "${ARGS}",
+    ]
+]
 black_base_args = [
     "--include",
     '"(\\.scons|\\.py|SConscript|SConstruct|\\.fam)$"',
@@ -333,12 +360,28 @@ distenv.PhonyTarget(
 
 # Start Flipper CLI via PySerial's miniterm
 distenv.PhonyTarget(
-    "cli", [["${PYTHON3}", "${FBT_SCRIPT_DIR}/serial_cli.py", "-p", "${FLIP_PORT}"]]
+    "cli",
+    [
+        [
+            "${PYTHON3}",
+            "${FBT_SCRIPT_DIR}/serial_cli.py",
+            "-p",
+            "${FLIP_PORT}",
+            "${ARGS}",
+        ]
+    ],
 )
 
-# Update WiFi devboard firmware
+# Update WiFi devboard firmware with release channel
 distenv.PhonyTarget(
-    "devboard_flash", [["${PYTHON3}", "${FBT_SCRIPT_DIR}/wifi_board.py"]]
+    "devboard_flash",
+    [
+        [
+            "${PYTHON3}",
+            "${FBT_SCRIPT_DIR}/wifi_board.py",
+            "${ARGS}",
+        ]
+    ],
 )
 
 
@@ -353,7 +396,7 @@ distenv.PhonyTarget(
 distenv.PhonyTarget(
     "get_stlink",
     distenv.Action(
-        lambda **kw: distenv.GetDevices(),
+        lambda **_: distenv.GetDevices(),
         None,
     ),
 )

diff --git a/documentation/fbt.md b/documentation/fbt.md
@@ -71,13 +71,13 @@ To use language servers other than the default VS Code C/C++ language server, us
 - `debug` - build and flash firmware, then attach with gdb with firmware's .elf loaded.
 - `debug_other`, `debug_other_blackmagic` - attach GDB without loading any `.elf`. It will allow you to manually add external `.elf` files with `add-symbol-file` in GDB.
 - `updater_debug` - attach GDB with the updater's `.elf` loaded.
-- `devboard_flash` - update WiFi dev board with the latest firmware.
+- `devboard_flash` - Update WiFi dev board. Supports `ARGS="..."` to pass extra arguments to the update script, e.g. `ARGS="-c dev"`.
 - `blackmagic` - debug firmware with Blackmagic probe (WiFi dev board).
-- `openocd` - just start OpenOCD.
+- `openocd` - just start OpenOCD. You can pass extra arguments with `ARGS="..."`.
 - `get_blackmagic` - output the blackmagic address in the GDB remote format. Useful for IDE integration.
 - `get_stlink` - output serial numbers for attached STLink probes. Used for specifying an adapter with `SWD_TRANSPORT_SERIAL=...`.
-- `lint`, `format` - run clang-format on the C source code to check and reformat it according to the `.clang-format` specs.
-- `lint_py`, `format_py` - run [black](https://black.readthedocs.io/en/stable/index.html) on the Python source code, build system files & application manifests.
+- `lint`, `format` - run clang-format on the C source code to check and reformat it according to the `.clang-format` specs. Supports `ARGS="..."` to pass extra arguments to clang-format.
+- `lint_py`, `format_py` - run [black](https://black.readthedocs.io/en/stable/index.html) on the Python source code, build system files & application manifests. Supports `ARGS="..."` to pass extra arguments to black.
 - `firmware_pvs` - generate a PVS Studio report for the firmware. Requires PVS Studio to be available on your system's `PATH`.
 - `cli` - start a Flipper CLI session over USB.
 

diff --git a/scripts/fbt_tools/fbt_dist.py b/scripts/fbt_tools/fbt_dist.py
@@ -150,6 +150,7 @@ def generate(env):
                         "--interface=${SWD_TRANSPORT}",
                         "--serial=${SWD_TRANSPORT_SERIAL}",
                         "${SOURCE}",
+                        "${ARGS}",
                     ],
                     Touch("${TARGET}"),
                 ]
@@ -162,6 +163,7 @@ def generate(env):
                         "-p",
                         "${FLIP_PORT}",
                         "${UPDATE_BUNDLE_DIR}/update.fuf",
+                        "${ARGS}",
                     ],
                     Touch("${TARGET}"),
                 ]
@@ -180,6 +182,7 @@ def generate(env):
                             "--stack_type=${COPRO_STACK_TYPE}",
                             "--stack_file=${COPRO_STACK_BIN}",
                             "--stack_addr=${COPRO_STACK_ADDR}",
+                            "${ARGS}",
                         ]
                     ],
                     "${COPROCOMSTR}",

diff --git a/scripts/ufbt/SConstruct b/scripts/ufbt/SConstruct
@@ -315,26 +315,56 @@ else:
 
 appenv.PhonyTarget(
     "cli",
-    [["${PYTHON3}", "${FBT_SCRIPT_DIR}/serial_cli.py", "-p", "${FLIP_PORT}"]],
+    [
+        [
+            "${PYTHON3}",
+            "${FBT_SCRIPT_DIR}/serial_cli.py",
+            "-p",
+            "${FLIP_PORT}",
+            "${ARGS}",
+        ]
+    ],
 )
 
 # Update WiFi devboard firmware
 dist_env.PhonyTarget(
-    "devboard_flash", [["${PYTHON3}", "${FBT_SCRIPT_DIR}/wifi_board.py"]]
+    "devboard_flash",
+    [
+        [
+            "${PYTHON3}",
+            "${FBT_SCRIPT_DIR}/wifi_board.py",
+            "${ARGS}",
+        ]
+    ],
 )
 
 # Linter
-
 dist_env.PhonyTarget(
     "lint",
-    [["${PYTHON3}", "${FBT_SCRIPT_DIR}/lint.py", "check", "${LINT_SOURCES}"]],
+    [
+        [
+            "${PYTHON3}",
+            "${FBT_SCRIPT_DIR}/lint.py",
+            "check",
+            "${LINT_SOURCES}",
+            "${ARGS}",
+        ]
+    ],
     source=original_app_dir.File(".clang-format"),
     LINT_SOURCES=[original_app_dir],
 )
 
 dist_env.PhonyTarget(
     "format",
-    [["${PYTHON3}", "${FBT_SCRIPT_DIR}/lint.py", "format", "${LINT_SOURCES}"]],
+    [
+        [
+            "${PYTHON3}",
+            "${FBT_SCRIPT_DIR}/lint.py",
+            "format",
+            "${LINT_SOURCES}",
+            "${ARGS}",
+        ]
+    ],
     source=original_app_dir.File(".clang-format"),
     LINT_SOURCES=[original_app_dir],
 )
@@ -456,6 +486,7 @@ if dolphin_src_dir.exists():
                 "send",
                 "${SOURCE}",
                 "/ext/dolphin",
+                "${ARGS}",
             ]
         ],
         source=ufbt_build_dir.Dir("dolphin"),

diff --git a/scripts/ufbt/site_tools/ufbt_help.py b/scripts/ufbt/site_tools/ufbt_help.py
@@ -29,7 +29,8 @@
     debug, debug_other, blackmagic:
         Start GDB
     devboard_flash:
-        Update WiFi dev board with the latest firmware
+        Update WiFi dev board. 
+        Supports ARGS="..." to pass extra arguments to the update script, e.g. ARGS="-c dev"
 
 Other:
     cli: