Skip to content

Add documentation on the new plugin system #179

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Jul 20, 2023
Merged

Add documentation on the new plugin system #179

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ac044a9
Add documentation on the new plugin system (#178)
MatteoPologruto Jul 20, 2023
f18a5d2
Apply Code Review suggestions
alessio-perugini Jul 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Apply Code Review suggestions
  • Loading branch information
@alessio-perugini
alessio-perugini committed Jul 20, 2023
commit f18a5d2eb84d501f045dd82a1cbd49728e968181
22 changes: 12 additions & 10 deletions docs/plugins.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Plugins

A new plugin-system has been implemented in the fwuploader. A plugin is basically another executable/tool, specifically
tailored for a board/family of boards, but with a well-defined user interface. Inside the plugin, there is all the
business logic to support a board/family of boards. Every plugin implements the
[interface](https://github.com/arduino/fwuploader-plugin-helper/blob/main/plugin.go#L28) contained in the
A new plugin-system has been implemented in the Arduino Firmware Uploader. A plugin is basically another
executable/tool, specifically tailored for a board/family of boards, but with a well-defined user interface. Inside the
plugin, there is all the business logic to support a board/family of boards. Every plugin implements the
[interface](https://pkg.go.dev/github.com/arduino/fwuploader-plugin-helper#Plugin) contained in the
[fwuploader-plugin-helper](https://github.com/arduino/fwuploader-plugin-helper) repository.

The fwuploader is still responsible for downloading the files required for the plugin to work:
Expand Down Expand Up @@ -35,10 +35,10 @@ Error: × Main thread panicked.
backtrace.
```

#### The esp32 module does not go into download mode
#### The ESP32 module does not go into download mode

On Linux, the uno r4 must be plugged into a **hub usb** to make the flash process work. Otherwise, it won’t be able to
reboot in download mode.
On Linux, the UNO R4 WiFi must be plugged into a **USB hub** to make the flash process work. Otherwise, it won’t be able
to reboot in download mode.

```bash
$ arduino-fwuploader firmware flash -b arduino:renesas_uno:unor4wifi -a /dev/ttyACM0 -v --log-level debug
Expand Down Expand Up @@ -81,9 +81,11 @@ Error: reboot mode: upload commands sketch: setting DTR to OFF

#### I flashed the certificates, but I am unable to reach the host

The **whole certificate chain** is needed to make it work. Using `-u` flags (ex: `-u www.arduino.cc:443`) won’t work
because it only downloads the root certificates. The solution is to use only the `-f` flag and provide a pem certificate
containing the whole chain.
The **whole certificate chain** is needed to make it work. Using
[`-u` flags](commands/arduino-fwuploader_certificates_flash.md#options) (ex: `-u www.arduino.cc:443`) won’t work because
it only downloads the root certificates. The solution is to use only the
[`-f` flag](commands/arduino-fwuploader_certificates_flash.md#options) and provide a pem certificate containing the
whole chain.

#### My antivirus says that `espflash` is a threat

Expand Down