Make pico_flash provider picotool path configurable

Changes the pico_flash provider to allow setting the full path to picotool as an environment
variable, in rebar.config, or from cli parameters when exacuting the task.

Closes #40

Signed-off-by: Winford <winford@object.stream>

Author: UncleGrumpy

CHANGELOG.md

@@ -16,6 +16,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - Added dialyzer task to simplify running dialyzer on AtomVM applications.
 - Added support for rp2350 devices to allow for default detection of the device mount path.
+- Added configuration paramenter for setting the path to picotool for the pico_flash task.
 
 ### Changed
 - The `uf2create` task now creates `universal` format uf2 files by default, suitable for both

README.md

@@ -449,6 +449,7 @@ The following table enumerates the properties that may be defined in your projec
 |-----|------|-------------|
 | `path` | `string()` | Path to pico device |
 | `reset` | `string()` | Path to serial device to reset before flashing |
+| `picotool` | `string()` | Path to picotool executable |
 
 Example:
 
@@ -458,6 +459,7 @@ Alternatively, the following environment variables may be used to control the ab
 
 * `ATOMVM_REBAR3_PLUGIN_PICO_MOUNT_PATH` | `ATOMVM_PICO_MOUNT_PATH`
 * `ATOMVM_REBAR3_PLUGIN_PICO_RESET_DEV` | `ATOMVM_PICO_RESET_DEV`
+* `ATOMVM_REBAR3_PLUGIN_PICOTOOL` | `ATOMVM_PICOTOOL`
 
 Any setting specified on the command line take precedence over entries in `rebar.config`, which in turn take precedence over environment variable settings, which in turn take precedence over the default values specified above.
 

src/atomvm_pico_flash_provider.erl

@@ -34,7 +34,8 @@
     {path, $p, "path", string,
         "Path to pico device (Defaults Linux: /run/media/${USER}/RPI-RP2, MacOS: /Volumes/RPI-RP2)"},
     {reset, $r, "reset", string,
-        "Path to serial device to reset before flashing (Defaults Linux: /dev/ttyACM0, MacOS: /dev/cu.usbmodem14*)"}
+        "Path to serial device to reset before flashing (Defaults Linux: /dev/ttyACM0, MacOS: /dev/cu.usbmodem14*)"},
+    {picotool, $t, "picotool", string, "Path to picotool utility (Default is to search in PATH)"}
 ]).
 
 %%
@@ -72,7 +73,8 @@ do(State) ->
         ok = do_flash(
             rebar_state:project_apps(State),
             maps:get(path, Opts),
-            maps:get(reset, Opts)
+            maps:get(reset, Opts),
+            maps:get(picotool, Opts)
         ),
         {ok, State}
     catch
@@ -109,9 +111,22 @@ env_opts() ->
         reset => os:getenv(
             "ATOMVM_REBAR3_PLUGIN_PICO_RESET_DEV",
             get_reset_dev()
+        ),
+        picotool => os:getenv(
+            "ATOMVM_REBAR3_PLUGIN_PICOTOOL",
+            os:getenv("ATOMVM_PICOTOOL", find_picotool())
         )
     }.
 
+%% @private
+find_picotool() ->
+    case os:find_executable("picotool") of
+        false ->
+            "";
+        Picotool ->
+            Picotool
+    end.
+
 %% @private
 get_stty_file_flag() ->
     {_Fam, System} = os:type(),
@@ -228,7 +243,7 @@ needs_reset(ResetDev) ->
     end.
 
 %% @private
-do_reset(ResetPort) ->
+do_reset(ResetPort, Picotool) ->
     Flag = get_stty_file_flag(),
     BootselMode = lists:join(" ", [
         "stty", Flag, ResetPort, "1200"
@@ -239,20 +254,19 @@ do_reset(ResetPort) ->
         "" ->
             ok;
         Error ->
-            case os:find_executable(picotool) of
-                false ->
-                    rebar_api:error(
-                        "Warning: ~s~nUnable to locate 'picotool', close the serial monitor before flashing, or install picotool for automatic disconnect and BOOTSEL mode.",
+            case Picotool of
+                "" ->
+                    rebar_api:abort(
+                        "Warning: ~s~nUnable to locate 'picotool', close the serial monitor before flashing, or supply the path to picotool if it is not installed in your PATH for automatic disconnect and BOOTSEL mode.",
                         [Error]
-                    ),
-                    erlang:throw(reset_error);
-                Picotool ->
+                    );
+                RP2tool ->
                     rebar_api:warn(
                         "Warning: ~s~nFor faster flashing remember to disconnect serial monitor first.",
                         [Error]
                     ),
                     DevReset = lists:join(" ", [
-                        Picotool, "reboot", "-f", "-u"
+                        RP2tool, "reboot", "-f", "-u"
                     ]),
                     rebar_api:warn("Disconnecting serial monitor with: `~s' in 5 seconds...", [
                         DevReset
@@ -284,14 +298,14 @@ get_uf2_appname(ProjectApps) ->
     binary_to_list(rebar_app_info:name(App)).
 
 %% @private
-do_flash(ProjectApps, PicoPath, ResetDev) ->
+do_flash(ProjectApps, PicoPath, ResetDev, Picotool) ->
     case needs_reset(ResetDev) of
         false ->
             rebar_api:debug("No Pico reset device found matching ~s.", [ResetDev]),
             ok;
         {true, ResetPort} ->
             rebar_api:debug("Pico at ~s needs reset...", [ResetPort]),
-            do_reset(ResetPort),
+            do_reset(ResetPort, Picotool),
             rebar_api:info("Waiting for the device at path ~s to settle and mount...", [PicoPath]),
             wait_for_mount(PicoPath, 0)
     end,