Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
78 commits
Select commit Hold shift + click to select a range
13a9f2d
Added whitepapers
Aug 25, 2023
87659e4
Remove 4S
Aug 25, 2023
86dc111
Applying changes
Sep 7, 2023
66827d6
Resolving change requests
Sep 14, 2023
91c9dc8
Merge pull request #3087 from raspberrypi/iss-3062
Sep 14, 2023
22ab9b9
fix typo
RuffaloLavoisier Sep 15, 2023
8127a6c
fix typo
RuffaloLavoisier Sep 15, 2023
c55fbf8
Merge pull request #3116 from RuffaloLavoisier/typo
Sep 15, 2023
d0828b4
Add plcehldr image and update text
Sep 15, 2023
a30cb45
Rip out old raspicam documentation and fix up references to "legacy c…
lurch Jun 27, 2023
b7da87c
Move "raspicam is now gone" notice to a more sensible place!
lurch Jun 27, 2023
efd754e
Removal of tvservice documentation.
lurch Jul 4, 2023
19a7e1c
Fix #2932
lurch Jul 13, 2023
56a5e6d
Remove defunct max_usb_current option
lurch Jul 18, 2023
f62c3d1
Remove explicit include-path and link-path flags. Part of #2996
lurch Jul 27, 2023
f630664
Update composite-video configuration instructions.
lurch Aug 1, 2023
19f06fc
Skeleton commit for the new legacy config.txt options page.
lurch Aug 1, 2023
c3bea82
Update chapters and index
jehlers42 Aug 3, 2023
6611fbd
More changes to text
jehlers42 Aug 3, 2023
9bb1548
Even more changes (I do many commits)
jehlers42 Aug 3, 2023
dce2d73
Removed numbered list
jehlers42 Aug 7, 2023
5e11a05
Update audio configuration instructions
lurch Aug 8, 2023
370286e
Split "legacy" config.txt options out into a separate page
lurch Aug 9, 2023
b62c164
Fix typo
lurch Aug 10, 2023
38c6277
Update display-rotation documentation
lurch Aug 10, 2023
68cf414
Adding images
jehlers42 Aug 11, 2023
52d942e
More images, heading changes for style, etc.
jehlers42 Aug 11, 2023
1ac23ec
fixing heading
jehlers42 Aug 11, 2023
296f116
Changed easily-modified references to X Windows
jehlers42 Aug 14, 2023
40fe2cb
Display rotation tweaks
lurch Aug 15, 2023
748e352
Reverted heading title
jehlers42 Aug 15, 2023
18c2cbb
More link fixes
jehlers42 Aug 15, 2023
059c23d
Update audio configuration to match latest version of raspi-config
lurch Aug 16, 2023
738fec3
Fixing grammatical issues
jehlers42 Aug 16, 2023
d3c59b5
Added alt text to images
jehlers42 Aug 16, 2023
9657ab5
Update legacy_config_txt/boot.adoc
lurch Aug 21, 2023
a46e439
Update omxplayer instructions to VLC instead.
lurch Aug 21, 2023
bfc50df
Edit display-rotation page to put most-likely instructions first
lurch Aug 21, 2023
ac7b1fd
Added a11y to os
Aug 22, 2023
20249e7
Remove outdated tutorials
Aug 22, 2023
685b563
Update legacy OS references
Aug 22, 2023
1848297
Resolving changes
Aug 22, 2023
79800df
Removed cmd-based blanking instructions
Aug 22, 2023
37c749f
small change
Aug 22, 2023
9d122c9
initial addition of pro audio details
Aug 22, 2023
9e0e674
Tweaking camera
Aug 23, 2023
85b0b93
Moved to Desktop
Aug 23, 2023
38566ac
Remove tbd link
Aug 23, 2023
48de454
Updated kernel to 6.1.y
Aug 23, 2023
426e49c
Updates to the HDMI configuration documentation
lurch Aug 30, 2023
2424acb
Add documentation for setting the resolution of the login-screen.
lurch Aug 30, 2023
f14bd85
Change dialog to dialogue
jehlers42 Aug 30, 2023
103398e
Update vcgencmd documentation
lurch Sep 4, 2023
383df1a
camera: Fix maximum exposure time value for Camera v1
naushir Sep 5, 2023
c595590
Update raspi-config documentation
lurch Sep 6, 2023
73e0a40
Add note about using Screen Configuration utility on X11
lurch Sep 7, 2023
430c38f
Updated boot partition mentions to use new path
Sep 8, 2023
ddca95d
Update screensaver.adoc
lurch Sep 11, 2023
3d88dc5
Remove mention of `vcgencmd display_power`
lurch Sep 11, 2023
4eda806
Updated missed explicit boot partition path mentions
Sep 11, 2023
09a9414
Touch Display updates
lurch Sep 12, 2023
f4780f9
Update libcamera_options_common.adoc
lurch Sep 12, 2023
a325675
Slightly expanded Wayland / X11 explanation.
lurch Sep 12, 2023
6f9a3ae
Merge display-rotation into display-resolution
lurch Sep 12, 2023
aaffb60
added new raspi-config img
Sep 11, 2023
88fc352
added more images
Sep 13, 2023
cb00439
Remove 'flipped' rotation options, as they're not supported by arandr
lurch Sep 13, 2023
26b2375
kernel and firmware packages have been renamed in Bookworm
lurch Sep 13, 2023
25b261f
Small bit missed out of last commit
lurch Sep 13, 2023
d0b367e
Added new images to relevant locations in docs
Sep 13, 2023
84d4d49
Updated display configuration instructions for Bookworm changes
Sep 13, 2023
683a735
Implemented andrew and al feedback
Sep 13, 2023
cdf9113
Updated to reflect journalctl
Sep 13, 2023
920f246
Modified journalctl arguments
Sep 14, 2023
550a5e8
Updated screenshot
Sep 14, 2023
ae527c0
Removed compositor
Sep 14, 2023
02fa083
Updated performance config
Sep 14, 2023
1dee857
Changed absolute link
Sep 15, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions documentation/asciidoc/accessories/audio/configuration.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ image::images/gui.png[]

