Merge pull request #10 from lnw/additionsAndFixes

additional functions, some comments, some typos

Author: Mango-kid

README.md

@@ -1,9 +1,9 @@
 # py-korad
-Korad Test & Measurment Equipment Python Library
+Korad Test & Measurement Equipment Python Library
 
 [![Python 3.7](https://img.shields.io/badge/python-3.7-blue.svg)](https://www.python.org/downloads/release/python-370/)
 
-This is the start of a reposistory to unify the Korad device drivers into a single repository. This is currently under development and notes will be shown below on what support is currently avalible.
+This is the start of a repository to unify the Korad device drivers into a single repository. This is currently under development and notes will be shown below on what support is currently avaliable.
 
 **Check out the Wiki for more info**
 
@@ -12,7 +12,7 @@ This is the start of a reposistory to unify the Korad device drivers into a sing
 - USB Interface: Separate USB class added - tested with batteryCurve only.
 
 ## KA P Series Power Supplies (ie. KA6003P)
-I will most likley pull this from one of the existing Korad Serial libraries.
+I will most likely pull this from one of the existing Korad Serial libraries.
 
 ## KD P Series Power Supplies
-Once I have compaired the SCPI command set between this device and the KA series hopefully we will just be able to unify these into a single class. 
+Once I have compared the SCPI command set between this device and the KA series hopefully we will just be able to unify these into a single class.

examples/batteryCurve.py

@@ -1,8 +1,9 @@
-"""This sample program will use the kel103 to test a batteries capacity and 
-show this information in matplotlib. This method is an aproximation and its resolution
-can be increase with sampling rate. 
 """
-import socket
+This sample program will use the kel103 to test a battery's capacity and
+show this information in matplotlib. This method is an aproximation and its
+resolution can be increased with sampling rate.
+"""
+
 import time
 import re
 import matplotlib
@@ -16,11 +17,14 @@
 MISSED_LIMIT = 10 # amount of missed samples that is allowed
 
 # setup the device (the IP of your ethernet/wifi interface, the IP of the Korad device)
-kel = kel103.kel103("192.168.8.126", "192.168.8.128", 18190)
+host_ip = "192.168.x.x"
+device_ip = "192.168.x.x"
+port = 18190
+kel = kel103.kel103(host_ip, device_ip, port)
 kel.checkDevice()
 
 # a quick battery test
-kel.setOutput(False)        
+kel.setOutput(False)
 voltage = kel.measureVolt()
 kel.setCurrent(dischargeRate)
 voltageData = []
@@ -33,24 +37,29 @@
 startTime = time.time()
 missedSuccessiveSamples = 0
 
+fileBasename = f"test_{time.time()}"
+
 while voltage > cutOffVoltage:
     try:
         # store the time before measuring volt/current
-        current_time = (time.time() - startTime)
+        currentTime = (time.time() - startTime)
         voltage = kel.measureVolt()
         current = kel.measureCurrent()
         voltageData.append(voltage)
         # Only append the timedata when volt/current measurements went fine.
         # This is because the voltage or current measurement could fail
-        # and then the x and y-axis would have different dimentions
-        timeData.append(current_time)
+        # and then the x and y-axis would have different dimensions
+        timeData.append(currentTime)
 
         # solve the current stuff as a running accumulation
-        capacity = ((startTime - time.time()) / 60 / 60) * current
+        capacity = ((time.time() - startTime) / 3600) * current
 
-        print("Voltage: " + str(voltage) + " V DC, Capacity: " + str(capacity) + " Ah")
-        time.sleep(0.25)
+        print(f"Voltage: {voltage:.3f} V DC, Capacity: {capacity:.3f} Ah")
+        time.sleep(1.0)
         missedSuccessiveSamples = 0
+
+        with open(f'{fileBasename}.txt', 'a') as f:
+          f.write(f"{currentTime} {voltage}\n")
     except Exception as e:
         print(e)
         missedSuccessiveSamples += 1
@@ -65,9 +74,10 @@
 fig, ax = plt.subplots()
 ax.plot(timeData, voltageData)
 
-ax.set(xlabel='time (s)', ylabel='voltage (V DC)',
-    title='Battery Discharge Test {}A: {:.4f}Ah'.format(dischargeRate, capacity))
+ax.set(xlabel='time (s)',
+       ylabel='voltage (V DC)',
+       title=f'Battery Discharge Test {dischargeRate:.3f}A: {capacity:.4f}Ah')
 ax.grid()
 
-fig.savefig("test_" + str(time.time()) + ".png")
+fig.savefig(f"{fileBasename}.png")
 plt.show()

examples/dynamicMode.py

@@ -4,7 +4,10 @@
 # 1st param: the IP of your ethernet/wifi interface
 # 2nd param: the IP of the Korad device
 # 3rd param: the port of the Korad device (18190 = default)
-kel = kel103.kel103("192.168.2.28", "192.168.7.183", 18190)
+host_ip = "192.168.x.x"
+device_ip = "192.168.x.x"
+port = 18190
+kel = kel103.kel103(host_ip, device_ip, port)
 
 print("Connecting to device..")
 try:

examples/internalResistance.py

@@ -0,0 +1,35 @@
+#!/usr/bin/env python
+"""
+This sample program uses the kel103 to measure the voltage drop and current
+for two resistances and calculate the internal resistance of the battery.  
+"""
+
+import time
+from korad import kel103
+
+
+def measureVoltageAndCurrentAtResistance(kel, resistance):
+    kel.setResistance(resistance)
+    kel.setOutput(True)
+    time.sleep(1.0)
+    u1 = kel.measureVolt()
+    i1 = kel.measureCurrent()
+    kel.setOutput(False)
+    return u1, i1
+
+def main():
+    host_ip = "192.168.x.x"
+    device_ip = "192.168.x.x"
+    port = 18190
+    kel = kel103.kel103(host_ip, device_ip, port)
+    kel.setOutput(False)
+    
+    u1, i1 = measureVoltageAndCurrentAtResistance(kel, 5)
+    u2, i2 = measureVoltageAndCurrentAtResistance(kel, 10)
+
+    ri = (u1 - u2) / (i2 - i1)
+    print(f"internal resistance {ri}")
+
+if __name__ == "__main__":
+    main()
+