Ss New Driver
Developmentss-new-driverSs New Driver is an Agent Skill for development published in the Serial-Studio/Serial-Studio repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.
Scaffold a new Serial Studio I/O driver (a new data source under app/src/IO/Drivers/). Use when adding support for a new bus/transport — e.g. "add a <X> driver", "support reading from <Y>", "new data source". Encodes the canonical driver pattern and every registration touch-point so the new driver actually shows up in the UI, CLI, and connection manager.
How to use this skill
Bring this guide into your coding agent with a prompt tailored to the tool you use.
- Open your project in Codex.
- Copy and paste the prompt below.
- Review files and risks before approving any action.
Inspect the Agent Skill at https://github.com/Serial-Studio/Serial-Studio/blob/HEAD/.claude/skills/ss-new-driver/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/ss-new-driver, but wait for my approval before writing files or running scripts.
Copying this prompt does not install or run the skill. Review third-party files before use.
Serial Studio — new I/O driver
Before writing anything, read app/src/IO/Drivers/BluetoothLE.h and BluetoothLE.cpp in
full. They are the canonical reference for the driver contract — match their structure,
signal/slot wiring, and driverProperties() shape rather than inventing a new layout. After
the read, restate the driver contract in chat in 2-3 sentences (pure virtuals, publish path,
timestamp-at-boundary) before scaffolding — a contract you've just named is one the new code
follows, not one it drifts from (doc/claude/j-space.md).
A driver subclasses IO::HAL_Driver (app/src/IO/HAL_Driver.h) and must implement the pure
virtuals: close, isOpen, isReadable, isWritable, configurationOk, write, open,
driverProperties, and setDriverProperty. Also consider the non-pure virtuals with default
bodies — deviceIdentifier(), selectByIdentifier(), applyConnectionSettings() — which
drive device selection and reconnection. Received bytes are published via
publishReceivedData(...) — stamp the timestamp at the driver boundary (source owns time;
see [ss-hotpath]). Never re-stamp downstream.
Touch-points to wire (verify each against an existing driver)
app/src/IO/Drivers/<Name>.h/.cpp— the driver class, SPDX header,.hordering rules.app/src/SerialStudio.h— add the value to theBusTypeenum (QML usesSerialStudio.BusType.*, never integer literals).app/src/IO/ConnectionManager.{h,cpp}— accessor (e.g.network()/uart()analogue), a UI-driver member pointer, and threeBusTypeswitches:activeUiDriver(),uiDriverForBusType(), andcreateDriver()— plus signal forwarding. Update all three.app/CMakeLists.txt— addsrc/IO/Drivers/<Name>.cppto theSOURCESlist (sources are listed explicitly, not globbed; commercial drivers go in the guardedset(SOURCES ${SOURCES} ...)block).- QML configuration UI — the driver panes are bespoke forms (nothing renders
driverProperties()generically): createapp/qml/MainWindow/Panes/SetupPanes/Drivers/<Name>.qml, add itsLoaderto theStackLayoutinSetupPanes/Hardware.qmlat the bus's enum position (the layout indexes byCpp_IO_Manager.busType), and register the new .qml in theQML_SOURCESlist inapp/CMakeLists.txt. app/src/API/EnumLabels.cpp— add the bus to thebusTypeSlug()andbusTypeLabel()switches (the API's string names for the bus; commercial buses go inside the#ifdef BUILD_COMMERCIALblock).app/src/DataModel/Project/ProjectEditorShared.h— add the bus to thebusTypeIcon()switch, andapp/src/DataModel/Project/ProjectEditorForms.cpp— add it to thebusTypescombobox list in the source form model (the oldProjectEditor.cppwas split; these live in the per-concern TUs now).- Icon — add the driver SVG under
app/rcc/icons/devices/drivers/and register it with a<file>entry inapp/rcc/rcc.qrc(busTypeIcon()returns itsqrc:/path). - CLI (optional) — if it should be launchable headless, add options in
app/src/Misc/CLI.{h,cpp}following the existingsetupUartConnection/setupTcpConnectionpattern. tests/utils/api_client.py(optional) — add the bus tobus_mapif integration tests should reach it viaio.setBusType(known drift:mqttis missing from it today).
The list above drifts as the app grows. Before declaring done, grep a recently added bus value
(e.g. grep -rn "BusType::HidDevice" app/src) and mirror every switch/list it appears in.
Rules
- This is a multi-file change (>3 files): state the plan and get confirmation before executing.
- Follow
doc/claude/code-style.md(header ordering,[[nodiscard]], no in-header member init,Q_EMITnotemit, Christmas-tree ordering). - Run
python scripts/code-verify.py --checkon the new files before handoff. - Do not build or run the app — leave compilation and runtime testing to the developer.