Skip to content

Commit 275e41c

Browse files
authored
Merge pull request #325 from nkaaf/nkaaf/fix_content_linter_warnings
Fix multiple content linter warnings
2 parents e28990c + 26f9b2b commit 275e41c

File tree

49 files changed

+128
-128
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+128
-128
lines changed

content/hardware/01.mkr/01.boards/mkr-1000-wifi/tutorials/wifi-101-library-examples/wifi-101-library-examples.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Guide to WiFi101
3-
description: 'Find examples & utilities for using the WiFi101 library, designed for the MKR 1000 WiFi and WiFi 101 Shield (retired).'
3+
description: 'Find examples & utilities for using the WiFi101 library, designed for the MKR 1000 WiFi and WiFi Shield 101 (retired).'
44
tags: [Wi-Fi]
55
author: Arduino
66
---
@@ -50,7 +50,7 @@ When you load the sketch on the board, it will wait for a serial monitor console
5050
5151
* Circuit:
5252
53-
* - WiFi101 Shield attached
53+
* - WiFi Shield 101 attached
5454
5555
*
5656
@@ -83,7 +83,7 @@ void setup() {
8383
8484
// Check for the presence of the shield
8585
86-
Serial.print("WiFi101 shield: ");
86+
Serial.print("WiFi Shield 101: ");
8787
8888
if (WiFi.status() == WL_NO_SHIELD) {
8989
@@ -154,7 +154,7 @@ void loop() {
154154

155155
### Update Firmware / Load Certificates
156156

157-
The 19.6.1 firmware is only available for model B of the WINC1500, this is used in the MKR1000 board. Unfortunately, the WiFi101 shield uses model A, which Atmel has stopped supporting, so there is no 19.6.1 firmware release for it, 19.4.4 will be the latest firmware version that is compatible.
157+
The 19.6.1 firmware is only available for model B of the WINC1500, this is used in the MKR1000 board. Unfortunately, the WiFi shield 101 uses model A, which Atmel has stopped supporting, so there is no 19.6.1 firmware release for it, 19.4.4 will be the latest firmware version that is compatible.
158158

159159
To simplify the process, we have prepared a specific sketch - this **FirmwareUpdater** - that you must load on the host board (either the one with the shield plugged in, or the MKR1000 itself) and an easy to use plug-in available in Arduino Software (IDE) 1.6.10 onwards.
160160

@@ -163,7 +163,7 @@ The `FirmwareUpdater.ino` sketch is available in **Examples > WiFi101**
163163

164164
![Select the "FirmwareUpdater" example.](assets/firmware_updater_sketch_101.png)
165165

166-
***When you load the sketch on the board, it prepares the communication between the plug-in and the WiFi chip. It opens up the communication through the serial port to the WiFi module hosted on the board. It is necessary to perform all the procedures managed by the Firmware Upgrader Plugin. Everything will be managed by the plug-in, but it is important to upload this sketch first.***
166+
***When you load the sketch on the board, it prepares the communication between the plug-in and the Wi-Fi chip. It opens up the communication through the serial port to the Wi-Fi module hosted on the board. It is necessary to perform all the procedures managed by the Firmware Upgrader Plugin. Everything will be managed by the plug-in, but it is important to upload this sketch first.***
167167

168168
Upload the sketch and keep the board (either the one with the shield plugged in, or the MKR1000 itself) connected to the computer.
169169

@@ -176,7 +176,7 @@ Once done, open the plug-in that is available in the tools menu.
176176
Your board should be in the list of the available serial ports.
177177
If not, please check that it is properly configured in the Tools menu.
178178

179-
To update the firmware you should choose the right typer of board. You can find your model looking at the WiFi module: the first line in the sticker or the last line of the silk print on the right side of the PCB shows the microcontroller model. It can be either MR210PA or MR510PB and the last letter shows yor model accordingly.
179+
To update the firmware you should choose the right typer of board. You can find your model looking at the Wi-Fi module: the first line in the sticker or the last line of the silk print on the right side of the PCB shows the microcontroller model. It can be either MR210PA or MR510PB and the last letter shows yor model accordingly.
180180

181181
![Find the model.](assets/MKR1000_RevA_B_20copy.png)
182182

@@ -186,10 +186,10 @@ Choose in the dropdown list the model corresponding to your unit and proceed cli
186186

187187
#### Certificate Uploading
188188

189-
With the same procedure, you may load root certificates on the WiFi module to access securely specific websites. Your board must be running the **FirmwareUpdater** sketch to work .The root certificates are issued by a limited number of certification authorities, but it is difficult to know which site is using which authority. To ease your life, we allow you to specify directly the URL to which you need to connect securely, leaving to us the task to download the root certificate.
190-
The list you are building is not saved from one session to the next one. It might happen that a few websites share the same root certificate. You don't have to worry about this as we take care of it. The space available on your WiFi module to store the certificates is limited to around 10 certificates that, being issued by a limited number of authorities, should be more than enough for the average projects.
189+
With the same procedure, you may load root certificates on the Wi-Fi module to access securely specific websites. Your board must be running the **FirmwareUpdater** sketch to work .The root certificates are issued by a limited number of certification authorities, but it is difficult to know which site is using which authority. To ease your life, we allow you to specify directly the URL to which you need to connect securely, leaving to us the task to download the root certificate.
190+
The list you are building is not saved from one session to the next one. It might happen that a few websites share the same root certificate. You don't have to worry about this as we take care of it. The space available on your Wi-Fi module to store the certificates is limited to around 10 certificates that, being issued by a limited number of authorities, should be more than enough for the average projects.
191191

192-
The procedure starts connecting your board (either the one with the shield plugged in, or the MKR1000 itself) to your computer and selecting it from the Tools menu of the Arduino Software (IDE). Load the FirmwareUpdater on the board and launch the **WiFi 101 Firmware Updater** from Tools and go to the third section of the interface.
192+
The procedure starts connecting your board (either the one with the shield plugged in, or the MKR1000 itself) to your computer and selecting it from the Tools menu of the Arduino Software (IDE). Load the FirmwareUpdater on the board and launch the **WiFi101 Firmware Updater** from Tools and go to the third section of the interface.
193193

194194
![Adding SSL root certificates.](assets/certificates_upload_101.png)
195195

@@ -972,7 +972,7 @@ void printMacAddress(byte mac[]) {
972972
}
973973
```
974974

975-
### Wifi101 Simple Web Server WiFi
975+
### Wifi101 Simple Web Server Wi-Fi
976976

977977
In this example, a simple web server lets you blink an LED via the web. This example will print the IP address of your WiFi Shield 101 or MKR1000 board (once connected) to the Arduino Software (IDE) Serial Monitor. Once you know the IP address of our board, you can open that address in a web browser to turn on and off the LED on pin 9.
978978

@@ -1531,7 +1531,7 @@ void printWiFiStatus() {
15311531
}
15321532
```
15331533

1534-
### Wifi101 WiFi Chat Server
1534+
### Wifi101 Wi-Fi Chat Server
15351535

15361536
A simple server that distributes any incoming messages to all connected clients. To use, open a terminal window, telnet to your WiFi shield's or MKR1000's IP address, and type away. Any incoming text will be sent to all connected clients (including the one typing). Additionally, you will be able to see the client's input in your Arduino Software (IDE) serial monitor as well.
15371537

@@ -1704,7 +1704,7 @@ void printWiFiStatus() {
17041704
```
17051705

17061706

1707-
### Wifi101 WiFi Udp Send Receive String
1707+
### Wifi101 Wi-Fi Udp Send Receive String
17081708

17091709
This tutorial waits for a UDP packet on a local port. When a valid packet is received, an acknowledge packet is sent back to the client on a specified outgoing port. It relies on a WiFi connection made to your LAN using an Arduino Wifi 101 Shield and Zero Board or the MKR1000 board.
17101710

@@ -1872,7 +1872,7 @@ void printWiFiStatus() {
18721872
}
18731873
```
18741874

1875-
### Wifi101 WiFi Web Client
1875+
### Wifi101 Wi-Fi Web Client
18761876

18771877
This example shows you how to make a HTTP request using a WiFi Shield 101 or a MKR1000 board. It returns a [Google search for the term "Arduino"](http://www.google.com/search?q=arduino). The results of this search are viewable as HTML through your Arduino Software (IDE) serial window.
18781878

@@ -2057,7 +2057,7 @@ void printWiFiStatus() {
20572057
```
20582058

20592059

2060-
### Wifi101 WiFi Web Client Repeating
2060+
### Wifi101 Wi-Fi Web Client Repeating
20612061

20622062
This example shows you how to make repeated HTTP requests using a WiFi Shield 101 or a MKR1000 board. It connects to [http://www.arduino.cc/latest.txt](/latest.txt). The content of the page is viewable through your Arduino Software (IDE) Serial Monitor window.
20632063

@@ -2262,9 +2262,9 @@ void printWiFiStatus() {
22622262
```
22632263

22642264

2265-
### Wifi101 Simple Web Server WiFi
2265+
### Wifi101 Simple Web Server Wi-Fi
22662266

2267-
In this example, you will use your WiFi Shield 101 and your Arduino Zero, or a MKR1000 board, to create a simple Web server. Using the WiFi library, your device will be able to answer a HTTP request received from the WiFI connection. After opening a browser and navigating to your WiFi shield's or MKR1000's IP address, your board will respond with just enough HTML for a browser to display the input values from all six analog pins.
2267+
In this example, you will use your WiFi Shield 101 and your Arduino Zero, or a MKR1000 board, to create a simple Web server. Using the Wi-Fi library, your device will be able to answer a HTTP request received from the Wi-FI connection. After opening a browser and navigating to your WiFi shield's or MKR1000's IP address, your board will respond with just enough HTML for a browser to display the input values from all six analog pins.
22682268

22692269
This example is written for a network using WPA encryption. For WEP or WPA, change the Wifi.begin() call accordingly.
22702270

content/hardware/01.mkr/01.boards/mkr-1000-wifi/tutorials/wifi-101-ota/WiFi101OTA.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: 'WiFi101 OTA with MKR 1000 WiFi'
55
tags: [WiFi101]
66
---
77

8-
This example shows how to use the WiFi101OTA library to update your sketch over the air. No extra hardware is required since the update is applied directly in the upper half of the internal flash. This means that the biggest possible size of the compiled sketch is 120KB.
8+
This example shows how to use the WiFi101OTA library to update your sketch over the air. No extra hardware is required since the update is applied directly in the upper half of the internal flash. This means that the biggest possible size of the compiled sketch is 120 KB.
99

1010
## Hardware Required
1111

@@ -29,7 +29,7 @@ Upload the example using the "classic" serial port method
2929

3030
![Step 4.](assets/WiFiOTA4.png)
3131

32-
Your MKR1000 will connect to the WiFi and expose itself as a Network port with the name and password you declared in the sketch with `WiFiOTA.begin` (the defaults name is "Arduino" while the password is "password").
32+
Your MKR1000 will connect to the Wi-Fi and expose itself as a Network port with the name and password you declared in the sketch with `WiFiOTA.begin` (the defaults name is "Arduino" while the password is "password").
3333

3434
At this point you are already able to update the sketch over the air! Open another sketch and make sure to add `WiFiOTA.begin()` in `setup()` and `WiFiOTA.poll()` in your `loop()` . If you forget about this you will lose the ability to upload over the air again (but you can still upload via serial, of course)
3535

content/hardware/01.mkr/01.boards/mkr-nb-1500/tutorials/nb-scan-network/nb-scan-network.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ The goals of this project are:
4343

4444
## The uBlox SARA-R4 Module
4545

46-
As every other MKR family board, the MKR NB 1500 board has a specific module for connectivity. It is called uBlox SARA-R4, and is designed to communicate over LTE Cat M1 or NB IoT networks with a speed of up to 375 kb/s.
46+
As every other MKR family board, the MKR NB 1500 board has a specific module for connectivity. It is called uBlox SARA-R4, and is designed to communicate over LTE Cat M1 or NB IoT networks with a speed of up to 375 Kbps.
4747

4848
It is designed to operate in temperature conditions between –40 °C to +85 °C, making it quite durable. It also offers low power consumption and coverage enhancement for deeper range into buildings and basements (and underground with NB1).
4949

content/hardware/01.mkr/01.boards/mkr-wan-1300/tutorials/lora-button-press/lora-button-press.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,13 @@ software:
2626

2727
In this tutorial, we will set up two Arduino MKR WAN 1300 to host a remote LED control. One board will be set up as a sender with a pushbutton that when it is pressed, an LED on the other board will turn on or off.
2828

29-
We will use the **LoRa®** library for the communication, and we will not use any external service.
29+
We will use the **LoRa** library for the communication, and we will not use any external service.
3030
___
3131

3232
## Hardware & Software Needed
3333

3434
- Arduino IDE ([online](https://create.arduino.cc/) or [offline](https://www.arduino.cc/en/main/software)).
35-
- LoRa® library installed, see the [github repository](https://github.com/sandeepmistry/arduino-LoRa).
35+
- LoRa library installed, see the [github repository](https://github.com/sandeepmistry/arduino-LoRa).
3636
- 2x [Arduino MKR WAN 1300](https://store.arduino.cc/mkr-wan-1300).
3737
- 2x [Antenna](https://store.arduino.cc/antenna).
3838
- 1x Pushbutton.
@@ -63,7 +63,7 @@ But let's take a look at what we need to include in the code. As we are using tw
6363

6464
**To create the sender sketch, we will have to do the following steps:**
6565

66-
- Initialize the **SPI** and **LoRa®** libraries.
66+
- Initialize the **SPI** and **LoRa** libraries.
6767
- Create a counter variable.
6868
- Set the radio frequency to 868E6 (Europe) or 915E6 (North America).
6969
- Create an if statement that checks if the button is pressed.
@@ -73,7 +73,7 @@ But let's take a look at what we need to include in the code. As we are using tw
7373

7474
**To create the receiver sketch, we will have to do the following steps:**
7575

76-
- Initialize the **SPI** and **LoRa®** libraries.
76+
- Initialize the **SPI** and **LoRa** libraries.
7777
- Create a string with the message "button pressed" stored.
7878
- Set the radio frequency to 868E6 (Europe) or 915E6 (North America).
7979
- Create a function to parse incoming packet.
@@ -85,11 +85,11 @@ But let's take a look at what we need to include in the code. As we are using tw
8585

8686
**1.** First, let's make sure we have the drivers installed. If we are using the Web Editor, we do not need to install anything. If we are using an offline editor, we need to install it manually. This can be done by navigating to **Tools > Board > Board Manager...**. Here we need to look for the **Arduino SAMD boards (32-bits ARM Cortex M0+)** and install it.
8787

88-
**2.** Now we need to download the **LoRa®** library from [this repository](https://github.com/sandeepmistry/arduino-LoRa), where you can install it by navigating to **Sketch > Include Library > Add .ZIP Library...** in the offline IDE.
88+
**2.** Now we need to download the **LoRa** library from [this repository](https://github.com/sandeepmistry/arduino-LoRa), where you can install it by navigating to **Sketch > Include Library > Add .ZIP Library...** in the offline IDE.
8989

9090
### Programming the Sender
9191

92-
In the initialization we will include the **SPI** and **LoRa®** libraries. We will then create the `counter` variable to track how many times we have pressed the button. Next, we will create the `button` and `buttonState` variables, used to assign the pushbutton to pin 2, and to read the state of it.
92+
In the initialization we will include the **SPI** and **LoRa** libraries. We will then create the `counter` variable to track how many times we have pressed the button. Next, we will create the `button` and `buttonState` variables, used to assign the pushbutton to pin 2, and to read the state of it.
9393

9494
```arduino
9595
#include <SPI.h>
@@ -102,7 +102,7 @@ int buttonState;
102102

103103
In the `setup()` we will first define the `button` pin as an `INPUT_PULLUP`. We will then begin serial communication, where we will use the command `while(!Serial);` to prevent the program from running until we open the Serial Monitor.
104104

105-
We will then initialize the **LoRa®** library, where we will set the radio frequency to 868E6, which is used in Europe for LoRa® communication. If we are located in North America, we need to change this to 915E6.
105+
We will then initialize the **LoRa** library, where we will set the radio frequency to 868E6, which is used in Europe for LoRa® communication. If we are located in North America, we need to change this to 915E6.
106106

107107
```arduino
108108
void setup() {
@@ -146,7 +146,7 @@ void loop() {
146146

147147
### Programming the Receiver
148148

149-
In the initialization we will first include the **SPI** and **LoRa®** libraries. Then we will create two strings: one empty, and one with the message "button pressed" stored. The `contents` string will be used to store incoming data, and the `buttonPress` string will be used to compare the contents with the incoming data.
149+
In the initialization we will first include the **SPI** and **LoRa** libraries. Then we will create two strings: one empty, and one with the message "button pressed" stored. The `contents` string will be used to store incoming data, and the `buttonPress` string will be used to compare the contents with the incoming data.
150150

151151
We then create the boolean `x`, which will switch from true to false each time `buttonPress` matches `contents`. We will also assign the `led` variable to pin 2.
152152

@@ -164,7 +164,7 @@ int led = 2;
164164

165165
In the `setup()` we will first define the `led` pin as an output. We will then begin serial communication, where we will use the command `while(!Serial);` to prevent the program from running until we open the Serial Monitor.
166166

167-
We will then initialize the **LoRa®** library, where we will set the radio frequency to 868E6, which is used in Europe for LoRa® communication. If we are located in North America, we need to change this to 915E6.
167+
We will then initialize the **LoRa** library, where we will set the radio frequency to 868E6, which is used in Europe for LoRa® communication. If we are located in North America, we need to change this to 915E6.
168168

169169
```arduino
170170
void setup() {

content/hardware/01.mkr/01.boards/mkr-wan-1300/tutorials/lora-message/lora-message.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ software:
2121

2222
In this tutorial, we will use two MKR WAN 1300's to set up a simple message service over the LoRa® network. This communication will be achieved through the Serial Monitor, where you can send and receive messages directly.
2323

24-
We will use the **LoRa®** library to for the communication, and we will not use any external services. Additionally, we will also create specific addresses for each board. This will help ensure that the messages that we send and receive are only displayed on the corresponding devices.
24+
We will use the **LoRa** library to for the communication, and we will not use any external services. Additionally, we will also create specific addresses for each board. This will help ensure that the messages that we send and receive are only displayed on the corresponding devices.
2525

26-
Special thanks to [Sandeep Mistry](https://github.com/sandeepmistry) for creating the [LoRa® library](https://github.com/sandeepmistry/arduino-LoRa).
26+
Special thanks to [Sandeep Mistry](https://github.com/sandeepmistry) for creating the [LoRa library](https://github.com/sandeepmistry/arduino-LoRa).
2727

2828
___
2929

@@ -54,7 +54,7 @@ To do this, we basically only need to create one sketch that we will upload to e
5454

5555
In the code, we will have to do the following to make it work:
5656

57-
- Initialize the **SPI** and **LoRa®** libraries.
57+
- Initialize the **SPI** and **LoRa** libraries.
5858
- Create a string to store outgoing messages.
5959
- Create two bytes: one for local address, one for the destination address.
6060
- Set the radio frequency to 868E6 (Europe) or 915E6 (North America).

content/hardware/01.mkr/01.boards/mkr-wan-1300/tutorials/lora-send-and-receive/lora-send-and-receive.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ int counter = 0;
104104

105105
In the `setup()` we will first begin serial communication, where we will use the command `while(!Serial);` to prevent the program from running until we open the Serial Monitor.
106106

107-
We will then initialize the **LoRa®** library, where we will set the radio frequency to 868E6, which is used in Europe for LoRa® communication. If we are located in North America, we need to change this to 915E6.
107+
We will then initialize the **LoRa** library, where we will set the radio frequency to 868E6, which is used in Europe for LoRa® communication. If we are located in North America, we need to change this to 915E6.
108108

109109

110110
```arduino

0 commit comments

Comments
 (0)