Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
41 commits
Select commit Hold shift + click to select a range
b64288b
Update the .NET installation instructions
Taytay Mar 5, 2022
0345770
Fix code formatting for .NET install instructions
Taytay Mar 5, 2022
f59a377
Add instructions for running and editing C# code
Taytay Mar 5, 2022
38d2f66
Update the VS Code installation instructions
Taytay Mar 5, 2022
2f50ec5
Update device-tree.adoc
agners Apr 11, 2022
e9b4448
Update documentation/asciidoc/computers/configuration/device-tree.adoc
agners Apr 11, 2022
eebd347
Update documentation/asciidoc/computers/configuration/device-tree.adoc
agners Apr 12, 2022
96d947e
Deleted all non-Imager installation paths
Apr 24, 2022
7a172e0
Cleaned up reference to deleted section
Apr 24, 2022
be3090a
Removed the 'Using Linux' section entirely
Apr 24, 2022
2f8768f
Update raspi-config.adoc
Apr 25, 2022
b864ae2
typo
lurch Apr 25, 2022
d23d08b
Update cm-emmc-flashing.adoc
Apr 29, 2022
7b30c72
Update installing-from-an-image.adoc
Apr 29, 2022
4f40b7f
Small edits to BCM2835 page
lurch May 3, 2022
80cbe56
Fixup kB and MB to be consistent with the style-guide
lurch May 4, 2022
9f58e6e
Bump nokogiri from 1.13.4 to 1.13.6
dependabot[bot] May 9, 2022
4588de0
Merge pull request #2531 from raspberrypi/styleguide_fixes
May 10, 2022
dbae4a0
Merge pull request #2534 from raspberrypi/dependabot/bundler/develop/…
May 10, 2022
90e9d30
Merge pull request #2529 from raspberrypi/lurch-patch-1
May 10, 2022
a354b68
Minor copy-edit
lurch May 10, 2022
bb59bd1
Merge pull request #2536 from raspberrypi/lurch-patch-1
May 11, 2022
ec408f6
Merge pull request #2506 from agners/patch-1
May 11, 2022
4376428
Merge pull request #2518 from raspberrypi/clean-up-install
May 11, 2022
5553141
Merge pull request #2467 from Taytay/patch-3
May 11, 2022
f9e5187
Remove redundant link
lurch May 11, 2022
a2e9545
Merge pull request #2538 from raspberrypi/lurch-patch-1
May 11, 2022
dd710fd
Minor bootloader updates + document the PARTITION property
timg236 May 11, 2022
ddf373d
Merge pull request #2539 from timg236/bootloader-partition-property
May 11, 2022
191d01c
Minor copy-edit
lurch May 11, 2022
8a1c3bb
Merge pull request #2540 from raspberrypi/lurch-patch-1
May 11, 2022
3b5ed1d
Update README.md
May 16, 2022
bcd5149
Update README.md
May 16, 2022
3e26016
Fix typo in libcamera_raw.adoc
ziemek99 May 19, 2022
d9895b4
Merge pull request #2545 from ziemek99/patch-1
May 20, 2022
42d3481
Document secure-boot config.txt properties
timg236 May 20, 2022
585e871
Small copy-edits
lurch May 23, 2022
5ff8fe9
Merge pull request #2543 from timg236/secure-boot-config-txt
May 23, 2022
c88d4c8
Merge pull request #2519 from raspberrypi/remove-using-linux
May 23, 2022
5cbb3c0
Fix redirects to match #2519
lurch May 23, 2022
c77fa8e
Merge pull request #2547 from raspberrypi/lurch-patch-1
May 24, 2022
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
2 changes: 1 addition & 1 deletion Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ GEM
jekyll (>= 3.5, < 5.0)
jekyll-feed (~> 0.9)
jekyll-seo-tag (~> 2.1)
nokogiri (1.13.4)
nokogiri (1.13.6)
mini_portile2 (~> 2.8.0)
racc (~> 1.4)
pathutil (0.16.2)
Expand Down
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,15 @@ $ brew install ruby@2.7

