system_webview

Real-time web-based system webview for ROS 2 — CPU, memory, swap, load average, and /rosout log viewer

• Links
  • Rosindex
  • Repository

• Standard Documents
  • README
  • LICENSE
  • PACKAGE
  • CHANGELOG
• ROS Package Dependencies
  • rclcpp
  • ament_index_cpp
  • rosbridge_server

README

system_webview

A real-time system monitoring dashboard for ROS 2. It provides a web-based UI that displays live CPU, memory, swap, and load average statistics, a scrollable /rosout log viewer, and interactive node and topic browsers — all served from a single ROS 2 node.

Features

Resource Monitor

Log Viewer

Node Viewer

Topic Viewer

Architecture

flowchart TB
    subgraph Browser["Browser (http://hostname:2525)"]
        direction LR
        Stats["System Stats<br/>(polls /api/system)"]
        Logs["/rosout Log Viewer<br/>(WebSocket → rosbridge :9090)"]
    end

    subgraph Backend
        direction LR
        HTTP["http_server<br/>(C++ node)<br/>:2525"]
        ROS["rosbridge_server<br/>(WebSocket node)<br/>:9090"]
    end

    subgraph System
        direction LR
        Proc["/proc/stat<br/>/proc/meminfo<br/>/proc/loadavg"]
        Graph["ROS 2 graph"]
    end

    Stats -->|HTTP GET| HTTP
    Logs -->|ws://| ROS
    HTTP --> Proc
    ROS --> Graph

Prerequisites

• ROS 2 (Humble, Iron, or Jazzy)

• colcon build tool

• Node.js ≥ 18 and npm (used at build time to compile the frontend)

• cpp-httplib development headers

Install system dependencies (Ubuntu)

sudo apt update
sudo apt install ros-${ROS_DISTRO}-rosbridge-server libcpp-httplib-dev nodejs npm

Note: If your distro’s Node.js is too old, use nvm to install a recent version.

Building

Clone into a colcon workspace and build:

mkdir -p ~/ros2_ws/src
cd ~/ros2_ws/src
git clone https://github.com/namo-robotics/ros2_system_webview.git

cd ~/ros2_ws
source /opt/ros/${ROS_DISTRO}/setup.bash
colcon build
source install/setup.bash

The build automatically runs npm install && npm run build inside the web/ directory and installs the static export to share/system_webview/web.

Usage

Launch

The included launch file starts two nodes: rosbridge_websocket and the http_server:

ros2 launch system_webview main.launch.py

Then open http://localhost:2525 in a browser.

Changing the HTTP port

ros2 launch system_webview main.launch.py http_port:=8080

Note: The rosbridge WebSocket port is hard-coded to 9090 because the web frontend expects this port.

Building the Web-App

The compiled webapp files are committed directly into the repo so that the ros2 package can be built without dependencies on npm or javascript packages.

To compile the web app and build the full ros2 package, run:

./build.sh

Development mode

A helper script runs the Next.js dev server (with hot-reload on port 3000), the C++ HTTP server (API on port 2525), and rosbridge side-by-side:

# Build once first
colcon build --packages-select system_webview
source install/setup.bash

./dev.sh
# → Web UI:    http://localhost:3000  (hot-reload)
# → Stats API: http://localhost:2525/api/system
# → rosbridge: ws://localhost:9090

Dependencies

Package	Purpose
rclcpp	ROS 2 C++ client library
rosbridge_server	WebSocket bridge for the browser
libcpp-httplib-dev	Header-only C++ HTTP server library

License

This project is licensed under the MIT License — see the LICENSE file for details.