Major Refactor - Repository Revitalization
This release represents a complete restructuring of the repository to make it professional, secure, and user-friendly.
🎯 What's New
Complete Documentation
- Comprehensive README with professional presentation
- 15-minute quick start guides for both Arduino and Raspberry Pi
- Platform selection guide to help choose between implementations
- Complete OSC protocol specification with examples
- Security policy and contribution guidelines
Unified Project Structure
- All implementations, hardware, and documentation in organized hierarchy
- Separate directories for Arduino Bluetooth and Raspberry Pi I2C implementations
- Complete hardware designs (PCBs, enclosures, BOM, datasheets)
- Automated test infrastructure
Security Improvements
- No hardcoded credentials in code
- Comprehensive .gitignore for sensitive files
- Security best practices documentation
- Configuration templates for all sensitive data
Hardware
- Complete PCB designs (KiCad) for haptic-belt and haptic-uhat
- Manufacturing-ready Gerber files
- 3D-printable enclosures
- Complete Bill of Materials
🔄 What Changed
Repository Structure
- Migrated Arduino_Node branch →
implementations/arduino-bluetooth/ - Migrated I2C_python branch →
implementations/raspberry-pi-i2c/ - Consolidated hardware files into unified
hardware/directory - All documentation now in
docs/directory
Code Organization
- Configuration extracted to separate files
- Modularized Arduino firmware
- Standardized file naming conventions
⚠️ Breaking Changes
- Configuration files must be created locally (not tracked by git)
- Directory structure has changed from old branch layout
- Dependencies must be installed for both implementations
📦 What's Preserved
- All features from previous branches maintained
- OSC protocol unchanged - existing applications still work
- Hardware designs remain compatible
- Old branches preserved as archive tags
For detailed migration notes and full changelog, see
CHANGELOG.md