Skip to content
Binary file modified documentation/asciidoc/accessories/build-hat/images/setting-up.png
100755 → 100644
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

NOTE: Before starting to work with your Raspberry Pi Build HAT you should xref:../computers/getting-started.adoc#setting-up-your-raspberry-pi[set up] your Raspberry Pi, xref:../computers/getting-started.adoc#installing-the-operating-system[install] the latest version of the operating system using https://www.raspberrypi.com/downloads/[Raspberry Pi Imager].

Attach 9mm spacers to the bottom of the board. Seat the Raspberry Pi Build HAT onto your Raspberry Pi. Make sure you put it on the right way up. Unlike other HATs, all the components are on the bottom, leaving room for a breadboard or LEGO® elements on top.
Attach 9mm spacers to the bottom of the board. Seat the Raspberry Pi Build HAT onto your Raspberry Pi. Make sure you put it on the right way up. Unlike other HATs, all the components are on the bottom, leaving room for a breadboard or LEGO® elements on top.

video::images/fitting-build-hat.webm[width="80%"]

Expand All @@ -18,22 +18,22 @@ The following pins are used by the Build HAT itself and you should not connect a
[cols="^1,^1,^1", width="75%", options="header"]
|===
| GPIO| Use | Status
| GPIO0/1 | ID prom |
| GPIO4| Reset |
| GPIO14| Tx |
| GPIO15| Rx |
| GPIO0/1 | ID prom |
| GPIO4| Reset |
| GPIO14| Tx |
| GPIO15| Rx |
| GPIO16 | RTS | unused
| GPIO17 | CTS | unused
|===


=== Set up your Raspberry Pi

Once the Raspberry Pi has booted, open the Raspberry Pi Configuration tool by clicking on the Raspberry Menu button and then selecting "Preferences" and then "Raspberry Pi Configuration".
Once the Raspberry Pi has booted, open the Control Centre tool by selecting the Raspberry Menu button and then selecting **Preferences > Control Centre**.

Click on the "interfaces" tab and adjust the Serial settings as shown below:
Select the **Interfaces** tab and adjust the serial settings as shown in the following image:

image::images/setting-up.png[width="50%"]
image::images/setting-up.png["The Interfaces tab. SSH, VNC, and Serial Port are enabled. The rest of the options are not enabled.", width="50%"]

==== Use your Raspberry Pi headless

Expand Down
4 changes: 2 additions & 2 deletions documentation/asciidoc/accessories/display/display_intro.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ image::images/display.png[The Raspberry Pi 7-inch Touch Display, width="70%"]

The Touch Display is compatible with all models of Raspberry Pi, except the Zero series and Keyboard series, which lack a DSI connector. The earliest Raspberry Pi models lack appropriate mounting holes, requiring additional mounting hardware to fit the stand-offs on the display PCB.

The display has the following key features:
The display has the following key features:

* 800×480px RGB LCD display
* 24-bit colour
Expand Down Expand Up @@ -79,7 +79,7 @@ Raspberry Pi OS _Bookworm_ and later include the Squeekboard on-screen keyboard

For applications which do not support text entry detection, use the keyboard icon at the right end of the taskbar to manually show and hide the keyboard.

You can also permanently show or hide the on-screen keyboard in the Display tab of Raspberry Pi Configuration or the `Display` section of `raspi-config`.
You can also permanently show or hide the on-screen keyboard in the **Display** tab of Control Centre or the `Display` section of `raspi-config`.

TIP: In Raspberry Pi OS releases prior to _Bookworm_, use `matchbox-keyboard` instead. If you use the wayfire desktop compositor, use `wvkbd` instead.

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
28 changes: 14 additions & 14 deletions documentation/asciidoc/accessories/touch-display-2/about.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
The https://www.raspberrypi.com/products/touch-display-2/[Raspberry Pi Touch Display 2] is a portrait orientation touchscreen LCD (with rotation options) designed for interactive projects like tablets, entertainment systems, and information dashboards.
The https://www.raspberrypi.com/products/touch-display-2/[Raspberry Pi Touch Display 2] is a portrait orientation touchscreen LCD (with rotation options) designed for interactive projects like tablets, entertainment systems, and information dashboards.