**NOTE:** Homebrew defaults to Ruby 3.0 which is incompatible with Asciidoctor.

**IMPORTANT:** Homebrew has problems using `/bin/zsh`, you may have to change your default shell to `/bin/bash`.

##### Set up Homebrew Version of Ruby

If you're using `csh` or `tcsh` add the following lines to your `.cshrc` or `.tcshrc`,

```
setenv PATH /usr/local/bin:/usr/local/sbin:$PATH

setenv PATH /usr/local/opt/ruby/bin:${PATH}
setenv PATH ${PATH}:/usr/local/lib/ruby/gems/2.7.0/bin
setenv LDFLAGS -L/usr/local/opt/ruby@2.7/lib
Expand All @@ -71,13 +75,18 @@ setenv PKG_CONFIG_PATH /usr/local/opt/ruby@2.7/lib/pkgconfig
or if you're using `bash` add the following lines to your `.bash_profile`,

```
export PATH="/usr/local/bin:/usr/local/sbin:$PATH"

export PATH="/usr/local/opt/ruby/bin:$PATH"
export PATH="$PATH:/usr/local/lib/ruby/gems/2.7.0/bin"
export PATH="/usr/local/opt/ruby@2.7/bin:$PATH"
export LDFLAGS="-L/usr/local/opt/ruby@2.7/lib"
export CPPFLAGS="-I/usr/local/opt/ruby@2.7/include"
export PKG_CONFIG_PATH="/usr/local/opt/ruby@2.7/lib/pkgconfig"
```
NOTE: If you are running macOS on an Apple Silicon based Mac, rather than an Intel Mac, substitute `/opt/homebrew/` for `/usr/local` in the lines dealing with `ruby@2.7` in the above block.

and then open a new Terminal window to make sure you're using the right version of Python and Ruby.

##### Install Dependencies

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,41 @@ WARNING: The installation script is run as `root`. You should read it first and
$ wget -O - https://raw.githubusercontent.com/pjgpetecodes/dotnet5pi/master/install.sh | sudo bash
----

After installing the .NET framework you also need to install the nuget packages:
After installing the .NET framework you can create your project:

[.bash]
----
$ dotnet add package System.Device.Gpio --source https://pkgs.dev.azure.com/dotnet/IoT/_packaging/nightly_iot_builds/nuget/v3/index.json
$ dotnet add package Iot.Device.Bindings --source https://pkgs.dev.azure.com/dotnet/IoT/_packaging/nightly_iot_builds/nuget/v3/index.json
$ dotnet new console --name buildhat
----

You can now create a project and edit it.
This creates a default program in the `buildhat` subdirectory, and we need to be in that directory in order to continue:

[.bash]
----
$ cd buildhat
----

You will now need to install the following nuget packages:
[.bash]
----
$ dotnet add package System.Device.Gpio --version 2.1.0
$ dotnet add package Iot.Device.Bindings --version 2.1.0
----

=== Running C# Code

You can run the program with the `dotnet run` command. Let's try it now to make sure everything works.
It should print "Hello World!"

[.bash]
----
$ dotnet run
Hello World!
----

(When instructed to "run the program" in the instructions that follow, you will simply rerun `dotnet run`)

=== Editing C# Code
In the instructions below, you will be editing the file `buildhat/Program.cs`, the C# program which was generated when you ran the above commands.

Any text editor will work to edit C# code, including Geany, the IDE/Text Editor that comes pre-installed. https://code.visualstudio.com/docs/setup/raspberry-pi/[Visual Studio Code] (often called "VS Code") is also a popular alternative.
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

=== Installing the Python Library

Install the Build HAT Python library. Open xref:../computers/using_linux.adoc#terminal[a Terminal window] and type,
Install the Build HAT Python library. Open a Terminal window and type,

[source]
----
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ libcamera-raw -t 2000 -o test.raw

The raw frames are dumped with no formatting information at all, one directly after another. The application prints the pixel format and image dimensions to the terminal window so that the user can know how to interpret the pixel data.

By default the raw frames are saved in a single (potentially very large) file. As we saw previously, the `--segement` option can be used conveniently to direct each to a separate file.
By default the raw frames are saved in a single (potentially very large) file. As we saw previously, the `--segment` option can be used conveniently to direct each to a separate file.
[,bash]
----
libcamera-raw -t 2000 --segment 1 -o test%05d.raw
Expand Down
6 changes: 3 additions & 3 deletions documentation/asciidoc/accessories/camera/raspicam.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ Capture your raw video with raspivid and wrap it in an MP4 container like this:

[,bash]
----
# Capture 30 seconds of raw video at 640x480 and 150kB/s bit rate into a pivideo.h264 file:
# Capture 30 seconds of raw video at 640x480 and 150kBps bit rate into a pivideo.h264 file:
raspivid -t 30000 -w 640 -h 480 -fps 25 -b 1200000 -p 0,0,640,480 -o pivideo.h264
# Wrap the raw video with an MP4 container:
MP4Box -add pivideo.h264 pivideo.mp4
Expand Down Expand Up @@ -945,7 +945,7 @@ Height of resulting video. This should be between 64 and 1080.
--bitrate, -b Set bitrate
----

Use bits per second, so 10Mbits/s would be `-b 10000000`. For H264, 1080p30 a high quality bitrate would be 15Mbits/s or more. Maximum bitrate is 25Mbits/s (`-b 25000000`), but much over 17Mbits/s won't show noticeable improvement at 1080p30.
Use bits per second, so 10Mbps would be `-b 10000000`. For H264, 1080p30 a high quality bitrate would be 15Mbps or more. Maximum bitrate is 25Mbps (`-b 25000000`), but much over 17Mbps won't show noticeable improvement at 1080p30.

----
--output, -o Output filename <filename>
Expand Down Expand Up @@ -1308,7 +1308,7 @@ Record a 5s clip with default settings (1080p30):
raspivid -t 5000 -o video.h264
----

Record a 5s clip at a specified bitrate (3.5Mbits/s):
Record a 5s clip at a specified bitrate (3.5Mbps):

[,bash]
----
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ For more information run

==== Writing to the eMMC (Windows)

After `rpiboot` completes, a new USB mass storage drive will appear in Windows. We recommend following this xref:getting-started.adoc#installing-images-on-windows[guide] and using Win32DiskImager to write images to the drive, rather than trying to use `/dev/sda` etc. from Cygwin.
After `rpiboot` completes, a new USB mass storage drive will appear in Windows. We recommend using https://www.raspberrypi.com/software/[Raspberry Pi Imager] to write images to the drive.

Make sure J4 (USB SLAVE BOOT ENABLE) / J2 (nRPI_BOOT) is set to the disabled position and/or nothing is plugged into the USB slave port. Power cycling the IO board should now result in the Compute Module booting from eMMC.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ During boot, the user can specify a specific ARM device tree to use via the `dev

