Redis Interface Documentation¶

Connection Details¶

The scooter runs a Redis instance on the MDB accessible at: - Host: 192.168.7.1
- Port: 6379

Local connection command:

redis-cli -h 192.168.7.1 -p 6379

Key Structure¶

The Redis database uses hash sets for system state storage. All fields default to empty strings ("") when data is unavailable unless otherwise noted.

For potential values, also see the Bluetooth reference.

Vehicle State (vehicle)¶

hgetall vehicle

Engine ECU (engine-ecu)¶

hgetall engine-ecu

Battery Management (battery:0 and battery:1)¶

hgetall battery:0
hgetall battery:1

Note: When battery is not present ("present": "false"), all fields will show default values as shown in examples.

Auxiliary Battery (aux-battery)¶

hgetall aux-battery

Connectivity Battery (cb-battery)¶

hgetall cb-battery

System Information (system)¶

hgetall system

Power Management (power-manager)¶

hgetall power-manager

Power Manager Busy Services (power-manager:busy-services)¶

hgetall power-manager:busy-services

Stores systemd inhibitors preventing suspend. Cleared and repopulated on updates.

Published to power-manager:busy-services channel with value "updated" when changed.

Power Multiplexing (power-mux)¶

hgetall power-mux

Internet Connectivity (internet)¶

hgetall internet

Dashboard Interface (dashboard)¶

hgetall dashboard

See Dashboard.

Bluetooth Interface (ble)¶

hgetall ble

Bluetooth Commands¶

The Bluetooth service accepts commands via the scooter:bluetooth Redis list. Commands are sent as strings:

# Send a command to the Bluetooth service
redis-cli -h 192.168.7.1 LPUSH scooter:bluetooth "command-name"

Available commands: - advertising-start-with-whitelisting - Start BLE advertising with whitelist filtering (only paired devices can connect) - advertising-restart-no-whitelisting - Restart advertising without whitelist restrictions (any device can connect) - advertising-stop - Stop BLE advertising completely - delete-all-bonds - Remove all paired/bonded devices from the system

Bluetooth Event Subscriptions¶

The Bluetooth service subscribes to several Redis channels and automatically updates the nRF52 module when values change:

Vehicle State Updates: - vehicle:state - Vehicle operating state changes - vehicle:seatbox:lock - Seatbox lock status changes - vehicle:handlebar:lock-sensor - Handlebar lock status changes

Battery Status Updates: - battery:0:state - Main battery 0 state changes - battery:0:present - Main battery 0 presence detection - battery:0:charge - Main battery 0 charge level - battery:1:state - Main battery 1 state changes - battery:1:present - Main battery 1 presence detection - battery:1:charge - Main battery 1 charge level

Power Management Updates: - power-manager:state - Power state changes trigger automatic data stream management

Bluetooth-Triggered Redis Requests¶

The Bluetooth service can write requests to Redis when receiving commands via BLE:

Scooter Control: - scooter:state → unlock / lock / lock-hibernate - scooter:seatbox → open - scooter:blinker → right / left / both / off

Power Management: - scooter:power → hibernate / hibernate-manual

Keycard Authentication (keycard)¶

hgetall keycard

Note: This hash expires after 10 seconds. Authentication events are also published to the keycard:authentication channel.

Navigation System¶

The navigation system uses two related hashes:

Main Navigation Status (navigation)

hgetall navigation

Navigation Coordinates (navigation:coord)

hgetall navigation:coord

GPS Data (gps)¶

hgetall gps

Over-the-Air Updates (ota)¶

hgetall ota

Settings (settings)¶

hgetall settings

LibreScoot Additional Settings¶

LibreScoot adds persistent settings managed by the settings-service:

See settings-service documentation for details on persistent settings.

Alarm System (alarm) - LibreScoot Only¶

hgetall alarm

Possible status values: - disabled - Alarm system is disabled - disarmed - Alarm enabled but not armed (vehicle not in stand-by) - armed - Alarm is armed and monitoring for motion - level-1-triggered - Level 1 alarm (notification only) - level-2-triggered - Level 2 alarm (horn + hazards)

See alarm-service documentation for details.

BMX055 Motion Sensor (bmx) - LibreScoot Only¶

hgetall bmx

Sensitivity levels: LOW, MEDIUM, HIGH

The alarm-service manages BMX055 configuration automatically based on alarm state.

Dashboard Backlight (dashboard) - LibreScoot Enhancement¶

LibreScoot adds these fields to the dashboard hash:

The dbc-illumination-service monitors the OPT3001 sensor and publishes to illumination. The dbc-backlight-service reads illumination and adjusts backlight automatically.

GPS State (gps) - LibreScoot Enhancement¶

LibreScoot adds GPS state tracking:

GPS states: - off - GPS is disabled - searching - Actively searching for GPS signal - fix-established - Valid GPS fix obtained (2D or 3D) - error - GPS configuration or connection failed

Modem Management (modem) - LibreScoot Only¶

hgetall modem

Internet Connectivity (internet) - LibreScoot Enhancement¶

LibreScoot adds modem health tracking:

Modem health states: - normal - Modem operating normally - recovering - Attempting recovery - recovery-failed-waiting-reboot - Recovery failed, waiting for reboot - permanent-failure-needs-replacement - Hardware failure

OTA Updates (ota) - LibreScoot Enhancement¶

LibreScoot adds per-component update tracking:

Update status values: idle, downloading, preparing, installing, pending-reboot, error

