RaspberryPi:Networking

There are many ways to interface with the Pi. This page will cover types of network connectivity. For more comprehensive, advanced networking details, see RaspberryPi:AdvancedConnectivity.

A Brief Overview of Networks

It is useful to have a basic idea of how networks, IP addresses, and subnets work. For this, it it suggested you read this article from Microsoft.

Wireless Connectivity

WiFi connectivity is a useful way of connecting the Pi to the internet as it enables more portability. You can adjust WiFi Connections either before boot, by creating a wpa_cupplicant.conf file on the boot partition, or while the pi is running, either by editing /etc/wpa/wpa_supplicant.conf directly, or using $ sudo raspi-config. Note that the raspi-config method will not work for Eduroam.

Simple Wifi Connections

If the Pi is up and running and you have access to it, you can run $ sudo raspi-config and enable WiFi using that menu, or editing /etc/wpa/wpa_supplicant.conf directly using an editor such as nano. However if you don't have access, you can create a a wpa_supplicant.conf file on the SD card, on the boot partition while it is plugged into another system.

If editing the wpa_supplicant configuration file, the contents should look something like the following:

ctrl_interface=DIR=/var/run/wpa_supplicant GROUP=netdev
update_config=1
country=ZA

network={
 ssid="<Name of your WiFi network>"
 psk="<Password for your WiFi network>"
}

Connecting to Eduroam

Connecting to Eduroam requires a fair amount of configuration which depends on your operating system. Generally though, edits to wpa_supplicant.conf and dhcpcd.conf are sufficient. Note that there are new releases of Raspberry Pi OS, and it is unknown if the edits for Buster are still required.

[Show/hide]

Raspbian Buster

Note: There have been updates to the Buster code base, and roll back of wpasupplicant might not be required. However this is currently unable to be tested due to the lockdown. If someone has the chance to test, please update this page accordingly. These instructions come from here.
Unfortunately, when you use bleeding edge technology, you may end up cutting yourself. Raspbian Buster updates wpa_supplicant to a version that doesn’t have support for the authentication method used by Eduroam. So we need to roll back wpa_supplicant to an older version. Ensure your Pi has internet access through a method such as Ethernet passthrough, and run the following:

$ sudo apt-get remove wpasupplicant

Edit /etc/apt/sources.list :

$ sudo nano /etc/apt/sources.list

And change

deb http://raspbian.raspberrypi.org/raspbian/ buster main contrib non-free rpi

to

deb http://raspbian.raspberrypi.org/raspbian/ stretch main contrib non-free rpi

Run

$ sudo apt-get update
$ sudo apt-get install wpasupplicant

This will install the correct version of wpa_supplicant. Check that version 2.4 is installed by running

$ wpa_supplicant -v

Now, change the sources file back.

$ sudo nano /etc/apt/sources.list

And edit the contents to contain

deb http://raspbian.raspberrypi.org/raspbian/ buster main contrib non-free rpi

Finally, run

$ sudo apt-get update

To update sources The correct version of wpa_supplicant should now be installed, and you can configure your Pi for WiFi as you would if you were using Raspbian Stretch as explained in below.

Raspbian Stretch

This section provides the instructions on how to configure the Pi to use Eduroam. It is possible to do using the GUI through VNC, but we will not cover that here.

1. SSH into your Pi.

2. Generate a hash for your password. Take note of it as it is needed in a later step

   $ echo -n your_uct_password_here | iconv -t utf16le | openssl md4
   

3. Open /etc/wpa_supplicant/wpa_supplicant.conf

   $ sudo nano /etc/wpa_supplicant/wpa_supplicant.conf

4. Edit it so it looks as follows:

       ctrl_interface=DIR=/var/run/wpa_supplicant GROUP=netdev
       update_config=1
       country=ZA
   
       network={
       ssid="eduroam"
       key_mgmt=WPA-EAP
       identity="studentnumber@wf.uct.ac.za"
       password=hash:generated_hash_from_earlier
       }
       

5. Save the file

6. Open /etc/dhcpcd.conf

    $ sudo nano /etc/dhcpcd.conf

