rename FirmwareUploader to arduino-firmwareuploader (#62)

* rename binary from FirmwareUploader to arduino-fwuploader

* rewrite README.md to be consistent after the refactoring

* revert change causing windows CI to fail

* change github repository handle (will cause the CI to fail)

* add hopefully useful comment for future me

Author: umbynos

.github/workflows/check-certificates.yml

@@ -16,7 +16,7 @@ env:
 jobs:
   get-certificates-list:
     # This workflow would fail in forks that don't have the certificate secrets defined
-    if: github.repository == 'arduino/FirmwareUploader'
+    if: github.repository == 'arduino/arduino-fwuploader'
     runs-on: ubuntu-latest
     outputs:
       certificates: ${{ steps.get-files.outputs.certificates }}
@@ -38,7 +38,7 @@ jobs:
 
   check-certificates:
     # This workflow would fail in forks that don't have the certificate secrets defined
-    if: github.repository == 'arduino/FirmwareUploader'
+    if: github.repository == 'arduino/arduino-fwuploader'
     runs-on: ubuntu-latest
     needs: get-certificates-list
 

.github/workflows/check-notarization-certificates.yml

@@ -16,7 +16,7 @@ env:
 jobs:
   check-certificates:
     # This workflow would fail in forks that don't have the certificate secrets defined
-    if: github.repository == 'arduino/FirmwareUploader'
+    if: github.repository == 'arduino/arduino-fwuploader'
     runs-on: ubuntu-latest
 
     strategy:

.github/workflows/link-validation.yml

@@ -9,7 +9,7 @@ on:
 jobs:
   verify-links:
     # Don't trigger on schedule event when in a fork
-    if: github.event_name != 'schedule' || (github.event_name == 'schedule' && github.repository == 'arduino/FirmwareUploader')
+    if: github.event_name != 'schedule' || (github.event_name == 'schedule' && github.repository == 'arduino/arduino-fwuploader')
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2

.github/workflows/release.yml

@@ -88,12 +88,12 @@ jobs:
         run: |
           # GitHub's upload/download-artifact@v2 actions don't preserve file permissions,
           # so we need to add execution permission back.
-          chmod +x dist/macos64/FirmwareUploader
+          chmod +x dist/macos64/arduino-fwuploader
           TAG=${GITHUB_REF/refs\/tags\//}
-          tar cjf dist/FirmwareUploader_${TAG}_macOS_64bit.tar.bz2 \
+          tar cjf dist/arduino-fwuploader_${TAG}_macOS_64bit.tar.bz2 \
           firmwares \
           LICENSE.txt \
-          -C dist/macos64/ FirmwareUploader
+          -C dist/macos64/ arduino-fwuploader
 
       - name: Upload artifacts
         uses: actions/upload-artifact@v2
@@ -146,4 +146,4 @@ jobs:
           bodyFile: "dist/CHANGELOG.md"
           draft: false
           prerelease: ${{ steps.prerelease.outputs.IS_PRE }}
-          artifacts: dist/FirmwareUploader*,dist/package_index.json
+          artifacts: dist/arduino-fwuploader*,dist/package_index.json

.gitignore

@@ -1,5 +1,5 @@
 /debug
-/FirmwareUploader*
+/arduino-fwuploader*
 /.vscode/
 .idea
 coverage_*.txt

README.md

@@ -6,60 +6,85 @@ Use this tool to update the firmware and/or add SSL certificates for any WINC, N
 
 You can download the Firmware/Certificates updater here:
 
-https://github.com/arduino/FirmwareUploader/releases/latest
+https://github.com/arduino/arduino-fwuploader/releases/latest
 
 ## Usage
 
-Extract the zip file and run (for example, NINA -> WiFi1010)
+### Firmware Flashing
+
+Extract the zip file and, to update a mkr 1010, run:
+
+```
+./arduino-fwuploader firmware flash -b arduino:samd:mkrwifi1010 -a /dev/ttyACM0
+```
+
+You just have to specify the fqbn (`-b` or `--fqbn`) of the board and the serial port (`-a` or `--address`) The firmware
+uploader will take care of fetching everything is required to perform the update process. If no module and version are
+specified **the latest version of the firmware** will be used.
+
+If you want to flash a specific version of a firmware you can use the `-m` or `--module` flag
+
+For example to flash a MKR1000 with 19.6.1 version of the firmware you can run something like:
 
 ```
-./FirmwareUploader --flasher firmwares/NINA/FirmwareUpdater.mkrwifi1010.ino.bin --firmware firmwares/NINA/1.2.1/NINA_W102.bin --port /dev/ttyACM0 --address arduino.cc:443 --restore_binary /tmp/arduino_build_619137/WiFiSSLClient.ino.bin --programmer {runtime.tools.bossac}/bossac
+./arduino-fwuploader firmware flash -b arduino:samd:mkr1000 -a /dev/ttyACM0 -m WINC1500@19.6.1
 ```
 
-To flash a MKR1000:
+There is also a retry mechanism bundled in the tool because the flashing process sometimes can be a bit unreliable. For
+example to update a Nano RP2040 Connect with the retry set to 2 you can use:
 
 ```
-./FirmwareUploader --flasher firmwares/WINC1500/FirmwareUpdater.mkr1000.ino.bin --firmware firmwares/WINC1500/19.5.4/m2m_aio_3a0.bin --port /dev/ttyACM0 --address arduino.cc:443 --restore_binary /tmp/arduino_build_619137/WiFiSSLClient.ino.bin --programmer {runtime.tools.bossac}/bossac
+./arduino-fwuploader firmware flash --fqbn arduino:mbed_nano:nanorp2040connect -a /dev/ttyACM0 --retries 2
 ```
 
-To update a MKRNB1500:
+It's possible also to list the available firmwares for every board/module with:
 
 ```
-./FirmwareUploader --flasher firmwares/SARA/SerialSARAPassthrough.ino.bin --firmware firmwares/SARA/5.6A2.00-to-5.6A2.01.pkg --port /dev/ttyACM0 --restore_binary firmwares/SARA/SerialSARAPassthrough.ino.bin --programmer {runtime.tools.bossac}/bossac
+./arduino-fwuploader firmware list
 ```
 
-To update a Nano RP2040 Connect:
+but you can also filter the results by specifying the `-b` or `--fqbn` flag
+
+The tool offers the ability to print output in json, with the `--format json`
+
+### Certificates
+
+The tool offers also the ability to flash SSL certificates to a board:
 
 ```
-./FirmwareUploader --flasher firmwares/NINA/FirmwareUpdater.nanorp2040connect.ino.elf --firmware firmwares/NINA/1.4.5/NINA_W102-Nano_RP2040_Connect.bin --port /dev/ttyACM0 --address arduino.cc:443 --programmer {runtime.tools.rp2040tools}/rp2040load
+/arduino-fwuploader flash -b arduino:samd:nano_33_iot" -a COM10 -u arduino.cc:443 -u google.cc:443
 ```
 
+or you can specify a path to a file with `-f`
+
 ### Command line options
 
-The full list of command line options can be obtained with the `-h` option: `./FirmwareUploader -h`
+The full list of command line options can be obtained with the `-h` option: `./arduino-fwuploader -h`
 
 ```
-FirmwareUploader (FirmwareUploader).
+Arduino Firmware Uploader (arduino-fwuploader).
 
 Usage:
-  FirmwareUploader [flags]
+  arduino-fwuploader [command]
 
 Examples:
-  ./FirmwareUploader <command> [flags...]
+  ./arduino-fwuploader <command> [flags...]
+
+Available Commands:
+  certificates Commands to operate on certificates.
+  firmware     Commands to operate on firmwares.
+  help         Help about any command
+  version      Shows version number of arduino-fwuploader.
 
 Flags:
-      --address strings            address (host:port) to fetch and flash root certificate for, multiple values allowed
-      --certs string               root certificate directory
-      --firmware string            firmware file to flash
-      --flasher string             firmware upload binary (precompiled for the right target)
-      --get_available_for string   Ask for available firmwares matching a given board
-  -h, --help                       help for FirmwareUploader
-      --model string               module model (winc, nina or sara)
-      --port string                serial port to use for flashing
-      --programmer string          path of programmer in use (avrdude/bossac)
-      --read                       read all firmware and output to stdout
-      --restore_binary string      binary to restore after the firmware upload (precompiled for the right target)
-      --retries int                Number of retries in case of upload failure (default 9)
+      --format string       The output format, can be {text|json}. (default "text")
+  -h, --help                help for arduino-fwuploader
+      --log-file string     Path to the file where logs will be written
+      --log-format string   The output format for the logs, can be {text|json}.
+      --log-level string    Messages with this level and above will be logged. Valid levels are: trace, debug, info, warn, error, fatal, panic (default "info")
+  -v, --verbose             Print the logs on the standard output.
+
+Use "arduino-fwuploader [command] --help" for more information about a command.
 ```
 
 ## How to build the tools from source file
@@ -72,7 +97,7 @@ task dist:<OS>_<ARCH>
 
 Where <OS> could be one of: `macOS`,`Windows`,`Linux`. And <ARCH>: `32bit`, `64bit`, `ARM` or `ARM64`
 
-This will create the `FirmwareUploader` executable.
+This will create the `arduino-fwuploader` executable.
 
 ## Security
 
@@ -96,4 +121,4 @@ details.
 You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the
 Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
-[security-policy]: https://github.com/arduino/FirmwareUploader/security/policy
+[security-policy]: https://github.com/arduino/arduino-fwuploader/security/policy

Taskfile.yml

@@ -91,7 +91,7 @@ tasks:
       - poetry run black .
 
 vars:
-  PROJECT_NAME: "FirmwareUploader"
+  PROJECT_NAME: "arduino-fwuploader"
   DIST_DIR: "dist"
   # build vars
   COMMIT:
@@ -106,9 +106,9 @@ vars:
   LDFLAGS: >
     -ldflags
     '
-    -X github.com/arduino/FirmwareUploader/version.versionString={{.VERSION}}
-    -X github.com/arduino/FirmwareUploader/version.commit={{ .COMMIT }}
-    -X github.com/arduino/FirmwareUploader/version.date={{.TIMESTAMP}}
+    -X github.com/arduino/arduino-fwuploader/version.versionString={{.VERSION}}
+    -X github.com/arduino/arduino-fwuploader/version.commit={{ .COMMIT }}
+    -X github.com/arduino/arduino-fwuploader/version.date={{.TIMESTAMP}}
     '
   # test vars
   GOFLAGS: "-timeout 10m -v -coverpkg=./... -covermode=atomic"
@@ -117,9 +117,9 @@ vars:
   TEST_LDFLAGS: >
     -ldflags
     '
-    -X github.com/arduino/FirmwareUploader/version.versionString={{.TEST_VERSION}}
-    -X github.com/arduino/FirmwareUploader/version.commit={{.TEST_COMMIT}}
-    -X github.com/arduino/FirmwareUploader/version.date={{.TIMESTAMP}}
+    -X github.com/arduino/arduino-fwuploader/version.versionString={{.TEST_VERSION}}
+    -X github.com/arduino/arduino-fwuploader/version.commit={{.TEST_COMMIT}}
+    -X github.com/arduino/arduino-fwuploader/version.date={{.TIMESTAMP}}
     '
   # check-lint vars
   GOLINTBIN:

cli/certificates/certificates.go

@@ -1,5 +1,5 @@
 /*
-  FirmwareUploader
+  arduino-fwuploader
   Copyright (c) 2021 Arduino LLC.  All right reserved.
 
   This library is free software; you can redistribute it and/or

cli/certificates/flash.go

@@ -1,5 +1,5 @@
 /*
-  FirmwareUploader
+  arduino-fwuploader
   Copyright (c) 2021 Arduino LLC.  All right reserved.
 
   This library is free software; you can redistribute it and/or
@@ -27,13 +27,13 @@ import (
 	"strings"
 	"time"
 
-	"github.com/arduino/FirmwareUploader/flasher"
-	"github.com/arduino/FirmwareUploader/indexes"
-	"github.com/arduino/FirmwareUploader/indexes/download"
-	programmer "github.com/arduino/FirmwareUploader/programmers"
 	"github.com/arduino/arduino-cli/arduino/serialutils"
 	"github.com/arduino/arduino-cli/cli/errorcodes"
 	"github.com/arduino/arduino-cli/cli/feedback"
+	"github.com/arduino/arduino-fwuploader/flasher"
+	"github.com/arduino/arduino-fwuploader/indexes"
+	"github.com/arduino/arduino-fwuploader/indexes/download"
+	programmer "github.com/arduino/arduino-fwuploader/programmers"
 	"github.com/arduino/go-paths-helper"
 	"github.com/arduino/go-properties-orderedmap"
 	"github.com/sirupsen/logrus"

cli/cli.go

@@ -1,5 +1,5 @@
 /*
-  FirmwareUploader
+  arduino-fwuploader
   Copyright (c) 2021 Arduino LLC.  All right reserved.
 
   This library is free software; you can redistribute it and/or
@@ -25,13 +25,13 @@ import (
 	"os"
 	"strings"
 
-	"github.com/arduino/FirmwareUploader/cli/certificates"
-	"github.com/arduino/FirmwareUploader/cli/firmware"
-	"github.com/arduino/FirmwareUploader/cli/version"
+	"github.com/arduino/arduino-fwuploader/cli/certificates"
+	"github.com/arduino/arduino-fwuploader/cli/firmware"
+	"github.com/arduino/arduino-fwuploader/cli/version"
 
-	v "github.com/arduino/FirmwareUploader/version"
 	"github.com/arduino/arduino-cli/cli/errorcodes"
 	"github.com/arduino/arduino-cli/cli/feedback"
+	v "github.com/arduino/arduino-fwuploader/version"
 	"github.com/mattn/go-colorable"
 	"github.com/rifflock/lfshook"
 	"github.com/sirupsen/logrus"
@@ -47,11 +47,11 @@ var (
 )
 
 func NewCommand() *cobra.Command {
-	// FirmwareUploader is the root command
+	// arduino-fwuploader is the root command
 	rootCmd := &cobra.Command{
-		Use:              "FirmwareUploader",
-		Short:            "FirmwareUploader.",
-		Long:             "FirmwareUploader (FirmwareUploader).",
+		Use:              "arduino-fwuploader",
+		Short:            "arduino-fwuploader.",
+		Long:             "Arduino Firmware Uploader (arduino-fwuploader).",
 		Example:          "  " + os.Args[0] + " <command> [flags...]",
 		Args:             cobra.NoArgs,
 		PersistentPreRun: preRun,