/pireplay

Capture and instantly replay the last moments by using a web application controlling a Raspberry Pi with a camera.

Primary LanguagePython

PiReplay

Capture and instantly replay the last moments by using a web application controlling a Raspberry Pi with a camera.

Take a look at the project's roadmap to see upcoming features (and all the work accomplished).

Note - Check out the pireplay Python package (CLI) on PyPI: https://pypi.org/project/pireplay (managed using Poetry).

Project Structure

A short description of the project's structure for quick reference:

  • cad: for 3D models files, 3D printing
  • pireplay: the source code of the Python pireplay package

Do It Yourself

Here are the instructions (tutorial) for setting up a fully working PiReplay device, using a Raspberry Pi Zero 2 W.

Requirements

  • Raspberry Pi Zero 2 W board
  • Micro SD card 64 GB
  • Raspberry Pi Camera module 3 (NoIR wide 120FOV, black)
  • CSI Camera FPC connector cable to Raspberry Pi Zero
  • Micro USB cable

Raspberry Pi Zero Setup

  1. Download and install the Raspberry Pi OS Imager: https://www.raspberrypi.com/software/
  2. Connect the SD card to your computer and flash the OS on the card using Raspberry Pi OS Imager
    1. Raspberry Pi Device: Raspberry Pi Zero 2 W
    2. Operating System: Raspberry Pi OS (other) > Raspberry Pi OS Lite (64-bit)
    3. Storage: Select SD card
    4. Next > Edit Settings (additional configuration)
      • General > Set hostname: pireplay.local
      • General > Set username and password: pireplay (use a safe password)
      • General > Configure wireless LAN: use your current Wi-Fi network credentials (only for setup purposes, we will use a Wi-Fi Hotspot configuration later).
      • Services > Enable SSH (using password authentication)
    5. Flash the SD card and wait till it completes
  3. Insert the SD card inside the Raspberry Pi and power it using the micro USB cable (wait a few seconds)
  4. Connect to your Raspberry Pi using an SSH client
    • You can connect using Putty, or simply running ssh from your terminal
    • Connect using pireplay@pireplay.local as the host (use port 22)
    • Enter the password you specified in Pi OS Imager during configuration

You are now connected via SSH to your brand new Raspberry Pi Zero.

PiReplay Setup

Once connected to the Raspberry Pi via SSH, you can install and set up the pireplay software to run on it.

INSTRUCTIONS NOT FINISHED

Troubleshoot

If you run into network problems on you device, you might want to use SSH over USB to fix them. Follow this tutorial to enable SSH over USB: https://gist.github.com/etoxin/d96418f0732c0de36f0f3c22f9bdd75d.

Contributions

Feel free to contribute by submitting pull requests, whether to add new features, improve existing functionality, or fix bugs :)

Before opening a new PR, make sure to open an issue to discuss it beforehand (first check if a similar issue does not already exist).

Powered by

This project would not be possible without the wonderful technologies below: