Skip to content

Commit

Permalink
Update references to Raspbian
Browse files Browse the repository at this point in the history
  • Loading branch information
bennuttall committed Feb 22, 2021
1 parent bdfb40c commit a591c0d
Show file tree
Hide file tree
Showing 5 changed files with 35 additions and 33 deletions.
7 changes: 4 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -108,9 +108,10 @@ this in the section on `mock pins`_.
Installation
============

GPIO Zero is installed by default in the Raspbian desktop image, available from
`raspberrypi.org`_. To install on Raspbian Lite or other operating systems,
including for PCs using remote GPIO, see the `Installing`_ chapter.
GPIO Zero is installed by default in the Raspberry Pi OS desktop image,
available from `raspberrypi.org`_. To install on Raspberry Pi OS Lite or other
operating systems, including for PCs using remote GPIO, see the `Installing`_
chapter.

.. _raspberrypi.org: https://www.raspberrypi.org/downloads/
.. _Installing: https://gpiozero.readthedocs.io/en/stable/installing.html
Expand Down
2 changes: 1 addition & 1 deletion docs/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ If you have multiple versions installed (e.g. from :command:`pip` and
be the version that ``import gpiozero`` will import.

If you receive the error "No module named pkg_resources", you need to install
:command:`pip`. This can be done with the following command in Raspbian:
:command:`pip`. This can be done with the following command in Raspberry Pi OS:

.. code-block:: console
Expand Down
16 changes: 8 additions & 8 deletions docs/installing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,11 @@
Installing GPIO Zero
====================

GPIO Zero is installed by default in the `Raspbian`_ image, and the
`Raspberry Pi Desktop`_ image for PC/Mac, both available from
`raspberrypi.org`_. Follow these guides to installing on Raspbian Lite
and other operating systems, including for PCs using the
:doc:`remote GPIO <remote_gpio>` feature.
GPIO Zero is installed by default in the `Raspberry Pi OS`_ desktop image, and
the `Raspberry Pi Desktop`_ image for PC/Mac, both available from
`raspberrypi.org`_. Follow these guides to installing on Raspberry Pi OS Lite
and other operating systems, including for PCs using the :doc:`remote GPIO
<remote_gpio>` feature.

Raspberry Pi
============
Expand Down Expand Up @@ -83,7 +83,7 @@ to install GPIO Zero on that computer using pip. See the :doc:`remote_gpio`
page for more information.


.. _Raspbian: https://www.raspberrypi.org/downloads/raspbian/
.. _Raspberry Pi Desktop: https://www.raspberrypi.org/downloads/raspberry-pi-desktop/
.. _raspberrypi.org: https://www.raspberrypi.org/downloads/
.. _Raspberry Pi OS: https://www.raspberrypi.org/software/operating-systems/
.. _Raspberry Pi Desktop: https://www.raspberrypi.org/software/raspberry-pi-desktop/
.. _raspberrypi.org: https://www.raspberrypi.org/software/
.. _get-pip: https://pip.pypa.io/en/stable/installing/
23 changes: 12 additions & 11 deletions docs/pi_zero_otg.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,9 @@ GPIO expander method - no SD card required

The GPIO expander method allows you to boot the Pi Zero over USB from the PC,
without an SD card. Your PC sends the required boot firmware to the Pi over the
USB cable, launching a mini version of Raspbian and booting it in RAM. The OS
then starts the pigpio daemon, allowing "remote" access over the USB cable.
USB cable, launching a mini version of Raspberry Pi OS and booting it in RAM.
The OS then starts the pigpio daemon, allowing "remote" access over the USB
cable.

At the time of writing, this is only possible using either the Raspberry Pi
Desktop x86 OS, or Ubuntu (or a derivative), or from another Raspberry Pi.
Expand All @@ -60,8 +61,8 @@ Raspberry Pi Desktop x86 setup
3. Live boot your PC or Mac into the OS (select "Run with persistence" and your
computer will be back to normal afterwards).

Raspberry Pi (Raspbian) setup
-----------------------------
Raspberry Pi setup (using Raspberry Pi OS)
------------------------------------------

1. Update your package list and install the ``usbbootgui`` package:

Expand Down Expand Up @@ -105,10 +106,9 @@ will automatically launch a prompt to select a role for the device. Select

It will take 30 seconds or so to flash it, then the dialogue will disappear.

Raspberry Pi Desktop and Raspbian will name your Pi Zero connection ``usb0``.
On Ubuntu, this will likely be something else. You can ping it using the
address ``fe80::1%`` followed by the connection string. You can look this up
using ``ifconfig``.
Raspberry Pi OS will name your Pi Zero connection ``usb0``. On Ubuntu, this will
likely be something else. You can ping it using the address ``fe80::1%``
followed by the connection string. You can look this up using ``ifconfig``.

Set the :envvar:`GPIOZERO_PIN_FACTORY` and :envvar:`PIGPIO_ADDR` environment
variables on your PC so GPIO Zero connects to the "remote" Pi Zero:
Expand All @@ -134,10 +134,11 @@ Read more on the GPIO expander in blog posts on `raspberrypi.org`_ and
Legacy method - SD card required
================================

The legacy method requires the Pi Zero to have a Raspbian SD card inserted.
The legacy method requires the Pi Zero to have an SD card with Raspberry Pi OS
inserted.

Start by creating a Raspbian (desktop or lite) SD card, and then configure the
boot partition like so:
Start by creating a Raspberry Pi OS (desktop or lite) SD card, and then
configure the boot partition like so:

1. Edit :file:`config.txt` and add ``dtoverlay=dwc2`` on a new line, then save
the file.
Expand Down
20 changes: 10 additions & 10 deletions docs/remote_gpio.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,9 @@ used.
Preparing the Raspberry Pi
==========================

If you're using Raspbian (desktop - not Raspbian Lite) then you have everything
you need to use the remote GPIO feature. If you're using Raspbian Lite, or
another distribution, you'll need to install pigpio:
If you're using Raspberry Pi OS (desktop - not Lite) then you have everything
you need to use the remote GPIO feature. If you're using Raspberry Pi OS Lite,
or another distribution, you'll need to install pigpio:

.. code-block:: console
Expand All @@ -70,8 +70,8 @@ Raspberry Pi.
Enable remote connections
-------------------------

On the Raspbian desktop image, you can enable *Remote GPIO* in the Raspberry
Pi configuration tool:
On the Raspberry Pi OS desktop image, you can enable *Remote GPIO* in the
Raspberry Pi configuration tool:

.. image:: images/raspi-config.png
:align: center
Expand Down Expand Up @@ -134,11 +134,11 @@ the ``-n`` flag. For example:
Preparing the control computer
==============================

If the control computer (the computer you're running your Python code from) is
a Raspberry Pi running Raspbian (or a PC running `Raspberry Pi Desktop x86`_),
then you have everything you need. If you're using another Linux distribution,
Mac OS or Windows then you'll need to install the `pigpio`_ Python library on
the PC.
If the control computer (the computer you're running your Python code from) is a
Raspberry Pi running Raspberry Pi OS (or a PC running `Raspberry Pi Desktop
x86`_), then you have everything you need. If you're using another Linux
distribution, Mac OS or Windows then you'll need to install the `pigpio`_ Python
library on the PC.


Raspberry Pi
Expand Down

0 comments on commit a591c0d

Please sign in to comment.