Skip to content

Commit cef9dfc

Browse files
umbynosumbynos
authored
Rename FirmwareUpdater to FirmwareUploader (#21)
1 parent 19b5f15 commit cef9dfc

18 files changed

+53
-49
lines changed

Diff for: ‎.github/workflows/check-certificates.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ env:
1616
jobs:
1717
get-certificates-list:
1818
# This workflow would fail in forks that don't have the certificate secrets defined
19-
if: github.repository == 'arduino/FirmwareUpdater'
19+
if: github.repository == 'arduino/FirmwareUploader'
2020
runs-on: ubuntu-latest
2121
outputs:
2222
certificates: ${{ steps.get-files.outputs.certificates }}
@@ -38,7 +38,7 @@ jobs:
3838
3939
check-certificates:
4040
# This workflow would fail in forks that don't have the certificate secrets defined
41-
if: github.repository == 'arduino/FirmwareUpdater'
41+
if: github.repository == 'arduino/FirmwareUploader'
4242
runs-on: ubuntu-latest
4343
needs: get-certificates-list
4444

Diff for: ‎.github/workflows/check-notarization-certificates.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ env:
1616
jobs:
1717
check-certificates:
1818
# This workflow would fail in forks that don't have the certificate secrets defined
19-
if: github.repository == 'arduino/FirmwareUpdater'
19+
if: github.repository == 'arduino/FirmwareUploader'
2020
runs-on: ubuntu-latest
2121

2222
strategy:

Diff for: ‎.github/workflows/link-validation.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ on:
99
jobs:
1010
verify-links:
1111
# Don't trigger on schedule event when in a fork
12-
if: github.event_name != 'schedule' || (github.event_name == 'schedule' && github.repository == 'arduino/FirmwareUpdater')
12+
if: github.event_name != 'schedule' || (github.event_name == 'schedule' && github.repository == 'arduino/FirmwareUploader')
1313
runs-on: ubuntu-latest
1414
steps:
1515
- uses: actions/checkout@v2

Diff for: ‎.github/workflows/release.yml

+3-3
Original file line numberDiff line numberDiff line change
@@ -87,10 +87,10 @@ jobs:
8787
# Repackage the signed binary replaced in place by Gon (ignoring the output zip file)
8888
run: |
8989
TAG=${GITHUB_REF/refs\/tags\//}
90-
tar cjf dist/FirmwareUpdater_${TAG}_macOS_64bit.tar.bz2 \
90+
tar cjf dist/FirmwareUploader_${TAG}_macOS_64bit.tar.bz2 \
9191
firmwares \
9292
LICENSE.txt \
93-
-C dist/macos64/ FirmwareUpdater
93+
-C dist/macos64/ FirmwareUploader
9494
9595
- name: Upload artifacts
9696
uses: actions/upload-artifact@v2
@@ -141,4 +141,4 @@ jobs:
141141
bodyFile: "dist/CHANGELOG.md"
142142
draft: false
143143
prerelease: ${{ steps.prerelease.outputs.IS_PRE }}
144-
artifacts: dist/FirmwareUpdater*,dist/package_index.json
144+
artifacts: dist/FirmwareUploader*,dist/package_index.json

Diff for: ‎.gitignore

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/debug
2-
/FirmwareUpdater*
2+
/FirmwareUploader*
33
/.vscode/
44
.idea
55
coverage_*.txt

Diff for: ‎README.md

+17-13
Original file line numberDiff line numberDiff line change
@@ -6,63 +6,67 @@ Use this tool to update the firmware and/or add SSL certificates for any WINC, N
66

77
You can download the Firmware/Certificates updater here:
88

9-
https://github.com/arduino/FirmwareUpdater/releases/latest
9+
https://github.com/arduino/FirmwareUploader/releases/latest
1010

1111
## Usage
1212

1313
Extract the zip file and run (for example, NINA -> WiFi1010)
1414

1515
```
16-
./$your_os/updater -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
16+
./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
1717
```
1818

1919
To flash a MKR1000:
2020

2121
```
22-
./$your_os/updater -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
22+
./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
2323
```
2424

2525
To update a MKRNB1500:
2626

2727
```
28-
./$your_os/updater -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
28+
./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
2929
```
3030

3131
### Command line options
3232

33-
The full list of command line options can be obtained with the `-h` option: `./updater -h`
33+
The full list of command line options can be obtained with the `-h` option: `./FirmwareUploader -h`
3434

3535
```
36-
Usage of ./distrib/linux64/updater:
36+
Usage of ./FirmwareUploader:
3737
-address value
3838
address (host:port) to fetch and flash root certificate for, multiple values allowed
3939
-certs string
4040
root certificate directory
4141
-firmware string
4242
firmware file to flash
4343
-flasher string
44-
firmware upload binary (precompiled for the right target) -> if not provided it will expect FirmwareUpdater sketch to be already flashed on the board
44+
firmware upload binary (precompiled for the right target)
45+
-get_available_for string
46+
Ask for available firmwares matching a given board
4547
-model string
46-
module model (winc or nina)
48+
module model (winc, nina or sara)
4749
-port string
4850
serial port to use for flashing
4951
-programmer string
5052
path of programmer in use (avrdude/bossac)
5153
-read
5254
read all firmware and output to stdout
5355
-restore_binary string
54-
firmware upload binary (precompiled for the right target) -> if not provided it will try to restore the original firmware
56+
firmware upload binary (precompiled for the right target)
5557
```
5658

5759
## How to build the tools from source file
5860

59-
From the sources root directory run:
61+
To build we use [task](https://taskfile.dev/) for simplicity. From the sources root directory run:
6062

6163
```
62-
go build -o updater
64+
task dist:<OS>_<ARCH>
6365
```
6466

65-
This will create the `updater` executable.
67+
Where <OS> could be one of: `macOS`,`Windows`,`Linux`. And <ARCH>: `32bit`, `64bit`, `ARM` or `ARM64`
68+
69+
This will create the `FirmwareUploader` executable.
6670

6771
## Security
6872

@@ -86,4 +90,4 @@ details.
8690
You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the
8791
Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
8892

89-
[security-policy]: https://github.com/arduino/FirmwareUpdater/security/policy
93+
[security-policy]: https://github.com/arduino/FirmwareUploader/security/policy

Diff for: ‎Taskfile.yml

+7-7
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ tasks:
5656
- npx {{ .PRETTIER }} --write "**/*.{yml,yaml}"
5757

5858
vars:
59-
PROJECT_NAME: "FirmwareUpdater"
59+
PROJECT_NAME: "FirmwareUploader"
6060
DIST_DIR: "dist"
6161
# build vars
6262
COMMIT:
@@ -71,9 +71,9 @@ vars:
7171
LDFLAGS: >
7272
-ldflags
7373
'
74-
-X github.com/arduino/FirmwareUpdater/version.versionString={{.VERSION}}
75-
-X github.com/arduino/FirmwareUpdater/version.commit={{ .COMMIT }}
76-
-X github.com/arduino/FirmwareUpdater/version.date={{.TIMESTAMP}}
74+
-X github.com/arduino/FirmwareUploader/version.versionString={{.VERSION}}
75+
-X github.com/arduino/FirmwareUploader/version.commit={{ .COMMIT }}
76+
-X github.com/arduino/FirmwareUploader/version.date={{.TIMESTAMP}}
7777
'
7878
# test vars
7979
GOFLAGS: "-timeout 10m -v -coverpkg=./... -covermode=atomic"
@@ -82,9 +82,9 @@ vars:
8282
TEST_LDFLAGS: >
8383
-ldflags
8484
'
85-
-X github.com/arduino/FirmwareUpdater/version.versionString={{.TEST_VERSION}}
86-
-X github.com/arduino/FirmwareUpdater/version.commit={{.TEST_COMMIT}}
87-
-X github.com/arduino/FirmwareUpdater/version.date={{.TIMESTAMP}}
85+
-X github.com/arduino/FirmwareUploader/version.versionString={{.TEST_VERSION}}
86+
-X github.com/arduino/FirmwareUploader/version.commit={{.TEST_COMMIT}}
87+
-X github.com/arduino/FirmwareUploader/version.date={{.TIMESTAMP}}
8888
'
8989
# check-lint vars
9090
GOLINTBIN:

Diff for: ‎go.mod

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
module github.com/arduino/FirmwareUpdater
1+
module github.com/arduino/FirmwareUploader
22

33
go 1.14
44

Diff for: ‎gon.config.hcl

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
source = ["dist/macos64/FirmwareUpdater"]
2-
bundle_id = "cc.arduino.FirmwareUpdater"
1+
source = ["dist/macos64/FirmwareUploader"]
2+
bundle_id = "cc.arduino.FirmwareUploader"
33

44
sign {
55
application_identity = "Developer ID Application: ARDUINO SA (7KT7ZWMCJT)"
@@ -8,5 +8,5 @@ sign {
88
# Ask Gon for zip output to force notarization process to take place.
99
# The CI will ignore the zip output, using the signed binary only.
1010
zip {
11-
output_path = "FirmwareUpdater.zip"
11+
output_path = "FirmwareUploader.zip"
1212
}

Diff for: ‎main.go

+5-5
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@ import (
88
"os"
99
"strings"
1010

11-
"github.com/arduino/FirmwareUpdater/modules/nina"
12-
"github.com/arduino/FirmwareUpdater/modules/sara"
13-
"github.com/arduino/FirmwareUpdater/modules/winc"
14-
"github.com/arduino/FirmwareUpdater/utils"
15-
"github.com/arduino/FirmwareUpdater/utils/context"
11+
"github.com/arduino/FirmwareUploader/modules/nina"
12+
"github.com/arduino/FirmwareUploader/modules/sara"
13+
"github.com/arduino/FirmwareUploader/modules/winc"
14+
"github.com/arduino/FirmwareUploader/utils"
15+
"github.com/arduino/FirmwareUploader/utils/context"
1616
)
1717

1818
var ctx context.Context

Diff for: ‎modules/nina/flasher.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ import (
2626
"log"
2727
"time"
2828

29-
"github.com/arduino/FirmwareUpdater/utils"
29+
"github.com/arduino/FirmwareUploader/utils"
3030
"go.bug.st/serial"
3131
)
3232

Diff for: ‎modules/nina/main.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@ import (
2828
"strconv"
2929
"strings"
3030

31-
"github.com/arduino/FirmwareUpdater/programmers/avrdude"
32-
"github.com/arduino/FirmwareUpdater/programmers/bossac"
33-
"github.com/arduino/FirmwareUpdater/utils/context"
31+
"github.com/arduino/FirmwareUploader/programmers/avrdude"
32+
"github.com/arduino/FirmwareUploader/programmers/bossac"
33+
"github.com/arduino/FirmwareUploader/utils/context"
3434
)
3535

3636
var f *Flasher

Diff for: ‎modules/sara/flasher.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ import (
2424
"strings"
2525
"time"
2626

27-
"github.com/arduino/FirmwareUpdater/utils"
27+
"github.com/arduino/FirmwareUploader/utils"
2828
"go.bug.st/serial"
2929
)
3030

Diff for: ‎modules/sara/main.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ package sara
2121

2222
import (
2323
"fmt"
24-
"github.com/arduino/FirmwareUpdater/programmers/bossac"
25-
"github.com/arduino/FirmwareUpdater/utils/context"
24+
"github.com/arduino/FirmwareUploader/programmers/bossac"
25+
"github.com/arduino/FirmwareUploader/utils/context"
2626
"io/ioutil"
2727
"log"
2828
"strconv"

Diff for: ‎modules/winc/flasher.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ import (
2525
"log"
2626
"time"
2727

28-
"github.com/arduino/FirmwareUpdater/utils"
28+
"github.com/arduino/FirmwareUploader/utils"
2929
"go.bug.st/serial"
3030
)
3131

Diff for: ‎modules/winc/main.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ import (
2828
"os"
2929
"strconv"
3030

31-
"github.com/arduino/FirmwareUpdater/programmers/bossac"
32-
"github.com/arduino/FirmwareUpdater/utils/context"
31+
"github.com/arduino/FirmwareUploader/programmers/bossac"
32+
"github.com/arduino/FirmwareUploader/utils/context"
3333
)
3434

3535
var f *Flasher

Diff for: ‎programmers/avrdude/avrdude.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import (
77
"path/filepath"
88
"time"
99

10-
"github.com/arduino/FirmwareUpdater/utils/context"
10+
"github.com/arduino/FirmwareUploader/utils/context"
1111
"github.com/arduino/arduino-cli/executils"
1212
"github.com/pkg/errors"
1313
)

Diff for: ‎programmers/bossac/bossac.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import (
77
"path/filepath"
88
"time"
99

10-
"github.com/arduino/FirmwareUpdater/utils/context"
10+
"github.com/arduino/FirmwareUploader/utils/context"
1111
"github.com/arduino/arduino-cli/arduino/serialutils"
1212
"github.com/arduino/arduino-cli/executils"
1313
"github.com/pkg/errors"

0 commit comments

Comments
 (0)