How anesbenmerzoug/ball-and-beam works
This repository implements an embedded ball-and-beam controller with a browser dashboard, plus a separate simulation. The principal workflow is to measure ball position, apply filtering and a selected manual or PID controller, and actuate the beam; the dashboard configures the controller and requests telemetry through the device web API. The excerpts show the web handlers’ shared-state interactions and the frontend’s component wiring, but not the firmware control-loop calls or the HTTP client implementation, so those links are marked unverified.
Main entry points: main.rs Firmware runtime · app.rs Web API · main.js Dashboard app · shared.rs Shared signals
Components 23
Embedded device
- Firmware runtime
ball-and-beam-main/src/bin/main.rs - VL6180 sensor
ball-and-beam-main/src/distance_sensor/vl6180.rs - Sensor interface
ball-and-beam-main/src/distance_sensor/base.rs - Servo actuation
ball-and-beam-main/src/servo.rs - Shared signals
ball-and-beam-main/src/shared.rs - Web API
ball-and-beam-main/src/web/app.rs - Network service
ball-and-beam-main/src/web/network.rs
Control libraries
- Filter interface
ball-and-beam-filters/src/base.rs - Position filters
ball-and-beam-filters/src/median.rs - Moving average
ball-and-beam-filters/src/moving_average.rs - Outlier filter
ball-and-beam-filters/src/outlier.rs - Controller interface
ball-and-beam-controllers/src/base.rs - Manual controller
ball-and-beam-controllers/src/manual.rs - PID controller
ball-and-beam-controllers/src/pid.rs - Controller wrapper
ball-and-beam-controllers/src/wrapper.rs
Web dashboard
- Dashboard app
frontend/src/main.js - API client
frontend/src/api.js - Controller settings
frontend/src/components/controllerConfig.js - PID controls
frontend/src/components/controllers/pid.js - Slider parameter
frontend/src/components/controllers/parameters/sliderParameter.js - Telemetry chart
frontend/src/components/dataChart.js
Simulation
- System simulation
simulation/simulation.py
Other components
- Operator
Connections 24
- Operator → Dashboard app: uses
- Dashboard app → API client: uses
frontend/src/main.js - Dashboard app → Controller settings: renders
frontend/src/main.js - Dashboard app → Telemetry chart: renders
frontend/src/main.js - Controller settings → PID controls: renders
frontend/src/components/controllerConfig.js - PID controls → Slider parameter: renders
frontend/src/components/controllers/pid.js - API client → Web API: sends API requests
- Web API → Shared signals: reads telemetry
ball-and-beam-main/src/web/app.rs - Web API → Shared signals: signals parameter updates
ball-and-beam-main/src/web/app.rs - Web API → Shared signals: sets run flag
ball-and-beam-main/src/web/app.rs - Firmware runtime → VL6180 sensor: samples position
- Firmware runtime → Position filters: filters measurements
- Firmware runtime → Controller wrapper: dispatches control
- Firmware runtime → Servo actuation: commands angle
- Firmware runtime → Shared signals: publishes state
- Network service → Web API: serves app
- Position filters → Filter interface: implements
ball-and-beam-filters/src/median.rs - Moving average → Filter interface: implements
ball-and-beam-filters/src/moving_average.rs - Outlier filter → Filter interface: implements
ball-and-beam-filters/src/outlier.rs - Manual controller → Controller interface: implements
ball-and-beam-controllers/src/manual.rs - PID controller → Controller interface: implements
ball-and-beam-controllers/src/pid.rs - Controller wrapper → Manual controller: wraps
ball-and-beam-controllers/src/wrapper.rs - Controller wrapper → PID controller: wraps
ball-and-beam-controllers/src/wrapper.rs - System simulation → Operator: models system