Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update to use Raspberry Pi imaging tool #1428

Merged
merged 13 commits into from
Mar 6, 2020
3 changes: 2 additions & 1 deletion glossary/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
- **Device Tree blob (DTB)** – A binary file containing a Device Tree; the result of compiling DTS files.
- **`dt-blob.bin`** – a binary file containing initial GPIO configuration that is read by the firmware at boot time; despite the name, this is __not__ Device Tree blob (although it is compiled by the Device Tree tools).
- **DVI** – [Digital Visual Interface](https://en.wikipedia.org/wiki/Digital_Visual_Interface), a video interface for connecting a source device to a monitor or display; electrically compatible with HDMI, so a simple adapter can convert from one to the other (excluding audio, which DVI does not support).
- **balenaEtcher** - The tool we recommend for [programming SD cards](../installation/installing-images/README.md) ready for use on our devices; available for Linux, Windows, and Mac.
- **balenaEtcher** - A graphical tool for [programming SD cards](../installation/installing-images/README.md) ready for use on our devices; available for Linux, Windows, and Mac. Now superceded by Raspberry Pi's own imaging tool, which can be downloaded [here](https://www.raspberrypi.org/downloads/)
- **FAQ** - Frequently Asked Questions! See our [FAQ]../faqs/).
- **Firmware** – Software that runs on a particular hardware device, for example a wireless chip or dongle; distinct from the usual software running on the Raspberry Pi in that it is usually a fixed binary blob of data that is loaded on to the device at startup; on the Raspberry Pi, the VC4 GPU requires firmware to be loaded to it at startup in order boot up and run the entire system.
- **GNU** - The [GNU Project](https://en.wikipedia.org/wiki/GNU_Project) is a free software mass collaboration project, which has produced huge amounts of software that is used on the Raspberry Pi, including Linux itself.
Expand Down Expand Up @@ -53,6 +53,7 @@
- **PoE** - Power over Ethernet, a mechanism to power a device through its Ethernet connection; we produce a [PoE HAT](https://www.raspberrypi.org/products/poe-hat) for the Raspberry Pi 3 Model B+ and Raspberry Pi 4 Model B.
- **Polyfuse** - A self-resetting electrical fuse used on some Pi models to protect against over-current; can take hours or even days to reset.
- **`raspi-config`** – A command line tool for configuring Raspbian's operating system features; see our [official documentation](../configuration/raspi-config.md).
- **Raspberry Pi Imaging Tool** - The official graphical tool for downloading and installing operating system images to the SD card. Download it [here](https://www.raspberrypi.org/downloads/)
JamesH65 marked this conversation as resolved.
Show resolved Hide resolved
- **raspivid, raspistill, raspiyuv, raspividyuv** – a set of applications to run the Raspberry Pi Camera Module in various modes; see our [official documentation](../raspbian/applications/camera.md).
- **Raspbian** - A Debian-based Linux distribution targeted at the entire Raspberry Pi range, regarded as the official operating system; the current version is based on Debian Buster, with the first release in June 2019; see the [Wikipedia entry for further release details](https://en.wikipedia.org/wiki/Raspbian).
- **Raspberry Pi Configuration Tool (`rcgui`)** – A graphical equivalent of `raspi-config`.
Expand Down
38 changes: 19 additions & 19 deletions installation/installing-images/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,39 +2,39 @@

This resource explains how to install a Raspberry Pi operating system image on an SD card. You will need another computer with an SD card reader to install the image.

We recommend most users download [NOOBS](../noobs.md), which is designed to be very easy to use. However, more advanced users looking to install a particular image should use this guide.
Before you start, don't forget to check [the SD card requirements](../sd-cards.md).

## Using the Raspberry Pi Imaging Tool

Raspberry Pi have developed a graphical SD card writing tool that works on Mac OS, Ubuntu 18.04 and Windows, and is the easiest option for most users as it will download the image and install it automatically to the SD card.

- Download the latest version of [Raspberry Pi Imager](https://www.raspberrypi.org/downloads/) and install it.
- Connect an SD card reader with the SD card inside.
- Open Raspberry Pi Imager and choose the required OS from the list presented.
- Choose the SD card you wish to write your image to.
- Review your selections and click 'WRITE' to begin writing data to the SD card.

## Using other tools

Most other tool require you to download the image first, then use the tool to write it to your SD card.
JamesH65 marked this conversation as resolved.
Show resolved Hide resolved

## Download the image
### Download the image

Official images for recommended operating systems are available to download from the Raspberry Pi website [Downloads page](https://www.raspberrypi.org/downloads/).
JamesH65 marked this conversation as resolved.
Show resolved Hide resolved

Alternative distributions are available from third-party vendors.

If you're not using balenaEtcher (see below), you'll need to unzip `.zip` downloads to get the image file (`.img`) to write to your SD card.
You may need to unzip `.zip` downloads to get the image file (`.img`) to write to your SD card.

**Note**: the Raspbian with Raspberry Pi Desktop image contained in the ZIP archive is over 4GB in size and uses the [ZIP64](https://en.wikipedia.org/wiki/Zip_%28file_format%29#ZIP64) format. To uncompress the archive, a unzip tool that supports ZIP64 is required. The following zip tools support ZIP64:

- [7-Zip](http://www.7-zip.org/) (Windows)
- [The Unarchiver](http://unarchiver.c3.cx/unarchiver) (Mac)
- [Unzip](https://linux.die.net/man/1/unzip) (Linux)

## Writing an image to the SD card

Before you start, don't forget to check [the SD card requirements](../sd-cards.md).

You will need to use an image writing tool to install the image you have downloaded on your SD card.

**balenaEtcher** is a graphical SD card writing tool that works on Mac OS, Linux and Windows, and is the easiest option for most users. balenaEtcher also supports writing images directly from the zip file, without any unzipping required. To write your image with balenaEtcher:

- Download the latest version of [balenaEtcher](https://www.balena.io/etcher/) and install it.
- Connect an SD card reader with the SD card inside.
- Open balenaEtcher and select from your hard drive the Raspberry Pi `.img` or `.zip` file you wish to write to the SD card.
- Select the SD card you wish to write your image to.
- Review your selections and click 'Flash!' to begin writing data to the SD card.

**Note**: for Linux users, `zenity` might need to be installed on your machine for `balenaEtcher` to be able to write the image on your SD card.
### Writing the image

For more advanced control of this process, see our system-specific guides:
How you write the image to the SD card will depend on the operating system you are using.

- [Linux](linux.md)
- [Mac OS](mac.md)
Expand Down
2 changes: 1 addition & 1 deletion installation/installing-images/linux.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Installing operating system images on Linux

[balenaEtcher](README.md) is typically the easiest option for most users to write images to SD cards, so it is a good place to start. If you're looking for more advanced options on Linux, you can use the standard command line tools below.
[Raspberry Pi Imager](README.md) is typically the easiest option for most users to write images to SD cards, so it is a good place to start. If you're looking for more advanced options on Linux, you can use the standard command line tools below.

**Note**: use of the `dd` tool can overwrite any partition of your machine. If you specify the wrong device in the instructions below, you could delete your primary Linux partition. Please be careful.

Expand Down
2 changes: 1 addition & 1 deletion installation/installing-images/mac.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Copying an operating system image to an SD card using Mac OS

[balenaEtcher](README.md) is the recommended option for most users to write images to SD cards.
[Raspberry Pi Imager](README.md) is the recommended option for most users to write images to SD cards.

## Determine SD device

Expand Down
2 changes: 1 addition & 1 deletion installation/installing-images/windows.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Installing operating system images using Windows

[balenaEtcher](https://www.balena.io/etcher/) is typically the easiest option for most users to write images to SD cards, so it is a good place to start. If you're looking for an alternative on Windows, you can use Win32DiskImager or imgFlasher.
[Raspberry Pi Imager](README.md) is our recommended option for most users to write images to SD cards, so it is a good place to start. If you're looking for an alternative on Windows, you can use balenaEtcher, Win32DiskImager or imgFlasher.

## balenaEtcher

Expand Down