https://github.com/railab/nxscli
A command-line client to the Apache NuttX NxScope real-time logging module
https://github.com/railab/nxscli
cli click embedded logging nuttx nxscli nxslib
Last synced: 8 months ago
JSON representation
A command-line client to the Apache NuttX NxScope real-time logging module
- Host: GitHub
- URL: https://github.com/railab/nxscli
- Owner: railab
- License: apache-2.0
- Created: 2023-02-02T14:28:20.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-10-05T09:26:12.000Z (over 2 years ago)
- Last Synced: 2025-03-30T11:41:38.474Z (about 1 year ago)
- Topics: cli, click, embedded, logging, nuttx, nxscli, nxslib
- Language: Python
- Homepage:
- Size: 173 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Nxscli
Nxscli is a command-line client package for the [Apache NuttX](https://nuttx.apache.org/)
NxScope real-time logging module.
Compatible with Python 3.10+.
## Features
* Plugins architecture, extendable through ``nxscli.extensions`` entrypoint
* Client-based triggering (global and per-channel triggers)
* Save data to CSV files
* Print samples
* Stream data over UDP (compatible with [PlotJuggler](https://github.com/facontidavide/PlotJuggler))
* NxScope protocol via serial port or Segger RTT interface
## Features Planned
* More triggering types
* Boolean operations on triggers
* Virtual channels and math operations on channels data
* Improve `pdevinfo` output (human-readable prints)
* Interactive mode
## Plugins
By default, we only support features that depend on the standard Python libraries.
The functionality is expadned by installing plugins.
Plugins are automatically deteceted by Nxscli.
Available plugins:
* [nxscli-mpl](https://github.com/railab/nxscli-mpl) - Matplotlib extension
* [nxscli-np](https://github.com/railab/nxscli-np) - Numpy extension
## Plugins Planned
* Stream data as audio (inspired by audio knock detection systems)
* PyQtGraph support
## Instalation
Nxscli can be installed by running `pip install nxscli`.
To install latest development version, use:
`pip install git+https://github.com/railab/nxscli.git`
## Usage
Look at [docs/usage](docs/usage.rst).
## Contributing
All contributions are welcome to this project.
To get started with developing Nxscli, see [CONTRIBUTING.md](CONTRIBUTING.md).