diff --git a/README.md b/README.md index 7cda059cb89681c1ab275291629c4ce835516fa5..4d29f06b00bad0584394f8814bf30ba23662fce0 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,14 @@ # uScope -[](https://www.codefactor.io/repository/bitbucket/ctw-bw/uscope) - This folder contains the source to the uScope ('micro-scope'), a real-time serial data scope for micropython boards. +It is a branch of https://bitbucket.org/ctw-bw/uscope intended for the "TCO ECG Monitor" hardware made for teh Technical Medicine course "Meten en Verwerken van Signalen". -## Versions - -| Branch | Connection Type | Devices | -| ------------- | --------------- | ---------------------------- | -| master | Serial | Micropython STM Nucleo, K64F | -| hid | HID USB | K64F | +It is based on the master branch (Serial USB mode), with additions to set the sample rate and control the recording and viewing length separately. -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 (see the [Downloads](../../downloads) section of this repository) or from source (see *getting started*). +Run the packaged executables (Windows or Mac) (see the [Dist](https://gitlab.utwente.nl/bss_development/neuro/uscope/-/tree/master/dist?ref_type=heads) 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. @@ -28,12 +20,13 @@ This environment is not committed to the repository. ## Getting started * In the root of this directory, run `python3 -m venv venv` to create a virtual environment called 'venv'. -* In a terminal, activate this environment by running `source venv/Scripts/activiate` (Linux), `source venv/Scripts/activiate.bat` +* In a terminal, activate this environment by running `source venv/Scripts/activiate` (Linux), `. venv/bin/activate` (Mac), `source venv/Scripts/activiate.bat` (Windows CMD) or `venv/Scripts/Activate.ps1` (Windows PowerShell). The latter is recommended for Windows. You should now see "(venv) $" at the start of your command line. -* Prepare the environment by running `pip install --upgrade pip` followed by `pip install -r requirements.txt`. +* Prepare the environment by running `pip install --upgrade pip` followed by `pip install -r requirements.txt`. +* (or manually install numpy PyQT and pyqtgraph: `pip install PyQt5` etc.) * Now run the program: `python3 main.py`. You can also easily set up an IDE like Pycharm to use this virtual environment. diff --git a/dist/uScope_TM_0.7_Mac.zip b/dist/uScope_TM_0.7_Mac.zip new file mode 100644 index 0000000000000000000000000000000000000000..308fffa67236fa61551ec04ddc8372587678b45a Binary files /dev/null and b/dist/uScope_TM_0.7_Mac.zip differ diff --git a/dist/uScope_TM_0.7.zip b/dist/uScope_TM_0.7_Windows.zip similarity index 100% rename from dist/uScope_TM_0.7.zip rename to dist/uScope_TM_0.7_Windows.zip