diff --git a/readme.md b/readme.md index 2c4901e..1353e24 100644 --- a/readme.md +++ b/readme.md @@ -1,9 +1,10 @@ -radio-edge-node +# radio-edge-node This repository contains the containerized supervisor and OP25 instance for the SDR nodes. It manages the local RF workload and synchronizes state with the central C2 via MQTT. -1. Directory Structure +## 1. Directory Structure +``` radio-edge-node/ ├── app/ │ ├── main.py # Entry point & MQTT Startup @@ -14,20 +15,22 @@ radio-edge-node/ ├── Dockerfile ├── docker-entrypoint.sh └── docker-compose.yml +``` - -2. Supervisor Logic +## 2. Supervisor Logic The supervisor performs three main tasks: -MQTT Phone-Home: On startup, it sends the Check-In packet to the C2. +- **MQTT Phone-Home**: On startup, it sends the Check-In packet to the C2. -Process Management: It wraps the OP25 multi_rx process. If the process dies, the supervisor can report the failure via MQTT. +- **Process Management**: It wraps the OP25 multi_rx process. If the process dies, the supervisor can report the failure via MQTT. -Metadata Tailing: (Planned) Tailing the OP25 stderr/stdout to extract real-time talkgroup grants for the C2 metadata bus. +- **Metadata Tailing**: (Planned) Tailing the OP25 stderr/stdout to extract real-time talkgroup grants for the C2 metadata bus. -3. Deployment +## 3. Deployment Set your .env variables (NODE_ID, MQTT_BROKER, etc.) -docker-compose up --build -d \ No newline at end of file +```bash +docker-compose up --build -d +``` \ No newline at end of file