There are a number of third-party audio software applications available for Raspberry Pi that will support the plug-and-play feature of our audio boards. Often these are used headless. They can be controlled via a PC or Mac application, or by a web server installed on Raspberry Pi, with interaction through a webpage.

If you need to configure Raspberry Pi OS yourself, perhaps if you're running a headless system of your own and don't have the option of control via the GUI, you will need to make your Raspberry Pi audio board the primary audio device in Raspberry Pi OS, disabling the Raspberry Pi’s on-board audio device. This is done by editing the `/boot/config.txt` file. Using a Terminal session connected to your Raspberry Pi via SSH, run the following command to edit the file:
If you need to configure Raspberry Pi OS yourself, perhaps if you're running a headless system of your own and don't have the option of control via the GUI, you will need to make your Raspberry Pi audio board the primary audio device in Raspberry Pi OS, disabling the Raspberry Pi’s on-board audio device. This is done by editing the xref:../computers/config_txt.adoc#what-is-config-txt[`/boot/firmware/config.txt`] file. Using a Terminal session connected to your Raspberry Pi via SSH, run the following command to edit the file:

----
$ sudo nano /boot/config.txt
$ sudo nano /boot/firmware/config.txt
----

Find the `dtparam=audio=on` line in the file and comment it out by placing a # symbol at the start of the line. Anything written after the # symbol in any given line will be disregarded by the program. Your ``/boot/config.txt`` file should now have the following entry:
Find the `dtparam=audio=on` line in the file and comment it out by placing a # symbol at the start of the line. Anything written after the # symbol in any given line will be disregarded by the program. Your `/boot/firmware/config.txt` file should now contain the following entry:

----
#dtparam=audio=on
Expand All @@ -24,7 +24,7 @@ Press CTRL+X, then Y and Enter to save, followed by a reboot of your Raspberry P
$ sudo reboot
----

