Skip to content

Correct example sketch names #1643

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.

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ This tutorial barely uses any external hardware, except an LED that we will cont
- `client.print()` - print something to the client (e.g. html code).
- `client.stop()` - closes the connection.

The sketch can be found in the snippet below. It is very similar to the sketch found in **File > Examples > WiFi101 > SimpleWebServer**, with only minor modifications.
The sketch can be found in the snippet below. It is very similar to the sketch found in **File > Examples > WiFi101 > SimpleWebServerWiFi**, with only minor modifications.

Upload the code to the board, and make sure the right board and port are selected.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ Enter the device name, in the screenshot below "MyMKRGSM1400" was used. "ES256"

## Connecting the Board to GCP IoT Core

1) Open the GCP IoT Core GSM sketch in the Arduino IDE using **File -> Examples ->Arduino Cloud Provider Examples -> GoogleCloudPlatformIoTCore->GCP_IoT_Core_GSM.**
1) Open the GCP IoT Core GSM sketch in the Arduino IDE using **File -> Examples -> Arduino Cloud Provider Examples -> Google Cloud Platform IoT Core -> GCP_IoT_Core_GSM**.

2) In the arduino_secrets.h tab, fill in the pin (if required) for the SIM card, as well as the GPRS APN, username and password for the cellular carrier you are using.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ Now that we have a self signed certificate and the SHA1 fingerprint to identify

## Connecting the Board to Azure IoT Hub

1) Open the Azure IoT Hub NB sketch in the Arduino IDE using **File -> Examples -> Arduino Cloud Provider Examples -> AzureIoTHub-> Azure_IoT_Hub_NB.**
1) Open the Azure IoT Hub NB sketch in the Arduino IDE using **File -> Examples -> Arduino Cloud Provider Examples -> Azure IoT Hub-> Azure_IoT_Hub_NB**.

2) In the arduino_secrets.h tab, fill in the pin (if required) for the SIM card.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ We will now get to the programming part of this tutorial. It focuses on two main

**2.** Now, we need to install the libraries needed. If we are using the Web Editor, there is no need to install anything. If we are using an offline editor, simply go to **Tools > Manage libraries..**, and search for **MKRNB** and install it.

**3.** With the drivers and library installed, we can now move on to create the sketch. This sketch is available as an example in the **MKRNB** library, and can be accessed directly through the editor by navigating to **File > Examples > MKRNB > Tools > ChangeRadioAccessTechnology**.
**3.** With the drivers and library installed, we can now move on to create the sketch. This sketch is available as an example in the **MKRNB** library, and can be accessed directly through the editor by navigating to **File > Examples > MKRNB > Tools > ChooseRadioAccessTechnology**.

The full code is also available further down this tutorial. But we will now also go through it step by step to understand the sketch a bit better.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ This tutorial barely uses any external hardware, except an LED that we will cont
- `client.print()` - print something to the client (e.g. html code).
- `client.stop()` - closes the connection.

The sketch can be found in the snippet below. It is very similar to the sketch found in **File > Examples > WiFiNINA > SimpleWebServer**, with only minor modifications.
The sketch can be found in the snippet below. It is very similar to the sketch found in **File > Examples > WiFiNINA > SimpleWebServerWiFi**, with only minor modifications.

Upload the code to the board, and make sure the right board and port are selected.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ Now that we have a CSR to identify the board, we need to login into the AWS cons

## Connecting the Board to AWS IoT Core

1) Open the AWS IoT Wi-Fi sketch in the Arduino IDE using the **File -> Examples -> Arduino Cloud Provider Examples -> AWSIoT-> AWS_IoT_WiFi.**
1) Open the AWS IoT Wi-Fi sketch in the Arduino IDE using the **File -> Examples -> Arduino Cloud Provider Examples -> AWS IoT-> AWS_IoT_WiFi**.

2) In the arduino_secrets.h tab. update the Wi-Fi settings with the SSID and password of your Wi-Fi network.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ We will now get to the programming part of this tutorial.

### Programming the Sender

We will start by programming the sender. The code can be found in the snippet below, or in the **CAN** library under **File > Examples > CAN > Sender**.
We will start by programming the sender. The code can be found in the snippet below, or in the **CAN** library under **File > Examples > CAN > CANSender**.

>**Note:** Make sure that you remember which board you upload to. As we are uploading two different sketches in total, we need to make sure we don't upload the sketches to the same board.

Expand Down Expand Up @@ -160,7 +160,7 @@ void loop() {

### Receiver Code

We will now program the receiver. The code can be found in the snippet below, or in the **CAN** library under **File > Examples > CAN > Receiver**.
We will now program the receiver. The code can be found in the snippet below, or in the **CAN** library under **File > Examples > CAN > CANReceiver**.

Upload the program to the board, and remember to change the upload port, so we don't accidentally upload the sketch to the wrong board.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ This tutorial barely uses any external hardware, except an LED that we will cont
- `client.print()` - print something to the client (e.g. html code).
- `client.stop()` - closes the connection.

The sketch can be found in the snippet below. It is very similar to the sketch found in **File > Examples > WiFiNINA > SimpleWebServer**, with only minor modifications.
The sketch can be found in the snippet below. It is very similar to the sketch found in **File > Examples > WiFiNINA > SimpleWebServerWiFi**, with only minor modifications.

Upload the code to the board, and make sure the right board and port are selected.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Let's program the Portenta with a sketch. You will also define a few helper func
* Create a new file named `FlashIAPLimits.h` to store the helper functions in a reusable file.

**Note:** Finished sketch its inside the tutorials library wrapper at:
**Examples > Arduino_Pro_Tutorials > Creating a Flash-Optimized Key-Value Store > FlashKeyValueStore**
**Examples > Arduino_Pro_Tutorials > Creating a Flash-Optimized Key-Value Store > FlashKeyValue**

### 3. Populate the Helper Functions
First let's add the helper functions to the `FlashIAPLimits.h` header. This will determine the available Flash limits to allocate the custom data.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,7 @@ void setup()
{
Serial.println("Higher version bootloader required to perform OTA.");
Serial.println("Please update the bootloader.");
Serial.println("File -> Examples -> STM32H747_System -> STM32H747_updateBootloader");
Serial.println("File -> Examples -> STM32H747_System -> STM32H747_manageBootloader");
return;
}

Expand Down Expand Up @@ -378,7 +378,7 @@ void setup()
{
Serial.println("Higher version bootloader required to perform OTA.");
Serial.println("Please update the bootloader.");
Serial.println("File -> Examples -> STM32H747_System -> STM32H747_updateBootloader ");
Serial.println("File -> Examples -> STM32H747_System -> STM32H747_manageBootloader");
return;
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ Begin by plugging in your Portenta board to your computer using a USB-C® cable
### 2. Create the Web Server Sketch
Next you need to create a web server sketch that will handle the HTTP GET requests and provide the client devices with the HTML web page. The [Wi-Fi](https://www.arduino.cc/en/Reference/WiFi) library provides all necessary methods that allows Arduino boards to use their Wi-Fi features provided by the on-board Wi-Fi module. To set up the web server copy the following code, paste it into a new sketch file and name it **SimpleWebServer.ino**.

**Note:** You can access the final sketch inside the library: **Examples > Arduino_Pro_Tutorials > Portenta H7 as a Wi-Fi Access Point > SimpleWebServer**
**Note:** You can access the final sketch inside the library: **Examples > Arduino_Pro_Tutorials > Portenta H7 as a WiFi Access Point > SimpleWebServer**

```cpp
#include <WiFi.h>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -97,11 +97,11 @@ In case you need more instructions about how to install libraries, read this [gu

To use the Arduino Speech Recognition Engine, you will need a free trial license or paid license. In any of the cases, the serial number of the board that you are using is necessary to activate the license.

To get your board's serial number, and once you have the library downloaded, navigate to **File > Examples > Cyberon_DSpotterSDK > GetSerialNumber**.
To get your board's serial number, and once you have the library downloaded, navigate to **File -> Examples -> DSpotterSDK\_Maker\_<board_name> -> GetSerialNumber**.

Connect your board to the computer, upload the sketch to it and, once is done, open the **Serial Monitor** to see your device's Serial Number.

***On the Arduino IDE 1.6.x or previous versions, you can also find the serial number as follow: select the board's serial port and click on `tools > Get Board Info`, you will see the "SN" number, save it for later.***
***On the Arduino IDE 1.6.x or previous versions, you can also find the serial number as follow: select the board's serial port and click on `tools -> Get Board Info`, you will see the "SN" number, save it for later.***

#### Get the Demo License

Expand All @@ -117,7 +117,7 @@ Once everything is ready, click on the **submit** button to get your license, it

### Test the Free Demo Sketch

* Open the sketch **File > Example > Cyberon_DSpotterSDK > VoiceRecognition**
* Open the sketch **File -> Examples -> DSpotterSDK\_Maker\_<board_name> -> VoiceRecognition**
* Navigate to the `CybLicense.h` tab.
* Paste your license between the brackets, like in the following example:
```cpp
Expand Down Expand Up @@ -193,7 +193,7 @@ Once everything is checked, click **Confirm** and you will get the model header

You will now get some files in your e-mail inbox. Download them to your computer.

On the IDE, open the example **File > Examples > Cyberon_DSpotterSDK > VoiceRecognition** and click **File > Save As...** and type a name for your sketch.
On the IDE, open the example **File -> Examples -> DSpotterSDK\_Maker\_<board_name> -> VoiceRecognition** and click **File -> Save As...** and type a name for your sketch.

Once it is saved, open your File Explorer, and navigate to your sketch path.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ First, please go to [Go's download page](https://golang.org/dl/) and follow the

### Set up the Board

First, you need to download the library **Arduino_BHY2** in the Arduino IDE. Next, you need to upload the **App.ino** example sketch inside the library. This sketch can be found in: **Examples > Arduino_BHY2 > App.ino**. Select the sketch and upload it to your board.
First, you need to download the library **Arduino_BHY2** in the Arduino IDE. Next, you need to upload the **App.ino** example sketch inside the library. This sketch can be found in: **Examples > Arduino_BHY2 > App**. Select the sketch and upload it to your board.

### Use the Bhy-Controller

Expand Down Expand Up @@ -132,7 +132,7 @@ bhy sensor read -live -p <YourCOMPort>
```

## Using a Passthrough Board with CLI
When you have a firmware for the BHI module or a sketch for the MCU already compiled in a **.bin** file, you can upload them through a MKR or Portenta board directly using the terminal. You need to upload a passthrough sketch to the MKR or Portenta board, allowing the Nicla to communicate with the computer through the host board. The sketch can be found at **Examples > Arduino_BHY_HOST > Passthrough.ino**.
When you have a firmware for the BHI module or a sketch for the MCU already compiled in a **.bin** file, you can upload them through a MKR or Portenta board directly using the terminal. You need to upload a passthrough sketch to the MKR or Portenta board, allowing the Nicla to communicate with the computer through the host board. The sketch can be found at **Examples > Arduino_BHY2Host > Passthrough**.

You then need to connect the Nicla board to the desired passthrough board either with an Eslov cable or you can mount the Nicla onto the board as a shield. If you wish to mount the Nicla as a shield, take a look at this [tutorial](./use-as-mkr-shield). Now that you have everything set up, you can use the commands below to upload the firmware or a sketch if they are in the right format.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ For further tips on how to operate the Nicla module check the [cheat sheet](http

The **Nicla Sense ME** will be listening to the Host board to send back the required data, this is all automated via the libraries **Arduino_BHY2** and **Arduino_BHY2Host**

The code is available inside the examples provided with the **Arduino_BHY2** Library. Open it by going to **Examples > Arduino_BHY2 > App.ino**
The code is available inside the examples provided with the **Arduino_BHY2** Library. Open it by going to **Examples > Arduino_BHY2 > App**.

This is the code, which initialize the sensors, and maintain the communication:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1143,7 +1143,7 @@ In this example, a Portenta C33 will be used as a gateway to forward Nicla Sense

The **Nicla Sense ME** will be listening to the Host board to send back the required data. This is all automated via the libraries **Arduino_BHY2** and **Arduino_BHY2Host**.

The code is available inside the examples provided with the Arduino_BHY2 Library. Open it by going to **Examples > Arduino_BHY2 > App.ino**.
The code is available inside the examples provided with the Arduino_BHY2 Library. Open it by going to **Examples > Arduino_BHY2 > App**.

```arduino
#include "Arduino.h"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -718,7 +718,7 @@ void loop() {
```
![Accelerometer and gyroscope output in the serial plotter](assets/imu-output.png)

***To test a Machine Learning model on the Arduino IDE, navigate to __File > Examples > MLC > NiclaVision_MLC_Motion_Intesity__ and it will identify three scenarios: `Stationary`, `Medium Intensity` and `High Intensity` movements.***
***To test a Machine Learning model on the Arduino IDE, navigate to __File > Examples > MLC > NiclaVision_MLC_Motion_Intensity__ and it will identify three scenarios: `Stationary`, `Medium Intensity` and `High Intensity` movements.***

### Microphone

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -157,11 +157,11 @@ The first step to connect your Opta™ device is getting the **device data endpo

The next step depends on the variant of your Opta™ device you have.

- **For Opta™ Lite (SKU: AFX00003)**: Open the AWS IoT Ethernet example sketch in the Arduino IDE using the File > Examples > Arduino Cloud Provider Examples > AWSIoT > AWS_IoT_Opta > **AWS_IoT_Opta_ethernet.ino**
- **For Opta™ Lite (SKU: AFX00003)**: Open the AWS IoT Ethernet example sketch in the Arduino IDE using the File > Examples > Arduino Cloud Provider Examples > AWS IoT > AWS_IoT_Opta > **AWS_IoT_Opta_Ethernet**

- **For Opta™ RS485 (SKU: AFX0001)**: Open the AWS IoT Ethernet example sketch in the Arduino IDE using the File > Examples > Arduino Cloud Provider Examples > AWSIoT > AWS_IoT_Opta > **AWS_IoT_Opta_ethernet.ino**
- **For Opta™ RS485 (SKU: AFX0001)**: Open the AWS IoT Ethernet example sketch in the Arduino IDE using the File > Examples > Arduino Cloud Provider Examples > AWS IoT > AWS_IoT_Opta > **AWS_IoT_Opta_Ethernet**

- **For Opta™ WiFi (SKU: AFX00002)**: If you connect using Ethernet, open the AWS IoT Ethernet example sketch in the Arduino IDE using the File > Examples > Arduino Cloud Provider Examples > AWSIoT > AWS_IoT_Opta >AWS_IoT_Opta_ethernet > **AWS_IoT_Opta_ethernet.ino**. If you connect using Wi-Fi®, open the AWS IoT Wi-Fi® example sketch in the Arduino IDE using the File > Examples > Arduino Cloud Provider Examples > AWSIoT > AWS_IoT_Opta->AWS_IoT_Opta_wifi > **AWS_IoT_Opta_wifi.ino**
- **For Opta™ WiFi (SKU: AFX00002)**: If you connect using Ethernet, open the AWS IoT Ethernet example sketch in the Arduino IDE using the File > Examples > Arduino Cloud Provider Examples > AWS IoT > AWS_IoT_Opta > **AWS_IoT_Opta_Ethernet**. If you connect using Wi-Fi®, open the AWS IoT Wi-Fi® example sketch in the Arduino IDE using the File > Examples > Arduino Cloud Provider Examples > AWS IoT > AWS_IoT_Opta > **AWS_IoT_Opta_WiFi**

In the `arduino_secrets.h` tab update the Wi-Fi® Setting with the SSID and password of your Wi-Fi® network. Update the `secret_broker` with the device data endpoint captured before, and update the `secret_port` with the proper port used to connect to AWS IoT. Finally, open the certificate file you downloaded with a text editor and copy/paste the value in the sketch in the `secret_certificate` area. In the image below, the `arduino_secrets.h` tab for the `AWS_IoT_Opta_wifi.ino` sketch is shown.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ The **GIGA R1** can be programmed through:

The GIGA R1 is based on the [Arduino Mbed OS GIGA Board Package](/tutorials/giga-r1-wifi/giga-getting-started), which also provides a set of examples that works out of the box.

These examples are available in the Arduino IDE via **File > Examples > Examples for GIGA**.
These examples are available in the Arduino IDE via **File > Examples > Examples for Arduino GIGA R1**.

### Mbed OS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ In this section you will find a series of examples that uses the microphone.

### PDM Example

This sketch can be found in **File > Examples > PDM** in the Arduino IDE. It reads the microphone data, stores it in a buffer and prints it to the Serial Monitor / Serial Plotter tool in the IDE.
This sketch can be found in **File > Examples > PDM > PDMSerialPlotter** in the Arduino IDE. It reads the microphone data, stores it in a buffer and prints it to the Serial Monitor / Serial Plotter tool in the IDE.

```arduino
#include <PDM.h>
Expand Down
Loading