forked from starforgelabs/py-korad-serial
-
Notifications
You must be signed in to change notification settings - Fork 0
/
koradserial.py
351 lines (264 loc) · 10.4 KB
/
koradserial.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
""" Serial communication with Korad KA3xxxP power supplies.
The intent is to give easy access to the power supply as Python objects, eliminating the need to know
special codes.
The object supports the python `with` statement to release the serial port automatically:
from koradserial import KoradSerial
with KoradSerial('/dev/tty.usbmodemfd121') as device:
print "Model: ", device.model
print "Status: ", device.status
LICENSE: MIT
RESOURCES:
http://www.eevblog.com/forum/testgear/power-supply-ps3005d-ka3005d-rs232-protocol/
http://www.eevblog.com/forum/testgear/korad-ka3005p-io-commands/
http://sigrok.org/wiki/Velleman_PS3005D
https://gist.github.com/k-nowicki/5379272
"""
from enum import Enum
from time import sleep
import serial
__all__ = ['KoradSerial', 'ChannelMode', 'OnOffState', 'Tracking']
class ChannelMode(Enum):
""" Represents channel modes.
These values should correspond to the values returned by the ``STATUS?`` command.
"""
constant_current = 0
constant_voltage = 1
class OnOffState(Enum):
""" Represents on/off states.
This could just as easily be done as a Boolean, but is explicit.
"""
off = 0
on = 1
class Tracking(Enum):
""" Tracking state for a multi-channel power supply.
These values should correspond to the values returned by the ``STATUS?`` command.
There seems to be conflicting information about these values.
The other values I've seen are:
* 0 - independent
* 1 - series
* 2 - parallel
* 3 - symmetric
However, I don't have a multi-channel power supply to test these.
"""
independent = 0
series = 1
parallel = 3
class Status(object):
""" Decode the KoradSerial status byte.
It appears that the firmware is a little wonky here.
SOURCE:
Taken from http://www.eevblog.com/forum/testgear/korad-ka3005p-io-commands/
Contents 8 bits in the following format
Bit Item Description
0 CH1 0=CC mode, 1=CV mode
1 CH2 0=CC mode, 1=CV mode
2, 3 Tracking 00=Independent, 01=Tracking series,11=Tracking parallel
4 Beep 0=Off, 1=On
5 Lock 0=Lock, 1=Unlock
6 Output 0=Off, 1=On
7 N/A N/A
"""
def __init__(self, status):
""" Initialize object with a KoradSerial status character.
:param status: Status value
:type status: int
"""
super(Status, self).__init__()
self.raw = status
self.channel1 = ChannelMode(status & 1)
self.channel2 = ChannelMode((status >> 1) & 1)
self.tracking = Tracking((status >> 2) & 3)
self.beep = OnOffState((status >> 4) & 1)
self.lock = OnOffState((status >> 5) & 1)
self.output = OnOffState((status >> 6) & 1)
def __repr__(self):
return "{0}".format(self.raw)
def __str__(self):
return "Channel 1: {0}, Channel 2: {1}, Tracking: {2}, Beep: {3}, Lock: {4}, Output: {5}".format(
self.channel1.name,
self.channel2.name,
self.tracking.name,
self.beep.name,
self.lock.name,
self.output.name,
)
def __unicode__(self):
return self.__str__()
def float_or_none(value):
try:
return float(value)
except (TypeError, ValueError):
return None
class KoradSerial(object):
""" Wrapper for communicating with a programmable KoradSerial KA3xxxxP power supply as a serial interface.
"""
class Channel(object):
""" Wrap a channel. """
def __init__(self, serial_, channel_number):
"""
:type serial_: KoradSerial.Serial
:type channel_number: int
"""
super(KoradSerial.Channel, self).__init__()
self.__serial = serial_
self.number = channel_number
@property
def current(self):
result = self.__serial.send_receive("ISET{0}?".format(self.number), fixed_length=6)
# There's a bug that return a 6th character of previous output.
# This has to be read and discarded otherwise it will be prepended to the next output
return float_or_none(result[:5])
@current.setter
def current(self, value):
self.__serial.send("ISET{0}:{1:05.3f}".format(self.number, value))
@property
def voltage(self):
return float_or_none(self.__serial.send_receive("VSET{0}?".format(self.number), fixed_length=5))
@voltage.setter
def voltage(self, value):
self.__serial.send("VSET{0}:{1:05.2f}".format(self.number, value))
@property
def output_current(self):
""" Retrieve this channel's current current output.
:return: Amperes
:rtype: float or None
"""
result = self.__serial.send_receive("IOUT{0}?".format(self.number), fixed_length=5)
return float_or_none(result)
@property
def output_voltage(self):
""" Retrieve this channel's current current voltage.
:return: Volts
:rtype: float or None
"""
result = self.__serial.send_receive("VOUT{0}?".format(self.number), fixed_length=5)
return float_or_none(result)
class Memory(object):
""" Wrap a memory setting. """
def __init__(self, serial_, memory_number):
super(KoradSerial.Memory, self).__init__()
self.__serial = serial_
self.number = memory_number
def recall(self):
""" Recall this memory's settings. """
self.__serial.send("RCL{0}".format(self.number))
def save(self):
""" Save the current voltage and current to this memory. """
self.__serial.send("SAV{0}".format(self.number))
class OnOffButton(object):
""" Wrap an off/off button. """
def __init__(self, serial_, on_command, off_command):
super(KoradSerial.OnOffButton, self).__init__()
self.__serial = serial_
self._on = on_command
self._off = off_command
def on(self):
self.__serial.send(self._on)
def off(self):
self.__serial.send(self._off)
class Serial(object):
""" Serial operations.
There are some quirky things in communication. They go here.
"""
def __init__(self, port, debug=False):
super(KoradSerial.Serial, self).__init__()
self.debug = debug
self.port = serial.Serial(port, 9600, timeout=1)
def read_character(self):
c = self.port.read(1)
if self.debug:
if len(c) > 0:
print "read: {0} = '{1}'".format(ord(c), c)
else:
print "read: timeout"
return c
def read_string(self, fixed_length=None):
""" Read a string.
It appears that the KoradSerial PSU returns zero-terminated strings.
:return: str
"""
result = []
c = self.read_character()
while len(c) > 0 and ord(c) != 0:
result.append(c)
if fixed_length is not None and len(result) == fixed_length:
break
c = self.read_character()
return ''.join(result)
def send(self, text):
if self.debug:
print "_send: ", text
sleep(0.1)
self.port.write(text)
def send_receive(self, text, fixed_length=None):
self.send(text)
return self.read_string(fixed_length)
def __init__(self, port, debug=False):
super(KoradSerial, self).__init__()
self.__serial = KoradSerial.Serial(port, debug)
# Channels: adjust voltage and current, discover current output voltage.
self.channels = [KoradSerial.Channel(self.__serial, i) for i in range(1, 3)]
# Memory recall/save buttons 1 through 5
self.memories = [KoradSerial.Memory(self.__serial, i) for i in range(1, 6)]
# Second column buttons
self.beep = KoradSerial.OnOffButton(self.__serial, "BEEP1", "BEEP0")
self.output = KoradSerial.OnOffButton(self.__serial, "OUT1", "OUT0")
self.over_current_protection = KoradSerial.OnOffButton(self.__serial, "OCP1", "OCP0")
self.over_voltage_protection = KoradSerial.OnOffButton(self.__serial, "OVP1", "OVP0")
def __enter__(self):
""" See documentation for Python's ``with`` command.
"""
return self
def __exit__(self, type, value, traceback):
""" See documentation for Python's ``with`` command.
"""
self.close()
return False
# ################################################################################
# Serial operations
# ################################################################################
@property
def is_open(self):
""" Report whether the serial port is open.
:rtype: bool
"""
return self.__serial.port.isOpen()
def close(self):
""" Close the serial port """
self.__serial.port.close()
def open(self):
""" Open the serial port """
self.__serial.port.open()
# ################################################################################
# Power supply operations
# ################################################################################
@property
def model(self):
""" Report the power supply model information.
:rtype: str
"""
return self.__serial.send_receive("*IDN?")
@property
def status(self):
""" Report the power supply status.
:rtype: KoradSerial.Status or None
"""
self.__serial.send("STATUS?")
status = self.__serial.read_character()
if len(status) == 0:
return None
else:
return Status(ord(status))
def track(self, value):
""" Set tracking mode.
This does nothing on single-channel power supply.
:param value: Tracking mode to set.
:type value: Tracking
"""
translate = {
Tracking.independent: "TRACK0",
Tracking.series: "TRACK1",
Tracking.parallel: "TRACK2",
}
if value in translate:
self.__serial.send(translate[value])