2. Installation Guide

Prerequisites

Raspberry Pi:

• We recommend using a Raspberry Pi 4B. But any model should work.
• Fresh installation of Raspbian; we recommend using Raspbian Buster over the more recent Bullseye release.
  • See here for a guide on flashing and installing Raspbian onto your SD card.
• Raspberry Pi camera module.
  • See here for hardware installation instructions. Remember to enable camera input with raspi-config!
• A display, mouse and keyboard.

Ubuntu (desktop):

• A webcam or USB camera compatible with OpenCV. This should usually not require further configuration.

To follow the subsequent install procedure, you will also need git. This may be installed with sudo apt install git.

Installation Video

Install Procedure

1. Clone the repository.

git clone https://github.com/albanjoseph/Signapse

2. Enter the Signapse project directory

cd Signapse

3. Run the setup.sh script to install all dependencies.

bash setup.sh

Note: Signapse is heavily reliant on a version of the OpenCV library which must be built from source, setup.sh builds a barebones version of this library with only the required modules. This may still take up to 15 minutes on a Raspberry Pi and around 10 minutes on an x86 machine. Great time to grab a coffee and explore some of our other wiki entries, or our releases page.

4. Run the build.sh script to build Signapse.

bash build.sh

Alternatively, build Signapse with cmake and make:

cmake .
make

5. Launch Signapse by running the executable located in the bin/ directory

bin/Signapse