Alternatively, the `/boot/config.txt` file can be edited directly onto the Raspberry Pi's microSD card, inserted into your usual computer. Using the default file manager, open the `boot` volume on the card and edit the `config.txt` file using an appropriate text editor, then save the file, eject the microSD card and reinsert it back into your Raspberry Pi.
Alternatively, the `/boot/firmware/config.txt` file can be edited directly onto the Raspberry Pi's microSD card, inserted into your usual computer. Using the default file manager, open the `/boot/firmware/` volume on the card and edit the `config.txt` file using an appropriate text editor, then save the file, eject the microSD card and reinsert it back into your Raspberry Pi.

=== Attaching the HAT

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,9 @@ Use a small flat-head screwdriver to attach your speaker to the screw terminals.

=== Setting up your Raspberry Pi

In this example, we are using Raspberry Pi OS Lite. Our guides on https://www.raspberrypi.com/documentation/computers/getting-started.html#installing-the-operating-system[Getting started] cover this topic in great detail. Make sure that you update your operating system before proceeding and follow the instructions provided for Codec Zero configuration, including the commands to enable the on-board microphone and speaker output.
In this example, we are using Raspberry Pi OS Lite. Refer to our guide on xref:../computers/getting-started.adoc#installing-the-operating-system[installing Raspberry Pi OS] for more details.

Make sure that you update your operating system before proceeding and follow the instructions provided for Codec Zero configuration, including the commands to enable the on-board microphone and speaker output.

=== Programming your Raspberry Pi

Expand Down
10 changes: 0 additions & 10 deletions documentation/asciidoc/accessories/audio/hardware-info.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -70,16 +70,6 @@ To restore a saved file:
$ sudo alsactl restore -f /home/pi/usecase.state
----

=== Using external USB devices

If you want to enable 1.2 amp USB support (to allow USB hard disks to power up when
accessory boards are in use), you may also want to add the following line to your `/boot/config.txt`
file:

----
max_usb_current=1
----

=== MPD-based audio with volume control

To allow Music Player Daemon (MPD)-based audio software to control the audio board’s built in volume, the file
Expand Down
Binary file modified documentation/asciidoc/accessories/audio/images/gui.png
100644 → 100755
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/accessories/build-hat/images/raspi-config-2.png
100644 → 100755
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/accessories/build-hat/images/setting-up.png
100644 → 100755
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 @@ -6,7 +6,7 @@ Install the Build HAT Python library. Open a Terminal window and type,

[source]
----
$ pip3 install buildhat
$ sudo apt install python3-buildhat
----

For more information about the Build HAT Python Library see https://buildhat.readthedocs.io/[ReadTheDocs].
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ Then, please follow the relevant setup instructions for the xref:../computers/ca
| Depends on lens

| Maximum exposure times (seconds)
| 6 (legacy) / 0.97 (libcamera)
| 0.97
| 11.76
| 112
| 112
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Connect the XVS wires to the 1.65V potential divider pull up.

==== Boot up both Raspberry Pis

The file `/sys/module/imx477/parameters/trigger_mode` determines which board outputs pulses, or waits to recieve pulses (source and sink).
The file `/sys/module/imx477/parameters/trigger_mode` determines which board outputs pulses, or waits to receive pulses (source and sink).
This parameter can only be altered in superuser mode.

On the sink, run:
Expand Down Expand Up @@ -57,7 +57,7 @@ This ensures that no frames are created or lost upon startup. The source whilst

=== Using the GS Camera

NOTE: The Global Shutter (GS) camera can also be operated in a synchonous mode. However, the source camera will record one extra frame. A much better alternative method to ensure that both cameras capture the same amount of frames is to use the xref:camera.adoc#external-trigger-on-the-gs-camera[external trigger method].
NOTE: The Global Shutter (GS) camera can also be operated in a synchronous mode. However, the source camera will record one extra frame. A much better alternative method to ensure that both cameras capture the same amount of frames is to use the xref:camera.adoc#external-trigger-on-the-gs-camera[external trigger method].

To operate as source and sink together, the Global Shutter Cameras also require connection of the XHS (horizontal sync) pins together. However, these do not need connection to a pullup resistor.

