You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/06-cli-getting-started.md
+9-9Lines changed: 9 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -3,12 +3,12 @@
3
3
Getting Started With the `Arduino CLI`
4
4
===============
5
5
## Introduction
6
-
For now, you need to use the Arduino CLI to upload sketches made with the Arduino_Threads library. It can be intimidating at first, but once you get the hang of it, it is not that different from working in the IDE.
6
+
For now, you need to use the Arduino CLI to upload sketches made with the `Arduino_Threads` library. It can be intimidating at first, but once you get the hang of it, it is not that different from working in the IDE.
7
7
8
8
This document will help you get started, showing you how to find all the information you need to get off the ground without needing to go in depth and learn everything there is to know about the CLI.
9
9
10
10
## Installing
11
-
Installing the Arduino CLI is really just as simple as downloading it and extracting the files from the .zip archive, once it is on your computer it is installed. However, to keep your workflow tidy and organized, we recommend moving it to directory with a short path. If you have been using the Arduino IDE, most likely the files are stored in your `Documents` folder, so let's put the CLI files in the same place.
11
+
To use the Arduino_Threads library, a special version of the Arduino CLI needs to be downloaded and installed. Installing the Arduino CLI is really just as simple as downloading it and extracting the files from the .zip archive, once it is on your computer it is installed. However, to keep your workflow tidy and organized, we recommend moving it to a directory with a short path. If you have been using the Arduino IDE, most likely the files are stored in your `Documents` folder, so let's put the CLI files in the same place.
12
12
13
13
Make a new folder in your `Documents` folder, and name it `CLI`, extract the files from the .zip archive to this folder.
14
14
@@ -34,12 +34,12 @@ cd ..
34
34
```
35
35
But we don't need to do that now, we want to be inside of the `CLI` folder, that is inside of the `Documents` folder.
36
36
37
-
Navigate to it with the command
37
+
Navigate to it with the command:
38
38
```
39
39
cd Documents/CLI
40
40
```
41
41
42
-
Once inside of `CLI`, you're ready to launch the Arduino CLI. Execute this command:
42
+
Once inside of `CLI`, you're ready to launch the Arduino CLI. Launching it this way, ensures that you are launching the special versin of the CLI that can handle the `Arduino_Threads` library. Execute this command:
43
43
```
44
44
start arduino-cli.exe
45
45
```
@@ -57,18 +57,18 @@ arduino-cli
57
57
If you get a list of all the available commands, everything is as it should, and you can move on to the next step.
58
58
59
59
## Finding Information About your Board
60
-
To compile sketches and to upload to your Arduino board, you need to know some information about the board you have connected, in this step we're going to find all the information we need. Connect your Arduino board to your computer, and execute the command:
60
+
To compile sketches and to upload to your Arduino board, you need to know some information about the board you have connected. In this step we're going to find all the information we need. Connect your Arduino board to your computer, and execute the command:
61
61
```
62
62
arduino-cli board list
63
63
```
64
-
If your board was found, you will get a bunch of information about it. The information we're interested in is the `FQBN`, and the port. `FQBN` stands for "Fully Qualified Board Name", and is how the computer refers to the board, the port is like an address for the board.
64
+
If your board was found, you will get a bunch of information about it. The information we're interested in is the `FQBN`, and the port. `FQBN` stands for "Fully Qualified Board Name", and is how the computer refers to the board. The port is like an address for the board.
65
65
66
66

67
67
68
-
If you are, like we are, using an Arduino Nano 33 BLE Sense, the `FQBN` will be `arduino:mbed_nano:nano33ble`, and we need to specify every time we are compiling and uploading sketches, that they need to be compiled for this board, just like we do in the IDE.
68
+
If you are, like we are, using an Arduino Nano 33 BLE Sense, the `FQBN` will be `arduino:mbed_nano:nano33ble`. We need to specify every time we are compiling and uploading sketches that they are to be compiled for this board, just like we do in the IDE.
69
69
70
70
## Installing Cores
71
-
If you have already used your Arduino board with the IDE, you can skip this step entirely. Otherwise, there are some files you may need to install to be able to use the board. But don't worry, it's just one command. The Arduino Nano 33 BLE Sense uses the `arduino:mbed_nano` core, which is another piece of information that we got from the last command we executed, so we need to install that before using the board.
71
+
If you have already used your Arduino board with the IDE, you can skip this step entirely. Otherwise, there are some files you may need to install to be able to use the board. But don't worry, it's just one command. The Arduino Nano 33 BLE Sense uses the `arduino:mbed_nano` core, which is another piece of information that we got from the board list command we executed, so we need to install that before using the board.
72
72
73
73
If you are unsure whether or not you have the core installed, go through with this step. If it is already installed, it won't do any harm to do it again.
74
74
@@ -99,7 +99,7 @@ Once you execute this command, it's going to start compiling unless something we
Now that the sketch is compiled, let's upload it! For this, we need to specify the FQBN again, as well as the port the board is connected to, so it's uploaded to the right place. To find the port, go back to the board list we got earlier, mine is connected to port `COM14`, but replace this part of the command with whatever port your list says. Now execute the command:
102
+
Now that the sketch is compiled, let's upload it! For this, we need to specify the FQBN again, as well as the port the board is connected to, so it's uploaded to the right place. To find the port, go back to the board list we got earlier, ours is connected to port `COM14`, but replace this part of the command with whatever port your list says. Now execute the command:
0 commit comments