diff --git a/README.md b/README.md index 8274631..fc12280 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,7 @@ Compatible with Python 3.10+. * 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](https://github.com/square/pylink) * user-specific stream data decoding (user-defined types) * support for custom protocols diff --git a/docs/usage.rst b/docs/usage.rst index 2f60380..cf33062 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -29,6 +29,14 @@ Quick start serial_buad = 100000 intf = SerialDevice(serial_path, serial_baud) + or device that support NxScope over Segger RTT interface: + + .. code-block:: python + + target_device = "STM32G431CB" + buffer_index = 1 + upsize = 2048 + intf = RTTDevice(target_device, buffer_index, upsize) 3. Create a NxScope instance and connect: @@ -156,7 +164,7 @@ Just use `DummyDev` class parameters: `chmax`, `flags` and `channels`. Serial port interface -"""""""""""""""""""""" +""""""""""""""""""""" You can use `socat` to connect to a simulated NuttX target: