diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index a81b5f78c..06b83605e 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -16,8 +16,8 @@ jobs: echo "Pull requests based on master can only come from the develop branch of this repository" echo "Please check your base branch as it should be develop by default" exit 1 - - uses: actions/checkout@v4 - - uses: actions/setup-python@v5 + - uses: actions/checkout@v5 + - uses: actions/setup-python@v6 with: python-version: 3.9 - name: Install Python dependencies diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml index 9ffb99cfc..8614b20a0 100644 --- a/.github/workflows/stale.yml +++ b/.github/workflows/stale.yml @@ -13,7 +13,7 @@ jobs: pull-requests: write steps: - - uses: actions/stale@v9 + - uses: actions/stale@v10 with: repo-token: ${{ secrets.GITHUB_TOKEN }} stale-issue-message: 'This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.' diff --git a/documentation/asciidoc/accessories/build-hat/images/setting-up.png b/documentation/asciidoc/accessories/build-hat/images/setting-up.png old mode 100755 new mode 100644 index 8964b0e44..e69d97a3c Binary files a/documentation/asciidoc/accessories/build-hat/images/setting-up.png and b/documentation/asciidoc/accessories/build-hat/images/setting-up.png differ diff --git a/documentation/asciidoc/accessories/build-hat/preparing-build-hat.adoc b/documentation/asciidoc/accessories/build-hat/preparing-build-hat.adoc index 0e19d8bda..824d67d74 100644 --- a/documentation/asciidoc/accessories/build-hat/preparing-build-hat.adoc +++ b/documentation/asciidoc/accessories/build-hat/preparing-build-hat.adoc @@ -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%"] @@ -18,10 +18,10 @@ 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 |=== @@ -29,11 +29,11 @@ The following pins are used by the Build HAT itself and you should not connect a === 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 diff --git a/documentation/asciidoc/accessories/display/display_intro.adoc b/documentation/asciidoc/accessories/display/display_intro.adoc index d61ea0398..b7f5204ec 100644 --- a/documentation/asciidoc/accessories/display/display_intro.adoc +++ b/documentation/asciidoc/accessories/display/display_intro.adoc @@ -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 @@ -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. diff --git a/documentation/asciidoc/accessories/monitor/images/monitor-hero.png b/documentation/asciidoc/accessories/monitor/images/monitor-hero.png index dbaa5f56d..b8c91e40f 100644 Binary files a/documentation/asciidoc/accessories/monitor/images/monitor-hero.png and b/documentation/asciidoc/accessories/monitor/images/monitor-hero.png differ diff --git a/documentation/asciidoc/accessories/touch-display-2/about.adoc b/documentation/asciidoc/accessories/touch-display-2/about.adoc index c3d8ab7e4..341cb8c75 100644 --- a/documentation/asciidoc/accessories/touch-display-2/about.adoc +++ b/documentation/asciidoc/accessories/touch-display-2/about.adoc @@ -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%"] @@ -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. @@ -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: @@ -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 @@ -90,8 +90,8 @@ 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. @@ -99,7 +99,7 @@ IMPORTANT: Disconnect your Raspberry Pi from power before completing the followi === 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. @@ -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 @@ -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: @@ -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`. @@ -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). diff --git a/documentation/asciidoc/computers/config_txt/overclocking.adoc b/documentation/asciidoc/computers/config_txt/overclocking.adoc index 40768eee4..1c7f33910 100644 --- a/documentation/asciidoc/computers/config_txt/overclocking.adoc +++ b/documentation/asciidoc/computers/config_txt/overclocking.adoc @@ -57,7 +57,7 @@ WARNING: Setting any overclocking parameters to values other than those used by | SDRAM phy voltage adjustment. [-16,8] equates to [0.8V,1.4V] with 0.025V steps. Not supported on Raspberry Pi 4 or later devices. | force_turbo -| Forces turbo mode frequencies even when the ARM cores are not busy. Enabling this may set the warranty bit if `over_voltage_*` is also set. +| Forces turbo mode frequencies even when the Arm cores are not busy. Enabling this may set the warranty bit if `over_voltage_*` is also set. | initial_turbo | Enables https://forums.raspberrypi.com/viewtopic.php?f=29&t=6201&start=425#p180099[turbo mode from boot] for the given value in seconds, or until `cpufreq` sets a frequency. The maximum value is `60`. The November 2024 firmware update made the following changes: @@ -339,9 +339,9 @@ NOTE: There is no need to use `hdmi_enable_4kp60` on Flagship models since Raspb ==== `force_turbo` -By default (`force_turbo=0`) the on-demand CPU frequency driver will raise clocks to their maximum frequencies when the ARM cores are busy, and will lower them to the minimum frequencies when the ARM cores are idle. +By default (`force_turbo=0`) the on-demand CPU frequency driver will raise clocks to their maximum frequencies when the Arm cores are busy, and will lower them to the minimum frequencies when the Arm cores are idle. -`force_turbo=1` overrides this behaviour and forces maximum frequencies even when the ARM cores are not busy. +`force_turbo=1` overrides this behaviour and forces maximum frequencies even when the Arm cores are not busy. === Clocks relationship @@ -349,7 +349,7 @@ By default (`force_turbo=0`) the on-demand CPU frequency driver will raise clock The GPU core, CPU, SDRAM and GPU each have their own PLLs and can have unrelated frequencies. The h264, v3d and ISP blocks share a PLL. -To view the Raspberry Pi's current frequency in KHz, type: `cat /sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq`. Divide the result by 1000 to find the value in MHz. Note that this frequency is the kernel _requested_ frequency, and it is possible that any throttling (for example at high temperatures) may mean the CPU is actually running more slowly than reported. An instantaneous measurement of the actual ARM CPU frequency can be retrieved using the vcgencmd `vcgencmd measure_clock arm`. This is displayed in Hertz. +To view the Raspberry Pi's current frequency in KHz, type: `cat /sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq`. Divide the result by 1000 to find the value in MHz. Note that this frequency is the kernel _requested_ frequency, and it is possible that any throttling (for example at high temperatures) may mean the CPU is actually running more slowly than reported. An instantaneous measurement of the actual Arm CPU frequency can be retrieved using the vcgencmd `vcgencmd measure_clock arm`. This is displayed in Hertz. === Monitoring core temperature [.whitepaper, title="Cooling a Raspberry Pi device", subtitle="", link=https://pip.raspberrypi.com/documents/RP-003608-WP-Cooling-a-Raspberry-Pi-device.pdf] @@ -368,7 +368,7 @@ Divide the result by 1000 to find the value in degrees Celsius. Alternatively, y Hitting the temperature limit is not harmful to the SoC, but it will cause the CPU to throttle. A heat sink can help to control the core temperature, and therefore performance. This is especially useful if the Raspberry Pi is running inside a case. Airflow over the heat sink will make cooling more efficient. -When the core temperature is between 80°C and 85°C, the ARM cores will be throttled back. If the temperature exceeds 85°C, the ARM cores and the GPU will be throttled back. +When the core temperature is between 80°C and 85°C, the Arm cores will be throttled back. If the temperature exceeds 85°C, the Arm cores and the GPU will be throttled back. For the Raspberry Pi 3 Model B+, the PCB technology has been changed to provide better heat dissipation and increased thermal mass. In addition, a soft temperature limit has been introduced, with the goal of maximising the time for which a device can "sprint" before reaching the hard limit at 85°C. When the soft limit is reached, the clock speed is reduced from 1.4GHz to 1.2GHz, and the operating voltage is reduced slightly. This reduces the rate of temperature increase: we trade a short period at 1.4GHz for a longer period at 1.2GHz. By default, the soft limit is 60°C. This can be changed via the `temp_soft_limit` setting in `config.txt`. @@ -378,7 +378,7 @@ It is essential to keep the supply voltage above 4.8V for reliable performance. To monitor the Raspberry Pi's PSU voltage, you will need to use a multimeter to measure between the VCC and GND pins on the GPIO. More information is available in the xref:raspberry-pi.adoc#power-supply[power] section of the documentation. -If the voltage drops below 4.63V (±5%), the ARM cores and the GPU will be throttled back, and a message indicating the low voltage state will be added to the kernel log. +If the voltage drops below 4.63V (±5%), the Arm cores and the GPU will be throttled back, and a message indicating the low voltage state will be added to the kernel log. The Raspberry Pi 5 PMIC has built in ADCs that allow the supply voltage to be measured. To view the current supply voltage, run the following command: diff --git a/documentation/asciidoc/computers/configuration/configuring-networking.adoc b/documentation/asciidoc/computers/configuration/configuring-networking.adoc index aea9de820..94b702dc1 100644 --- a/documentation/asciidoc/computers/configuration/configuring-networking.adoc +++ b/documentation/asciidoc/computers/configuration/configuring-networking.adoc @@ -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] diff --git a/documentation/asciidoc/computers/configuration/device-tree.adoc b/documentation/asciidoc/computers/configuration/device-tree.adoc index 248fd63cf..af8aad80b 100644 --- a/documentation/asciidoc/computers/configuration/device-tree.adoc +++ b/documentation/asciidoc/computers/configuration/device-tree.adoc @@ -725,7 +725,7 @@ dtoverlay= [[part3.3]] ==== Board-specific labels and parameters -Raspberry Pi boards have two I2C interfaces. These are nominally split: one for the ARM, and one for VideoCore (the GPU). On almost all models, `i2c1` belongs to the ARM and `i2c0` to VC, where it is used to control the camera and read the HAT EEPROM. However, there are two early revisions of the Model B that have those roles reversed. +Raspberry Pi boards have two I2C interfaces. These are nominally split: one for the Arm CPU, and one for the VideoCore GPU. On almost all models, `i2c1` belongs to the CPU and `i2c0` to the GPU, where it is used to control the camera and read the HAT EEPROM. However, there are two early revisions of the Model B that have those roles reversed. To make it possible to use one set of overlays and parameters with all Raspberry Pis, the firmware creates some board-specific DT parameters. These are: diff --git a/documentation/asciidoc/computers/configuration/images/blanking.png b/documentation/asciidoc/computers/configuration/images/blanking.png index 6ec7406c7..0ef13f8a6 100644 Binary files a/documentation/asciidoc/computers/configuration/images/blanking.png and b/documentation/asciidoc/computers/configuration/images/blanking.png differ diff --git a/documentation/asciidoc/computers/configuration/images/key.png b/documentation/asciidoc/computers/configuration/images/key.png index ca0c65b11..6469f91fb 100755 Binary files a/documentation/asciidoc/computers/configuration/images/key.png and b/documentation/asciidoc/computers/configuration/images/key.png differ diff --git a/documentation/asciidoc/computers/configuration/images/network-hidden-authentication.png b/documentation/asciidoc/computers/configuration/images/network-hidden-authentication.png index 87f12a9aa..1b6310291 100644 Binary files a/documentation/asciidoc/computers/configuration/images/network-hidden-authentication.png and b/documentation/asciidoc/computers/configuration/images/network-hidden-authentication.png differ diff --git a/documentation/asciidoc/computers/configuration/images/network-hidden.png b/documentation/asciidoc/computers/configuration/images/network-hidden.png index 42d0d7948..1e2964305 100644 Binary files a/documentation/asciidoc/computers/configuration/images/network-hidden.png and b/documentation/asciidoc/computers/configuration/images/network-hidden.png differ diff --git a/documentation/asciidoc/computers/configuration/images/pi-configuration.png b/documentation/asciidoc/computers/configuration/images/pi-configuration.png index c7bee2fad..c5bbf319b 100644 Binary files a/documentation/asciidoc/computers/configuration/images/pi-configuration.png and b/documentation/asciidoc/computers/configuration/images/pi-configuration.png differ diff --git a/documentation/asciidoc/computers/configuration/images/wifi2.png b/documentation/asciidoc/computers/configuration/images/wifi2.png index 536abb0c1..627b04ea9 100755 Binary files a/documentation/asciidoc/computers/configuration/images/wifi2.png and b/documentation/asciidoc/computers/configuration/images/wifi2.png differ diff --git a/documentation/asciidoc/computers/configuration/raspi-config.adoc b/documentation/asciidoc/computers/configuration/raspi-config.adoc index 483cb66bc..e20802967 100644 --- a/documentation/asciidoc/computers/configuration/raspi-config.adoc +++ b/documentation/asciidoc/computers/configuration/raspi-config.adoc @@ -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: @@ -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: diff --git a/documentation/asciidoc/computers/configuration/screensaver.adoc b/documentation/asciidoc/computers/configuration/screensaver.adoc index f12900f3f..66523154c 100644 --- a/documentation/asciidoc/computers/configuration/screensaver.adoc +++ b/documentation/asciidoc/computers/configuration/screensaver.adoc @@ -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 @@ -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 diff --git a/documentation/asciidoc/computers/getting-started/images/recommended-software.png b/documentation/asciidoc/computers/getting-started/images/recommended-software.png index 11eb335ed..ea58679d4 100644 Binary files a/documentation/asciidoc/computers/getting-started/images/recommended-software.png and b/documentation/asciidoc/computers/getting-started/images/recommended-software.png differ diff --git a/documentation/asciidoc/computers/legacy_config_txt/memory.adoc b/documentation/asciidoc/computers/legacy_config_txt/memory.adoc index 11996ade0..7edd2327a 100644 --- a/documentation/asciidoc/computers/legacy_config_txt/memory.adoc +++ b/documentation/asciidoc/computers/legacy_config_txt/memory.adoc @@ -50,5 +50,5 @@ The `gpu_mem_1024` command sets the GPU memory in megabytes for Raspberry Pis wi === `disable_l2cache` -Setting this to `1` disables the CPU's access to the GPU's L2 cache and requires a corresponding L2 disabled kernel. Default value on BCM2835 is `0`. On BCM2836, BCM2837, BCM2711, and BCM2712, the ARMs have their own L2 cache and therefore the default is `1`. The standard Raspberry Pi `kernel.img` and `kernel7.img` builds reflect this difference in cache setting. +Setting this to `1` disables the CPU's access to the GPU's L2 cache and requires a corresponding L2 disabled kernel. Default value on BCM2835 is `0`. On BCM2836, BCM2837, BCM2711, and BCM2712, the Arm CPUs have their own L2 cache and therefore the default is `1`. The standard Raspberry Pi `kernel.img` and `kernel7.img` builds reflect this difference in cache setting. diff --git a/documentation/asciidoc/computers/os/graphics-utilities.adoc b/documentation/asciidoc/computers/os/graphics-utilities.adoc index b37e8ab81..3c44bfcaf 100644 --- a/documentation/asciidoc/computers/os/graphics-utilities.adoc +++ b/documentation/asciidoc/computers/os/graphics-utilities.adoc @@ -84,7 +84,7 @@ This returns the current frequency of the specified clock. Accepts the following | clock | Description | `arm` -| ARM core(s) +| Arm core(s) | `core` | GPU core diff --git a/documentation/asciidoc/computers/os/images/thonny-venv.png b/documentation/asciidoc/computers/os/images/thonny-venv.png index 5025e4fd2..f255b406e 100644 Binary files a/documentation/asciidoc/computers/os/images/thonny-venv.png and b/documentation/asciidoc/computers/os/images/thonny-venv.png differ diff --git a/documentation/asciidoc/computers/os/updating.adoc b/documentation/asciidoc/computers/os/updating.adoc index dfb7242f3..224762eb3 100644 --- a/documentation/asciidoc/computers/os/updating.adoc +++ b/documentation/asciidoc/computers/os/updating.adoc @@ -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 you've 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**. diff --git a/documentation/asciidoc/computers/processors/bcm2711.adoc b/documentation/asciidoc/computers/processors/bcm2711.adoc index 70ea47ee8..4d199dfa7 100644 --- a/documentation/asciidoc/computers/processors/bcm2711.adoc +++ b/documentation/asciidoc/computers/processors/bcm2711.adoc @@ -1,12 +1,12 @@ == BCM2711 -This is the Broadcom chip used in the Raspberry Pi 4 Model B, Compute Module 4, and Pi 400. The architecture of the BCM2711 is a considerable upgrade on that used by the SoCs in earlier Raspberry Pi models. It continues the quad-core CPU design of the BCM2837, but uses the more powerful ARM A72 core. It has a greatly improved GPU feature set with much faster input/output, due to the incorporation of a PCIe link that connects the USB 2 and USB 3 ports, and a natively attached Ethernet controller. It is also capable of addressing more memory than the SoCs used before. +This is the Broadcom chip used in the Raspberry Pi 4 Model B, Compute Module 4, and Pi 400. The architecture of the BCM2711 is a considerable upgrade on that used by the SoCs in earlier Raspberry Pi models. It continues the quad-core CPU design of the BCM2837, but uses the more powerful Arm A72 core. It has a greatly improved GPU feature set with much faster input/output, due to the incorporation of a PCIe link that connects the USB 2 and USB 3 ports, and a natively attached Ethernet controller. It is also capable of addressing more memory than the SoCs used before. -The ARM cores are capable of running at up to 1.5 GHz, making the Raspberry Pi 4 about 50% faster than the Raspberry Pi 3B+. The new VideoCore VI 3D unit now runs at up to 500 MHz. The ARM cores are 64-bit, and while the VideoCore is 32-bit, there is a new Memory Management Unit, which means it can access more memory than previous versions. +The Arm cores are capable of running at up to 1.5 GHz, making the Raspberry Pi 4 about 50% faster than the Raspberry Pi 3B+. The new VideoCore VI 3D unit now runs at up to 500 MHz. The Arm cores are 64-bit, and while the VideoCore is 32-bit, there is a new Memory Management Unit, which means it can access more memory than previous versions. The BCM2711 chip continues to use the heat spreading technology started with the BCM2837B0, which provides better thermal management. -*Processor:* Quad-core https://en.wikipedia.org/wiki/ARM_Cortex-A72[Cortex-A72] (ARM v8) 64-bit SoC @ 1.5 GHz. +*Processor:* Quad-core https://en.wikipedia.org/wiki/ARM_Cortex-A72[Cortex-A72] (Armv8-A) 64-bit SoC @ 1.5 GHz. *Memory:* Accesses up to 8GB LPDDR4-2400 SDRAM (depending on model) diff --git a/documentation/asciidoc/computers/processors/bcm2712.adoc b/documentation/asciidoc/computers/processors/bcm2712.adoc index 8adae73ed..e4a97e657 100644 --- a/documentation/asciidoc/computers/processors/bcm2712.adoc +++ b/documentation/asciidoc/computers/processors/bcm2712.adoc @@ -7,7 +7,7 @@ Built around a quad-core Arm Cortex-A76 CPU cluster, clocked at up to 2.4GHz, wi Headline features include: * Quad-core Arm Cortex-A76 @ 2.4GHz -** ARMv8-A ISA +** Armv8-A ISA ** 64KByte I and D caches ** 512KB L2 per core, 2MB shared L3 * New Raspberry Pi-developed ISP diff --git a/documentation/asciidoc/computers/processors/bcm2837.adoc b/documentation/asciidoc/computers/processors/bcm2837.adoc index 16694e5f9..b776c301a 100644 --- a/documentation/asciidoc/computers/processors/bcm2837.adoc +++ b/documentation/asciidoc/computers/processors/bcm2837.adoc @@ -1,10 +1,10 @@ == BCM2837 -This is the Broadcom chip used in the Raspberry Pi 3 Model B, later models of the Raspberry Pi 2 Model B, and the Raspberry Pi Compute Module 3. The underlying architecture of the BCM2837 is identical to the BCM2836. The only significant difference is the replacement of the ARMv7 quad core cluster with a quad-core ARM Cortex A53 (ARMv8) cluster. +This is the Broadcom chip used in the Raspberry Pi 3 Model B, later models of the Raspberry Pi 2 Model B, and the Raspberry Pi Compute Module 3. The underlying architecture of the BCM2837 is identical to the BCM2836. The only significant difference is the replacement of the Armv7 quad core cluster with a quad-core Arm Cortex A53 (Armv8) cluster. -The ARM cores run at 1.2GHz, making the device about 50% faster than the Raspberry Pi 2. The VideoCore IV runs at 400MHz. +The Arm cores run at 1.2GHz, making the device about 50% faster than the Raspberry Pi 2. The VideoCore IV runs at 400MHz. -Please refer to the following BCM2836 document for details on the ARM peripherals specification, which also applies to the BCM2837. +Please refer to the following BCM2836 document for details on the Arm peripherals specification, which also applies to the BCM2837. -* https://datasheets.raspberrypi.com/bcm2836/bcm2836-peripherals.pdf[BCM2836 ARM-local peripherals] +* https://datasheets.raspberrypi.com/bcm2836/bcm2836-peripherals.pdf[BCM2836 Arm-local peripherals] * https://developer.arm.com/documentation/ddi0500/latest/[Cortex-A53 MPCore Processor Technical Reference Manual] diff --git a/documentation/asciidoc/computers/processors/bcm2837b0.adoc b/documentation/asciidoc/computers/processors/bcm2837b0.adoc index 3589bdf10..2ee24cc4b 100644 --- a/documentation/asciidoc/computers/processors/bcm2837b0.adoc +++ b/documentation/asciidoc/computers/processors/bcm2837b0.adoc @@ -1,8 +1,8 @@ == BCM2837B0 -This is the Broadcom chip used in the Raspberry Pi 3 Models A+, B+, and the Raspberry Pi Compute Module 3+. The underlying architecture of the BCM2837B0 is identical to the BCM2837 chip used in other versions of the Raspberry Pi. The ARM core hardware is the same, only the frequency is rated higher. +This is the Broadcom chip used in the Raspberry Pi 3 Models A+, B+, and the Raspberry Pi Compute Module 3+. The underlying architecture of the BCM2837B0 is identical to the BCM2837 chip used in other versions of the Raspberry Pi. The Arm core hardware is the same, only the frequency is rated higher. -The ARM cores are capable of running at up to 1.4GHz, making the 3B+/3A+ about 17% faster than the original Raspberry Pi 3. The VideoCore IV runs at 400MHz. The ARM core is 64-bit, while the VideoCore IV is 32-bit. +The Arm cores are capable of running at up to 1.4GHz, making the 3B+/3A+ about 17% faster than the original Raspberry Pi 3. The VideoCore IV runs at 400MHz. The Arm core is 64-bit, while the VideoCore IV is 32-bit. The BCM2837B0 chip is packaged slightly differently to the BCM2837, and most notably includes a heat spreader for better thermals. This allows higher clock frequencies, and more accurate monitoring and control of the chip's temperature. diff --git a/documentation/asciidoc/computers/processors/rp3a0.adoc b/documentation/asciidoc/computers/processors/rp3a0.adoc index 4ec33136a..6faeed7bf 100644 --- a/documentation/asciidoc/computers/processors/rp3a0.adoc +++ b/documentation/asciidoc/computers/processors/rp3a0.adoc @@ -1,6 +1,6 @@ == RP3A0 -The Raspberry Pi RP3A0 is our first System-in-Package (SiP) consisting of a Broadcom BCM2710A1 — which is the silicon die packaged inside the Broadcom xref:processors.adoc#bcm2837[BCM2837] chip which is used on the xref:raspberry-pi.adoc#raspberry-pi-3-model-b-2[Raspberry Pi 3] — along with 512MB of DRAM. +The Raspberry Pi RP3A0 is our first System-in-Package (SiP) consisting of a Broadcom BCM2710A1 — which is the silicon die packaged inside the Broadcom xref:processors.adoc#bcm2837[BCM2837] chip which is used on the xref:raspberry-pi.adoc#raspberry-pi-3-model-b-2[Raspberry Pi 3] — along with 512MB of DRAM. It is used by the xref:raspberry-pi.adoc#raspberry-pi-zero-2-w[Raspberry Pi Zero 2 W]. @@ -8,12 +8,12 @@ image:images/RP3A0-crosssection.png[width="70%"] The RP3A0 is a Quad-core 64-bit Arm Cortex A53 CPU clocked at 1 GHz, although with a heat sink or other cooling solution in place, the chip can be potentially overclocked to 1.2 GHz. -Please refer to the following BCM2836 document for details on the ARM peripherals specification, which also applies to the BCM2837 and RP3A0. +Please refer to the following BCM2836 document for details on the Arm peripherals specification, which also applies to the BCM2837 and RP3A0. -* https://datasheets.raspberrypi.com/bcm2836/bcm2836-peripherals.pdf[BCM2836 ARM-local peripherals] +* https://datasheets.raspberrypi.com/bcm2836/bcm2836-peripherals.pdf[BCM2836 Arm-local peripherals] * https://developer.arm.com/documentation/ddi0500/latest/[Cortex-A53 MPCore Processor Technical Reference Manual] [NOTE] ==== -The original xref:raspberry-pi.adoc#raspberry-pi-zero[Raspberry Pi Zero] uses Package-on-Package (PoP) DRAM, where the DRAM is soldered directly on top of the xref:processors.adoc#bcm2835[BCM2835] chip. +The original xref:raspberry-pi.adoc#raspberry-pi-zero[Raspberry Pi Zero] uses Package-on-Package (PoP) DRAM, where the DRAM is soldered directly on top of the xref:processors.adoc#bcm2835[BCM2835] chip. ==== diff --git a/documentation/asciidoc/computers/raspberry-pi/boot-gpio.adoc b/documentation/asciidoc/computers/raspberry-pi/boot-gpio.adoc index 6545bc3c9..337261155 100644 --- a/documentation/asciidoc/computers/raspberry-pi/boot-gpio.adoc +++ b/documentation/asciidoc/computers/raspberry-pi/boot-gpio.adoc @@ -87,4 +87,4 @@ NOTE: The various boot modes are attempted in the numerical order of the GPIO li SD0 is the Broadcom SD card/MMC interface. When the boot ROM within the SoC runs, it always connects SD0 to the built-in microSD card slot. On Compute Modules with an eMMC device, SD0 is connected to that; on the Compute Module Lite SD0 is available on the edge connector and connects to the microSD card slot in the CMIO carrier board. SD1 is the Arasan SD card/MMC interface which is also capable of SDIO. All Raspberry Pi models with built-in wireless LAN use SD1 to connect to the wireless chip via SDIO. -The default pull resistance on the GPIO lines is 50KΩ, as documented on page 102 of the https://datasheets.raspberrypi.com/bcm2835/bcm2835-peripherals.pdf[BCM2835 ARM peripherals datasheet]. A pull resistance of 5KΩ is recommended to pull a GPIO line up: this will allow the GPIO to function but not consume too much power. +The default pull resistance on the GPIO lines is 50KΩ, as documented on page 102 of the https://datasheets.raspberrypi.com/bcm2835/bcm2835-peripherals.pdf[BCM2835 Arm peripherals datasheet]. A pull resistance of 5KΩ is recommended to pull a GPIO line up: this will allow the GPIO to function but not consume too much power. diff --git a/documentation/asciidoc/computers/raspberry-pi/bootflow-legacy.adoc b/documentation/asciidoc/computers/raspberry-pi/bootflow-legacy.adoc index 29e7c821d..346c513f5 100644 --- a/documentation/asciidoc/computers/raspberry-pi/bootflow-legacy.adoc +++ b/documentation/asciidoc/computers/raspberry-pi/bootflow-legacy.adoc @@ -39,7 +39,7 @@ Next, the boot ROM checks each of the boot sources for a file called `bootcode.b [NOTE] ==== * If there is no SD card inserted, the SD boot mode takes five seconds to fail. To reduce this and fall back to USB more quickly, you can either insert an SD card with nothing on it or use the GPIO bootmode OTP setting described above to only enable USB. -* The default pull for the GPIOs is defined on page 102 of the https://datasheets.raspberrypi.com/bcm2835/bcm2835-peripherals.pdf[ARM Peripherals datasheet]. If the value at boot time does not equal the default pull, then that boot mode is enabled. +* The default pull for the GPIOs is defined on page 102 of the https://datasheets.raspberrypi.com/bcm2835/bcm2835-peripherals.pdf[Arm Peripherals datasheet]. If the value at boot time does not equal the default pull, then that boot mode is enabled. * USB enumeration is a means of enabling power to the downstream devices on a hub, then waiting for the device to pull the D+ and D- lines to indicate if it is either USB 1 or USB 2. This can take time: on some devices it can take up to three seconds for a hard disk drive to spin up and start the enumeration process. Because this is the only way of detecting that the hardware is attached, we have to wait for a minimum amount of time (two seconds). If the device fails to respond after this maximum timeout, it is possible to increase the timeout to five seconds using `program_usb_boot_timeout=1` in `config.txt`. * MSD boot takes precedence over Ethernet boot. * It is no longer necessary for the first partition to be the FAT partition, as the MSD boot will continue to search for a FAT partition beyond the first one. diff --git a/documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc b/documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc index 8be245f72..5ad20922a 100644 --- a/documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc +++ b/documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc @@ -152,7 +152,7 @@ The `BOOT_ORDER` property defines the sequence for the different boot modes. It If set to a non-zero value (in seconds), enables a hardware watchdog timer in the bootloader. If the OS is not started within the specified time, the watchdog will reset the system. -The bootloader watchdog is automatically cancelled as soon as the ARM CPU is started. It does **not** monitor the OS after the handover from the bootloader. +The bootloader watchdog is automatically cancelled as soon as the Arm CPU is started. It does **not** monitor the OS after the handover from the bootloader. This is useful for unattended or remote systems to ensure recovery from failed boots (e.g. if the OS never loads). diff --git a/documentation/asciidoc/computers/raspberry-pi/frequency-management.adoc b/documentation/asciidoc/computers/raspberry-pi/frequency-management.adoc index d8baf8c40..e71d65294 100644 --- a/documentation/asciidoc/computers/raspberry-pi/frequency-management.adoc +++ b/documentation/asciidoc/computers/raspberry-pi/frequency-management.adoc @@ -34,7 +34,7 @@ Due to possible system stability problems involved with running an undervoltage, NOTE: This setting has been removed on 5-series devices and is effectively always mode 3. -In addition, a more stepped CPU governor is also used to produce finer-grained control of ARM core frequencies, which means the DVFS is more effective. The steps are now 1500MHz, 1000MHz, 750MHz, and 600MHz. These steps can also help when the SoC is being throttled, and mean that throttling all the way back to 600MHz is much less likely, giving an overall increase in fully loaded performance. +In addition, a more stepped CPU governor is also used to produce finer-grained control of Arm core frequencies, which means the DVFS is more effective. The steps are now 1500MHz, 1000MHz, 750MHz, and 600MHz. These steps can also help when the SoC is being throttled, and mean that throttling all the way back to 600MHz is much less likely, giving an overall increase in fully loaded performance. The default CPU governor is `ondemand`. The governor can be manually changed with the `cpufreq-set` command (from the `cpufrequtils` package) to reduce idle power consumption: @@ -65,7 +65,7 @@ To ensure the best performance for your Raspberry Pi, use an active cooling solu For Raspberry Pi 4, add the https://www.raspberrypi.com/products/raspberry-pi-4-case-fan/[Raspberry Pi 4 Case Fan] to the lid of the Raspberry Pi 4 case. -==== Raspberry Pi 5 fans +==== Raspberry Pi 5 fans For Raspberry Pi 5, use one of the official fan options: diff --git a/documentation/asciidoc/computers/remote-access/find-your-ip-address.adoc b/documentation/asciidoc/computers/remote-access/find-your-ip-address.adoc index 326ee3d7e..d3a946e62 100644 --- a/documentation/asciidoc/computers/remote-access/find-your-ip-address.adoc +++ b/documentation/asciidoc/computers/remote-access/find-your-ip-address.adoc @@ -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 diff --git a/documentation/asciidoc/computers/remote-access/images/network-tooltip.png b/documentation/asciidoc/computers/remote-access/images/network-tooltip.png index 86351ee3b..38e9fc34d 100644 Binary files a/documentation/asciidoc/computers/remote-access/images/network-tooltip.png and b/documentation/asciidoc/computers/remote-access/images/network-tooltip.png differ diff --git a/documentation/asciidoc/computers/remote-access/images/raspberry-pi-configuration.png b/documentation/asciidoc/computers/remote-access/images/raspberry-pi-configuration.png index 2c99724c1..d7667147b 100644 Binary files a/documentation/asciidoc/computers/remote-access/images/raspberry-pi-configuration.png and b/documentation/asciidoc/computers/remote-access/images/raspberry-pi-configuration.png differ diff --git a/documentation/asciidoc/computers/remote-access/images/vnc-enable.png b/documentation/asciidoc/computers/remote-access/images/vnc-enable.png index 4c81b61ea..37a6f7123 100644 Binary files a/documentation/asciidoc/computers/remote-access/images/vnc-enable.png and b/documentation/asciidoc/computers/remote-access/images/vnc-enable.png differ diff --git a/documentation/asciidoc/computers/remote-access/images/vnc-tigervnc-desktop.png b/documentation/asciidoc/computers/remote-access/images/vnc-tigervnc-desktop.png index e8420b865..5fed688dd 100644 Binary files a/documentation/asciidoc/computers/remote-access/images/vnc-tigervnc-desktop.png and b/documentation/asciidoc/computers/remote-access/images/vnc-tigervnc-desktop.png differ diff --git a/documentation/asciidoc/computers/remote-access/ssh.adoc b/documentation/asciidoc/computers/remote-access/ssh.adoc index aaa58862a..c6861b784 100644 --- a/documentation/asciidoc/computers/remote-access/ssh.adoc +++ b/documentation/asciidoc/computers/remote-access/ssh.adoc @@ -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*. @@ -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: Raspberry Pi OS 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 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. @@ -180,14 +180,14 @@ On the computer you use to remotely connect to the Raspberry Pi, use the followi $ ssh-copy-id @ ---- -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] ---- diff --git a/documentation/asciidoc/computers/remote-access/vnc.adoc b/documentation/asciidoc/computers/remote-access/vnc.adoc index e7ee1c300..a482e3178 100644 --- a/documentation/asciidoc/computers/remote-access/vnc.adoc +++ b/documentation/asciidoc/computers/remote-access/vnc.adoc @@ -21,19 +21,19 @@ TIP: Once enabled, you can access your WayVNC configuration at `/etc/wayvnc/`. ==== Enable VNC Server Graphically . Boot into the graphical desktop on your Raspberry Pi. -. Click the Raspberry Pi icon in the system tray of your desktop. -. Select *Preferences* > *Raspberry Pi Configuration* from the menu. +. Select the Raspberry Pi icon in the system tray of your desktop. +. Select *Preferences* > *Control Centre* from the menu. + -- -image::images/raspberry-pi-configuration.png[alt="Select Raspberry Pi Configuration from the Preferences menu in the system tray",width="80%"] +image::images/raspberry-pi-configuration.png[alt="Select Control Centre from the Preferences menu in the system tray",width="80%"] -- . Navigate to the *Interfaces* tab. -. Click the radio button next to *VNC* into the active position. +. Toggle the radio button next to *VNC* into the active position. + -- image::images/vnc-enable.png[alt="In the Interfaces tab, click the VNC toggle into the active position to enable VNC.",width="80%"] -- -. Click the *OK* button to save your configuration changes. +. Select the *OK* button to save your configuration changes. ==== Enable the VNC server on the command line @@ -88,8 +88,8 @@ image::images/vnc-tigervnc-cert-signer-warning.png[alt="TigerVNC warning about c -- image::images/vnc-tigervnc-username-password.png[alt="Entering a username and password to authenticate via TigerVNC",width="60%"] -- -. Click the "OK" button to authenticate with the VNC server. If your credentials are correct, TigerVNC should open a window containing the desktop corresponding to your account on the Raspberry Pi. You should be able to move your mouse and keyboard to input text and interact with the desktop. +. Click the "OK" button to authenticate with the VNC server. If your credentials are correct, TigerVNC should open a window containing the desktop corresponding to your account on the Raspberry Pi. You should be able to use your mouse and keyboard to interact with the desktop and input text. + -- image::images/vnc-tigervnc-desktop.png[alt="The desktop of a Raspberry Pi after successfully authenticating with TigerVNC",width="60%"] --- +-- \ No newline at end of file diff --git a/documentation/asciidoc/computers/software-sources.adoc b/documentation/asciidoc/computers/software-sources.adoc index c29a3de0f..f3ed7fbc2 100644 --- a/documentation/asciidoc/computers/software-sources.adoc +++ b/documentation/asciidoc/computers/software-sources.adoc @@ -108,8 +108,8 @@ The file manager used by the desktop, which also displays the desktop background https://github.com/raspberrypi-ui/appset:: The Appearance settings panel. -https://github.com/raspberrypi-ui/rc_gui:: -The Raspberry Pi Configuration settings panel. +https://github.com/raspberrypi-ui/rpcc:: +The Control Centre settings panel. https://github.com/raspberrypi-ui/rasputin:: The Mouse and Keyboard settings panel. diff --git a/documentation/asciidoc/microcontrollers/debug-probe/installing-tools.adoc b/documentation/asciidoc/microcontrollers/debug-probe/installing-tools.adoc index 4ade8e9ca..1ac3f94b4 100644 --- a/documentation/asciidoc/microcontrollers/debug-probe/installing-tools.adoc +++ b/documentation/asciidoc/microcontrollers/debug-probe/installing-tools.adoc @@ -2,7 +2,7 @@ To use the Debug Probe, OpenOCD and the GNU Project Debugger (GDB) are required. An Integrated Development Environment (IDE) may also be useful. -On Raspberry Pi OS, most Linux variants, macOS, and Microsoft Windows, it is recommended to install our VS Code extension. This extension bundles OpenOCD, ARM toolchains, GDB, and register definitions for Pico-series microcontrollers. +On Raspberry Pi OS, most Linux variants, macOS, and Microsoft Windows, it is recommended to install our VS Code extension. This extension bundles OpenOCD, Arm toolchains, GDB, and register definitions for Pico-series microcontrollers. See Chapter 3 of our https://datasheets.raspberrypi.com/pico/getting-started-with-pico.pdf[Getting Started with Raspberry Pi Pico] guide. diff --git a/documentation/asciidoc/microcontrollers/debug-probe/introduction.adoc b/documentation/asciidoc/microcontrollers/debug-probe/introduction.adoc index 89219915a..3703a213c 100644 --- a/documentation/asciidoc/microcontrollers/debug-probe/introduction.adoc +++ b/documentation/asciidoc/microcontrollers/debug-probe/introduction.adoc @@ -4,7 +4,7 @@ image::images/debug-probe.jpg[width="100%"] The Raspberry Pi Debug Probe is a USB device that provides both a UART serial port and a standard Arm Serial Wire Debug (SWD) interface. The probe is designed for easy, solderless, plug-and-play debugging. It has the following features: -* USB to ARM https://developer.arm.com/documentation/ihi0031/a/The-Serial-Wire-Debug-Port\--SW-DP-/Introduction-to-the-ARM-Serial-Wire-Debug\--SWD\--protocol[Serial Wire Debug] (SWD) port +* USB to Arm https://developer.arm.com/documentation/ihi0031/a/The-Serial-Wire-Debug-Port\--SW-DP-/Introduction-to-the-ARM-Serial-Wire-Debug\--SWD\--protocol[Serial Wire Debug] (SWD) port * USB to UART bridge * Compatible with the https://developer.arm.com/documentation/101451/0100/About-CMSIS-DAP[CMSIS-DAP] standard * Works with https://openocd.org/[OpenOCD] and other tools supporting CMSIS-DAP diff --git a/documentation/asciidoc/microcontrollers/debug-probe/swd-connection.adoc b/documentation/asciidoc/microcontrollers/debug-probe/swd-connection.adoc index 33a5f0a2f..7b7fbfa95 100644 --- a/documentation/asciidoc/microcontrollers/debug-probe/swd-connection.adoc +++ b/documentation/asciidoc/microcontrollers/debug-probe/swd-connection.adoc @@ -8,7 +8,7 @@ We recommend the use of the Raspberry Pi Pico VSCode extension, which integrates === Standalone program upload -Once you have built a binary: +Once you have built a binary: [source,console] ---- @@ -21,7 +21,7 @@ NOTE: When you use the Debug Probe to upload a binary the ELF version of the fil This will use `openocd` in server mode, and connect GDB, which gives you breakpoints and single-step over a console interface. -[IMPORTANT] +[IMPORTANT] ====== To allow debugging, you must build your binaries as `Debug` rather than `Release` build type, e.g. @@ -39,7 +39,7 @@ $ make -j4 In a debug build you will get more information when you run it under the debugger, as the compiler builds your program with the information to tell GDB what your program is doing. ====== -NOTE: For computers that are _not_ Raspberry Pis, a variant of GDB that can debug ARM processors is required. Use one of the following alternatives depending on your operating system and device: +NOTE: For computers that are _not_ Raspberry Pis, a variant of GDB that can debug Arm processors is required. Use one of the following alternatives depending on your operating system and device: * On Linux devices, use `gdb-multiarch`. * On macOS and Windows devices, use `arm-none-eabi-gdb` from the toolchain on https://developer.arm.com/downloads/-/arm-gnu-toolchain-downloads[Arm's website] diff --git a/documentation/asciidoc/microcontrollers/silicon/rp2040.adoc b/documentation/asciidoc/microcontrollers/silicon/rp2040.adoc index d6fd01309..f80c1c515 100644 --- a/documentation/asciidoc/microcontrollers/silicon/rp2040.adoc +++ b/documentation/asciidoc/microcontrollers/silicon/rp2040.adoc @@ -37,7 +37,7 @@ power Key features: -* Dual ARM Cortex-M0+ @ 133MHz +* Dual Arm Cortex-M0+ @ 133MHz * 264kB on-chip SRAM in six independent banks * Support for up to 16MB of off-chip Flash memory via dedicated QSPI bus * DMA controller diff --git a/documentation/asciidoc/services/connect/install.adoc b/documentation/asciidoc/services/connect/install.adoc index 7c8224c22..321984e02 100644 --- a/documentation/asciidoc/services/connect/install.adoc +++ b/documentation/asciidoc/services/connect/install.adoc @@ -1,37 +1,7 @@ -[[install-connect]] -== Install +[[install-connect-lite]] +== Install Connect Lite -If Connect isn't already installed in your version of Raspberry Pi OS, open a Terminal window. Run the following command to update your system and packages: - -[source,console] ----- -$ sudo apt update -$ sudo apt full-upgrade ----- - -Run the following command on your Raspberry Pi to install Connect: - -[source,console] ----- -$ sudo apt install rpi-connect ----- - -You can also install Connect from the Recommended Software application. - -After installation, use the `rpi-connect` command line interface to start Connect for your current user: - -[source,console] ----- -$ rpi-connect on ----- - -Alternatively, click the Connect icon in the menu bar to open a dropdown menu and select *Turn On Raspberry Pi Connect*: - -image::images/turn-on-connect.png[width="80%"] - -=== Connect Lite - -We distribute an alternate *Lite* variant of Connect that only supports remote shell access, with no ability to screen share. +For Raspberry Pi OS Lite, we distribute an alternate *Lite* variant of Connect that only supports remote shell access, with no ability to screen share. Run the following command on your Raspberry Pi to install Connect Lite: @@ -49,11 +19,9 @@ $ rpi-connect on xref:connect.adoc#enable-remote-shell-at-all-times[Enable user-lingering] to make your device accessible even when your user account isn't logged in. -TIP: Lite commands use the same `rpi-connect` name as the full version of Connect. `rpi-connect-lite` is just a package name. - -=== Manually start and stop Connect +== Manually start and stop Connect -To start Connect from the command line, run the following command: +To start Connect or Connect Lite from the command line, run the following command: [source,console] ---- diff --git a/documentation/asciidoc/services/connect/introduction.adoc b/documentation/asciidoc/services/connect/introduction.adoc index 19ef62fc3..bfccb6487 100644 --- a/documentation/asciidoc/services/connect/introduction.adoc +++ b/documentation/asciidoc/services/connect/introduction.adoc @@ -4,7 +4,9 @@ Raspberry Pi Connect provides secure access to your Raspberry Pi from anywhere i image::images/hero.png[width="100%"] -To use Connect, xref:connect.adoc#install-connect[install the Connect software] and xref:connect.adoc#link-connect[link your device with an account] on your Raspberry Pi. Then visit https://connect.raspberrypi.com[connect.raspberrypi.com] to access the desktop or a shell running on your Raspberry Pi in a browser window. +Connect is installed by default in Raspberry Pi OS Desktop and Raspberry Pi OS Full (desktop with recommended software). Raspberry Pi OS Lite doesn't include Connect by default, but you can xref:connect.adoc#install-connect-lite[install Connect Lite]. + +To use Connect, xref:connect.adoc#link-connect[link your device with a Connect account]. Visit https://connect.raspberrypi.com[connect.raspberrypi.com] to access the desktop or a shell running on your Raspberry Pi in a browser window. Connect uses a secure, encrypted connection. By default, Connect communicates directly between your Raspberry Pi and your browser. However, when Connect can't establish a direct connection between your Raspberry Pi and your browser, we use a relay server. In such cases, Raspberry Pi only retains the metadata required to operate Connect. diff --git a/documentation/asciidoc/services/connect/use.adoc b/documentation/asciidoc/services/connect/use.adoc index a954a50f2..2388242c4 100644 --- a/documentation/asciidoc/services/connect/use.adoc +++ b/documentation/asciidoc/services/connect/use.adoc @@ -7,15 +7,15 @@ Now that you've installed and started Connect on your Raspberry Pi device, you m ====== Desktop:: + -If you're using the Connect plugin for the menu bar, click **Turn On Raspberry Pi Connect** for the first time to open your browser, prompting you to sign in with your Raspberry Pi ID: +From the Connect icon in the menu bar, select **Turn On Raspberry Pi Connect** for the first time to open your browser, prompting you to sign in with your Raspberry Pi ID: + image::images/browser-sign-in.png[width="80%"] + -Alternatively, choose **Sign In...** from the dropdown menu: +If you have already turned on Connect, choose **Sign In...** from the dropdown menu: + image::images/sign-in.png[width="80%"] + -If you don't already have a Raspberry Pi ID, click *create one for free* to xref:id.adoc#create-a-raspberry-pi-id[create one]. +If you don't already have a Raspberry Pi ID, select *create one for free* to xref:id.adoc#create-a-raspberry-pi-id[create one]. CLI:: + @@ -26,7 +26,7 @@ Use the following command to generate a link that will connect your device with $ rpi-connect signin ---- + -This command should output something like the following: +This command outputs something like the following: + ---- Complete sign in by visiting https://connect.raspberrypi.com/verify/XXXX-XXXX @@ -38,7 +38,7 @@ Visit the verification URL on any device and sign in with your Raspberry Pi ID t === Finish linking your Raspberry Pi -After authenticating, assign a name to your device. Choose a name that uniquely identifies the device. Click the **Create device and sign in** button to continue. +After authenticating, assign a name to your device. Choose a name that uniquely identifies the device. Select the **Create device and sign in** button to continue. image::images/new-device.png[width="80%"] @@ -68,7 +68,7 @@ Connect redirects you to the Raspberry Pi ID service to sign in. After signing i image::images/devices.png[width="80%"] -Click the **Connect via** button to the right of the device you would like to access. Select the **Screen sharing** option from the menu. This opens a browser window that displays your device's desktop. +Select the **Connect via** button to the right of the device you want to access. Select the **Screen sharing** option from the menu. This opens a browser window that displays your device's desktop. image::images/waiting-for-screen-sharing.png[width="80%"] @@ -88,7 +88,7 @@ image::images/screen-sharing-notification.png[width="80%"] ==== Stop screen sharing -To close a screen sharing session, click the **Disconnect** button above your desktop. +To close a screen sharing session, select the **Disconnect** button above your desktop. image::images/screen-sharing-ended.png[width="80%"] @@ -129,7 +129,7 @@ Connect redirects you to the Raspberry Pi ID service to sign in. After signing i image::images/devices.png[width="80%"] -Click the **Connect via** button to the right of the device you would like to access. Select the **Remote shell** option from the menu. This opens a shell session on your device. +Select the **Connect via** button to the right of the device you would like to access. Select the **Remote shell** option from the menu. This opens a shell session on your device. image::images/waiting-for-remote-shell.png[width="80%"] @@ -215,7 +215,7 @@ The Connect dashboard lists all of the devices linked with your Connect account image::images/devices.png[width="80%"] -Click on a device name to open the device details page. This screen provides low-level information about your device. You can also edit the device name or remove the device from Connect. +Select a device name to open the device details page. This screen provides low-level information about your device. You can also edit the device name or remove the device from Connect. image::images/device.png[width="80%"] diff --git a/jekyll-assets/_layouts/boxes.html b/jekyll-assets/_layouts/boxes.html index 921302169..b86426c8a 100644 --- a/jekyll-assets/_layouts/boxes.html +++ b/jekyll-assets/_layouts/boxes.html @@ -9,12 +9,12 @@

