summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Friesel <derf@finalrewind.org>2021-11-07 20:03:18 +0100
committerDaniel Friesel <derf@finalrewind.org>2021-11-07 20:03:18 +0100
commit1dae1524e10b103dccd5c24e9bedf6916f1444b8 (patch)
tree527b49550014b3035c422a379030204c4ff7ceec
parent278d1386f748bc477cfb542662780497515ca102 (diff)
README: Add examples
-rw-r--r--README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
index 0e542e2..f1cb5ea 100644
--- a/README.md
+++ b/README.md
@@ -31,6 +31,24 @@ this software, you acknowledge that you are aware of these risks.
See `bin/korad-logger --help` for usage details.
+## Examples
+
+Log voltage and current of a manually configured PSU whose output is already
+enabled. Press Ctrl+C to exit. You may also specify a timeout in seconds
+("0" means no timeout).
+
+```
+bin/korad-logger --save logfile 0
+```
+
+Generate an I-V curve for a power LED supporting up to 200mA and a voltage
+limit of 5V. The output is turned on at the start of the measurement and
+turned off at the end.
+
+```
+bin/kaxxxxp-viewer --voltage-limit 5 --current-range '0 0.2 0.001' --save led.log 210
+```
+
## Dependencies
* Python 3 with the following modules: numpy, serial