In addition to loading an ARM dtb, `start.elf` supports loading additional Device Tree 'overlays' via the `dtoverlay` parameter in `config.txt`, for example adding as many `dtoverlay=myoverlay` lines as required as overlays to `config.txt`, noting that overlays live in `/overlays` and are suffixed `-overlay.dtb` e.g. `/overlays/myoverlay-overlay.dtb`. Overlays are merged with the base dtb file before the data is passed to the Linux kernel when it starts.

Overlays are used to add data to the base dtb that (nominally) describes non board-specific hardware. This includes GPIO pins used and their function, as well as the device(s) attached, so that the correct drivers can be loaded. The convention is that on a Raspberry Pi, all hardware attached to the Bank0 GPIOs (the GPIO header) should be described using an overlay. On a Compute Module all hardware attached to the Bank0 and Bank1 GPIOs should be described in an overlay file. You don't have to follow these conventions: you can roll all the information into one single dtb file, as previously described, replacing `bcm2708-rpi-cm.dtb`. However, following the conventions means that you can use a 'standard' Raspberry Pi OS release, with its standard base dtb and all the product-specific information contained in a separate overlay. Occasionally the base dtb might change - usually in a way that will not break overlays - which is why using an overlay is suggested.
Overlays are used to add data to the base dtb that (nominally) describes non-board-specific hardware. This includes GPIO pins used and their function, as well as the device(s) attached, so that the correct drivers can be loaded. The convention is that on a Raspberry Pi, all hardware attached to the Bank0 GPIOs (the GPIO header) should be described using an overlay. On a Compute Module all hardware attached to the Bank0 and Bank1 GPIOs should be described in an overlay file. You don't have to follow these conventions: you can roll all the information into one single dtb file, as previously described, replacing `bcm2708-rpi-cm.dtb`. However, following the conventions means that you can use a 'standard' Raspberry Pi OS release, with its standard base dtb and all the product-specific information contained in a separate overlay. Occasionally the base dtb might change - usually in a way that will not break overlays - which is why using an overlay is suggested.

