Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generalize name of "Firmware Updater" #2176

Merged
merged 1 commit into from
Aug 21, 2023

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented Aug 18, 2023

Motivation

Some Arduino boards have a supplemental hardware module that provides functionality separate from the primary microcontroller the sketch program runs on.

Enhancements or fixes to the firmware that runs on these supplemental modules may be made over time so it is important for the users of these boards to have an easy way to update the firmware. Arduino IDE provides a tool for doing this.

At the time the tool was created, the poor choice was made to include the names of the specific modules it supported at the time in the tool's name. As was inevitable, that list has changed, rendering the tool name no longer accurate.

The immediate problem is that support has been added for updating the "bridge" and radio module on the UNO R4 WiFi (#2165, arduino/arduino-fwuploader#172). That module is neither a "WiFi101" nor a "NINA", so the tool name does not reflect the support for the UNO R4 WiFi.

More significant changes in the supported modules are under way and will be introduced in the next release:

Change description

Rather than attempting to maintain a regularly changing and overly verbose name that includes the list of every supported module, it is better to use a name for the tool that only describes its general purpose, leaving the task of describing the specific supported modules to the documentation.

Reviewer checklist

  • PR addresses a single concern.
  • The PR has no duplicates (please search among the Pull Requests before creating one)
  • PR title and description are properly filled.
  • Docs have been added / updated (for bug fixes / features)

@per1234 per1234 added type: enhancement Proposed improvement topic: code Related to content of the project itself labels Aug 18, 2023
@per1234 per1234 requested a review from kittaakos August 18, 2023 19:55
@per1234 per1234 self-assigned this Aug 18, 2023
@per1234
Copy link
Contributor Author

per1234 commented Aug 19, 2023

I see the "Arduino IDE" workflow run for this PR failed due to a test failure:

https://github.com/arduino/arduino-ide/actions/runs/5906567394/job/16022857803?pr=2176#step:7:1016

This test failure also occurs on the main branch:

https://github.com/arduino/arduino-ide/actions/runs/5909092994/job/16029290009#step:7:1016

So it is unrelated to the changes proposed in this pull request.

@kittaakos
Copy link
Contributor

I see the "Arduino IDE" workflow run for this PR failed due to a test failure:

https://github.com/arduino/arduino-ide/actions/runs/5906567394/job/16022857803?pr=2176#step:7:1016

This test failure also occurs on the main branch:

https://github.com/arduino/arduino-ide/actions/runs/5909092994/job/16029290009#step:7:1016

So it is unrelated to the changes proposed in this pull request.

Some magic started to happen in the CLI. The CLI version is pinned:

"arduino-cli": {
"version": {
"owner": "arduino",
"repo": "arduino-cli",
"commitish": "38479dc"
}

Version 38479dc is checked out by the CI. Ref: arduino/arduino-cli@38479dc.

The IDE tests expect to see the git-snapshot version in the stdout after executing the arduino-cli version command.

But I see something different:

./arduino-ide-extension/src/node/resources/arduino-cli version
arduino-cli  Version: 0.34.0-rc.1 Commit: 38479dc7 Date: 2023-08-19T10:46:49Z

It's already pointing to the RC. The quick fix is to update the version to the RC CLI. See #2178.

The longer fix is to stop doing a remote fetch when arduino-cli version is requested.

Copy link
Contributor

@kittaakos kittaakos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

Some Arduino boards have a supplemental hardware module that provides functionality separate from the primary
microcontroller the sketch program runs on.

Enhancements or fixes to the firmware that runs on these supplemental modules may be made over time so it is important
for the users of these boards to have an easy way to update the firmware. Arduino IDE provides a tool for doing this.

At the time the tool was created, the poor choice was made to include the names of the specific modules it supported at
the time in the tool's name. As was inevitable, that list has changed, rendering the tool name no longer accurate.

The immediate problem is that support has been added for updating the "bridge" and radio module on the UNO R4 WiFi. That
module is neither a "WiFi101" nor a "NINA", so the tool name does not reflect the support for the UNO R4 WiFi.

More significant changes in the supported modules are under way and will be introduced in the next release:

- Dropping support for the "WiFi101" module
- Adding support for the module on the Portenta C33 board

Rather than attempting to maintain a regularly changing and overly verbose name that includes the list of every
supported module, it is better to use a name for the tool that only describes its general purpose, leaving the task of
describing the specific supported modules to the documentation.
@per1234 per1234 merged commit 10b3882 into arduino:main Aug 21, 2023
17 checks passed
@per1234 per1234 deleted the rename-fwuploader branch August 21, 2023 15:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: code Related to content of the project itself type: enhancement Proposed improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants