Installation

Pick one method — they all get you pieeg-server ready to run.

One-line install (recommended)


curl -sSL https://raw.githubusercontent.com/pieeg-club/PiEEG-server/main/install.sh | bash

First time on Raspberry Pi? Run sudo reboot after install to enable SPI.

Clone & setup


git clone https://github.com/pieeg-club/PiEEG-server.git
cd PiEEG-server
./setup.sh

pip install


pip install pieeg-server

Requires Python 3.10+.

IronBCI / EAREEG Support

For Bluetooth Low Energy boards (IronBCI, EAREEG), install the ironbci extra:


pip install pieeg-server[ironbci]

Then run with:


pieeg-server --device ironbci8                     # auto-scan for BLE device
pieeg-server --device ironbci8 --ble-name MyBoard   # custom device name
pieeg-server --device ironbci8 --ble-address AA:BB:CC:DD:EE:FF  # skip scan

IronBCI boards use the ADS1299 chip over BLE and support 8 channels. The BLE transport requires the bleak Python package (≥0.21).

Optional Dependencies

Extra	Install	Use case
`lsl`	`pip install pieeg-server[lsl]`	Lab Streaming Layer outlet
`rpi`	`pip install pieeg-server[rpi]`	Raspberry Pi SPI support
`ironbci`	`pip install pieeg-server[ironbci]`	Bluetooth LE for IronBCI / EAREEG boards
`dev`	`pip install pieeg-server[dev]`	pytest + development tools

System Requirements

Requirement	Minimum
Python	3.10+
OS	Linux (Raspberry Pi OS for hardware), macOS/Windows for mock mode
RAM	256 MB
Network	Any — WebSocket streams over local network

Verify Installation


pieeg-server doctor    # diagnose hardware, software, configuration
pieeg-server --mock    # start with synthetic data (no hardware needed)

Open http://localhost:1617 to see the dashboard.