Skip to content

Commit 589ea2f

Browse files
Apply Code Rewview suggestions
1 parent ac044a9 commit 589ea2f

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

docs/plugins.md

+12-10
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# Plugins
22

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

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

38-
#### The esp32 module does not go into download mode
38+
#### The ESP32 module does not go into download mode
3939

40-
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
41-
reboot in download mode.
40+
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
41+
to reboot in download mode.
4242

4343
```bash
4444
$ arduino-fwuploader firmware flash -b arduino:renesas_uno:unor4wifi -a /dev/ttyACM0 -v --log-level debug
@@ -81,9 +81,11 @@ Error: reboot mode: upload commands sketch: setting DTR to OFF
8181
8282
#### I flashed the certificates, but I am unable to reach the host
8383
84-
The **whole certificate chain** is needed to make it work. Using `-u` flags (ex: `-u www.arduino.cc:443`) won’t work
85-
because it only downloads the root certificates. The solution is to use only the `-f` flag and provide a pem certificate
86-
containing the whole chain.
84+
The **whole certificate chain** is needed to make it work. Using
85+
[`-u` flags](commands/arduino-fwuploader_certificates_flash.md#options) (ex: `-u www.arduino.cc:443`) won’t work because
86+
it only downloads the root certificates. The solution is to use only the
87+
[`-f` flag](commands/arduino-fwuploader_certificates_flash.md#options) and provide a pem certificate containing the
88+
whole chain.
8789
8890
#### My antivirus says that `espflash` is a threat
8991

0 commit comments

Comments
 (0)