Nxscli is a command-line client package for the Apache NuttX NxScope real-time logging module.
It is also a reusable Python runtime layer for NxScope streaming, channel
control, triggers, and plugin orchestration. The nxscli internals are used
by other tools (for example GUI applications) to build more advanced workflows
without re-implementing NxScope communication logic.
Compatible with Python 3.10+.
- Plugins architecture, extendable through
nxscli.extensionsentrypoint - Client-based triggering (global and per-channel triggers)
- Save data to CSV files
- Save data to Numpy files (
pnpsave) and memmap files (pnpmem) - Print samples
- Stream data over UDP (compatible with PlotJuggler)
- NxScope protocol via serial port or Segger RTT interface
- Virtual channels and math operations on channels data
- Optional control server (
--control-server) for extensions
- More triggering types
- Boolean operations on triggers
- Improve
pdevinfooutput (human-readable prints) - Interactive mode
By default, nxscli ships with core plugins including CSV, printer, UDP,
and NumPy file capture (pnpsave and pnpmem).
Additional functionality is expanded by installing optional plugins.
Plugins are automatically detected by Nxscli.
Available plugins:
- nxscli-mpl - Matplotlib extension
- nxscli-pqg - PyQtGraph extension
- Stream data as audio (inspired by audio knock detection systems)
Nxscli can be installed by running pip install nxscli.
To install latest development version, use:
pip install git+https://github.com/railab/nxscli.git
Look at docs/usage.
nxscli is not only a CLI frontend. It can be imported and reused by external
applications that need:
- NxScope connection handling (serial/RTT and compatible interfaces)
- channel configuration and stream lifecycle control
- plugin loading and runtime execution
- trigger and data-processing orchestration
This makes nxscli the integration layer for higher-level tools such as
custom dashboards, GUIs, and automation scripts.
All contributions are welcome to this project.
To get started with developing Nxscli, see CONTRIBUTING.md.