Skip to content
Snippets Groups Projects
Commit b7283b52 authored by Roberto-R's avatar Roberto-R
Browse files

Updated readme

parent fc5f8b68
No related branches found
No related tags found
No related merge requests found
......@@ -4,13 +4,22 @@
This folder contains the source to the uScope ('micro-scope'), a real-time serial data scope for micropython boards.
## Versions
| Branch | Connection Type | Devices |
| ------------- | --------------- | ---------------------------- |
| master | Serial | Micropython STM Nucleo, K64F |
| hid | HID USB | K64F |
uScope was originally made to run with regular serial. Later a new version was made based on HID USB, as it is a bit faster and timing is much more robust.
Note that the microcontroller must implement the HID protocol. So not every microcontroller USB port will support it out of the box.
## How to use
Run the packaged .exe or from source (see *getting started*). Select the COM port on which data is being sent (this should be different from the REPL port) and click connect.
Run the packaged .exe (see the [Downloads](../../downloads) section of this repository) or from source (see *getting started*).
Select the COM port or HID name on which data is being sent (this could be different from the REPL port) and click connect.
Use the 'Save' button to make exports, or right-click on a plot to make a singular export.
If the applications starts to lag or even crash after conneting, try increasing the render frames value to slow down graph rendering.
## PyQt 5
The GUI is made in PyQt5 (https://build-system.fman.io/pyqt5-tutorial). Development is done from a virtual environment.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment