Skip to main content

TAPPER Client Installation

Basic installation of the TAPPER client application.

Prepare​

TL;DR
# For easy copy
sudo apt update && sudo apt upgrade
sudo reboot
# reconnect
sudo apt install git pipx python3-dev
pipx ensurepath
sudo raspi-config # enable serial port and SPI
pipx install 'git+ssh://git@github.com/hardwario/tapper.git@main#egg=tapper' # stable

Continue at Test it out

Flash the Raspberry Pi​

tip

Raspberry Pi Imager allows you to set up a hostname, SSH, WiFi, and other settings.

Update the Raspberry Pi​

  • Connect to your Raspberry Pi through SSH (ssh <host>)
  • Run sudo apt update && sudo apt upgrade
    • This will update your indexes and download newer versions of installed packages
  • Reboot (sudo reboot)

Install and set up required packages​

  • We will need git, pipx, and python3-dev: sudo apt install git pipx python3-dev
  • pipx needs to be added to PATH: pipx ensurepath
    • This adds an entry into your ~/.bashrc
    • To load it without logging out, use source ~/.bashrc

Why these?​

  • Git for downloading the TAPPER Client
  • pipx for installation into a separate virtual environment
  • python3-dev are utilities for Python modules using C-compiled code

Enable SPI and serial port​

  • Enable the serial port and SPI interface using sudo raspi-config
    • They are under Interface options

Install the TAPPER client​

Regular Install (recommended)

Regular install: pipx install 'git+https://github.com/hardwario/tapper.git@main#egg=tapper'

Bleeding Edge

Bleeding-edge install (likely to experience bugs): pipx install 'git+https://github.com/hardwario/tapper.git@dev#egg=tapper'

pipx experimentally supports suffixes if you want the bleeding-edge version with a suffix, append --suffix <suffix> to the command.
Example: --suffix dev would result in the command tapperdev

Test it out​

  • Run TAPPER in debug mode: tapper run -d -h <your_mqtt_broker_host>
info
  • -d enables DEBUG logging into the CLI
  • -h specifies the MQTT host