Add ESP32 support with secureLSL encryption#1
Merged
neuromechanist merged 4 commits intomainfrom Mar 18, 2026
Merged
Conversation
Add liblsl-ESP32: clean-room C reimplementation of the LSL wire protocol for ESP32 microcontrollers with full secureLSL encryption. Components: - Core library (~4100 lines C, ESP-IDF component) - 4 examples: basic_outlet, basic_inlet, secure_outlet, secure_inlet - Benchmark suite: throughput firmware + desktop Python scripts - Documentation: architecture, security guide, benchmarks Key features: - Protocol v1.10, wire-compatible with desktop liblsl/secureLSL - ChaCha20-Poly1305 encryption, Ed25519 key exchange via libsodium - Sustains up to 1000 Hz with near-zero packet loss - Zero measurable encryption overhead (async on dual-core) - ~200KB SRAM footprint, 300KB+ free for application Documentation integrated into mkdocs site under ESP32 section.
- Fix key exchange terminology: X25519 (not Ed25519) - Add passphrase caveat (ESP32 uses raw keys, not encrypted_private_key) - Add key distribution workflow (import desktop keys recommended) - Fix broken links: use GitHub URLs instead of relative paths - Add MkDocs admonitions (warning, note) matching secureLSL style - Add section separators (---) for consistency - Show export_pubkey and has_keypair in API overview - Replace "Not measurable" with "2 KB heap (push async)" in perf table - Cross-reference secureLSL Installation instead of inline build commands - Remove duplicated key extraction snippet (link to security guide) - Consistent line count (~4,000) - Add copyright headers to all remaining source files - Add nonce policy documentation (strict vs windowed)
Member
Author
PR Review Complete - All findings addressedCode reviewer (5 findings)
Doc reviewer (13 findings)
Positive findings
|
ESP32 support is a significant feature addition warranting a minor version bump from 1.0.0 to 1.1.0. Updated: mkdocs.yml, liblsl/CMakeLists.txt, CHANGELOG.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds liblsl-ESP32: a clean-room C reimplementation of the LSL wire protocol for ESP32 microcontrollers with full secureLSL encryption support.
What's included
Core library (
liblsl-ESP32/components/liblsl_esp32/, ~4100 lines C)Examples (4 projects)
Benchmarks (firmware + desktop Python scripts)
Documentation (integrated into mkdocs)
docs/esp32/overview.md-- scope, quick start, API, performance, compatibilityliblsl-ESP32/docs/-- architecture, security guide, benchmarksKey design decisions
Hardware-verified performance
Bidirectional encrypted interop verified with desktop secureLSL (cpp_secure_inlet/outlet).
Protocol compatibility