Skip to content

Commit e0212ce

Browse files
committed
Update ssh.md
1 parent 24931e7 commit e0212ce

File tree

1 file changed

+30
-32
lines changed
  • content/hardware/02.uno/boards/uno-q/tutorials/05.ssh

1 file changed

+30
-32
lines changed

content/hardware/02.uno/boards/uno-q/tutorials/05.ssh/ssh.md

Lines changed: 30 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -7,37 +7,36 @@ author: Karl Söderby
77

88
The [Arduino® UNO Q](https://store.arduino.cc/products/uno-q) can be programmed via the [Arduino App Lab](/software/app-lab/), a desktop application supporting code editing and running [Apps](/software/app-lab/tutorials/getting-started/#create--run-apps) on the board without any external tools.
99

10-
The board's microprocessor (running Debian OS) can also be accessed using Secure Shell (SSH), a method that allows remote connection to your board over a local network. This allows you to among other things:
10+
The board's microprocessor (running Debian OS) can also be accessed using Secure Shell (SSH), a method that allows remote connection to your board over a local network. This allows you to, among other things:
1111
- Access the board's shell and perform operations on the board remotely.
12-
- Transfer files from your local computer to the board remotely (using SCP)
12+
- Transfer files from your local computer to the board remotely (using SCP).
1313

14-
The UNO Q board comes pre-packaged with the Arduino App Lab, which is based on the `arduino-app-cli` tool<sup>1</sup> This allows you among other things, to **launch Apps through the command line**, instead of using the desktop App.
14+
The UNO Q board comes pre-packaged with the Arduino App Lab, which is based on the `arduino-app-cli` tool<sup>1</sup>. This allows you, among other things, to **launch Apps through the command line**, instead of using the desktop App.
1515

16-
<sup>1</sup> Read more about the `arduino-app-cli` in the [Arduino App CLI guide](/software/app-lab/tutorials/cli/)
16+
<sup>1</sup> Read more about the `arduino-app-cli` in the [Arduino App CLI guide](/software/app-lab/tutorials/cli/).
1717

1818
## Requirements
1919

2020
### Hardware Requirements
2121

2222
- [Arduino® UNO Q](https://store.arduino.cc/products/uno-q)
23-
- 5 VDC 3 A power supply (e.g. a phone charger or USB port from computer)
23+
- 5 VDC 3 A power supply (e.g., a phone charger or USB port from a computer)
2424

2525
### Software Requirements
2626

2727
- [First setup](/software/app-lab/tutorials/getting-started/#install--set-up-arduino-app-lab) of board completed\*
28-
- A SSH client tool installed on computer (MacOS, Windows 10+, Ubuntu has built-in SSH client tools)
29-
- Access to local Wi-Fi® network (both computer & board needs to be on the same network)
30-
31-
***During the first setup, Wi-Fi® credentials are entered, and the board will automatically enable SSH - without completing it, it is not possible to access the board via SSH unless activated manually.***
28+
- An SSH client tool installed on the computer (macOS, Windows 10+, Ubuntu has built-in SSH client tools)
29+
- Access to a local Wi-Fi® network (both computer & board need to be on the same network)
3230

31+
***During the first setup, Wi-Fi® credentials are entered, and the board will automatically enable SSH. Without completing it, it is not possible to access the board via SSH unless activated manually.***
3332

3433
## Installing SSH (Local Computer)
3534

36-
SSH is a network protocol, and not a tool itself. There are many different SSH tools to choose from, and most operating systems has a built-in tool. In this section, we will cover how to set it up on some common operating systems (MacOS, Windows, Ubuntu).
35+
SSH is a network protocol, not a tool itself. There are many different SSH tools to choose from, and most operating systems have a built-in tool. In this section, we will cover how to set it up on some common operating systems (macOS, Windows, Ubuntu).
3736

38-
### MacOS
37+
### macOS
3938

40-
MacOS features a built-in `ssh` tool based on [OpenSSH](https://www.openssh.com/), and **should work out of the box**. Check if the tool is present on your machine by running the following in a terminal:
39+
macOS features a built-in `ssh` tool based on [OpenSSH](https://www.openssh.com/), and **should work out of the box**. Check if the tool is present on your machine by running the following in a terminal:
4140

4241
```sh
4342
ssh -V
@@ -51,7 +50,7 @@ OpenSSH_9.9p2, LibreSSL 3.3.6
5150

5251
Which means it is working properly. ✅
5352

54-
***If you are running an outdated/custom system that for some reason does not feature SSH, you can look into installing [OpenSSH](https://formulae.brew.sh/formula/openssh) and [LibreSSL](https://formulae.brew.sh/formula/libressl) manually via e.g. Brew.***
53+
***If you are running an outdated/custom system that for some reason does not feature SSH, you can look into installing [OpenSSH](https://formulae.brew.sh/formula/openssh) and [LibreSSL](https://formulae.brew.sh/formula/libressl) manually via, e.g., Brew.***
5554

5655
### Windows
5756

@@ -69,11 +68,11 @@ OpenSSH_for_Windows_x.x, LibreSSL 3.x.x
6968

7069
This means it is working properly. ✅
7170

72-
***For older Windows machines, use a package manager such as [Chocolatey](https://chocolatey.org/) to install the OpenSSH / LibreSSL.***
71+
***For older Windows machines, use a package manager such as [Chocolatey](https://chocolatey.org/) to install OpenSSH / LibreSSL.***
7372

7473
### Linux (Ubuntu)
7574

76-
Many Linux OS include SSH clients, with no requirement to install additional tools. To verify tools are installed, open a terminal on your Windows machine, and type:
75+
Many Linux OS include SSH clients, with no requirement to install additional tools. To verify tools are installed, open a terminal on your Ubuntu machine, and type:
7776

7877
```sh
7978
ssh -V
@@ -91,25 +90,25 @@ This means it is working properly. ✅
9190

9291
## Connecting via SSH
9392

94-
To connect to an UNO Q board via SSH, we only need to know the **board name and password**. This is setup during the first setup.
93+
To connect to an UNO Q board via SSH, we only need to know the **board name and password**. This is set up during the first setup.
9594

96-
1. Open a terminal
95+
1. Open a terminal.
9796
2. Run the following command:
9897

9998
```sh
100-
ssh arduino@<boardname>.local #replace <boardname> with your boardname
99+
ssh arduino@<boardname>.local #replace <boardname> with your board name
101100
```
102101

103102
3. Type `yes` when asked to connect.
104103
4. Enter the password for the board.
105104

106-
After entering the password, we should be entering the board's shell, and we can now perform operations!
105+
After entering the password, you should enter the board's shell, and you can now perform operations!
107106

108-
See below how it should look like when we have successfully accessed the board's shell.
107+
See below how it should look when you have successfully accessed the board's shell.
109108

110-
### MacOS Confirmation
109+
### macOS Confirmation
111110

112-
![MacOS SSH access](assets/ssh-macos.png)
111+
![macOS SSH access](assets/ssh-macos.png)
113112

114113
### Windows Confirmation
115114

@@ -121,15 +120,15 @@ See below how it should look like when we have successfully accessed the board's
121120

122121
## Arduino App CLI
123122

124-
The `arduino-app-cli` can be used to start & stop Apps on the board from the terminal. When accessing the board via SSH, we can run commands such as `arduino-app-cli app start <app>`.
123+
The `arduino-app-cli` can be used to start & stop Apps on the board from the terminal. When accessing the board via SSH, you can run commands such as `arduino-app-cli app start <app>`.
125124

126125
More details on the `arduino-app-cli` tool can be found in the [Arduino App CLI guide](/software/app-lab/tutorials/cli/).
127126

128127
## File Transfer
129128

130129
To transfer files from your computer to the board, use the `scp` tool. The tool can be used to either **push** or **pull** files to and from the board.
131130

132-
This is done by specifying a local path on your computer (e.g. `/User/documents/file.xx`), and a path on the board (e.g. `/home/arduino/`).
131+
This is done by specifying a local path on your computer (e.g., `/User/documents/file.xx`), and a path on the board (e.g., `/home/arduino/`).
133132

134133
### Push Files
135134

@@ -149,17 +148,16 @@ To **pull** a file, use the command below:
149148
scp arduino@<boardname>.local:/home/arduino/test-transfer.txt ./
150149
```
151150

152-
This will pull the file to the directory where you run the command. `./` can be replaced by specifying a path (e.g. `/User/documents/`).
153-
151+
This will pull the file to the directory where you run the command. `./` can be replaced by specifying a path (e.g., `/User/documents/`).
154152

155153
## Troubleshooting
156154

157-
If the SSH connection fails, there are some common things to check out:
158-
- Has the first setup been completed? If not, follow the instructions at [here](/software/app-lab/tutorials/getting-started/#install--set-up-arduino-app-lab) and see the instructions. The first setup will enable SSH on the board which is required to connect.
159-
- If the SSH connection gets stuck even though first setup has been completed, it may be a local network issue. Check that the board is connected to the same network as our computer.
155+
If the SSH connection fails, there are some common things to check:
156+
- Has the first setup been completed? If not, follow the instructions [here](/software/app-lab/tutorials/getting-started/#install--set-up-arduino-app-lab) and see the instructions. The first setup will enable SSH on the board, which is required to connect.
157+
- If the SSH connection gets stuck even though the first setup has been completed, it may be a local network issue. Check that the board is connected to the same network as your computer.
160158

161-
### Issues with MDNS
159+
### Issues with MDNS
162160

163161
Some networks may block using mDNS, which allows us to use a "friendly" name (`arduino@<boardname>.local`), instead of using the actual IP address of the board. There are two ways to work around this:
164-
1. Instead of using `arduino@<boardname>.local`, use the board's IP address directly. The IP address can be accessed by either launching board in SBC mode, and typing `hostname -I` in a terminal. This will reveal the IP address of your board.
165-
2. (advanced) Edit the `/etc/hosts` on your local computer by running `sudo nano /etc/hosts`. In the bottom of the file, add `<boardipaddress> <boardname>.local`. This will allow you to connect using `ssh arduino@<boardname>.local`.
162+
1. Instead of using `arduino@<boardname>.local`, use the board's IP address directly. The IP address can be accessed by either launching the board in SBC mode and typing `hostname -I` in a terminal. This will reveal the IP address of your board.
163+
2. (advanced) Edit the `/etc/hosts` on your local computer by running `sudo nano /etc/hosts`. At the bottom of the file, add `<boardipaddress> <boardname>.local`. This will allow you to connect using `ssh arduino@<boardname>.local`.

0 commit comments

Comments
 (0)