Support / field manual

Find the fault.Keep the signal.

A direct route from the first connection to signal quality, WebSocket output, integrations, and diagnostics—without hiding the system behind a help center.

Start the sequence Open documentation
StartInstallation
InspectDashboard
ConnectWebSocket
DiagnoseDoctor

01 / Fast route

Three steps to
a visible stream.

Begin with the official installation path, verify the stream in the browser, then connect the application layer.

01 / 02 MIN

Install the Server

Enable SPI, install PiEEG Server, and start the service on Raspberry Pi OS.

pip install pieeg-server02 / 01 MIN

Open the Dashboard

Connect through the local browser dashboard and inspect the live stream.

http://raspberrypi.local:161703 / 03 MIN

Stream from Code

Connect a WebSocket client to the local server; the stream uses plain JSON.

ws://raspberrypi.local:1616

02 / Manual index

Enter at the layer
you are working on.

The documentation is organized around the real acquisition path: hardware, server, stream, integration, and diagnosis.

Start

InstallationOne-line Raspberry Pi OS setupQuick startFirst live streamConfigurationCLI and service options

Hardware

Device overviewSupported boards and specificationsAccessoriesElectrodes, caps, and interfacesSignal qualityNoise elimination and setup practiceSafetyIsolation and intended-use guidance

Software

ServerModes, options, and serviceDashboardBrowser visualizationRecordingSave sessions to CSVDetectorsBlink, focus, and event detectors

Interface

WebSocket APIReal-time stream on port 1616Data formatFrame structure and fieldsJupyterLive analysis notebooksLSLOpenViBE, MNE, and LabRecorder route

Diagnose

Self diagnosticsRun PiEEG Server doctorSecurityAuthentication and network exposureArchitecturePlatform internals and modulesDiscordAsk the builder community

03 / Bench commands

Use the
actual path.

These commands match the official PiEEG Server workflow.

Install and launchShell
pip install pieeg-server
sudo reboot
pieeg-server
Stream via PythonWebSocket
async with websockets.connect(
  "ws://raspberrypi.local:1616"
) as ws:
  async for msg in ws:
    print(json.loads(msg)["channels"])
Run diagnosticsCLI
pieeg-server doctor

04 / Still blocked?

Bring the issue
into the open.

Use GitHub for reproducible software issues, Discord for builder-to-builder help, or email for a direct support question.

Open GitHub Email support