Skip to content

Commit 36a61ab

Browse files
committed
README.md: added usage example of the help option
1 parent 6d85fa7 commit 36a61ab

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
11
# Hantek1008Driver
22

3-
This project provides the ability to use Hantek 1008 USB-oscilloscopes without the proprietary software on Linux and Windows (not tested). You can include the Hantek1008 from 'hantek1008.py' class in your project to get access to the features of the device or use the csvexport.py Python application to gain data and save it to a file.
3+
This project provides the ability to use Hantek 1008 USB-oscilloscopes without the proprietary software on Linux and Windows (not tested). You can include the Hantek1008 from 'hantek1008.py' class in your project, to get access to the features of the device, or use the csvexport.py Python application to gain data and save it to a file.
44

55
### Usageexample of csvexport.py:
66
`python3 csvexport.py mydata.csv -s 1 2`
77
This will write the measured data of channel 1 and 2 to 'mydata.csv' until you press CTRL+C to stop the measurement.
88

9+
### Help Options:
10+
`python3 csvexport.py --help`
11+
This will show you all the available options/parameters and explains them in-depth.
12+
913

1014
### Notes:
1115
* Requires Python >= 3.6
@@ -15,7 +19,3 @@ This will write the measured data of channel 1 and 2 to 'mydata.csv' until you p
1519
ACTION=="add", SUBSYSTEM=="usb", ATTRS{idVendor}=="0783", ATTR{idProduct}=="5725", MODE="0666"
1620
2. Then `sudo udevadm control -R`
1721
3. Replug the device
18-
19-
### TODO:
20-
* Usage example of the Hantek1008 class
21-
* Better comments in source

0 commit comments

Comments
 (0)