Unverified Commit 278d1386 authored by Daniel Friesel's avatar Daniel Friesel
Browse files

kaxxxxp-viewer -> korad-logger; add related projects

parent 112ddcc2
Loading
Loading
Loading
Loading
+22 −9
Original line number Original line Diff line number Diff line
# 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
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,
Lab and equipped with a USB serial port, allowing them to be used as simple,
low-resolution measurement devices. See the [sigrok
low-resolution measurement devices. See the [sigrok
wiki](https://sigrok.org/wiki/Korad_KAxxxxP_series) for details.
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
It has been successfully used with "RND 320-KA3005P" (single-channel) and "RND
320-KA3305P" (dual-channel) supplies. Observed attributes:
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
Voltage and current range depend on the device, the resolutions are probably
identical.
identical.


**Warning:** In addition to reading voltage and current values, the serial
**Warning:** The KAxxxxP serial interface supports both reading current/voltage
interface also supports *setting* them. This is not supported by
data and writing current/voltage limits. korad-logger uses these to change
kaxxxxp-viewer. However, be warned that communication errors or bugs may cause
PSU attributes at runtime, if requested. The serial protocol does not use
the power supply to receive a write command with an arbitrary voltage or
checksums or similar mechanisms, so communication errors or bugs may cause the
current value, which may result in damaged equipment, fire, or other harm. By
power supply to receive a write command with an arbitrary voltage or current
using this software, you acknowledge that you are aware of these risks.
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
## Dependencies


* Python 3 with the following modules: numpy, serial
* Python 3 with the following modules: numpy, serial
* Data Visualization (--plot): python3-matplotlib
* 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)
+15 −10
Original line number Original line Diff line number Diff line
@@ -5,22 +5,27 @@
#
#
# SPDX-License-Identifier: GPL-2.0-or-later
# 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
DESCRIPTION


kaxxxxp-viewer logs voltage and current readings provided by a KAxxxxP power supply
korad-logger logs voltage and current readings provided by a KAxxxxP power
with serial/USB interface, sold under brands such as Korad or RND Lab.
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)
It is also capable of performing simple control tasks, such as stepping through
or loaded from a logfile using --load <file>. Data can be plotted or aggregated on stdout.
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
WARNING


The power supply's serial communication protocol is supports both read and write
The KAxxxxP serial interface supports both reading current/voltage
operations. Communication errors or bugs may cause the power supply to set an
data and writing current/voltage limits. korad-logger uses these to change
incompatible voltage or current limit, which may result in damaged equipment or
PSU attributes at runtime, if requested. The serial protocol does not use
fire. By using this software, you acknowledge that you are aware of these risks
checksums or similar mechanisms, so communication errors or bugs may cause the
and the following disclaimer.
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
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
any express or implied warranties, including, but not limited to, the implied