Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update readme #39

Merged
merged 1 commit into from
Oct 4, 2023
Merged

update readme #39

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
10 changes: 9 additions & 1 deletion docs/usage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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:

Expand Down