Pimoroni Learning

https://learn.pimoroni.com/
Admin
This project provides tutorials and guides for using Pimoroni products and components, helping users...
Tokens:199,807
Snippets:3,235
Trust Score:8.9
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install Mote from GitHub

Source: https://learn.pimoroni.com/article/getting-started-with-mote

Manual installation by cloning the repository and running the setup script.

```bash
git clone https://github.com/pimoroni/mote
cd mote/python/library
sudo python setup.py install
```

--------------------------------

### Navigate to examples directory

Source: https://learn.pimoroni.com/article/getting-started-with-unicorn-hat

Changes the current working directory to the location where Unicorn HAT examples are installed.

```bash
cd ~/Pimoroni/unicornhat/examples/
```

--------------------------------

### List Available Examples

Source: https://learn.pimoroni.com/article/getting-started-with-enviro-plus

Navigates to the examples directory and lists files.

```bash
cd enviroplus-python
cd examples
ls
```

--------------------------------

### Install BME680 using one-line installer

Source: https://learn.pimoroni.com/article/getting-started-with-bme680-breakout

Executes the automated installation script to set up the library and download examples to the home directory.

```bash
curl https://get.pimoroni.com/bme680 | bash
```

--------------------------------

### Run RetroPie Installation Script

Source: https://learn.pimoroni.com/article/setting-up-picade-max

Navigates to the setup directory and executes the installation script with root privileges.

```bash
cd RetroPie-Setup
sudo ./retropie_setup.sh
```

--------------------------------

### Install Micro Dot pHAT Python library

Source: https://learn.pimoroni.com/article/assembling-micro-dot-phat

Use the one-line installer to set up the library and download example scripts.

```bash
curl https://get.pimoroni.com/microdotphat | bash
```

--------------------------------

### Install PyUSB from GitHub

Source: https://learn.pimoroni.com/article/controlling-your-robot-wireless-keyboard

Clone the PyUSB repository and install it using the setup script.

```bash
git clone https://github.com/walac/pyusb
cd pyusb
sudo python setup.py install
```

--------------------------------

### Install BME680 library from repository

Source: https://learn.pimoroni.com/article/getting-started-with-bme680-breakout

Clones the official repository and runs the installation script to set up the library and examples.

```bash
git clone https://github.com/pimoroni/bme680-python
cd bme680-python
sudo ./install.sh
```

--------------------------------

### Build SDK Examples

Source: https://learn.pimoroni.com/article/getting-started-with-picosystem-and-c%2B%2B

Configures and compiles the example projects provided with the SDK.

```bash
cd ~/picosystem/build
cmake ..
make

```

--------------------------------

### Navigate to Examples

Source: https://learn.pimoroni.com/article/getting-started-with-unicorn-hat-mini

Commands to access the directory containing the provided example scripts.

```bash
cd ~/Pimoroni/unicornhatmini/examples
ls
```

--------------------------------

### Run Example Scripts

Source: https://learn.pimoroni.com/article/getting-started-with-automation-hat-and-phat

Commands to execute the provided example scripts.

```bash
python3 output.py
```

```bash
python3 analog.py
python3 input.py
python3 relay.py
```

--------------------------------

### Navigate to Example Directories

Source: https://learn.pimoroni.com/article/getting-started-with-automation-hat-and-phat

Commands to navigate to the HAT or HAT Mini example directories.

```bash
cd ~/Pimoroni/automationhat/examples/hat/
```

```bash
cd ~/Pimoroni/automationhat/examples/hat-mini/
```

--------------------------------

### Install Node.js and npm

Source: https://learn.pimoroni.com/article/controlling-display-o-tron-with-node-js

Finalize the installation of the compiled Node.js binaries.

```bash
sudo make install

```

--------------------------------

### Download and Install Library

Source: https://learn.pimoroni.com/article/getting-started-with-unicorn-hat-mini

Commands to clone the repository and run the installation script.

```bash
git clone https://github.com/pimoroni/unicornhatmini-python
cd unicornhatmini-python
sudo ./install.sh
```

--------------------------------

### Run PiGlow Example Script