See update-service documentation for details.

Version Information - LibreScoot Only¶

MDB Version (version:mdb)¶

hgetall version:mdb

Contains all fields from /etc/os-release with lowercase keys (e.g., version_id, build_id).

DBC Version (version:dbc)¶

hgetall version:dbc

Contains all fields from /etc/os-release with lowercase keys.

The version-service populates these hashes on startup from the OS release information.

Event Streams¶

Fault Events (events:faults)¶

Stream of system fault events using XADD:

XREAD STREAMS events:faults 0

Each entry contains: - group - Component group (e.g., "cb-battery", "modem") - code - Fault code - description - Human-readable fault description

Command Channels¶

The scooter accepts control commands via Redis list-based channels using LPUSH. Commands are queued and processed by the vehicle service.

Scooter State Control (scooter:state)¶

Controls the lock/unlock state of the scooter.

# Lock the scooter
redis-cli -h 192.168.7.1 LPUSH scooter:state lock

# Unlock the scooter
redis-cli -h 192.168.7.1 LPUSH scooter:state unlock

# Lock and request hibernation
redis-cli -h 192.168.7.1 LPUSH scooter:state lock-hibernate

Available commands: lock, unlock, lock-hibernate

Seatbox Control (scooter:seatbox)¶

Controls the seatbox lock mechanism.

# Open the seatbox
redis-cli -h 192.168.7.1 LPUSH scooter:seatbox open

Available commands: open

Horn Control (scooter:horn)¶

Controls the horn/buzzer.

# Turn horn on
redis-cli -h 192.168.7.1 LPUSH scooter:horn on

# Turn horn off
redis-cli -h 192.168.7.1 LPUSH scooter:horn off

Available commands: on, off

Blinker Control (scooter:blinker)¶

Controls the turn signals/blinkers.

# Left blinker
redis-cli -h 192.168.7.1 LPUSH scooter:blinker left

# Right blinker
redis-cli -h 192.168.7.1 LPUSH scooter:blinker right

# Hazard mode (both blinkers)
redis-cli -h 192.168.7.1 LPUSH scooter:blinker both

# Turn off blinkers
redis-cli -h 192.168.7.1 LPUSH scooter:blinker off

Available commands: left, right, both, off

Alarm Control (scooter:alarm) - LibreScoot Only¶

Controls the motion-based alarm system.

# Enable alarm system
redis-cli -h 192.168.7.1 LPUSH scooter:alarm enable

# Disable alarm system
redis-cli -h 192.168.7.1 LPUSH scooter:alarm disable

# Manual alarm trigger (30 seconds)
redis-cli -h 192.168.7.1 LPUSH scooter:alarm start:30

# Stop alarm immediately
redis-cli -h 192.168.7.1 LPUSH scooter:alarm stop

Available commands: enable, disable, start:<seconds>, stop

BMX Sensor Control (scooter:bmx) - LibreScoot Only¶

Controls BMX055 accelerometer/gyroscope configuration. Typically used by alarm-service.

# Configure sensitivity
redis-cli -h 192.168.7.1 LPUSH scooter:bmx sensitivity:MEDIUM

# Configure interrupt pin
redis-cli -h 192.168.7.1 LPUSH scooter:bmx pin:INT2

# Enable interrupt
redis-cli -h 192.168.7.1 LPUSH scooter:bmx interrupt:enable

Available commands: sensitivity:<LOW|MEDIUM|HIGH>, pin:<NONE|INT1|INT2>, interrupt:<enable|disable>

Power Control (scooter:power) - LibreScoot Enhanced¶

LibreScoot adds more power control commands:

# Request running state (highest priority)
redis-cli -h 192.168.7.1 LPUSH scooter:power run

# Request suspend
redis-cli -h 192.168.7.1 LPUSH scooter:power suspend

# Request hibernation
redis-cli -h 192.168.7.1 LPUSH scooter:power hibernate

# Manual hibernation (user-initiated)
redis-cli -h 192.168.7.1 LPUSH scooter:power hibernate-manual

# Timer-based hibernation
redis-cli -h 192.168.7.1 LPUSH scooter:power hibernate-timer

# Reboot system
redis-cli -h 192.168.7.1 LPUSH scooter:power reboot

Available commands: run, suspend, hibernate, hibernate-manual, hibernate-timer, reboot

Modem Control (scooter:modem) - LibreScoot Only¶

Controls modem power state and GPS.

# Enable modem
redis-cli -h 192.168.7.1 LPUSH scooter:modem enable

# Disable modem
redis-cli -h 192.168.7.1 LPUSH scooter:modem disable

# Enable GPS
redis-cli -h 192.168.7.1 LPUSH scooter:modem gps:enable

# Disable GPS
redis-cli -h 192.168.7.1 LPUSH scooter:modem gps:disable

Available commands: enable, disable, gps:enable, gps:disable

Update Control (scooter:update) - LibreScoot Only¶

Controls OTA update system.

# Force immediate update check (both MDB and DBC)
redis-cli -h 192.168.7.1 LPUSH scooter:update check-now

Available commands: check-now

Command Channel Notes¶

• Commands use the LPUSH operation to queue requests
• Services subscribe to these channels using BRPOP and process commands sequentially
• State changes resulting from commands are published to the corresponding hash fields and pub/sub channels
• Command results can be monitored by subscribing to the relevant state hashes (e.g., vehicle hash for lock/unlock state)
• LibreScoot adds several new command channels for alarm, BMX, modem, and update control