An open API service indexing awesome lists of open source software.

https://github.com/mrrobot62/udp-viewer

Cross-platform UDP log viewer with real-time monitoring, replay, filtering, and integrated Plot & Logic Analyzer for embedded systems debugging
https://github.com/mrrobot62/udp-viewer

arduino data-visualization debugging embedded embedded-systems esp32 log-analysis log-viewer logic-analyzer plotting pyqt5 python realtime udp udp-log-viewer udp-viewer

Last synced: about 1 month ago
JSON representation

Cross-platform UDP log viewer with real-time monitoring, replay, filtering, and integrated Plot & Logic Analyzer for embedded systems debugging

Awesome Lists containing this project

README

          

# UDP Log Viewer with Plot & Logic Analyzer for Embedded Debugging
UDP Log Viewer with integrated Plot and Logic Analyzer for embedded systems debugging (Arduino, ESP32, MCU, IoT)

- Built-in Plot Visualizer (time series data)
- Built-in Logic Analyzer (digital signals)

![Intro](assets/UDP-LOG-VIEWER4.gif)

## Why using this tool?

Debugging embedded devices over UDP is painful.
This tool makes it simple and visual. Not only viewing data, visualizing data as well.

## Documentation

Complete English documentation:

- [docs/DOCUMENTATION_en.md](docs/DOCUMENTATION_en.md)
- [docs/USER_GUIDE_en.md](docs/USER_GUIDE_en.md)
- [docs/CONFIGURATION_REFERENCE_en.md](docs/CONFIGURATION_REFERENCE_en.md)
- [docs/SUPPORTED_CSV_INPUT_FORMATS_en.md](docs/SUPPORTED_CSV_INPUT_FORMATS_en.md)
- [docs/RELEASE_0.17.0.md](docs/RELEASE_0.17.0.md)

Complete German documentation:

- [docs/DOKUMENTATION_de.md](docs/DOKUMENTATION_de.md)
- [docs/USER_GUIDE_de.md](docs/USER_GUIDE_de.md)
- [docs/CONFIGURATION_REFERENCE_de.md](docs/CONFIGURATION_REFERENCE_de.md)
- [docs/SUPPORTED_CSV_INPUT_FORMATS_de.md](docs/SUPPORTED_CSV_INPUT_FORMATS_de.md)
- [docs/RELEASE_0.17.0_de.md](docs/RELEASE_0.17.0_de.md)

## HowTo use UDP on EPS32 Demo project
If you want to play around with an ESP32 & logging, please visit this demo repository
https://github.com/mrRobot62/esp-udp-logging.git

## Windows-User
please use setup.exe to install this viewer

## ToDo for MAC users
after installation this application is not signed and can't be started directly.
You have to set this command: `xattr -dr com.apple.quarantine /Applications/UDPLogViewer.app`

## Screenshots

Screenshot assets are stored under [assets/screenshots](assets/screenshots).

### Main Screen

![UDP Log Viewer main screen with active connection, reset workflow, and rule chips](assets/screenshots/udp_log_viewer_main_highlighted.png)

### Rule Configuration

![UDP Log Viewer filter-rule dialog on top of the main window](assets/screenshots/udp_log_viewer_main_rule_config.png)

### Project Dialog

![UDP Log Viewer project dialog with Markdown project description](assets/screenshots/udp_log_viewer_project_config.png)

### Plot Visualizer Tooltip

**Timebased visualizing**
![Plot visualizer with legend, target lines, and tooltip values](assets/screenshots/udp_log_viewer_plot_tooltip.png)

**Measuring time**

![Measure timing](assets/screenshots/udp_log_viewer_plot_measure3.png)

### Logic Measurement

**Measuring HIGH/LOW phase**
![Logic visualizer signal measurement with red and blue markers](assets/screenshots/udp_log_viewer_logic_signal.png)

**Measuring signal period**
![Logic visualizer period measurement with red and blue markers](assets/screenshots/udp_log_viewer_logic_period.png)

## Current Scope

The current codebase includes:

- real-time UDP log reception
- filter, exclude, and highlight rules
- live session logging
- main-window `RESET` support to start a fresh log phase inside the same app session
- runtime project contexts for grouping logs and screenshots per test session
- project descriptions stored as `README_.md` inside the project folder
- replay of saved log files
- built-in simulation for text, temperature, and logic traffic
- CSV-based data visualization
- logic-channel visualization
- visualizer color selection with 16 preset colors and HTML code `#RRGGBB`
- configurable visualizer footers with presets, placeholders, and formatting
- edge and period measurement directly inside the logic graph
- runtime `Legend` toggle in plot and logic graph windows
- keyboard-driven screenshot/save shortcuts and explicit `TAB` navigation in the main and graph windows
- macOS and Windows packaging scripts

## Quick-Start (from source)
```
git clone ...
pip install -r requirements.txt
python main.py
```

## Install & Run
- MacOSX
- download DMG and install
- run this `xattr -dr com.apple.quarantine /Applications/UDPLogViewer.app`
- Windows
- download setup.exe and run

## Run From Source
```bash
python -m venv venv
source venv/bin/activate
pip install -e .[dev]
udp-log-viewer
```
## 🧪 Testing

The project includes a comprehensive test suite under `/tests`.

## Developer Bootstrap

```bash
./scripts/bootstrap_macos_linux.sh
```
# You like it?
⭐ If you like this project, consider giving it a star!