wes
eda93dc7fe
Fix: Add trailing frame byte to COBS encoder
2025-12-29 09:55:46 -05:00
wes
1ce475f7dc
Clean up documentation for public release
...
Changes:
- Rewrote PROTOCOL_FINDINGS.md to be clean protocol spec
- Removed all DLL/assembly/class name references
- Removed outdated "Next Steps" sections
- Focused purely on protocol documentation
- Added clear packet examples and command reference
- Removed outdated historical docs:
- SUMMARY.md (investigation notes, now obsolete)
- ANALYSIS_GUIDE.md (pre-completion guide, no longer needed)
- Created .claude.md for internal context
- Contains all decompilation details
- Lists specific DLL names and source locations
- Preserves context for AI assistants
- Added to .gitignore (not committed to repo)
Result:
- Public repo now has clean, legal documentation
- Internal context preserved for development
- Reduced legal surface area
- Docs focus on protocol, not implementation source
Remaining docs (all clean):
- PROTOCOL_FINDINGS.md - Protocol specification
- IMPLEMENTATION_GUIDE.md - Python implementation guide
- HOME_ASSISTANT_INTEGRATION.md - HA integration plan
- MISSION_ACCOMPLISHED.md - Project summary
2025-12-29 09:45:06 -05:00
wes
718a13c02f
Reorganize repository structure into logical folders
...
Structure:
- src/ - Python implementation (cobs_protocol.py, onecontrol_client.py)
- docs/ - All documentation markdown files
- scripts/ - Extraction scripts (for reference only)
Changes:
- Moved Python files to src/
- Moved all .md docs to docs/
- Moved extraction scripts to scripts/
- Updated README.md with new structure
- Updated import paths in README examples
- Added placeholder for future Quartz documentation URL
Benefits:
- Cleaner repository organization
- Easier to navigate
- Separates code from documentation
- Follows standard project conventions
2025-12-29 09:33:20 -05:00
wes
c62fbf1bd4
Remove reference to decompiled source code from README
...
The decompiled code is not included in the repository (excluded via .gitignore).
Mentioning it in the README could create legal concerns and is misleading.
2025-12-29 09:29:10 -05:00
wes
da2387e29c
Add Apache 2.0 license and strengthen legal compliance
...
- Added Apache License 2.0 (full text)
- Strengthened README disclaimer with interoperability language
- Added references to DMCA 1201(f) and EU Software Directive Article 6
- Clarified what IS and IS NOT included in repo
- Added license badge to README
- Explicitly states purpose: legally purchased hardware integration
Compliance checklist:
✅ Clean room implementation (no decompiled code in repo)
✅ .gitignore excludes all binaries and extracted code
✅ Interoperability defense clearly stated
✅ Apache 2.0 license with patent grant clause
✅ Disclaimer for Lippert Components Inc.
2025-12-29 09:12:11 -05:00
wes
7dd4f55a0c
Initial commit: Lippert OneControl protocol reverse engineering
...
✅ Protocol fully reversed from decompiled Xamarin app
✅ All 431 .NET assemblies extracted and decompiled
✅ COBS encoder/decoder implemented in Python
✅ CRC8 checksum implementation
✅ Complete BLE client for OneControl devices
✅ Comprehensive documentation
Files included:
- cobs_protocol.py: COBS encoding/decoding + CRC8
- onecontrol_client.py: Full BLE client implementation
- Complete protocol documentation
- Home Assistant integration guide
- ESPHome Bluetooth Proxy setup
- Extraction scripts for reference
Ready for testing with RV hardware (April 2025)
2025-12-29 08:50:16 -05:00
wes