| Name | nxscli JSON |
| Version |
0.5.1
JSON |
| download |
| home_page | |
| Summary | Nxscope CLI client |
| upload_time | 2023-10-05 09:27:13 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.10 |
| license | Apache-2.0 |
| keywords |
nuttx
nxslib
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
# 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).
Raw data
{
"_id": null,
"home_page": "",
"name": "nxscli",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "",
"keywords": "nuttx,nxslib",
"author": "",
"author_email": "raiden00 <raiden00@railab.me>",
"download_url": "https://files.pythonhosted.org/packages/5a/c9/b6bf7c8e2c6b449b6318c6a47d743b0e803eb9f8480c7e405638a8f35280/nxscli-0.5.1.tar.gz",
"platform": null,
"description": "# Nxscli\n\n\nNxscli is a command-line client package for the [Apache NuttX](https://nuttx.apache.org/)\nNxScope real-time logging module.\n\nCompatible with Python 3.10+.\n\n## Features\n\n* Plugins architecture, extendable through ``nxscli.extensions`` entrypoint\n* Client-based triggering (global and per-channel triggers)\n* Save data to CSV files\n* Print samples\n* Stream data over UDP (compatible with [PlotJuggler](https://github.com/facontidavide/PlotJuggler))\n* NxScope protocol via serial port or Segger RTT interface\n\n## Features Planned\n\n* More triggering types\n* Boolean operations on triggers\n* Virtual channels and math operations on channels data\n* Improve `pdevinfo` output (human-readable prints)\n* Interactive mode\n\n## Plugins\n\nBy default, we only support features that depend on the standard Python libraries.\nThe functionality is expadned by installing plugins.\nPlugins are automatically deteceted by Nxscli.\n\nAvailable plugins:\n\n* [nxscli-mpl](https://github.com/railab/nxscli-mpl) - Matplotlib extension\n* [nxscli-np](https://github.com/railab/nxscli-np) - Numpy extension\n\n## Plugins Planned\n\n* Stream data as audio (inspired by audio knock detection systems)\n* PyQtGraph support\n\n## Instalation\n\nNxscli can be installed by running `pip install nxscli`.\n\nTo install latest development version, use:\n\n`pip install git+https://github.com/railab/nxscli.git`\n\n## Usage\n\nLook at [docs/usage](docs/usage.rst).\n\n\n## Contributing\n\nAll contributions are welcome to this project. \n\nTo get started with developing Nxscli, see [CONTRIBUTING.md](CONTRIBUTING.md).\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Nxscope CLI client",
"version": "0.5.1",
"project_urls": {
"Changelog": "https://github.com/railab/nxscli/blob/master/CHANGES.md",
"Homepage": "https://github.com/railab/nxscli"
},
"split_keywords": [
"nuttx",
"nxslib"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d0ff75f7596fcc74ab6a498dcd4e7d37f0c3ec6b82a4dee34ba3184f0e071e75",
"md5": "3ea89cb19e639be388ab21934b558927",
"sha256": "99abe48f40dcfe2f31ea8811cd1e6245ed59a34edf06ddddfee1a909fa1c97b7"
},
"downloads": -1,
"filename": "nxscli-0.5.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3ea89cb19e639be388ab21934b558927",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 35789,
"upload_time": "2023-10-05T09:27:10",
"upload_time_iso_8601": "2023-10-05T09:27:10.844564Z",
"url": "https://files.pythonhosted.org/packages/d0/ff/75f7596fcc74ab6a498dcd4e7d37f0c3ec6b82a4dee34ba3184f0e071e75/nxscli-0.5.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5ac9b6bf7c8e2c6b449b6318c6a47d743b0e803eb9f8480c7e405638a8f35280",
"md5": "33fbeb7c7e655b1a4b6784ee6a8306fa",
"sha256": "4d8d73ac4f217939e4e6671269902472e30e5995dba770cc5e418f047914581b"
},
"downloads": -1,
"filename": "nxscli-0.5.1.tar.gz",
"has_sig": false,
"md5_digest": "33fbeb7c7e655b1a4b6784ee6a8306fa",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 29334,
"upload_time": "2023-10-05T09:27:13",
"upload_time_iso_8601": "2023-10-05T09:27:13.059150Z",
"url": "https://files.pythonhosted.org/packages/5a/c9/b6bf7c8e2c6b449b6318c6a47d743b0e803eb9f8480c7e405638a8f35280/nxscli-0.5.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-05 09:27:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "railab",
"github_project": "nxscli",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "nxscli"
}