Source: https://learn.pimoroni.com/article/setting-up-your-piglow

Execute the cycle.py script to start the LED light animation. Use CTRL+C to stop the script.

```python
python cycle.py
```

--------------------------------

### Install Homebridge and plugin

Source: https://learn.pimoroni.com/article/using-mote-with-homekit-and-siri

Installs the Homebridge server and the HTTP-RGB plugin globally.

```bash
sudo npm install -g --unsafe-perm homebridge
sudo npm install -g --unsafe-perm homebridge-better-http-rgb
```

--------------------------------

### Navigate to Inky wHAT examples

Source: https://learn.pimoroni.com/article/getting-started-with-inky-what

Change the current directory to the location of the wHAT-specific examples.

```bash
cd ~/Pimoroni/inky/examples/what
```

--------------------------------

### Navigate to the examples directory

Source: https://learn.pimoroni.com/article/comics-on-inky-impression

Use this command to access the directory containing the comic display examples.

```bash
cd ~/Pimoroni/inky/examples/spectra6/comics
```

--------------------------------

### Navigate to examples directory

Source: https://learn.pimoroni.com/article/getting-started-with-explorer-hat

Change the current directory to the location where Explorer HAT example scripts are stored.

```bash
cd ~/Pimoroni/explorerhat
```

--------------------------------

### Install Flask library

Source: https://learn.pimoroni.com/article/using-mote-with-homekit-and-siri

Install the Flask web framework using pip.

```bash
sudo pip install flask
```

--------------------------------

### Navigate to Display-o-Tron examples

Source: https://learn.pimoroni.com/article/getting-started-with-display-o-tron

Change the current directory to the location of the basic Display-o-Tron example scripts.

```bash
cd ~/Pimoroni/displayotron/examples/basic
```

--------------------------------

### Run the AirPlay installer

Source: https://learn.pimoroni.com/article/streaming-airplay-to-your-pi

Execute the Pimoroni AirPlay installer script via curl.

```bash
curl https://get.pimoroni.com/airdac | bash
```

--------------------------------

### Navigate to Examples Directory

Source: https://learn.pimoroni.com/article/getting-started-with-inky-impression

Changes the current directory to the location of the Spectra Inky examples.

```bash
cd ~/Pimoroni/inky/examples/spectra6
```

--------------------------------

### Run Example Script

Source: https://learn.pimoroni.com/article/getting-started-with-unicorn-hat-mini

Command to execute a specific Python example script.

```bash
python3 demo.py
```

--------------------------------

### Install Display-O-Tron Prerequisites

Source: https://learn.pimoroni.com/article/controlling-display-o-tron-with-node-js

Run the Pimoroni installation script to prepare the Raspberry Pi environment.

```bash
curl https://get.pimoroni.com/displayotron | bash
```

--------------------------------

### Execute Spotify installer

Source: https://learn.pimoroni.com/article/streaming-spotify-to-your-pi

Run the Pimoroni Spotify installation script via curl.

```bash
curl https://get.pimoroni.com/spotipy | bash
```

--------------------------------

### Install Enviro+ Software

Source: https://learn.pimoroni.com/article/enviro-plus-and-luftdaten-air-quality-station

Clones the repository and runs the installation script to configure necessary interfaces.

```bash
git clone https://github.com/pimoroni/enviroplus-python
cd enviroplus-python
sudo ./install.sh
```

--------------------------------

### Run Piano HAT Example

Source: https://learn.pimoroni.com/article/build-an-itty-bitty-beat-box

Executes the simple-piano.py example script to verify Piano HAT functionality.

```bash
cd /home/pi/Pimoroni/pianohat/examples
python simple-piano.py
```

--------------------------------

### Install PICO-8 dependencies

Source: https://learn.pimoroni.com/article/setting-up-picade

Install the required SDL2 development library on the Raspberry Pi.

```bash
sudo apt install libsdl2-dev
```

--------------------------------

### Clone Raspberry Pi Pico examples

Source: https://learn.pimoroni.com/article/pico-development-using-wsl

Downloads the official Raspberry Pi Pico example repository.

```bash
git clone -b master https://github.com/raspberrypi/pico-examples.git
```