=== dt-blob.bin

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
== What is `config.txt`?

The Raspberry Pi uses a configuration file instead of the https://en.wikipedia.org/wiki/BIOS[BIOS] you would expect to find on a conventional PC. The system configuration parameters, which would traditionally be edited and stored using a BIOS, are stored instead in an optional text file named `config.txt`. This is read by the GPU before the ARM CPU and Linux are initialised. It must therefore be located on the first (boot) partition of your SD card, alongside `bootcode.bin` and `start.elf`. This file is normally accessible as `/boot/config.txt` from Linux, and must be edited as xref:using_linux.adoc#root-and-sudo[root]. From Windows or OS X it is visible as a file in the only accessible part of the card. If you need to apply some of the config settings below, but you don't have a `config.txt` on your boot partition yet, simply create it as a new text file.
The Raspberry Pi uses a configuration file instead of the https://en.wikipedia.org/wiki/BIOS[BIOS] you would expect to find on a conventional PC. The system configuration parameters, which would traditionally be edited and stored using a BIOS, are stored instead in an optional text file named `config.txt`. This is read by the GPU before the ARM CPU and Linux are initialised. It must therefore be located on the first (boot) partition of your SD card, alongside `bootcode.bin` and `start.elf`. This file is normally accessible as `/boot/config.txt` from Linux, and must be edited as the `root` user. From Windows or OS X it is visible as a file in the only accessible part of the card. If you need to apply some of the config settings below, but you don't have a `config.txt` on your boot partition yet, simply create it as a new text file.

Any changes will only take effect after you have rebooted your Raspberry Pi. After Linux has booted, you can view the current active settings using the following commands:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -980,7 +980,7 @@ This sets an (exclusive) limit to the loaded device tree. By default the device
If non-zero, turn on some extra logging for the firmware's device tree processing.

`enable_uart`
Enable the primary/console xref:configuration.adoc#configuring-uarts[UART] (ttyS0 on a Raspberry Pi 3, ttyAMA0 otherwise - unless swapped with an overlay such as miniuart-bt). If the primary UART is ttyAMA0 then enable_uart defaults to 1 (enabled), otherwise it defaults to 0 (disabled). This is because it is necessary to stop the core frequency from changing which would make ttyS0 unusable, so `enable_uart=1` implies core_freq=250 (unless force_turbo=1). In some cases this is a performance hit, so it is off by default.
Enable the primary/console xref:configuration.adoc#configuring-uarts[UART] (ttyS0 on a Raspberry Pi 3, 4, 400, Zero W and Zero 2 W, ttyAMA0 otherwise - unless swapped with an overlay such as miniuart-bt). If the primary UART is ttyAMA0 then `enable_uart` defaults to 1 (enabled), otherwise it defaults to 0 (disabled). This is because it is necessary to stop the core frequency from changing which would make ttyS0 unusable, so `enable_uart=1` implies `core_freq=250` (unless `force_turbo=1`). In some cases this is a performance hit, so it is off by default.

