Files
marte-debug/README.md

49 lines
1.2 KiB
Markdown

# MARTe2 Debug Suite
An interactive observability and debugging suite for the MARTe2 real-time framework.
## Quick Start
### 1. Build the project
```bash
. ./env.sh
make -f Makefile.gcc
```
### 2. Run Integration Tests
```bash
./Build/x86-linux/Test/Integration/Integration/IntegrationTests.ex # Runs all tests
```
### 3. Launch GUI
```bash
cd Tools/gui_client
cargo run --release
```
## Features
- **Live Tree:** Explore the MARTe2 object database in real-time.
- **Oscilloscope:** Trace any signal at high frequency (100Hz+) with automatic scaling.
- **Signal Forcing:** Inject values directly into the real-time memory map.
- **Log Forwarding:** Integrated framework log viewer with regex filtering.
- **Execution Control:** Global pause/resume via scheduler-level hooks.
## Usage
To enable debugging in your application, add the following to your `.cfg`:
```text
+DebugService = {
Class = DebugService
ControlPort = 8080
UdpPort = 8081
}
+LoggerService = {
Class = LoggerService
+DebugConsumer = {
Class = TcpLogger
Port = 8082
}
}
```
The suite automatically patches the registry to instrument your existing Brokers and Schedulers.