--------------------------------

### Install Picade Plasma software

Source: https://learn.pimoroni.com/article/fitting-picade-plasma-buttons

Use the one-line installer to set up the necessary software for the Plasma buttons.

```bash
curl https://get.pimoroni.com/plasma | bash
```

--------------------------------

### Install Explorer HAT software

Source: https://learn.pimoroni.com/article/building-the-tiny-4wd

Downloads and executes the installation script for the Explorer HAT/pHAT library.

```bash
curl https://get.pimoroni.com/explorerhat | bash
```

--------------------------------

### Install Automation HAT library

Source: https://learn.pimoroni.com/article/getting-started-with-automation-hat-and-phat

Commands to clone the repository and execute the installation script on a Raspberry Pi.

```bash
git clone https://github.com/pimoroni/automation-hat
cd automation-hat
./install.sh
```

--------------------------------

### Run the BME680 example script

Source: https://learn.pimoroni.com/article/getting-started-with-bme680-breakout

Executes the provided example script to display continuous sensor readings.

```bash
cd /home/pi/Pimoroni/bme680/examples
python read-all.py
```

--------------------------------

### Install Trilobot Python Library

Source: https://learn.pimoroni.com/article/assembling-trilobot

Downloads the library from GitHub, navigates to the directory, and executes the installation script.

```bash
git clone https://github.com/pimoroni/trilobot-python
cd trilobot-python
sudo ./install.sh
```

--------------------------------

### Install Explorer Craft Library

Source: https://learn.pimoroni.com/article/making-a-minecraft-thermometer

Run this command in the terminal to install the required library for the Explorer HAT.

```bash
sudo pip install explorercraft
```

--------------------------------

### Install PicoSystem build tools

Source: https://learn.pimoroni.com/article/getting-started-with-picosystem-and-c%2B%2B

Installs the required ARM cross-compilation toolchain and libraries on a Linux-based system.

```bash
sudo apt install cmake gcc-arm-none-eabi libnewlib-arm-none-eabi libstdc++-arm-none-eabi-newlib
```

--------------------------------

### Navigate to examples directory

Source: https://learn.pimoroni.com/article/getting-started-with-inky-phat

Changes the current working directory to the location where Inky examples are stored.

```bash
cd ~/Pimoroni/inky/examples
```

--------------------------------

### Install Blinkt! software

Source: https://learn.pimoroni.com/article/beginning-with-blinkt

Executes the installation script for Blinkt! drivers. Requires an active internet connection.

```bash
curl https://get.pimoroni.com/blinkt | bash
```

--------------------------------

### Run Drum HAT Example

Source: https://learn.pimoroni.com/article/build-an-itty-bitty-beat-box

Executes the drums.py example script to verify Drum HAT functionality.

```bash
cd /home/pi/Pimoroni/drumhat/examples
python drums.py
```

--------------------------------

### Install Speaker pHAT software

Source: https://learn.pimoroni.com/article/say-anything-with-a-speaker-phat

Use the one-line installer to set up the necessary drivers and software for the Speaker pHAT.

```bash
curl -sS https://get.pimoroni.com/speakerphat | bash
```

--------------------------------

### Run the simple example script

Source: https://learn.pimoroni.com/article/getting-started-with-unicorn-hat

Executes the simple.py script to verify that the Unicorn HAT hardware is functioning correctly.

```bash
sudo python ./simple.py
```

--------------------------------

### Install Inky pHAT dependencies

Source: https://learn.pimoroni.com/article/getting-started-with-inky-phat

Run this command to install all necessary Python libraries and fonts required for the Inky pHAT examples.

```bash
pip install pillow requests beautifulsoup4 fonts font-source-sans-pro font-source-serif-pro font-fredoka-one font-hanken-grotesk font-intuitive geocoder seaborn wikiquotes
```

--------------------------------

### Run the flash example script

Source: https://learn.pimoroni.com/article/assembling-micro-dot-phat

Navigate to the examples directory and execute the flash script to verify hardware functionality.

```bash
cd /home/pi/Pimoroni/microdotphat/examples
python flash.py
```

--------------------------------

