summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Friesel <derf@finalrewind.org>2021-11-07 06:53:52 +0100
committerDaniel Friesel <derf@finalrewind.org>2021-11-07 06:53:52 +0100
commit278d1386f748bc477cfb542662780497515ca102 (patch)
treeb3a88e757cabb79f65ed23b7bfd114c6349e00a1
parent112ddcc2ac7050df45cf0a73201d155c020f8500 (diff)
kaxxxxp-viewer -> korad-logger; add related projects
-rw-r--r--README.md31
-rwxr-xr-xbin/korad-logger (renamed from bin/kaxxxxp-viewer)25
2 files changed, 37 insertions, 19 deletions
diff --git a/README.md b/README.md
index d655042..0e542e2 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,14 @@
-# kaxxxxp-viewer - Data Logger and Viewer for KAxxxxP power supplies
+# korad-logger - Data Logger and Controller for KAxxxxP power supplies
-**kaxxxxp-viewer** acquires and visualizes voltage and current data from
+**korad-logger** acquires and visualizes voltage and current data from
KAxxxxP power supplies. These are sold under brand names such as Korad or RND
Lab and equipped with a USB serial port, allowing them to be used as simple,
low-resolution measurement devices. See the [sigrok
wiki](https://sigrok.org/wiki/Korad_KAxxxxP_series) for details.
+korad-logger is capable of performing simple control tasks, such as stepping
+through voltage/current slopes for automated I-V curve measurements.
+
It has been successfully used with "RND 320-KA3005P" (single-channel) and "RND
320-KA3305P" (dual-channel) supplies. Observed attributes:
@@ -18,16 +21,26 @@ It has been successfully used with "RND 320-KA3005P" (single-channel) and "RND
Voltage and current range depend on the device, the resolutions are probably
identical.
-**Warning:** In addition to reading voltage and current values, the serial
-interface also supports *setting* them. This is not supported by
-kaxxxxp-viewer. However, be warned that communication errors or bugs may cause
-the power supply to receive a write command with an arbitrary voltage or
-current value, which may result in damaged equipment, fire, or other harm. By
-using this software, you acknowledge that you are aware of these risks.
+**Warning:** The KAxxxxP serial interface supports both reading current/voltage
+data and writing current/voltage limits. korad-logger uses these to change
+PSU attributes at runtime, if requested. The serial protocol does not use
+checksums or similar mechanisms, so communication errors or bugs may cause the
+power supply to receive a write command with an arbitrary voltage or current
+value. This may result in damaged equipment, fire, or other harm. By using
+this software, you acknowledge that you are aware of these risks.
-See `bin/kaxxxxp-viewer --help` for usage details.
+See `bin/korad-logger --help` for usage details.
## Dependencies
* Python 3 with the following modules: numpy, serial
* Data Visualization (--plot): python3-matplotlib
+
+## Related work
+
+This is by far not the first project for korad PSU logging and control. See also:
+
+* [libsigrok](https://sigrok.org/wiki/Korad_KAxxxxP_series)
+* [koradctl](https://github.com/attie/koradctl)
+* [KoradControl](https://github.com/maximaximal/KoradControl)
+* [Korad-KA6003P-Software](https://github.com/Tamagotono/Korad-KA6003P-Software)
diff --git a/bin/kaxxxxp-viewer b/bin/korad-logger
index 742d6af..84d9483 100755
--- a/bin/kaxxxxp-viewer
+++ b/bin/korad-logger
@@ -5,22 +5,27 @@
#
# SPDX-License-Identifier: GPL-2.0-or-later
-"""kaxxxxp-viewer - Data Logger and Viewer for KAxxxxP power supplies
+"""korad-logger - Data Logger and Controller for Korad KAxxxxP power supplies
DESCRIPTION
-kaxxxxp-viewer logs voltage and current readings provided by a KAxxxxP power supply
-with serial/USB interface, sold under brands such as Korad or RND Lab.
-Measurements can be taken directly (by specifying <measurement duration> in seconds)
-or loaded from a logfile using --load <file>. Data can be plotted or aggregated on stdout.
+korad-logger logs voltage and current readings provided by a KAxxxxP power
+supply with serial/USB interface, sold under brands such as Korad or RND Lab.
+It is also capable of performing simple control tasks, such as stepping through
+voltage/current slopes for automated I-V curve measurements. Measurements can
+be taken directly (by specifying <measurement duration> in seconds) or loaded
+from a logfile using --load <file>. Data can be plotted or aggregated on stdout.
WARNING
-The power supply's serial communication protocol is supports both read and write
-operations. Communication errors or bugs may cause the power supply to set an
-incompatible voltage or current limit, which may result in damaged equipment or
-fire. By using this software, you acknowledge that you are aware of these risks
-and the following disclaimer.
+The KAxxxxP serial interface supports both reading current/voltage
+data and writing current/voltage limits. korad-logger uses these to change
+PSU attributes at runtime, if requested. The serial protocol does not use
+checksums or similar mechanisms, so communication errors or bugs may cause the
+power supply to receive a write command with an arbitrary voltage or current
+value. This may result in damaged equipment, fire, or other harm. By using
+this software, you acknowledge that you are aware of these risks and the
+following disclaimer.
This software is provided by the copyright holders and contributors "as is" and
any express or implied warranties, including, but not limited to, the implied