Monitor the state
get_neural_state / get_channel_qualityRead session-relative focus, relaxation, engagement, band powers, signal quality, and recent state changes on demand.
A conversation with the signal
PiEEG Agent is a natural-language EEG lab notebook. It connects questions to documented analysis tools while keeping the measurement method visible.
“How is my signal?”
01 / Tool grammar
A question selects a documented operation. The operation reads the signal, returns a measured result, and preserves its scientific limits.
get_neural_state / get_channel_qualityRead session-relative focus, relaxation, engagement, band powers, signal quality, and recent state changes on demand.
start / record / finish_pattern_trainingCapture labeled rest and active repetitions, fit a regularized detector, and report leave-one-repetition-out validation.
analyze_spectrum / connectivityRequest individual alpha frequency, aperiodic slope, spectral entropy, frontal asymmetry, or cross-channel amplitude coupling.
record_session / compare_sessionsCapture labeled windows and describe their within-session differences with effect sizes and explicit limits on generalization.
02 / Architecture
The acquisition path continues even when no language model is running.
A dedicated LSL thread and ring buffer keep incoming samples separate from language-model latency.
The model pulls named tools on demand. Raw voltage arrays are not continuously pushed into the conversation.
Events and measured features create language-sized representations while the original stream remains available.
Device actions stay read-only by default, with preview and execute modes made explicit.
03 / Local instrument
PiEEG Agent requires Python 3.10 or later. Its prebuilt frontend does not require a local Node.js installation.
Open installation guidecurl -sSL https://raw.githubusercontent.com/pieeg-club/PiEEG-agent/main/install.sh | bashpieeg-agent webOpen http://localhost:8000 after launch.pieeg-server --mock --lslpieeg-agent web04 / Action boundary
Device control is optional. The default web command is read-only; preview and execution require explicit command-line modes.
pieeg-agent webMonitoring and analysis. No device-control actions.
pieeg-agent web --allow-actionsShows the proposed action without executing it.
pieeg-agent web --allow-actions --executeRuns allowed actions through cooldowns, allowlists, and audit logging.
PiEEG Agent is designed for neurofeedback research and UX prototyping—not clinical use. Focus, relaxation, and engagement are session-relative indices rather than clinical values.
Question / Tool / Measure / Explain