Skip to content

Commit 253e89e

Browse files
committed
Updates to readme
1 parent f6e5ed9 commit 253e89e

File tree

1 file changed

+54
-11
lines changed

1 file changed

+54
-11
lines changed

README.adoc

+54-11
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,66 @@
1-
= Firmware/Certificates updater for the Arduino WiFi 101 Shield =
1+
= Firmware/Certificates updater for the WiFi 101 and MKR1000 =
22

33
Use this tool to update the SSL root-certificates installed on the
4-
WiFi 101 shield.
4+
Arduino/Genuino WiFi 101 shield or the Arduino/Genuino MKR1000 board.
55

66
== Usage ==
77

8+
=== To update SSL Certificates ===
9+
810
1. Upload the https://github.com/arduino-libraries/WiFi101/tree/master/examples/FirmwareUpdater[FirmwareUpdater]
911
sketch onto your board. You need to install the lastest WiFi101 library
1012
(available through the library manager of the Arduino IDE). The sketch is
11-
included as an example of the library,
12-
```File -> Examples -> WiFi101 -> FirmwareUpdater```.
13+
included as an example of the library: `File -> Examples -> WiFi101 -> FirmwareUpdater`
1314
2. Run "winc1500-uploader-gui".
14-
3. The tools is able to fetch root certificates directly from the
15-
websites, just write the IP or domain in the text box and click
16-
on the "Fetch" button.
17-
4. Select the serial port of the board running the "FirmwareUploader"
18-
sketch.
15+
3. This tool is able to fetch the SSL Root Certificates directly from the
16+
target websites, just write the IP or domain in the text box and click
17+
on the "Fetch" button (you can repeat this step multiple times to add
18+
more certificates).
19+
4. Select the serial port of the board running the "FirmwareUploader" sketch.
1920
5. Click "Update" button.
2021

21-
== How to build ==
22+
**WARNING:** the storage reserved for the certificates is very small. You can load,
23+
roughly, 10 certificates but the exact number may be lower depending on the size of the
24+
certificates.
25+
26+
=== To update firmware ===
27+
28+
This is possible using the Command-Line tool:
29+
30+
1. Upload the https://github.com/arduino-libraries/WiFi101/tree/master/examples/FirmwareUpdater[FirmwareUpdater]
31+
sketch onto your board. You need to install the lastest WiFi101 library
32+
(available through the library manager of the Arduino IDE). The sketch is
33+
included as an example of the library: `File -> Examples -> WiFi101 -> FirmwareUpdater`
34+
2. Read the label on the top of your WINC1500 in order to determine the model of the WiFi module.
35+
The last letter should tell if you have a Model A or Model B, for example:
36+
- `ATWINC1500-MR210PA` -> is a WINC1500 Model A
37+
- `ATSAMW25H18-MR510PB` -> is a WINC1500 Model B
38+
3. Based on your WINC1500 model you must use:
39+
- `firmware/19.4.4/m2m_aio_2b0.bin` for Model A
40+
- `firmware/19.4.4/m2m_aio_3a0.bin` for Model B
41+
4. Run the following command line
42+
`./winc1500-uploader -firmware XXX -port YYY`
43+
replacing `XXX` with your firmware file determined on step 3) and `YYY` with your serial port number. +
44+
For example:
45+
`./winc1500-uploader -firmware firmware/19.4.4/m2m_aio_2b0.bin -port /dev/ttyACM0`
46+
47+
=== Other command line options ===
48+
49+
The full list of command line options can be obtained with the `-h` option: `./winc1500-uploader -h`
50+
51+
Usage of ./winc1500-uploader:
52+
-address value
53+
address (host:port) to fetch and flash root certificate for, multiple values allowed
54+
-certs string
55+
root certificate directory
56+
-firmware string
57+
firmware file to flash
58+
-port string
59+
serial port to use for flashing
60+
-read
61+
read all firmware and output to stdout
62+
63+
== How to build the tools from source file ==
2264

2365
go get go.bug.st/serial
2466
go build src/github.com/arduino-libraries/WiFi101-FirmwareUpdater/cli/main/winc1500-uploader.go
@@ -32,7 +74,7 @@ WiFi 101 shield.
3274

3375
== License ==
3476

35-
Copyright (c) 2015 Arduino LLC. All right reserved.
77+
Copyright (c) 2015-2016 Arduino LLC. All right reserved.
3678

3779
This library is free software; you can redistribute it and/or
3880
modify it under the terms of the GNU Lesser General Public
@@ -47,3 +89,4 @@ Lesser General Public License for more details.
4789
You should have received a copy of the GNU Lesser General Public
4890
License along with this library; if not, write to the Free Software
4991
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
92+

0 commit comments

Comments
 (0)