Expand Down
75 changes: 23 additions & 52 deletions documentation/asciidoc/accessories/display/display_intro.adoc
Original file line number Diff line number Diff line change
@@ -1,36 +1,47 @@
== Raspberry Pi Touch Display

The Raspberry Pi Touch Display is an LCD display which connects to the Raspberry Pi through the DSI connector. In some situations, it allows for the use of both the HDMI and LCD displays at the same time (this requires software support).
The https://www.raspberrypi.com/products/raspberry-pi-touch-display/[Raspberry Pi Touch Display] is an LCD display which connects to the Raspberry Pi through the DSI connector. In recent versions of Raspberry Pi OS, both the HDMI and LCD display outputs can be used at the same time.

=== Board Support

The DSI display is designed to work with all models of Raspberry Pi, however early models that do not have mounting holes (the Raspberry Pi 1 Model A and B) will require additional mounting hardware to fit the HAT-dimensioned stand-offs on the display PCB.

=== Physical Installation
=== Connecting a Raspberry Pi

The following image shows how to attach the Raspberry Pi to the back of the Touch Display (if required), and how to connect both the data (ribbon cable) and power (red/black wires) from the Raspberry Pi to the display. If you are not attaching the Raspberry Pi to the back of the display, take extra care when attaching the ribbon cable to ensure it is the correct way round. The black and red power wires should be attached to the GND and 5v pins respectively.
The following image shows how to attach a Raspberry Pi to the back of the Touch Display using the included standoffs. It also shows the connections you need to make between Raspberry Pi and the display's PCB. You can also mount the touch display in a separate chassis if you have one available. The connections remain the same, though you may need longer cables depending on the chassis you use.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this needs properly expanding with several images that show this process step-by-step. Possibly we should go down the route of an animated GIF, e.g. see https://www.raspberrypi.com/documentation/accessories/build-hat.html#preparing-your-build-hat.


image::images/GPIO_power-500x333.jpg[DSI Display Connections]
image::images/GPIO_power-500x333.jpg[DSI Display pinout]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This image needs reshot by Brian. He has an Asana task to reshoot all (most) of the existing documentation imagery. So no need to nudge him about this one.


The other three pins should be left disconnected, unless connecting the display to an original Raspberry Pi 1 Model A or B. See the section on xref:display.adoc#legacy-support[legacy support] for more information on connecting the display to an original Raspberry Pi.
Connect one end of the ribbon cable to the `RPI-DISPLAY` port on the Touch Display PCB (make sure the blue stripe faces the PCB) and then connect the other end to the `DISPLAY` port on the Raspberry Pi (the blue stripe should face outwards).

==== Powering the Touch Display

There are two options to power the Touch Display: using the Raspberry Pi's GPIO to send power, or powering the display directly with a separate micro USB cable.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should sub-section, if there are two options there should be two separate sections.


WARNING: If you use a micro USB cable to power the display it must be mounted inside a chassis to reduce the risk of electrocution. The chassis also must block access to the display's PCB while its in use.

The following instructions are only relevant if you're using the Raspberry Pi for power. Do not make these connections when powering the display through its micro USB port.

Make sure the Raspberry Pi is powered off and unplugged, then connect one end of the black jumper wire to pin six (GND) on the Raspberry Pi and one end of the red jumper wire to pin four (5V). Next, connect the other end of the black wire to the GND pin on the display and the other end of the red wire to the 5V pin on the display.

.Connect the red and black wires to 5V and GND
image::images/touch-GPIO.png[Illustration of display pins, width=250]
Copy link
Contributor

@aallan aallan Sep 16, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't use pixel widths, e.g. width=250. Instead use percentiles, e.g. width="50%"


The other three pins on the Touch Display are used to connect the display to an original Raspberry Pi 1 Model A or B. Refer to our documentation on xref:display.adoc#legacy-support[legacy support] for more information.

NOTE: An original Raspberry Pi can be easily identified from other models, it is the only model with a 26-pin rather than 40-pin GPIO header connector.

=== Screen Orientation

LCD displays have an optimum viewing angle, and depending on how the screen is mounted it may be necessary to change the orientation of the display to give the best results. By default, the Raspberry Pi Touch Display and Raspberry Pi are set up to work best when viewed from slightly above, for example on a desktop. If viewing from below, you can physically rotate the display, and then tell the system software to compensate by running the screen upside down.

