-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathxln_run_pgm.py
189 lines (180 loc) · 8.92 KB
/
xln_run_pgm.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
###################################################################################################
# XLN_RUN_PGM - RUN A STORED PROGRAM FROM THE MEMORY
# --------------------------------------------------------------------
#
# This is an example code to demonstrate the BK PRECISION XLN Programmable Power Supply Series.
#
# The XLN series have a CP1202 Serial to USB bridge, and enumerate as a serial port.
# On Windows, it will enumerate as a 'COMxx' port name.
# On MacOSX, it will enumerate as a '/dev/tty.usbserial-<serial_number>', where <serial_number>
# is the equipment serial number. This naming scheme allows multiple XLN units to be connected to the
# same computer, and to be correctly identified.
#
# The example code uses the pyserial module, and SCPI commands to control the XLN power supply.
# This is the basic sequence to talk to the power supply:
#
# 1) Identify the serial port device name. On Windows, it enumerates as a 'COMxx' virtual serial port.
# On MacOS, it enumerates as a tty.usbserial device, with name '/dev/tty.usbserial-<sernum>', where
# <sernum> is the serial number of the XLN power supply.
#
# 2) The communication uses the PySerial module API, to open the serial port and exchange ascii strings
# with the power supply. All strings exchanged to/from the serial port are byte strings, and need to
# be byte encoded.
#
# 3) The XLN series devices have a CP1202 Serial-to-USB Bridge chip, which is bus-powered. So, even when
# the power supply is unpowered or unresponsive, the USB device port can be enumerated and opened. This
# requires an positive identification from the power supply, before starting sending control commands.
#
# 4) The power supply responds with its full device name to the '*IDN?' command, and also with the model and
# version to the commands 'MODEL?' and 'VER?'. The serial number can also be read with the 'SYS:SER?' SCPI
# command. We use here the MODEL returned to validate a working device.
# NOTE: If the power supply is connected and powered up, but is not responding to any identification commands,
# it might be necessary to do a manual power OFF/ON on the power supply.
#
# 5) Some commands do not need a response, but a few commands are query/response commands, and need to have the
# response read, even if it will be discarded.
#
# 6) The serial port must be closed at the end of the program, to avoid a locked port in some operating systems.
#
#--------------------------------------------------------------------------------------------------
# DESCRIPTION
# -----------
#
# The program opens the serial port, authenticates the XLN power supply model, and sends the following sequence of
# commands:
# 1) Turn the output ON
# 2) Selects a stored program from memory '1'
# 3) Runs the selected program
# 4) Monitors the execution of the program and waits for it to run and stop
# 5) Turn the output OFF
# 6) Close the serial port
#
#--------------------------------------------------------------------------------------------------
# THIS CODE IS CREATED BY GRIDVORTEX SYSTEMS FOR CISTEK EQUIPAMENTOS DE MEDICAO AS EXAMPLE CODE
# SUPPORT FOR CISTEK CUSTOMERS. THIS CODE IS PROVIDED AS IS, WITH NO IMPLIED OR EXPLICIT GUARANTEES
# OF PERFORMANCE OR FUNCTIONALITY.
# NEITHER CISTEK NOR GRIDVORTEX ARE LIABLE FOR ANY DIRECT OR INDIRECT DAMAGES DERIVED FROM USE OF
# THIS CODE.
# THIS CODE IS PUBLISHED AS OPEN SOURCE FOR FREE USE. SUPPORT WILL BE PROVIDED ON GOODWILL, WITH NO
# OBLIGATION OF SUPPORT OR SERVICE BEING IMPLIED WITH THE PROVISION OF THIS CODE.
#--------------------------------------------------------------------------------------------------
# LICENSE: BSD 2-CLAUSE LICENSE
#
# Copyright (c) 2023, by Jonny Doin, GridVortex Systems
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain the above copyright notice, this list
# of conditions and the following disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright notice, this
# list of conditions and the following disclaimer in the documentation and/or other
# materials provided with the distribution.
#
# 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 WARRANTIES
# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
# SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
# TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
# BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
# DAMAGE.
#
###################################################################################################
import serial
import time
script_ver = "v1.0.8"
model_id = b'XLN3640' # change the model_id to your XLN model
portname = '/dev/tty.usbserial-275K22178' # change the device port name for your device name!
# on windows use 'COMxx'
def read_integer(instr):
try:
rd = instr.readline()
# print('rd: ', rd)
resp = int(rd)
except:
resp = 0
return resp
# main code
print()
print('B&K PRECISION REMOTE CONTROL EXAMPLE BY CISTEK')
print('LIST PROGRAM EXECUTION ', script_ver)
print('----------------------------------------------')
bk = serial.Serial()
bk.port = portname
bk.baudrate = 57600
bk.timeout = 0.2
bk.open()
if bk.is_open:
print('Serial port OPEN')
# The serial port is open, but we need to make the power supply to respond to *IDN? before sending commands.
bk.reset_input_buffer()
bk.reset_output_buffer()
bk.write("\r\n".encode())
bk.write("*idn?\r\n".encode())
idn = bk.readline()
bk.write("MODEL?\r\n".encode())
model = bk.readline()
bk.write("SYS:SER?\r\n".encode())
sernum = bk.readline()
bk.write("VER?\r\n".encode())
version = bk.readline()
print('portname:\t\t', portname)
print('Instrument ID:\t\t', idn)
print('Instrument MODEL:\t', model)
print('Instrument VERSION:\t', version)
print('Instrument SN:\t\t', sernum)
if model_id in model:
# The power supply responded. Now we can send SCPI commands.
print(model_id.decode(), "validated!")
bk.write("*cls\r\n".encode())
bk.write("OUTP ON\r\n".encode())
bk.write("OUTP?\r\n".encode())
print("OUTP? : ", bk.readline())
bk.write("STATUS?\r\n".encode())
print("STATUS? : ", bk.readline())
# Select program 1
bk.write("PROG 1\r\n".encode())
time.sleep(0.2)
bk.write("PROG:TOTA?\r\n".encode())
time.sleep(0.2)
steps = read_integer(bk)
print("PROG:TOTA? : ", steps)
if steps == 0:
print('PROGRAM 1 IS EMPTY')
else:
bk.write("PROG:RUN ON\r\n".encode())
time.sleep(0.2)
print('PROG:RUN ON')
while True:
time.sleep(0.2)
bk.write("PROG:RUN?\r\n".encode())
time.sleep(0.2)
resp = bk.readline()
if b'ON' in resp:
print("PROGRAM RUNNING ...")
break
while True:
time.sleep(0.2)
bk.write("PROG:RUN?\r\n".encode())
time.sleep(0.2)
resp = bk.readline()
if b'OFF' in resp:
print("PROGRAM STOPPED.")
break
bk.write("PROG:RUN OFF\r\n".encode())
time.sleep(2)
# bk.write("OUTP OFF\r\n".encode())
bk.write("OUTP ON\r\n".encode())
time.sleep(0.2)
bk.write("OUTP?\r\n".encode())
print("OUTP? : ", bk.readline())
else:
print('MODEL ID ERROR!')
bk.close()
print('Serial port CLOSED')
else:
print('ERROR: serial.open() failed.')