### Install BME680 library via pip

Source: https://learn.pimoroni.com/article/getting-started-with-bme680-breakout

Installs the library package using pip. Note that this method does not automatically download the example files.

```bash
sudo pip install bme680
```

--------------------------------

### Run all-in-one sensor example

Source: https://learn.pimoroni.com/article/getting-started-with-enviro-plus

Executes the comprehensive example that displays data from all sensors on the LCD. Use the light/proximity sensor to toggle screens and press Ctrl+C to exit.

```bash
python all-in-one.py
```

--------------------------------

### Install JVSDisplayOTron Dependency

Source: https://learn.pimoroni.com/article/controlling-display-o-tron-with-node-js

Install the module and save it to package.json.

```bash
npm install jvsdisplayotron --save
```

```text
npm WARN package.json jvsdisplayotron_example@1.0.0 No repository field.
npm WARN package.json jvsdisplayotron_example@1.0.0 No README data
```

--------------------------------

### Install libusb-dev

Source: https://learn.pimoroni.com/article/controlling-your-robot-wireless-keyboard

Install the required libusb-dev dependency before setting up PyUSB.

```bash
sudo apt-get install libusb-dev
```

--------------------------------

### Run 0.96" LCD example

Source: https://learn.pimoroni.com/article/getting-started-with-enviro-plus

Executes the Hello World script for the onboard LCD display.

```bash
python lcd.py
```

--------------------------------

### Install Homebridge dependencies

Source: https://learn.pimoroni.com/article/using-mote-with-homekit-and-siri

Installs the required Avahi library for Homebridge discovery.

```bash
sudo apt-get install libavahi-compat-libdnssd-dev
```

--------------------------------

### Remove Installer Files

Source: https://learn.pimoroni.com/article/getting-started-with-unicorn-hat-mini

Command to delete the cloned directory after installation is complete.

```bash
sudo rm -r ~/unicornhatmini-python
```

--------------------------------

### Start the Unicorn Paint application

Source: https://learn.pimoroni.com/article/getting-started-with-unicorn-paint

Launches the paint.py script with root privileges.

```bash
sudo ./paint.py
```

--------------------------------

### Install requests library

Source: https://learn.pimoroni.com/article/getting-started-with-mote

Command to install the requests library via terminal.

```bash
sudo pip install requests
```

--------------------------------

### Create main.py script

Source: https://learn.pimoroni.com/article/micropython-on-esp-iot-phat

Write a simple script to the filesystem to start the webREPL service automatically.

```python
>>> main=open('main.py','w')
>>> main.write('import webrepl\nwebrepl.start()')
>>> main.close()
```

--------------------------------

### Install smbus2 Dependency

Source: https://learn.pimoroni.com/article/enviro-plus-and-luftdaten-air-quality-station

Installs the smbus2 library required for the Luftdaten script.

```bash
sudo pip install smbus2
```

--------------------------------

### Install Schedule Library

Source: https://learn.pimoroni.com/article/cute-alarm-clock

Command to install the schedule library via pip.

```bash
sudo pip install schedule
```

--------------------------------

### Initialize NPM Package

Source: https://learn.pimoroni.com/article/controlling-display-o-tron-with-node-js

Initialize a new npm project and create the entry point file.

```bash
npm init
```

```text
name: (jvsdisplayotron_example)
version: (1.0.0)
description: JVSDisplayOTron Example
entry point: (index.js)
test command:
git repository:
keywords:
author:
license: (ISC) MIT
```

```bash
touch index.js
```

--------------------------------

### Open pi-lluminate.py for Editing

Source: https://learn.pimoroni.com/article/control-hue-with-envirophat

Access the example script using the nano text editor on the Raspberry Pi.

```bash
nano /home/pi/Pimoroni/enviro-phat/examples/advanced/pi-lluminate.py
```

--------------------------------

### Download RetroPie Setup Script

Source: https://learn.pimoroni.com/article/setting-up-picade-max

Clones the RetroPie-Setup repository from GitHub to the home directory.

```bash
cd ~
git clone --depth=1 https://github.com/RetroPie/RetroPie-Setup.git
```

