Merge pull request #3179 from raspberrypi/develop

Push to production

documentation/asciidoc/accessories/tv-hat.adoc

@@ -1,61 +1 @@
-== Getting Started
-
-The TV HAT has an on-board DVB-T2 tuner that allows you to receive and decode digital television streams on your Raspberry Pi. Then you can watch these streams on the Raspberry Pi or on any computer connected to the same network as the Raspberry Pi.
-
-The software we recommend to decode the streams (known as multiplexes, or muxes for short) and view content is called TVHeadend, and instructions for setting it up are below. The TV HAT can decode one mux at a time, and each mux can contain several channels to choose from. Content can either be viewed on the Raspberry Pi to which the TV-HAT is connected, or sent to another device on the same network.
-
-*You will need:*
-
-* A TV aerial
-* A Raspberry Pi TV HAT with its stand-offs, screws, and aerial adaptor
-* A Raspberry Pi that is connected to the internet (plus a mouse, keyboard, and display, if
-you are not accessing the Raspberry Pi remotely)
-* Optional: another computer connected to the same network
-
-== Setup Instructions
-
-*On your Raspberry Pi:*
-
-* Connect the aerial adaptor to the TV HAT:
- ** With the adaptor pointing away from the USB ports, press the HAT gently down over the Raspberry Pi's GPIO pins
- ** Place the spacers at two or three of the corners of the HAT, and tighten the screws through the mounting
-holes to hold them in place.
-* Connect the TV HAT's aerial adaptor to the cable from your TV aerial.
-* Set up the Raspberry Pi with the newest version of the Raspberry Pi OS operating system, which you can download from our https://www.raspberrypi.com/software/operating-systems/#raspberry-pi-os-32-bit[downloads page].
-* Start up your Raspberry Pi, open a terminal window, and run the following two commands to install the `tvheadend` software:
-+
-----
-sudo apt update
-sudo apt install tvheadend
-----
-
-* During the `tvheadend` installation, you will be asked to choose an administrator account name and password. You'll need these later, so make sure to pick something you can remember.
-
-*In a web browser on a different computer:*
-
-* Type the following into the address bar: `+http://raspberrypi.local:9981/extjs.html+`
-* This should connect to `tvheadend` running on the Raspberry Pi.
- ** If the address above doesn't work, you'll need to find out the IP address of the Raspberry Pi. Open a terminal window on your Raspberry Pi, and run the command `hostname -I`
- ** You'll see the IP address in one or two formats: a string of four numbers separated by dots, then, if you are on a IPv6 network, a space, then a long string of numbers and letters separated by colons.
- ** Note down everything before the space (the four numbers and dots), and type this into the address bar instead of the `raspberrypi.local` part of the address.
-* Once you have connected to `tvheadend` via the browser, you will be prompted to sign in. Use the account name and password you chose when you installed `tvheadend` on the Raspberry Pi. A setup wizard should appear.
-* First, set the language you want `tvheadend` to use (*English (GB)* worked for us; we have not yet tested other languages).
-* Next, set up network, user, and administrator access. If you don't have specific preferences, leave *Allowed network* blank, and enter an asterisk (*) in the *username* and *password* fields. This will let anyone connected to your local network access `tvheadend`.
-* You should see a window titled *Network settings*. Under *Network 2*, you should see `Tuner: Sony CDX2880 #0 : DVB-T #0`. For *Network type*, choose `DVB-T Network`.
-* The next window is *Assign predefined muxes to networks*; here, you select the TV stream to receive and decode. Under Network 1, for predefined muxes, select your local TV transmitter.
- ** Your local transmitter can be found using the https://www.freeview.co.uk/help[Freeview website]. Enter your postcode to see which transmitter should give you a good signal.
-* When you click *Save & Next*, the software will start scanning for the selected mux, and will show a progress bar. After about two minutes, you should see something like:
-+
-----
-Found muxes: 8
-Found services: 172
-----
-
-* In the next window, titled *Service mapping*, tick all three boxes: *Map all services*, *Create provider tags*, and *Create network tags*.
-* Next you should see a list of TV channels you can watch, along with the programmes they're currently showing.
-* To watch a TV channel in the browser, click the little TV icon to the left of the channel listing, just to the right of the *i* icon. This brings up an in-browser media player. Depending on the decoding facilities  built into your browser and the type of stream being played, you may find that playback can be jerky. In these cases, we recommend using a local media player as the playback application.
-* To watch a TV channel in a local media player, e.g. VLC https://www.videolan.org/vlc[www.videolan.org/vlc], you'll need to download it as a stream. Click the `i` icon to the left of a channel listing to bring up the information panel for that channel. Here you can see a stream file that you can download.
-
-`tvheadend` is supported by numerous apps, such as TvhClient for iOS, which will play TV from the Raspberry Pi.
-
-To discuss other features or uses of the TV HAT, please visit our https://forums.raspberrypi.com/[forums].
+include::tv-hat/about-tv-hat.adoc[]