.The Raspberry Pi Touch Display 2
image::images/touch-display-2-hero.jpg[width="80%"]
Expand Down Expand Up @@ -36,7 +36,7 @@ The Touch Display 2 is available in two sizes: 5-inch and 7-inch (measured diago
Touch Display 2 (both 5-inch and 7-inch) includes the following features:

* **720 x 1280 pixel resolution.** High-definition output.
* **24-bit RGB display.** Capable of showing over 16 million colours.
* **24-bit RGB display.** Capable of showing over 16 million colours.
* **Multitouch.** Supports up to five simultaneous touch points.
* **Mouse-equivalence.** Supports full desktop control without a physical mouse, for example, selecting, dragging, scrolling, and long-pressing for menus.
* **On-screen keyboard.** Supports a visual keyboard in place of a physical keyboard.
Expand All @@ -62,7 +62,7 @@ image::images/touch-display-2-whats-in-the-booooox.jpg["Parts included in the To
The Touch Display 2 connects to a Raspberry Pi using:

- A **DSI connector** for video and touch data.
- The **GPIO header** for power.
- The **GPIO header** for power.

To make the DSI connection, use a **Flat Flexible Cable (FFC)** included with your display. The type of FFC you need depends on your Raspberry Pi model:

Expand All @@ -78,7 +78,7 @@ After determining the correct FFC for your Raspberry Pi model, you can connect y
.A Raspberry Pi 5 connected and mounted to the Touch Display 2
image::images/touch-display-2-installation-diagram.png["A Raspberry Pi 5 connected and mounted to the Touch Display 2", width="80%"]

IMPORTANT: Disconnect your Raspberry Pi from power before completing the following steps.
IMPORTANT: Disconnect your Raspberry Pi from power before completing the following steps.

=== Step 1. Connect FFC to Touch Display 2

Expand All @@ -90,16 +90,16 @@ IMPORTANT: Disconnect your Raspberry Pi from power before completing the followi

=== Step 2. Connect FFC to Raspberry Pi

. Slide the retaining clip upwards from both sides of the DSI connector of your Raspberry Pi.
- This port should be marked with some variation of the term **DISPLAY**, **CAM/DISP**, or **DISP**.
. Slide the retaining clip upwards from both sides of the DSI connector of your Raspberry Pi.
- This port should be marked with some variation of the term **DISPLAY**, **CAM/DISP**, or **DISP**.
- If your Raspberry Pi has multiple DSI connectors, we recommend using the port labelled **1**.
. Insert the other end of your FFC into the Raspberry Pi DSI connector, with the metal contacts facing the Ethernet and USB-A ports.
. Hold the FFC firmly in place and simultaneously push the retaining clip back down on the FFC connector of the Raspberry Pi to secure the cable.

=== Step 3. Connect the GPIO power cable

. Plug the smaller end of the GPIO power cable into the **J1** port on the Touch Display 2.
. Connect the three-pin end of the GPIO power cable to your xref:../computers/raspberry-pi.adoc#gpio[Raspberry Pi's GPIO].
. Connect the three-pin end of the GPIO power cable to your xref:../computers/raspberry-pi.adoc#gpio[Raspberry Pi's GPIO].

This connects the red cable (5 V power) to pin 2 and the black cable (ground) to pin 6. Viewed from above, with the Ethernet and USB-A ports facing down, these pins are located in the top-right corner of the board, with pin 2 in the top right-most position.

Expand All @@ -123,7 +123,7 @@ Raspberry Pi OS **Bookworm** and later already includes the **Squeekboard on-scr

For applications that don't support text entry detection, you can manually show or hide the keyboard using the keyboard icon at the right side of the taskbar. You can also permanently show or hide the on-screen keyboard using the Raspberry Pi graphical interface or the command line.

- **Raspberry Pi desktop interface:** From the Raspberry Pi menu, go to **Preferences > Raspberry Pi Configuration > Display** and choose your on-screen keyboard setting.
- **Raspberry Pi desktop interface:** From the Raspberry Pi menu, go to **Preferences > Control Centre > Display** and choose your on-screen keyboard setting.
- **Command line:** Open a terminal and enter `sudo raspi-config`. Navigate to the **Display** section of `raspi-config` and then choose your keyboard setting.

== Change screen orientation
Expand All @@ -135,7 +135,7 @@ You have four rotation options:
- **0** maintains the default display position, which is a portrait orientation.
- **90** rotates the display 90 degrees to the right (clockwise), making it a landscape orientation.
- **180** rotates the display 180 degrees to the right (clockwise), which flips the display upside down.
- **270** rotates the display 270 degrees to the right (clockwise), which is the same as rotating the display 90 degrees to the left (counterclockwise), making it a landscape orientation.
- **270** rotates the display 270 degrees to the right (clockwise), which is the same as rotating the display 90 degrees to the left (counterclockwise), making it a landscape orientation.

=== With a desktop
If you have the Raspberry Pi OS desktop running, you can rotate the display through the **Screen Configuration** tool:
Expand All @@ -160,14 +160,14 @@ NOTE: You can't rotate the DSI display separately from the HDMI display with `cm

== Customise touchscreen settings

You can use the Device Tree overlay to tell Raspberry Pi OS how to configure the Touch Display 2 at boot.
You can use the Device Tree overlay to tell Raspberry Pi OS how to configure the Touch Display 2 at boot.

- For the 5-inch display, the overlay is called `vc4-kms-dsi-ili9881-5inch`.
- For the 7-inch display, the overlay is called `vc4-kms-dsi-ili9881-7inch`.

You can modify the Device Tree overlay in the boot configuration file (`/boot/firmware/config.txt`).

Open `/boot/firmware/config.txt` and then add the required Device Tree parameters to the `dtoverlay` line, separated by commas.
Open `/boot/firmware/config.txt` and then add the required Device Tree parameters to the `dtoverlay` line, separated by commas.

- Booleans (`invx`, `invy`, `swapxy`, and `disable_touch`) default to true if present, but you can set them to false using the suffix `=0`.
- Integers (`sizex` and `sizey`) require a number, for example, `sizey=240`.
Expand Down Expand Up @@ -210,14 +210,14 @@ dtoverlay=vc4-kms-dsi-ili9881-7inch,invx,invy

== Connect to a Compute Module

Unlike Raspberry Pi single board computers (SBC), which automatically detect the official Raspberry Pi Touch displays, Raspberry Pi Compute Modules don't automatically detect connected devices; you must tell it what display is attached.
Unlike Raspberry Pi single board computers (SBC), which automatically detect the official Raspberry Pi Touch displays, Raspberry Pi Compute Modules don't automatically detect connected devices; you must tell it what display is attached.

This is because the connections between the SoC and DSI connectors on a Raspberry Pi are fixed and the system knows what hardware is connected; auto-detection ensures that the correct Device Tree settings are passed to the Linux kernel, so the display works without additional configuration.
This is because the connections between the SoC and DSI connectors on a Raspberry Pi are fixed and the system knows what hardware is connected; auto-detection ensures that the correct Device Tree settings are passed to the Linux kernel, so the display works without additional configuration.

Compute Modules, intended for industrial and custom applications, expose all GPIOs and interfaces. This provides greater flexibility for connecting hardware, but means that a Compute Module can't automatically detect devices like the Touch Display 2. This means that, for Compute Modules, the Device Tree fragments, which tell the kernel how to interact with the display, must be manually specified. You can do this in three ways:

- By adding an overlay entry in `config.txt`. This is the simplest option. For configuration instructions, see the xref:../computers/compute-module.adoc#attaching-the-touch-display-2-lcd-panel[Compute Module hardware documentation].
- Using a custom base device tree file. This is an advanced method not covered in this online documentation.
- Using a HAT EEPROM (if present).
- Using a HAT EEPROM (if present).


Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ NOTE: Starting with Raspberry Pi OS _Bookworm_, Network Manager is the default n

Access Network Manager via the network icon at the right-hand end of the menu bar. If you are using a Raspberry Pi with built-in wireless connectivity, or if a wireless dongle is plugged in, click this icon to bring up a list of available wireless networks. If you see the message 'No APs found - scanning...', wait a few seconds, and Network Manager should find your network.

NOTE: Devices with dual-band wireless automatically disable networking until you assign a wireless LAN country. Flagship models since Raspberry Pi 3B+, Compute Modules since CM4, and Keyboard models support dual-band wireless. To set a wireless LAN country, open the Raspberry Pi Configuration application from the Preferences menu, select *Localisation* and select your country from the menu.
NOTE: Devices with dual-band wireless automatically disable networking until you assign a wireless LAN country. Flagship models since Raspberry Pi 3B+, Compute Modules since CM4, and Keyboard models support dual-band wireless. To set a wireless LAN country, open the Control Centre application from the **Preferences** menu, select *Localisation* and select your country from the menu.

image::images/wifi2.png[wifi2]

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentation/asciidoc/computers/configuration/images/key.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentation/asciidoc/computers/configuration/images/wifi2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@

=== Getting started

To open the configuration tool from the desktop GUI, go to **Preferences** > **Raspberry Pi Configuration**.
To open the configuration tool from the desktop GUI, go to **Preferences** > **Control Centre**.

NOTE: In previous versions of Raspberry Pi OS, the Control Centre application was called Raspberry Pi Configuration.

Alternatively, run the following command to access the configuration tool via the terminal:

Expand All @@ -14,7 +16,7 @@ Alternatively, run the following command to access the configuration tool via th
$ sudo raspi-config
----

TIP: Some advanced configuration is available in the `raspi-config` CLI, but not the Raspberry Pi Configuration GUI.
TIP: Some advanced configuration is available in the `raspi-config` CLI, but not the Control Centre GUI.

To navigate the configuration tool from the terminal:

Expand Down
14 changes: 8 additions & 6 deletions documentation/asciidoc/computers/configuration/screensaver.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,19 @@ You can configure your Raspberry Pi to blank the screen after a period of inacti

=== Desktop

You can control screen blanking using the *Screen Blanking* option in the Raspberry Pi Configuration menu.
You can control screen blanking using the *Screen Blanking* option in Control Centre.

==== Raspberry Pi Configuration
==== Control Centre

Click the Raspberry Pi button in the menu bar. Navigate to *Preferences* > *Raspberry Pi Configuration*.
Click the Raspberry Pi button in the menu bar. Navigate to *Preferences* > *Control Centre*.

image::images/pi-configuration.png[opening the Raspberry Pi Configuration menu from the desktop]
NOTE: In previous versions of Raspberry Pi OS, the Control Centre application was called Raspberry Pi Configuration.

image::images/pi-configuration.png[opening the Control Centre menu from the desktop]

Select the *Display* tab. Toggle the *Screen Blanking* radio button into the on position. Press *OK* to confirm your selection.

image::images/blanking.png[toggle Screen Blanking on in the Raspberry Pi Configuration menu]
image::images/blanking.png[toggle Screen Blanking on in the Control Centre menu]

==== CLI

Expand All @@ -29,7 +31,7 @@ Use the arrow keys to navigate and the *Enter* key to select. Select `Display Op

=== Console

The `dpms_timeout` screen blanking configuration used by Raspberry Pi Configuration only affects desktop sessions. In *console mode*, when your Raspberry Pi is connected to a monitor and keyboard with only a terminal for input, use the `consoleblank` setting in the kernel command line.
The `dpms_timeout` screen blanking configuration only affects desktop sessions. In *console mode*, when your Raspberry Pi is connected to a monitor and keyboard with only a terminal for input, use the `consoleblank` setting in the kernel command line.

==== Set console mode screen blanking

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentation/asciidoc/computers/os/images/thonny-venv.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 3 additions & 1 deletion documentation/asciidoc/computers/os/updating.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,9 @@ $ sudo apt install rpd-x-extras
$ sudo reboot
----

You now have all the packages that comprise Raspberry Pi OS Desktop. If you want to return to the Lite version of Raspberry Pi OS, you can remove these packages.
You now have all the packages that comprise Raspberry Pi OS Desktop.

If you want to return to the Lite version of Raspberry Pi OS, you can remove these packages. Alternatively, to have the Lite experience without removing the desktop packages installed, use xref:../computers/configuration.adoc#raspi-config[raspi-config] to set your Raspberry Pi to boot to the command line.

You can also install the recommended applications included in Raspberry Pi OS Full by going to your Raspberry Pi main menu and selecting **Preferences > Recommended Software**.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ PING raspberrypi.local (192.168.1.131): 56 data bytes
64 bytes from 192.168.1.131: icmp_seq=0 ttl=255 time=2.618 ms
----

TIP: If you change the system hostname of your Raspberry Pi using Raspberry Pi Configuration, `raspi-config`, or `/etc/hostname`, Avahi updates the `.local` mDNS address. If you don't remember the hostname of your Raspberry Pi, you can install Avahi on another device, then use https://linux.die.net/man/1/avahi-browse[`avahi-browse`] to browse all the hosts and services on your local network.
TIP: If you change the system hostname of your Raspberry Pi using Control Centre `raspi-config`, or `/etc/hostname`, Avahi updates the `.local` mDNS address. If you don't remember the hostname of your Raspberry Pi, you can install Avahi on another device, then use https://linux.die.net/man/1/avahi-browse[`avahi-browse`] to browse all the hosts and services on your local network.

=== Check your router's list of devices

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 4 additions & 4 deletions documentation/asciidoc/computers/remote-access/ssh.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ By default, Raspberry Pi OS disables the SSH server. Enable SSH in one of the fo
======
On the desktop::
+
. From the *Preferences* menu, launch *Raspberry Pi Configuration*.
. From the *Preferences* menu, launch *Control Centre*.
. Navigate to the *Interfaces* tab.
. Select *Enabled* next to *SSH*.
. Click *OK*.
Expand Down Expand Up @@ -76,7 +76,7 @@ NOTE: If you receive a `connection timed out` error, you may have entered the wr

==== Forward X11 over SSH

NOTE: On Raspberry Pi 4 and 5, Raspberry Pi OS Bookworm uses the Wayland window server by default. You can only forward X11 if you use the X window server. To enable window forwarding over X11, switch your desktop to the X window server in Raspberry Pi Configuration.
NOTE: On Raspberry Pi 4 and 5, Raspberry Pi OS Bookworm and later use the Wayland window server by default. You can only forward X11 if you use the X window server. To enable window forwarding over X11, switch your desktop to the X window server in Control Centre or the Raspberry Pi configuration CLI.

NOTE: X11 is no longer installed by default on many desktop environments. Install a third-party X server such as https://www.xquartz.org/[XQuartz] to use X11 forwarding.

Expand Down Expand Up @@ -180,14 +180,14 @@ On the computer you use to remotely connect to the Raspberry Pi, use the followi
$ ssh-copy-id <username>@<ip address>
----

When prompted, enter the password for your user account on the Raspberry Pi.
When prompted, enter the password for your user account on the Raspberry Pi.
You can now connect to your Raspberry Pi without entering a password.

==== Manually copy a public key to your Raspberry Pi

If your operating system does not support `ssh-copy-id`, you can instead copy your public key with xref:remote-access.adoc#scp[`scp`].

First, _on your Raspberry Pi_, create the directory where Linux expects to find keys:
First, _on your Raspberry Pi_, create the directory where Linux expects to find keys:

[source,console]
----
Expand Down
Loading