Repository navigation
Home
ziogianni92 edited this page Oct 4, 2026
·
3 revisions
This guide explains how RumiaConfigurator is built, so that you can read the code, change it and add to it on your own. It describes the code as it is in this version of the repository and is updated together with the code.
The public wiki of the project is generated from these files at every release: edit the files here, never the wiki.
If you are new to the project, read the pages in this order:
- Architecture: the layers, the rules that are never broken and what happens from the command line to the window on screen.
- Environment: install the tools, run the app, the tests and the checks, and understand what the CI does.
- Core services: user folders, settings and the application log.
- User interface: the main window, its views and how they talk to each other.
- Theme: colors, fonts, icons, the generated style sheet and the brand components.
- Translations: how texts are translated and switched at run time.
- Connection: adapters, opening the CAN bus, explained errors.
- Data flow: from the receive thread to the screen, frame buffer, frames per second and bus load.
- Network: finding the nodes, their identity, NMT state and heartbeat alarm, the network panel.
- EDS and products: loading EDS and DCF files, recognising the Rumia products, the profile of each node.
-
Simulator and demo mode: simulated CANopen nodes for the
tests and for
--demo. - Testing: how the tests are organised and how to write one.
- Recipes: step-by-step instructions for the most common changes.
| Page | Covers |
|---|---|
| Architecture | layers, rules, start-up sequence, folder layout |
| Environment | uv, commands, ruff, mypy, CI |
| Core services |
paths, settings, app_log
|
| User interface |
app.py, MainWindow, top bar, network panel, work area, status bar |
| Theme | tokens, style sheet, ThemeManager, fonts, icons, brand widgets, theme demo |
| Translations |
tr(), retranslate(), LanguageManager, .ts and .qm files |
| Connection |
ConnectionService, states, adapter detection, ErrorKind and messages, Linux permissions, adding a backend |
| Data flow | receive thread, FrameBuffer and cursors, LiveData at 30 Hz, frames/s and bus load |
| Network | scan, passive listening, identity, NMT states, heartbeat alarm, NodeRegistry, NodePanel
|
| EDS and products | tolerant EDS/DCF loader and its warnings, minimal CiA 301 dictionary, recognition rules, ProfileRegistry, adding a product |
| Simulator and demo mode |
Simulator, simulated Smart IMU and INCLI Sense, EDS loader, test fixtures, --demo banner |
| Testing | test layout, fixtures, Qt tests, writing a new test |
| Recipes | common changes, one checklist each |
- File paths are written from the root of the repository, for example
src/rumia_configurator/core/settings.py. - Requirement codes such as
FR-APP-01orUI-COL-02refer to the project requirements; they also appear in commit messages and docstrings, so you can search the code for them. - Code, names, comments and this guide are in English. The user interface is in Italian and English.
The wiki is generated from these files, so a few rules keep it working (a test checks them):
- Every page starts with a
# Titleline. The title becomes the name of the wiki page (# Core services→ page Core services); changing a title renames the page. - All pages live in this folder, without subfolders, and link to each other
with relative links:
[Theme](theme.md#colors). - Write paths of the code from the repository root, in backticks:
`src/rumia_configurator/core/settings.py`. In the wiki they become links to the code of the release. - Every new page must be linked from the list in this file.
Generated from docs/development/ at v0.6.1. Edit the source files in the repository, not this wiki.