How kjames3/x3_ws works
This is a ROS 2 workspace for operating a Yahboom X3 robot, with a WebSocket control server as the browser-facing entry point. The main workflow is browser commands and telemetry through the server, which interfaces with robot hardware and ROS 2; in ROS 2 mode, navigation, mapping, perception, and safety capabilities support autonomous operation. The README documents the two browser connections and operating modes. Source-index references confirm several server dependencies, but unsampled implementation details limit further call-level links.
Main entry points: server_x3.py WebSocket server · x3_bringup.launch.py ROS bringup · main.js Web interface · nav2_client.py Nav2 client
Components 25
Control and interface
- WebSocket server
src/server_x3.py - Web interface
src/web/main.js - Foxglove bridge
Sensing and perception
- OAK-D driver
src/oakd_driver.py - Camera ROS publisher
src/oakd_ros_publisher.py - YOLO detector
src/trt_detector.py - Person tracking
src/c3_person_tracker.py - Lidar tracking
src/lidar_person_tracker.py - Velocity estimation
src/velocity_estimator.py
Navigation and safety
- Nav2 client
src/nav2_client.py - Frontier exploration
src/frontier_explorer.py - Initial pose
src/auto_initial_pose.py - Map prior
src/map_prior.py - CBF safety filter
src/cbf_filter.py - Pedestrian critic
src/nav2_mppi_dbas_controller/src/dbas_critic.cpp - SLAM stack
src/yahboomcar_nav/launch/x3_slam.launch.py - Nav2 stack
src/yahboomcar_nav/launch/x3_nav2.launch.py
Robot platform
- ROS 2 graph
- Robot hardware
- Mecanum drivers
src/drivers_x3.py - Rosmaster library
src/Rosmaster_Lib.py - Battery monitoring
src/battery.py - ROS base node
src/yahboomcar_base_node/src/base_node_X3.cpp - ROS bringup
src/yahboomcar_nav/launch/x3_bringup.launch.py
Other components
- Browser operator
Connections 24
- Browser operator → Web interface: opens interface
- Web interface → WebSocket server: WebSocket control
- Web interface → Foxglove bridge: WebSocket maps
- WebSocket server → Mecanum drivers: uses drivers
src/server_x3.py - Mecanum drivers → Rosmaster library: delegates to
src/drivers_x3.py - WebSocket server → OAK-D driver: uses camera
src/server_x3.py - WebSocket server → Camera ROS publisher: uses publisher
src/server_x3.py - WebSocket server → YOLO detector: uses detector
src/server_x3.py - WebSocket server → Person tracking: uses tracker
src/server_x3.py - WebSocket server → Lidar tracking: uses tracker
src/server_x3.py - WebSocket server → Velocity estimation: uses estimator
src/server_x3.py - WebSocket server → Battery monitoring: uses battery
src/server_x3.py - WebSocket server → Nav2 client: uses client
src/server_x3.py - WebSocket server → Frontier exploration: uses explorer
src/server_x3.py - WebSocket server → CBF safety filter: uses filter
src/server_x3.py - WebSocket server → Robot hardware: hardware I/O
- WebSocket server → ROS 2 graph: ROS 2 interface
- Foxglove bridge → ROS 2 graph: streams map scan
- ROS bringup → ROS base node: starts drivers
- ROS bringup → SLAM stack: starts SLAM
- ROS bringup → Nav2 stack: starts navigation
- Nav2 client → Nav2 stack: sends goals
- Map prior → Initial pose: provides prior
src/map_prior.py - Pedestrian critic → ROS 2 graph: subscribes pedestrian data
src/nav2_mppi_dbas_controller/src/dbas_critic.cpp