--------------------------------

### Install alsaaudio library

Source: https://learn.pimoroni.com/article/scroll-phat-spectrum-analyser

Installs the Python alsaaudio library required for audio processing.

```bash
sudo apt-get install python-alsaaudio
```

--------------------------------

### Configure software for Trinket programming

Source: https://learn.pimoroni.com/article/raspberry-pi-programming-adafruit-trinket

Use these commands to clone the repository and execute the setup script on Raspbian.

```bash
git clone https://github.com/pimoroni/programming-trinket-with-raspberry-pi
cd programming-trinket-with-raspberry-pi
./setup-raspbian
```

--------------------------------

### Setting up the display and drawing canvas

Source: https://learn.pimoroni.com/article/getting-started-with-enviro-plus

Initializes the display hardware and creates a blank RGB image for drawing.

```python
disp.begin()

img = Image.new('RGB', (disp.width, disp.height), color=(0, 0, 0))
draw = ImageDraw.Draw(img)
```

--------------------------------

### Install Flask and psutil

Source: https://learn.pimoroni.com/article/raspberry-pi-system-stats-python

Command to install the required Python libraries for the web service.

```bash
sudo pip install psutil flask
```

--------------------------------

### Install Python pip

Source: https://learn.pimoroni.com/article/raspberry-pi-system-stats-python

Command to install the Python package manager on a Raspberry Pi.

```bash
sudo apt-get install python-pip
```

--------------------------------

### Initialize Unicorn HAT Mini

Source: https://learn.pimoroni.com/article/getting-started-with-unicorn-hat-mini

Import the library and create an instance to control the HAT.

```python
from unicornhatmini import UnicornHATMini
uh = UnicornHATMini()
```

--------------------------------

### Install GCC 4.9

Source: https://learn.pimoroni.com/article/controlling-display-o-tron-with-node-js

Install specific versions of GCC and G++ required for compilation.

```bash
 sudo apt-get install gcc-4.9 g++-4.9

```

--------------------------------

### Install inputs library

Source: https://learn.pimoroni.com/article/building-the-tiny-4wd

Installs the Python inputs library required for gamepad recognition.

```bash
sudo pip install inputs
```

--------------------------------

### Remove Installation Directory

Source: https://learn.pimoroni.com/article/assembling-trilobot

Deletes the cloned repository folder after the installation process is complete.

```bash
sudo rm -r ~/trilobot-python/
```

--------------------------------

### Run Light and Proximity Example

Source: https://learn.pimoroni.com/article/getting-started-with-enviro-plus

Executes the script to display ambient light and proximity values.

```bash
python light.py
```

--------------------------------

### Run the Adafruit IO Example

Source: https://learn.pimoroni.com/article/getting-started-with-weather-hat

Execute the script from the terminal to begin posting sensor data to the cloud.

```bash
python adafruit-io.py
```

--------------------------------

### Re-enable and start the background service

Source: https://learn.pimoroni.com/article/getting-started-with-fan-shim

Configures the service to start on boot and initiates it immediately.

```bash
sudo systemctl enable pimoroni-fanshim.service
sudo systemctl start pimoroni-fanshim.service
```

--------------------------------

### Run Luftdaten Script

Source: https://learn.pimoroni.com/article/enviro-plus-and-luftdaten-air-quality-station

Navigates to the examples directory and executes the Luftdaten monitoring script.

```bash
cd enviroplus-python/examples
python luftdaten.py
```

--------------------------------

### Upgrade Node.js and install npm

Source: https://learn.pimoroni.com/article/using-mote-with-homekit-and-siri

Updates the system and installs the latest version of Node.js and npm.

```bash
sudo apt-get update
sudo apt-get upgrade
curl -sL https://deb.nodesource.com/setup_6.x | sudo -E bash -
sudo apt-get install -y nodejs npm
```

--------------------------------

### Install Scroll pHAT library

Source: https://learn.pimoroni.com/article/scroll-phat-spectrum-analyser

Executes the one-line installer script for Scroll pHAT configuration.

```bash
curl https://get.pimoroni.com/scrollphat | bash
```
Tokens:
Raw