How eclipse-kuksa/kuksa-can-provider works
Project Type and Purpose
• This is a standalone Python “provider” service that sits between a CAN bus (or a replayed CAN dump) and the KUKSA ecosystem (Server and/or Databroker).
• It supports two modes:
• dbc2val – reads raw CAN frames, parses via a DBC file, maps to VSS signals, and pushes into KUKSA Server/Databroker.
• val2dbc – subscribes to VSS signals on the Databroker, maps back to DBC signals, and sends CAN frames onto the bus.
Top-Level Architectural Components
File tree and README to see these key parts:
• Entrypoint script: dbcfeeder.py
• Core library package: dbcfeederlib/
• Config and mapping:
• config/ (INIs, default JSONs)
• mapping/vss_*/ (per-version mapping JSONs + overlay specs)
• External interfaces:
• SocketCAN (or virtual CAN via createvcan.sh)
• CAN dump files (candump.log, candump-*.xz)
• ELM/OBDLink and J1939 support modules
• External services:
• KUKSA Server
• KUKSA Databroker
• Dockerfile and CI workflows (for containerization and testing).
Main System Components (to represent
a. CAN Input Layer
• SocketCAN interface or replay engine (CAN player).
• Optionally ELM/OBDLink and SAE-J1939 readers.
b. CAN Provider Core
• CLI/Controller (dbcfeeder.py)
• CAN Reader/Player (canreader, canplayer)
• DBC Reader & Parser (dbcreader, dbcparser, dbc2vssmapper)
• Mapping Engine (uses vss_dbc.json and default values JSON)
• Message Builder (canmessage)
c. Client Wrappers
• KUKSA Databroker client wrapper
• KUKSA Server client wrapper
• Databroker subscription loop (for val2dbc mode)
d. External Services
• KUKSA Server
• KUKSA Databroker
e. Configuration & Mapping Artifacts
• config/*.ini, dbc_default_values.json
• mapping/vss_*.json & overlay.vspec files
Interactions and Data Flows
• dbc2val mode (CAN → KUKSA):
1. CAN frames arrive via SocketCAN or replay stream
2. Frames passed to CAN Reader → parsed by DBC Parser
3. Parsed signals fed into Mapper → VSS datapoints
4. Client Wrapper sends datapoints to KUKSA Server or Databroker
• val2dbc mode (KUKSA → CAN):
1. Databroker client subscribes to VSS signals
2. Incoming values go into Mapper, merged with default values
3. CAN message builder assembles frames
4. CAN Client sends frames onto SocketCAN
Architectural Patterns & Principles
• Modular layering: input readers, processing/parsing layer, mapping layer, output clients
• Configuration-driven: mapping and defaults are external JSON/INI, not hard-coded
• Test harness in test/ covering all modules