documentation/asciidoc/accessories/tv-hat/about-tv-hat.adoc

@@ -0,0 +1,75 @@
+== About the TV HAT
+
+.The Raspberry Pi TV HAT
+image::images/tv-hat.jpg[width="80%"]
+
+The Raspberry Pi TV HAT allows you to receive digital terrestrial TV broadcast systems, using an onboard DVB-T and DVB-T2 tuner, on a Raspberry Pi. With the board you can receive and view TV on a Raspberry Pi, or create a TV server that allows you to stream received TV over a network to other devices. The TV HAT can be used with any 40-pin Raspberry Pi board as a server for other devices on the network. Performance when receiving and viewing TV on the Pi itself can vary, and we recommend using a Raspberry Pi 2 or later for thi spurpose
+
+Key features:
+
+* Sony CXD2880 TV tuner
+* Supported TV standards: DVB-T2, DVB-T
+* Reception frequency: VHF III, UHF IV, UHF V
+* Channel bandwidth:
+** DVB-T2: 1.7MHz, 5MHz, 6MHz, 7MHz, 8MHz
+** DVB-T: 5MHz, 6MHz, 7MHz, 8MHz
+
+== About DVB-T
+
+WARNING: The TV HAT does not support ATSC, the digital TV standard used in North America.
+
+Digital Video Broadcasting – Terrestrial (DVB-T) is the DVB European-based consortium standard for the broadcast transmission of digital terrestrial television. There are other digital TV standards used elsewhere in the world, e.g. ATSC which is used in North American. However the TV HAT only supports the DVB-T and DVB-T2 standards.
+
+.DTT system implemented or adopted (Source: DVB/EBU/BNE DTT Deployment Database, March 2023)
+image::images/dvbt-map.png[width="80%"]
+
+== Setup Instructions
+
+Follow our xref:../computers/getting-started.adoc[getting started] documentation and set up the Raspberry Pi with the newest version of Raspberry Pi OS operating system
+
+Connect the aerial adaptor to the TV HAT and with the adaptor pointing away from the USB ports, press the HAT gently down over the Raspberry Pi's GPIO pins, and place the spacers at two or three of the corners of the HAT, and tighten the screws through the mounting holes to hold them in place. Then connect the TV HAT's aerial adaptor to the cable from your TV aerial.
+
+The software we recommend to decode the streams (known as multiplexes, or muxes for short) and view content is called TVHeadend. The TV HAT can decode one mux at a time, and each mux can contain several channels to choose from. Content can either be viewed on the Raspberry Pi to which the TV-HAT is connected, or sent to another device on the same network.
+
+Boot your Raspberry Pi and then go ahead open a terminal window, and run the following two commands to install the `tvheadend` software:
+
+[source, bash]
+----
+$ sudo apt update
+$ sudo apt install tvheadend
+----
+
+During the `tvheadend` installation, you will be asked to choose an administrator account name and password. You'll need these later, so make sure to pick something you can remember.
+
+On another computer on your network, open up a web browser and type the following into the address bar: `http://raspberrypi.local:9981/extjs.html`
+
+This should connect to `tvheadend` running on the Raspberry Pi. Once you have connected to `tvheadend` via the browser, you will be prompted to sign in using the account name and password you chose when you installed `tvheadend` on the Raspberry Pi. 
+
+A setup wizard should appear.
+
+You will be first ask to set the language you want `tvheadend` to use, and then to set up network, user, and administrator access. If you don't have specific preferences, leave *Allowed network* blank, and enter an asterisk (*) in the *username* and *password* fields. This will let anyone connected to your local network access `tvheadend`.
+
+You should see a window titled *Network settings*. Under *Network 2*, you should see `Tuner: Sony CDX2880 #0 : DVB-T #0`. For *Network type*, choose `DVB-T Network`. The next window is *Assign predefined muxes to networks*; here, you select the TV stream to receive and decode. Under Network 1, for predefined muxes, select your local TV transmitter.
+
+NOTE: Your local transmitter can be found using the https://www.freeview.co.uk/help[Freeview website]. Enter your postcode to see which transmitter should give you a good signal.
+
+When you click *Save & Next*, the software will start scanning for the selected mux, and will show a progress bar. After about two minutes, you should see something like:
+
+[source, bash]
+----
+Found muxes: 8
+Found services: 172
+----
+
+In the next window, titled *Service mapping*, tick all three boxes: *Map all services*, *Create provider tags*, and *Create network tags*. You should see a list of TV channels you can watch, along with the programmes they're currently showing. 
+
+To watch a TV channel in the browser, click the little TV icon to the left of the channel listing, just to the right of the *i* icon. This brings up an in-browser media player. Depending on the decoding facilities  built into your browser and the type of stream being played, you may find that playback can be jerky. In these cases, we recommend using a local media player as the playback application.
+
+To watch a TV channel in a local media player, e.g. https://www.videolan.org/vlc[VLC], you'll need to download it as a stream. Click the `i` icon to the left of a channel listing to bring up the information panel for that channel. Here you can see a stream file that you can download.
+
+NOTE: `tvheadend` is supported by numerous apps, such as TvhClient for iOS, which will play TV from the Raspberry Pi.
+
+== Mechanical Drawing
+
+.The Raspberry Pi TV HAT
+image::images/mechanical.png[]

