librescoot-scootui (scootui-qt)¶

The original Flutter/Dart scootui is deprecated and replaced by this Qt/QML version.

Description¶

ScootUI is the primary user interface for Librescoot. It runs on the DBC (Dashboard Computer) and communicates with all Librescoot services via Redis.

• Qt 6 / QML — UI framework
• QMapLibre — Vector map rendering
• Valhalla — Routing engine
• hiredis — Redis client (async pub/sub + worker thread for polling)
• CMake — Build system

Features¶

Real-time Telemetry Display¶

• Speed (raw or wheel-corrected), power output, battery levels
• Odometer, trip meter, GPS status, connectivity indicators
• System warnings and fault codes

View Modes¶

• Cluster — Speedometer and vehicle status
• Map — 3D-tilted navigation with turn-by-turn directions
• Destination — Saved locations and destination input
• Navigation Setup — Route preview and confirmation
• OTA Update — System update progress and control

Navigation¶

• Offline vector map support (MBTiles via QMapLibre)
• Online map tiles (CartoDB) as alternative
• Valhalla routing (on-device or remote)
• Speed limit indicators from vector tiles
• Auto-rotating map with heading tracking

Other¶

• Alarm status display
• Hop-on / hop-off combo lock screen
• Light and dark themes with auto-switching
• Configurable blinker overlay styles
• Multi-language support

Build¶

Desktop (simulator mode)¶

./run-desktop.sh

Or manually:

cmake -B build -DDESKTOP_MODE=ON -DCMAKE_BUILD_TYPE=Debug
cmake --build build -j$(nproc)
SCOOTUI_REDIS_HOST=none ./build/bin/scootui

SCOOTUI_REDIS_HOST=none disables Redis and activates the built-in simulator.

Target (cross-compile for i.MX6 armhf)¶

./cross-build.sh [Release|Debug]

Produces deploy-armhf/ with binary, Qt plugins, and launcher. Deploy:

scp -r deploy-armhf/* target:/opt/scootui/
ssh target /opt/scootui/run-scootui.sh

Make shortcuts¶

make build    # Configure and build
make run      # Build and run
make clean    # Remove build directory

Environment Variables¶

Redis Operations¶

Subscriptions (pub/sub + periodic HGETALL)¶

Additionally polled (no subscription): system, version:mdb, version:dbc (30 s).

HSET Writes¶

Note: scootui is not consume-only on the navigation hash. When the rider sets a destination in the UI, NavigationService writes the destination fields above and publishes navigation = updated; clearing the destination blanks the same fields and publishes navigation = cleared.

LPUSH Commands¶

HDEL¶

• navigation destination, latitude, longitude, address, timestamp — on destination clear

LRANGE¶

• usb:log (indices 0–19) — UMS transfer log, polled while usb status is processing

Settings¶

Settings are stored in the settings Redis hash. Managed by settings-service.

Hardware Interfaces¶

Serial Number¶

Primary: /sys/devices/soc0/serial_number

Fallback (OTP fuses): /sys/fsl_otp/HW_OCOTP_CFG0 + HW_OCOTP_CFG1

Boot Animation¶

On Linux startup:

1. Fades in framebuffer overlay: imx-overlay-alpha fade 0 255 1000 (skipped on kernel 6.6 imx-drm)
2. Stops boot animation: systemctl stop boot-animation.service

Shutdown¶

On SIGTERM or vehicle state → shutting-down: ShutdownStore::forceBlackout() blacks out the display.

Map Tiles¶

Offline tiles expected at /data/maps/map.mbtiles on the DBC. The app watches /data/maps/ via inotify and reloads map services when the file appears or changes.

Routing tiles live separately at /data/valhalla/tiles.tar, which Valhalla mmaps as its tile_extract and which therefore has to stay an uncompressed seekable tar.

MapDownloadService fetches both from the manifest at downloads.librescoot.org/releases/tiles.json, keyed by region slug. Each region's map and valhalla entries carry url, size and sha256 describing the uncompressed artifact. Downloads resume via HTTP Range into a per-asset .part file.

The .mbtiles is not compressed for transport. Its vector tiles are already gzipped per tile, so the archive only compresses by about 1.14x.

Project Structure¶

src/
  core/           App initialization, environment config
  models/         Data models and enums
  repositories/   Redis (hiredis-based) and in-memory MDB implementations
  stores/         QML-exposed state stores
  services/       System services (navigation, settings, map, input, ...)
  routing/        Valhalla client and route models
  simulator/      Simulator service (desktop mode only)
  l10n/           Translations
qml/
  screens/        Main UI screens
  widgets/        Reusable UI components
  overlays/       Modal overlays (menu, toast, ...)
  simulator/      Simulator panel (desktop mode only)
  theme/          Theme definitions

Dependencies¶

• Redis server
• Qt 6.4+ (Quick, Qml, Svg, Network, Sql, Concurrent)
• QMapLibre (required on target; optional in desktop mode)
• hiredis
• Valhalla routing engine

Related Documentation¶

• dashboard/README.md — Complete dashboard documentation
• dashboard/REDIS.md — Redis operations reference
• Redis Operations — Dashboard hash fields
• States — Vehicle state display