A centralized communications dashboard for multi-layered control in ground stations, all-in-one DAQ solutions, and hardware interfaces.
Comms is a modular, extensible platform designed to streamline hardware development and monitoring.
- Alpha v1.0: First stable release (unreleased, scheduled) with one-way communication.
- Alpha v2.0 (Dev Branch): Adds two-way communication, new widgets, and performance boosts.
- Engine + Dynamic Modules (Python) - Hardware interfacing and data streams.
- Stream Handler + Stream Transformers (Python + WebSocket) - Real-time data flow.
- AriesUI + Aries Modules (NodeJS + Electron + TailwindCSS + DaisyUI) - Customizable UI.
- Modularity: Components run independently across devices and frameworks.
- HyperThreader: Manages and debugs all instances concurrently.
Click to Explore v2.0 Features
- Bidirectional UI-to-hardware control with instant feedback.
- Enhanced error handling and status reporting.
- Configurable update rates via HyperThreader.
- Automatic metadata handling.
- Value change notifications and history tracking.
- Configurable stream priorities and error recovery.
- Toggle Control: Binary (0/1) with real-time feedback and error states.
- Slider Control: Continuous values with auto-range, units, and debounced updates.
- Value Monitor: Tracks changes with timestamps and source attribution.
- Default 100ms update rate, adjustable via HyperThreader.
- Optimized WebSocket settings, better memory use, and real-time rate tweaks.
- Comprehensive logging, command history, and real-time status.
- Debug windows for Stream Handler, Engine, and configurations.
Engine (aka "en")
- Role: Core layer for hardware communications.
- Features:
- Dynamic module loading with safe initialization.
- Async operations and hardware abstraction.
- Configurable update rates (100ms default in v2.0).
- Error handling, recovery, and debug propagation.
- Value change notifications (v2.0).
- DynamicModules (DynMods):
- Hardware wrappers (e.g., sensors) using serial or other methods.
- Streams hardware variables to the Engine.
- Examples: Serial Communication, Random Number Generator, Custom Templates.
- Negotiator Class: Links Engine to Stream Handler.
Stream Handler (aka "sh")
- Role: Manages data flow between Engine and UI.
- Features:
- WebSocket-based (Socketify, 100ms timeout in v2.0).
- Message queuing, priority routing, and compression.
- Real-time stream creation/deletion/updates.
- Debug interface with pause/resume (v2.0).
- Streams:
- Syncs data exchanges (actions, readings) between frontend/backend.
- One-sided or bidirectional (v2.0).
- Logger: Logs active readings and actions.
- Stream Transformer: Applies protocol/message conversions.
AriesUI (aka "ui")
- Role: Visualization and control interface.
- Features:
- Grid layout (Gridstack) with drag-and-drop widgets.
- Real-time data visualization and monitoring.
- New widgets: Toggle, Slider, Value Monitor (v2.0).
- Responsive to rate changes with error feedback (v2.0).
- AriesMods:
- Extensions: JavaScript, UI, Backend Hardware, or combinations.
- Marketplace: Centralized module hub.
- Profiles: Stores layouts, streams, and hardware configs (saved locally).
Alpha v1.0 (Implemented)
- One-way communication, data acquisition, and visualization.
- Engine with custom plugins and DynamicModules.
- Stream Handler with WebSocket streaming.
- AriesUI with dynamic dashboards.
- AriesMods: Drag-and-drop widgets, live data, marketplace.
- HyperThreader for instance management.
Alpha v2.0 (New Features)
- Two-way communication with real-time control.
- Enhanced stream management (metadata, priorities).
- New widgets: Toggle, Slider, Value Monitor.
- Performance: 100ms update rate, HyperThreader-configurable.
- Debug: Logging, history, real-time status.
{
"type": "negotiation",
"status": "active",
"data": {
"module_id": {
"name": "Module Name",
"status": "active",
"config": {
"update_rate": 1.0,
"enabled_streams": ["stream1"],
"debug_mode": false
},
"streams": {
"stream1": {
"stream_id": 1,
"name": "Temperature",
"datatype": "float",
"unit": "Celsius",
"status": "active",
"metadata": {
"sensor": "TMP36",
"precision": 0.1,
"location": "main_chamber"
},
"value": 25.4,
"priority": "high"
}
}
}
},
"msg-sent-timestamp": "2024-10-30 00:09:54"
}- v2.0 Additions: Value history, source attribution, priorities.
- Python 3.8+
- Node.js 14+
- npm or yarn
# Clone v2.0 Dev Branch
git clone -b Dev2.0V https://github.com/AryanRai/Comms.git
cd Comms
# Install Python dependencies
pip install socketify
# Install UI dependencies
cd ui/ariesUI
npm install- Via HyperThreader (Recommended):
conda comms python HyperThreader.py
- Separately:
# Start Stream Handler cd StreamHandler python stream_handlerv2.3.py # or sh/sh.py for v2.0 # Start Engine cd Engine python engine.py # or en/en.py for v2.0 # Launch AriesUI cd ui/ariesUI npm start
Creating Custom Modules
class CustomModule:
def __init__(self):
self.config = {
"notify_on_change": True,
"update_rate": 0.1
}
self.streams = {
"1": Stream(
stream_id=1,
name="SensorName",
datatype="float",
unit="Units",
status="active",
metadata={"sensor": "Model", "precision": 0.1}
)
}
self.debug_messages = []
self.value_change_history = []
def _handle_value_change(self, stream_id, old_value, new_value, source="internal"):
# Track value changes
pass
async def update_streams_forever(self):
# Continuous updates
passconst ControlWidget = ({ streamId }) => {
const [value, setValue] = useState(0);
const [status, setStatus] = useState("idle");
// Control logic here
return (
<div className="control-widget">
{/* Widget content */}
</div>
);
};Comms/
├── Engine/
│ ├── engine.py # Main engine process
│ └── DynamicModules/ # Hardware modules
│ ├── hw_module_1.py # Sample module
│ └── hw_win_serial_chyappy.py # Serial module
├── StreamHandler/
│ └── stream_handlerv2.3.py # WebSocket server
├── ui/ariesUI/ # Electron-based UI
│ ├── src/
│ │ ├── App.js # Main React app
│ │ ├── components/ # React components
│ │ └── assets/ # CSS, JS, etc.
│ └── main.js # Electron main process
└── HyperThreader.py # Instance manager
- Short-Term: Unique sensor data GUI per grid, fix stream format, add refresh controls.
- Long-Term: 3D mode (Three.js), mobile hosting, online Stream Handler with codes.
Check out our Contributing Guidelines. Pull requests are welcome!