Skip to content

Commit 026fc1b

Browse files
Update readme (#6)
1 parent 0f96274 commit 026fc1b

File tree

2 files changed

+1429
-1
lines changed

2 files changed

+1429
-1
lines changed

README.md

Lines changed: 66 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,66 @@
1-
# nina-fwuploader-plugin
1+
# nina-fwuploader-plugin
2+
3+
[![Check Go status](https://github.com/arduino/nina-fwuploader-plugin/actions/workflows/check-go-task.yml/badge.svg)](https://github.com/arduino/nina-fwuploader-plugin/actions/workflows/check-go-task.yml)
4+
5+
The `nina-fwuploader-plugin` is a core component of the [arduino-fwuploader](https://github.com/arduino/arduino-fwuploader). The purpose of this plugin is to abstract all the
6+
business logic needed to update firmware and certificates for the nina family boards:
7+
- [MKR WiFi 1010](https://docs.arduino.cc/hardware/mkr-wifi-1010)
8+
- [Nano 33 IoT](https://docs.arduino.cc/hardware/nano-33-iot)
9+
- [UNO WiFi Rev2](https://docs.arduino.cc/hardware/uno-wifi-rev2)
10+
- [Nano RP2040 Connect](https://docs.arduino.cc/hardware/nano-rp2040-connect)
11+
12+
## How to contribute
13+
14+
Contributions are welcome!
15+
16+
:sparkles: Thanks to all our [contributors](https://github.com/arduino/nina-fwuploader-plugin/graphs/contributors)! :sparkles:
17+
18+
### Requirements
19+
20+
1. [Go](https://go.dev/) version 1.20 or later
21+
1. [Task](https://taskfile.dev/) to help you run the most common tasks from the command line
22+
1. One of the nina family supported boards.
23+
24+
## Development
25+
26+
When running the plugin inside the fwuploader, the required tools are downloaded by the fwuploader. If you run only the plugin, you must provide them by hand.
27+
Therefore be sure to place the `rp2040tools`, `avrdude`, and `bossac` binaries in the correct folders like the following:
28+
29+
```bash
30+
.
31+
├── bossac
32+
│   └── 1.7.0-arduino3
33+
│   └── bossac
34+
├── avrdude
35+
│   └── 6.3.0-arduino17
36+
│   └── bin
37+
│   └── avrdude
38+
├── rp2040tools
39+
│   └── 1.0.6
40+
│   └── rp2040load
41+
└── nina-fwuploader-plugin_linux_amd64
42+
└── bin
43+
└── nina-fwuploader-plugin
44+
```
45+
46+
**Commands**
47+
48+
- `nina-fwuploader-plugin cert flash -p /dev/ttyACM0 ~/Documents/certificate.pem`
49+
- `nina-fwuploader-plugin firmware get-version -p /dev/ttyACM0`
50+
- `nina-fwuploader-plugin firmware flash -p /dev/ttyACM0 ~/Documents/fw0.2.0.bin`
51+
52+
## Security
53+
54+
If you think you found a vulnerability or other security-related bug in the nina-fwuploader-plugin, please read our [security
55+
policy] and report the bug to our Security Team 🛡️ Thank you!
56+
57+
e-mail contact: [email protected]
58+
59+
## License
60+
61+
nina-fwuploader-plugin is licensed under the [AGPL 3.0](LICENSE.txt) license.
62+
63+
You can be released from the requirements of the above license by purchasing a commercial license. Buying such a license
64+
is mandatory if you want to modify or otherwise use the software for commercial activities involving the Arduino
65+
software without disclosing the source code of your own applications. To purchase a commercial license, send an email to
66+

0 commit comments

Comments
 (0)