Skip to content

Feature/protocol documentation #306

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
msanlli merged 8 commits into from
Jun 8, 2025
Merged

Feature/protocol documentation #306

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
3c69876
Add comprehensive message structures documentation
msanlli Jun 8, 2025
a3805a8
Add binary protocol specification for vehicle-backend communication
msanlli Jun 8, 2025
19a36fa
Add WebSocket API specification for backend-frontend communication
msanlli Jun 8, 2025
c3a95b5
Add protocol overview documentation
msanlli Jun 8, 2025
a758c5a
Update architecture README with new protocol documentation
msanlli Jun 8, 2025
9457932
Update ADJ submodule reference
msanlli Jun 8, 2025
82b080d
Add packet-sender ADJ configuration files
msanlli Jun 8, 2025
54320ea
Merge branch 'develop' into feature/protocol-documentation
msanlli Jun 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion backend/cmd/adj
Open in desktop
Submodule adj updated from 4c320a to 553ce4
10 changes: 9 additions & 1 deletion docs/architecture/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,9 +99,17 @@ The Hyperloop H10 Control Station is a real-time monitoring and control system d
- Plugin-based architecture for new sensors
- Horizontal scaling capabilities

## Communication Protocols

Comprehensive documentation for all communication layers:

- [**Protocols Overview**](./protocols.md) - High-level communication architecture
- [**Message Structures**](./message-structures.md) - Complete message format specifications
- [**Binary Protocol**](./binary-protocol.md) - Vehicle ↔ Backend wire protocol
- [**WebSocket API**](./websocket-api.md) - Backend ↔ Frontend API specification

## Related Documentation

- [Backend Architecture](backend.md) - Detailed backend design
- [Frontend Architecture](frontend.md) - Frontend application structure
- [Communication Protocols](protocols.md) - Network and data protocols
- [Development Setup](../development/DEVELOPMENT.md) - Getting started guide
Loading
Loading