7. Make sure the following lines are in the document:

   interface wlan0
   metric 200
   

8. Reboot your Pi

9. WiFi Generally takes a little longer to initialize than Ethernet, so give it time. You can see if it’s ready by running

   $ ifconfig 

   And seeing if an IPv4 address (“inet”) has been given.

10. Test your configuration by pinging from the WiFi interface:

    $ ping google.com -I wlan0

Ethernet Connectivity

Ethernet is the physical connection made using a CAT 5 or 6 cable - though there are ways that Ethernet can be mimicked over USB (see Details on the Pi 0 and 0W for more information).

There are two sorts of Ethernet Connectivity we will consider. The first is just connecting the Pi to a known Ethernet network. It is simple as it requires no configuration, but it means you will need to use other methods to ensure the network allows SSH traffic and to ensure you can determine the IP of the Pi.

The second is using Ethernet passthrough from your computer to the Raspberry Pi. This leaves the WiFi free to host your own access point, and you can host services such as a Node-Red server or media center on the Pi.

If you're on a private network, connecting your Pi to a router will usually just assign it an IP address and internet connectivity automatically works. If you're on a linux-based system, like Ubuntu, you can use the hostname of the Pi to connect. By default this is "raspberrypi", so you could SSH in using "SSH pi@raspberrypi". However, in most cases, you'll want to know the IP address and assign a static IP address.

Static IPs

Setting a static IP makes it easy to access the Pi and ensures that the IP address of the Pi is always known. In this course, we assign the Pi an IP address of 192.168.137.15. The reason for this is that when using Ethernet Passthrough on Windows, Windows asserts a domain of 192.168.137.x, with the host PC being assigned 192.168.137.1. Keep in mind that all devices will need to be on the same subnet though, so if you're assigning a static IP to be used on your own Ethernet network, you need to know what the subnet of that network is.

If you're connecting your Pi through your desktop, you'll need to assign a static IP to the desktop, too.

Setting a static IP on your Desktop

If you're connecting your Pi through your desktop, you'll need to assign a static IP to the desktop, too. If you're setting a static IP on a Pi that's already connected directly to the network through a router or similar network switch, you can ignore setting a static IP on the computer.

Windows

[Show/hide]

To change the IP of your Ethernet port on Windows 10, complete the following steps:

• Right click on your network option in Windows taskbar
• Select “Open Network & Internet Settings”, on the lower right hand side of the screen.
• Select “Change Adapted Options”
• Right click on the Ethernet Connection and select “Properties”
• Select “Internet Protocol Version 4 (TCP/IPv4) and click ”Properties"
• Select “Use the following IP address:” and enter in the following options:
  

- IP Address: 192.168.137.1
- Subnet Mask: 255.255.255.0

• You have successfully changed the IP of the Ethernet card on your computer. It is suggested that you now ensure connectivity by attempting to ping the Pi.

The IPv4 configuration screen in Windows 10

Ubuntu

[Show/hide]

To change the IP of your Ethernet port on Ubuntu, complete the following steps:

• Click the network interface icon on the status bar and select Wired Settings
• Click the gear button of the interface you’d like to change
• Select the IPv4 Tab, and change the IPv4 method to Manual
• Under “Addresses” enter in the following:
  

- IP Address: 192.168.137.1
- Subnet Mask: 255.255.255.0

• You can leave Gateway and DNS blank

The IPv4 configuration screen in Ubuntu 18.10

Setting a static IP on the Pi

To set a static IP on the Pi, you have multiple options. You can do it before first boot by addling a line to cmdline.txt on the boot partition of the SD card, or once the Pi is running by editing dhcpcd. Before setting the static IP, ensure you have the correct subdomain, and that you don't assign an IP that another device on the network is using. If you're assinging it a static IP and you have, for example, a router acting as a DHCP server, ensure the IP you assign is outside of DHCP range.

From the boot partition

[Show/hide]

1. Insert the SD card into your computer and navigate to the BOOT partition

2. Open “cmdline.txt” and append the following to the line (don’t create a new line)

    ip=192.168.137.15 

   This tells the Raspberry Pi to configure the Ethernet port to use the IP address 192.168.137.15