Raspberry Pi Documentation

-
+
{% include tabs.html %}
-
+
{% for item in site.data.index.tabs %} {% if page.dir == item.path or page.dir == "/" and item.default_tab and item.default_tab == "yes" %} diff --git a/jekyll-assets/_layouts/docs.html b/jekyll-assets/_layouts/docs.html index 086155303..f8f6a9948 100644 --- a/jekyll-assets/_layouts/docs.html +++ b/jekyll-assets/_layouts/docs.html @@ -11,19 +11,19 @@
-
+
-
+
-
+

{{ page.sub_title | markdownify | remove: '

' | remove: '

'}}

{{ content }}
-
On this page
+

On this page

diff --git a/jekyll-assets/css/style.css b/jekyll-assets/css/style.css index 420fe3435..58465ec9b 100644 --- a/jekyll-assets/css/style.css +++ b/jekyll-assets/css/style.css @@ -15,6 +15,7 @@ --accent: #cd2355; --docsearch-primary-color: var(--accent); --docsearch-logo-color: var(--red-tint); + --docsearch-muted-color: #333; --copy-button-bg: #f6f6f6; --copy-button-text: #444; --textcolor: black; @@ -56,6 +57,7 @@ --accent: #d75a64; --docsearch-primary-color: var(--accent); --docsearch-logo-color: var(--red-tint); + --docsearch-muted-color: #333; --copy-button-bg: #707070; --copy-button-text: #CCC; --textcolor: white; @@ -182,6 +184,10 @@ div.subtitle p { background-color: var(--toc-hover-colour); } +#docs-header h2 { + font-size: initial; +} + #docs-header a { font-size: 1.9em; font-weight: 400; @@ -754,7 +760,7 @@ h6 .anchor::before { #content p { font-size: 0.95em; - font-weight: 300; + font-weight: 400; line-height: 1.5em; margin-bottom: 15px; } @@ -926,7 +932,7 @@ span.mlabel { } #content td.content { - font-weight: 300; + font-weight: 400; } #content p > code, @@ -954,7 +960,7 @@ td div.listingblock div.content code { div.imageblock div.title { color: var(--subtle-text); font-style: italic; - font-weight: 300; + font-weight: 400; font-size: 0.8em; margin-top: -15px; margin-bottom: 30px; @@ -1212,7 +1218,7 @@ div.memitem { table.params, p.returns { - font-weight: 300; + font-weight: 400; } table.params td { diff --git a/requirements.txt b/requirements.txt index d4aaeb7f9..591f0f18d 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,3 +1,3 @@ -pyyaml == 6.0.2 +pyyaml == 6.0.3 lxml beautifulsoup4