Skip to content
/ nxslib Public

A client library to the Apache NuttX NxScope module

License

Notifications You must be signed in to change notification settings

railab/nxslib

Repository files navigation

Nxslib

master workflow

Nxslib is a Python client library for the Apache NuttX NxScope real-time logging module.

Compatible with Python 3.10+.

Features

  • built-in simulated NxScope device that allows application development without connecting a real NuttX device
  • support for the NxScope serial protocol
  • support for Segger RTT interface based on pylink
  • user-specific stream data decoding (user-defined types)
  • support for custom protocols

Instalation

Nxslib can be installed by running pip install nxslib.

To install latest development version, use:

pip install git+https://github.com/railab/nxslib.git

Contributing

All contributions are welcome to this project.

To get started with developing Nxslib, see CONTRIBUTING.md.

Usage

Look at docs/usage.

Tools

  • Nxscli - a command-line interface based on Nxslib