documentation/asciidoc/computers/compute-module/datasheet.adoc

@@ -13,13 +13,6 @@ There is also a KiCad PCB design set available:
 
 * https://datasheets.raspberrypi.com/cm4io/CM4IO-KiCAD.zip[Compute Module 4 IO Board KiCad files]
 
-[.whitepaper, title="Transitioning from CM3 to CM4", subtitle="", link=https://pip.raspberrypi.com/categories/685-whitepapers-app-notes/documents/RP-003469-WP/Transitioning-from-CM3-to-CM4.pdf]
-****
-This whitepaper is for those who wish to move from using a Raspberry Pi Compute Module (CM) 1 or 3 to a Raspberry Pi CM 4.
-
-From a software perspective, the move from Raspberry Pi CM 1/3 to Raspberry Pi CM 4 is relatively painless, as Raspberry Pi OS should work on all platforms.
-****
-
 [.whitepaper, title="Configuring the Compute Module 4", subtitle="", link=https://pip.raspberrypi.com/categories/685-whitepapers-app-notes/documents/RP-003470-WP/Configuring-the-Compute-Module-4.pdf]
 ****
 The Raspberry Pi Compute Module 4 (CM 4) is available in a number of different hardware configurations. Sometimes it may be necessary to disable some of these features when they are not required.
@@ -50,6 +43,13 @@ Schematics for the Compute Module camera/display adapter board (CMCDA):
 
 * https://datasheets.raspberrypi.com/cmcda/cmcda-schematics.pdf[CMCDA Rev 1.1]
 
+[.whitepaper, title="Transitioning from CM3 to CM4", subtitle="", link=https://pip.raspberrypi.com/categories/685-whitepapers-app-notes/documents/RP-003469-WP/Transitioning-from-CM3-to-CM4.pdf]
+****
+This whitepaper is for those who wish to move from using a Raspberry Pi Compute Module (CM) 1 or 3 to a Raspberry Pi CM 4.
+
+From a software perspective, the move from Raspberry Pi CM 1/3 to Raspberry Pi CM 4 is relatively painless, as Raspberry Pi OS should work on all platforms.
+****
+
 ==== Under Voltage Detection
 
 Schematic for an under-voltage detection circuit, as used in older models of Raspberry Pi:

documentation/asciidoc/computers/configuration/boot_folder.adoc

@@ -6,11 +6,13 @@ When the Raspberry Pi is powered on, it loads various files from the boot partit
 
 Once Linux has booted, the boot partition is mounted as `/boot/firmware/`.
 
+NOTE: Prior to _Bookworm_, Raspberry Pi OS stored the boot partition at `/boot/`. Since _Bookworm_, the boot partition is located at `/boot/firmware/`.
+
 === Boot Folder Contents
 
 ==== bootcode.bin
 
-This is the bootloader, which is loaded by the SoC on boot, does some very basic setup, and then loads one of the `start*.elf` files. `bootcode.bin` is not used on the Raspberry Pi 4, because it has been replaced by boot code in the xref:raspberry-pi.adoc#raspberry-pi-4-boot-eeprom[onboard EEPROM].
+This is the bootloader, which is loaded by the SoC on boot; it does some very basic setup, and then loads one of the `start*.elf` files. `bootcode.bin` is not used on the Raspberry Pi 4, because it has been replaced by boot code in the xref:raspberry-pi.adoc#raspberry-pi-4-boot-eeprom[onboard EEPROM].
 
 ==== start.elf, start_x.elf, start_db.elf, start_cd.elf, start4.elf, start4x.elf, start4db.elf, start4cd.elf
 
@@ -27,7 +29,7 @@ These are linker files and are matched pairs with the `start*.elf` files listed
 
 ==== cmdline.txt
 
-The kernel command line passed in to the kernel when it boots.
+The kernel <<the-kernel-command-line,command line>> passed in to the kernel when it boots.
 
 ==== config.txt
 

documentation/asciidoc/computers/configuration/screensaver.adoc

@@ -37,7 +37,7 @@ The `dpms_timeout` variable controls the number of seconds of inactivity require
 
 === 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 boot command line.
+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.
 
 ==== Set console mode screen blanking