How aurora-opensource/xviz works
Main Components and Architecture
The system should be represented as a modular architecture with these key components:
a) Core Protocol Layer:
• Three supported formats: JSON, Binary, and Protobuf
• Protocol message types (envelope, session, primitives, etc.)
b) Server-Side Components:
• XVIZ Server Module
• Provider System
• Data Conversion Layer
• WebSocket Communication
c) Client-Side Components:
• Parser Module
• Synchronizer
• Stream Buffer
• Data Access Layer
Component Relationships
a) Data Flow:
• Raw Data Sources → Converters → XVIZ Protocol
• XVIZ Protocol → Server → WebSocket → Client
• Client → Parser → Synchronized Data → Visualization
b) Module Dependencies:
• Builder → Schema (validation)
• Parser → Schema (validation)
• Server → IO (data handling)
• CLI → All Components (tooling)
Specific Implementation Details
Important architectural elements:
a) Builder Module:
• Metadata Builder
• Primitive Builder
• UI Builder
• Variable Builder
b) Parser Module:
• Stream Synchronizer
• Object Collection
• Style Parser
• Worker System
c) IO Module:
• Source/Sink System
• Providers
• Readers/Writers
• Format Handlers
Additional Layers
Supporting systems:
• Validation Layer (Schema)
• CLI Tools Interface
• ROS Integration
• Example Converters (KITTI, Nutonomy)
Implementation Notes
Architectural decisions:
• Modular design with clear separation of concerns
• Support for multiple data formats
• Real-time data handling capabilities
• Extensible converter system
• Flexible synchronization mechanisms
This architecture reflects XVIZ's design as a comprehensive system for handling autonomy data, from ingestion through conversion, transport, and visualization.