`overlay_prefix`
Specifies a subdirectory/prefix from which to load overlays - defaults to "overlays/". Note the trailing "/". If desired you can add something after the final "/" to add a prefix to each file, although this is not likely to be needed.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,9 @@ Specify the audio output destination.
[[change-user-password]]
===== Password

The default user on Raspberry Pi OS is `pi` with the password `raspberry`. You can change that here. Read about other xref:using_linux.adoc#linux-users[users].
You can change the 'default' user password.

NOTE: Until recently the default user on Raspberry Pi OS was `pi` with the password `raspberry`. The default user is now set on first boot using a configuration wizard.

[[hostname]]
===== Hostname
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ NOTE: Choosing option 'Q' will save the file with any syntax errors still in pla

An up-to-date distribution contains all the latest security fixes, so you should go ahead and xref:os.adoc#updating-and-upgrading-raspberry-pi-os[update] your version of Raspberry Pi OS to the latest version.

If you are using SSH to connect to your Raspberry Pi, it can be worthwhile to xref:using_linux.adoc#scheduling-tasks-with-cron[add a cron job] that specifically updates the ssh-server. The following command, perhaps as a daily cron job, will ensure you have the latest SSH security fixes promptly, independent of your normal update process.
If you are using SSH to connect to your Raspberry Pi, it can be worthwhile to add a `cron` job that specifically updates the ssh-server. The following command, perhaps as a daily cron job, will ensure you have the latest SSH security fixes promptly, independent of your normal update process.

[,bash]
----
Expand Down
11 changes: 1 addition & 10 deletions documentation/asciidoc/computers/getting-started.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,6 @@ include::getting-started/setting-up.adoc[]

include::getting-started/installing-from-an-image.adoc[]

include::getting-started/configuring.adoc[]

include::getting-started/network-installation.adoc[]

include::getting-started/installing-from-chromeos.adoc[]

include::getting-started/installing-from-linux.adoc[]

include::getting-started/installing-from-mac.adoc[]

include::getting-started/installing-from-windows.adoc[]

include::getting-started/configuring.adoc[]
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
== Installing the Operating System

Raspberry Pi recommend the use of https://www.raspberrypi.com/software/[Raspberry Pi Imager] to install an operating system on your SD card. You will need another computer with an SD card reader to install the image.
Raspberry Pi recommend the use of https://www.raspberrypi.com/software/[Raspberry Pi Imager] to install an operating system on to your SD card. You will need another computer with an SD card reader to install the image. Raspberry Pi Imager can be run on another Raspberry Pi, but also works on Microsoft Windows, Apple macOS, and Linux.

NOTE: Before you start, don't forget to check the xref:getting-started.adoc#sd-cards[SD card requirements].

Expand Down Expand Up @@ -45,7 +45,7 @@ If you are installing Raspberry Pi OS Lite and intend to run it xref:configurati

=== Downloading an Image

If you are using a different tool than Raspberry Pi Imager to write to your SD Card, most require you to download the image first, then use the tool to write it to the card. Official images for recommended operating systems are available to download from the Raspberry Pi website https://www.raspberrypi.com/software/operating-systems/#raspberry-pi-os-32-bit[downloads page]. Alternative operating systems for Raspberry Pi computers are https://www.raspberrypi.com/software/operating-systems/#third-party-software[also available] from some third-party vendors.
If you are using a different tool than Raspberry Pi Imager to write to your SD Card, most require you to download the image first, then use the tool to write it to the card. Official images for recommended operating systems are available to download from the Raspberry Pi website https://www.raspberrypi.com/software/operating-systems/#raspberry-pi-os-32-bit[downloads page]. Alternative operating systems for Raspberry Pi computers are also available from some third-party vendors.

You may need to unzip the downloaded file (`.zip`) to get the image file (`.img`) you need to write to the card.

Expand Down

This file was deleted.

Loading