Metadata-Version: 2.1
Name: koradctl
Version: 0.7
Summary: Control utility for Korad / Tenma power supplies
Home-page: https://github.com/attie/koradctl
Author: Attie Grande
Author-email: attie@attie.co.uk
License: BSD-3-Clause
Description: # `koradctl` - Power Supply Control Utility and Library
        
        `koradctl` is a simple python library to support the control and automation of Korad KAxxxxP series power supplies.
        These supplies are also rebadged as other brands including Tenma and Vellerman (see [here](https://sigrok.org/wiki/Korad_KAxxxxP_series) for a more complete list).
        
        `koradctl` has been tested with bench power supplies that respond with the following firmware identification.
        Please let me know if you have successfully used `koradctl` with other power supplies.
        
        - `TENMA 72-2540 V2.1`
        
        ## Install
        
        ```bash
        pip install koradctl
        ```
        
        ## Usage
        
        ```bash
        # Output off
        koradctl -e off
        
        # Toggle the output
        koradctl -e toggle
        
        # 12v, 400mA, Output on, Monitor with readings once every 10 seconds
        koradctl -v 12 -i 0.4 -e on -M -f 10
        
        # 3.3v, 250mA, OCP on, OVP off, Output on, Monitor once
        koradctl --ocp on --ovp off -v 3.3 -i 0.25 -e on -m
        
        # 5v, 150mA, Output on, Monitor with default interval, Turn output off on ^C
        koradctl -v 5 -i 0.15 -e on -M -o
        
        # further usage information:
        koradctl --help
        ```
        
        ## Power Supply API
        
        - Misc
            - `get_identity()`
            - `is_tested()`
            - `get_status()`
        - Output State
            - `get_output_state()`
            - `set_output_state(enabled)`
        - Voltage and Over Current Protection
            - `get_ovp_ocp_state()`
            - `set_ocp_state(enabled)`
            - `set_ovp_state(enabled)`
        - Setpoint Control
            - Voltage
                - `get_voltage_setpoint()`
                - `set_voltage_setpoint(voltage)`
            - Current
                - `get_current_setpoint()`
                - `set_current_setpoint(current)`
        - Output Readings
            - `get_output_voltage()`
            - `get_output_current()`
            - `get_output_power()`
            - `get_output_readings()`
        
        ## Development Setup
        
        ```bash
        virtualenv -p python3 venv
        . venv/bin/activate
        pip install -r requirements.txt
        ```
        
        ## Todo
        
        - Local configuration file
            - Default Voltage / Current setpoint
            - Voltage / Current limits
            - Monitor interval
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Manufacturing
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: System Administrators
Classifier: License :: Freely Distributable
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Operating System :: POSIX
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development :: Embedded Systems
Classifier: Topic :: Utilities
Requires-Python: >=3.6
Description-Content-Type: text/markdown