3. Enable SSH as per Section [sec:SSH].

4. You need to configure your PC to use the same subnet as the Pi. To do so, see the information below in the section on Assigning a static IP to the Pi.

In dhcpcd (while the Pi is running)

[Show/hide]

Once you’ve successfully SSH’d into your Pi, it’s a good idea to configure the networking options in the config files directly. You will need to set a static IP on the computer first if you are SSH'ing through an Ethernet connection.

Use a text editor such as nano to open /etc/dhcpcd.conf as sudo user, and edit it to the following:

# Static IP profile for eth0
profile static_eth0
static ip_address=192.168.137.15/24
static routers=192.168.137.1
static domain_name_servers=192.168.137.1 8.8.8.8

# Ethernet interface configuration 
interface eth0
fallback static_eth0

# Wireless configuration
interface wlan0
metric 200

WiFi to Ethernet Passthrough

In a situation when you can't or don't want to connect to a WiFi network, but are connected to a computer through an Ethernet port There may be a situation in which you want your Pi to work as an access point rather than using the WiFi interface to provide the Pi with internet access. In this situation, you need to get internet access through the Ethernet port. Before starting, you need to ensure the computer you're using has a static IP assigned. When enabling network sharing on Windows, it automatically assigns 192.168.137.1. Once that's done, complete the following to enable network sharing:

Windows

[Show/hide]

1. Ensure the Pi is unplugged
2. Right click on your network option in Windows taskbar
3. Select “Open Network & Internet Settings”, on the lower right hand side of the screen.
4. Select “Change Adapted Options”
5. Right click on your WiFi network and select “Properties”
6. Click the “Sharing” tab, and enable the first checkbox <ref>This setting is what forces us to have to use the subnet 192.168.137.x.</ref>
7. Select the Ethernet connection that your Pi will be using in the drop down box (Usually just “Ethernet”, but may be different if there are multiple Ethernet posts on your system)

Using WiFi to Ethernet passthrough in Windows

Ubuntu

[Show/hide]

1. Ensure the Pi is unplugged and turned off.
2. Open a terminal and run nm-connection-editor
3. Select the wired connection you’d like to share your WiFi to
4. Select the IPv4 settings tab
5. Under Method, select “Shared to other computers”
6. under the IP addresses, click “Add” and enter in an address of 192.168.137.1, and a netmask of 24
7. Select “Save”, and close the windows
8. Plug in the Pi, start an SSH session and see if you can ping google.co.za

nm-connection-editor in Ubuntu 18.10

Other Connectivity Methods

There are ways other than WiFi and Ethernet as a means of connecting headlessly (without a keyboard and screen directly attached) to the Pi.

TTL over USB

Note: The Pi uses 3.3V logic levels. Using a 5V logic module will permanently damage the pins.

This option allows you to use a USB to UART converter such as a FT232R or CP2102. Begin by removing the SD card, and insert it into a computer. Make the following changes on the boot partition:

cmdline.txt: add the following (on the same line)

console=serial0,115200 

config.txt

uart_enable=1
dtoverlay=pi3-disable-bt

Using USB connectivity on the Pi 0/0W

In order to use this method on Windows you require Apple Bonjour Print Services as well as PuTTY.

With the SD card plugged into your computer, open up the boot partition and make the following changes:

1. Be sure to enable SSH as described at RaspberryPi:Networking#Enabling_SSH
2. At the bottom of config.txt, add the following line

   dtoverlay=dwc2

3. On the same line in cmdline.txt, append the following:

    modules-load=dwc2,g_ether

Open up a terminal window (or PuTTY if you're on Windows). After about 90 or so seconds, you should be able to SSH in (assuming you enabled SSH on the Pi) by connecting to raspberrypi.local. You may (if you're using PuTTY) get a message about keys and hashes and hosts - just click "yes". You can then log in with the username "pi" and the password "raspberry".

Internet Access over USB

If you don't have WiFi connectivity, you can send an internet connection from your computer over USB.

In order to provide the Pi with internet access, you need to do the following:

1. Share your computer's connection with the Pi as you have done in the "WiFi to Ethernet Passthrough" section above. You will be sharing your regular connection with an Ethernet connection, as that is how the Pi 0 has been set up. In the test I ran
3. On the Pi, you need to configure DHCPCD to have usb0 use a static IP of 192.168.137.x. The rest of this wiki has been written with x=15
4. SSH in using "raspberrypi.local" as the address to connect to
5. Run sudo nano /etc/dhcpcd.conf, scroll to the bottom, and add the following:

   interface usb0
   static ip_address=192.168.137.15
   static router = 192.168.137.1
   static domain_name_servers=192.168.137.1 8.8.8.8
   

6. Save and close the file
7. Run the command sudo route add default gw 192.168.137.1
8. Reboot the Pi
9. SSH in again. You should be able to ssh in using "192.168.137.15" now, as well as "raspberrypi.local"
10. To test connectivity, try pinging google.com. You should get a valid response back.

Ensuring Connectivity

Sometimes you may want to debug your connection to the Pi. A fast way to do this is via the ping command. Ping sends a packet to a particular host (in this case the Pi), and measures the time taken for a response from that host.

To use the ping command, open a command prompt window or terminal and type the following:

$ ping 192.168.137.15

If that host is unreachable (the Pi hasn’t booted yet or is incorrectly configured), a message will show that the host is unreachable. If everything was correctly configured, you should get

Reply from 192.168.137.15: bytes=32 time<1ns TTL=64

This means your Pi and computer are both correctly configured. See section [sec:SSH] for configuring your Pi for SSH access.

NB: Don’t be surprised if you can’t ping a Windows machine from your Pi. Windows blocks the specific type of packet required for a ping in the firewall.

Networking Protocols

For a more detailed overview on useful networking protocols, see Network Protocols

SSH

Enabling SSH

If you have not connected to your Pi and configured it for SSH, you need to do so. SSH is disabled by default on new installations of Raspbian.

To enable SSH, add it as an enabled service in the raspi-config menu. If you do not have access to the Pi as yet, do the following:

1. Insert the SD card into a computer
2. Navigate to the BOOT partition
3. Create a file called “ssh”. Note there is no file extension!
4. Your Pi will enable SSH upon next boot

Using SSH

To use SSH on your Pi, you need to connect to the computer to a network. See Section [sec:NetworkingOnThePi] on various ways that can be done (it is suggested to use Ethernet upon first connection).

Once your Pi is connected to the computer and you have ensured connection (see Section [sec:Connectivity-EnsuringConnectivity]), use can log in to your Pi via SSH. If you are on a Linux-based system, such as Ubuntu or Mac, you should be able to run the following. Note that the default username is “pi” and the default password is “raspberry”.

$ ssh <username>@192.168.137.15

If you are on Windows, you may need to use PuTTY. Some instances of windows have SSH in the command line, and you can run the command shown above. But if not, you will need to do the following:

1. Open PuTTY
2. In the “Hostname” field, enter in “192.168.137.15”
3. Click “Open”. A terminal window will be opened. If it is the first time you’re SSH’ing into your Pi on this particular computer, you will be asked about the server fingerprint. Click “Yes” to continue.
4. You will be asked for a username and password. The default username is “pi” and the password is “raspberry”.
5. You should now successfully connected to your Raspberry Pi via SSH

VNC

To learn about how to install VNC, see

1. Ensure the VNC service is enabled on the Pi

1. Connect to the Pi through VNC.
2. Set your preferred resolution for Raspbian
   1. In the desktop menu, go to Preferences - Raspberry Pi Configuration and click the “Set Resolution” button.
   2. Select a more appropriate resolution (1280*720 suggested)
   3. Select “Okay” and then “Okay”. You will be asked to reboot your Pi, do so.
3. Set the VNC resolution
   1. Through editing /boot/config.txt, uncomment the following lines relating to framebuffer_width and framebuffer_height
   2. On the desktop on VNC, use the settings. Do this if you have already connected to VNC. This is a little more difficult as it required you to play with windows in order to see the buttons you need.