==== KMS and FKMS Mode

KMS and FKMS modes are used by default on the Raspberry Pi 4B. KMS and FKMS use the DRM/MESA libraries to provide graphics and 3D acceleration.

To set screen orientation when running the graphical desktop, select the `Screen Configuration` option from the `Preferences` menu. Right click on the DSI display rectangle in the layout editor, select Orientation then the required option.

To set screen orientation when in console mode, you will need to edit the kernel command line to pass the required orientation to the system.

[,bash]
----
sudo nano /boot/cmdline.txt
sudo nano /boot/firmware/cmdline.txt
----

To rotate by 90 degrees clockwise, add the following to the cmdline, making sure everything is on the same line, do not add any carriage returns. Possible rotation values are 0, 90, 180 and 270.
Expand All @@ -39,47 +50,7 @@ To rotate by 90 degrees clockwise, add the following to the cmdline, making sure
video=DSI-1:800x480@60,rotate=90
----

NOTE: In console mode it is not possible to rotate the DSI display separately to the HDMI display, so if you have both attached they must both be set to the same value.

==== Legacy Graphics Mode

Legacy graphics mode is used by default on all Raspberry Pi models prior to the Raspberry Pi 4B, and can also be used on the Raspberry Pi 4B if required, by disabling KMS and FKMS modes by commenting out the KMS or FKMS line in `config.txt`.

NOTE: Legacy mode on the Raspberry Pi 4B has no 3D acceleration so it should only be used if you have a specific reason for needing it.

To flip the display, add the following line to the file `/boot/config.txt`:

`lcd_rotate=2`

This will vertically flip the LCD and the touch screen, compensating for the physical orientation of the display.

You can also rotate the display by adding the following to the `config.txt` file.

* `display_lcd_rotate=x`, where `x` can be one of the following:

|===
| display_lcd_rotate | result

| 0
| no rotation

| 1
| rotate 90 degrees clockwise

| 2
| rotate 180 degrees clockwise

| 3
| rotate 270 degrees clockwise

| 0x10000
| horizontal flip

| 0x20000
| vertical flip
|===

NOTE: The 90 and 270 degree rotation options require additional memory on the GPU, so these will not work with the 16MB GPU split.
NOTE: In console mode it is not possible to rotate the DSI display separately to the HDMI display, so if you have both attached they must both be set to the same rotation value.

=== Touchscreen Orientation

Expand Down Expand Up @@ -136,4 +107,4 @@ Read our troubleshooting steps, tips, and tricks here: xref:display.adoc#trouble

* Outer dimensions: 192.96 × 110.76mm
* Viewable area: 154.08 × 85.92mm
* https://datasheets.raspberrypi.com/display/7-inch-display-mechanical-drawing.pdf[Download mechanical drawing (PDF)]
* https://datasheets.raspberrypi.com/display/7-inch-display-mechanical-drawing.pdf[Download mechanical drawing (PDF)]
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 1 addition & 2 deletions documentation/asciidoc/accessories/display/legacy.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,9 @@ Using the jumper cables, connect SCL/SDA on the GPIO header to the horizontal pi

For the GPIO header pinout, see http://pinout.xyz/[this diagram].

DSI display autodetection is disabled by default on these boards. To enable detection, add the following line to `/boot/config.txt`:
DSI display autodetection is disabled by default on these boards. To enable detection, add the following line to the xref:../computers/config_txt.adoc#what-is-config-txt[`/boot/firmware/config.txt`] file:

`ignore_lcd=0`

Power the setup via the `PWR IN` micro-USB connector on the display board. Do not power the setup via the Raspberry Pi's micro-USB port: the input polyfuse's maximum current rating will be exceeded as the display consumes approximately 400mA.

NOTE: With the display connected to the GPIO I2C pins, the GPU will assume control of the respective I2C bus. The host operating system should not access this I2C bus, as simultaneous use of the bus by both the GPU and Linux will result in sporadic crashes.
Loading