forked from Snigelson/DS1054Z_screen_capture
-
Notifications
You must be signed in to change notification settings - Fork 2
/
OscScreenGrabLAN.py
executable file
·287 lines (239 loc) · 10.1 KB
/
OscScreenGrabLAN.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
#!/usr/bin/env python3
from telnetlib_receive_all import Telnet
from Rigol_functions import *
import time
import sys
import os
import platform
import logging
__version__ = 'v1.1.0'
# Added TMC Blockheader decoding
# Added possibility to manually allow run for scopes other then DS1000Z
__author__ = 'RoGeorge'
#
# TODO: Write all SCPI commands in their short name, with capitals
# TODO: Add ignore instrument model switch instead of asking
#
# TODO: Detect if the scope is in RUN or in STOP mode (looking at the length of data extracted)
# TODO: Add logic for 1200/mdep points to avoid displaying the 'Invalid Input!' message
# TODO: Add message for csv data points: mdep (all) or 1200 (screen), depending on RUN/STOP state, MATH and WAV:MODE
# TODO: Add STOP scope switch
#
# TODO: Add debug switch
# TODO: Clarify info, warning, error, debug and print messages
#
# TODO: Add automated version increase
#
# TODO: Extract all memory datapoints. For the moment, CSV is limited to the displayed 1200 datapoints.
# TODO: Use arrays instead of strings and lists for csv mode.
#
# TODO: variables/functions name refactoring
# TODO: Fine tune maximum chunk size request
# TODO: Investigate scaling. Sometimes 3.0e-008 instead of expected 3.0e-000
# TODO: Add timestamp and mark the trigger point as t0
# TODO: Use channels label instead of chan1, chan2, chan3, chan4, math
# TODO: Add command line parameters file path
# TODO: Speed-up the transfer, try to replace Telnet with direct TCP
# TODO: Add GUI
# TODO: Add browse and custom filename selection
# TODO: Create executable distributions
#
# Set the desired logging level (DEBUG, INFO, WARNING, ERROR, CRITICAL)
logging.basicConfig(level=logging.INFO,
format='%(asctime)s - %(levelname)s - %(message)s',
filename=os.path.basename(sys.argv[0]) + '.log',
filemode='w')
logging.info("***** New run started...")
logging.info("OS Platform: " + str(platform.uname()))
log_running_python_versions()
# Update the next lines for your own default settings:
path_to_save = "captures/"
save_format = "PNG"
IP_DS1104Z = "192.168.1.3"
# Rigol/LXI specific constants
port = 5555
big_wait = 10
smallWait = 1
company = 0
model = 1
serial = 2
# Check command line parameters
script_name = os.path.basename(sys.argv[0])
def print_help():
print ()
print ("Usage:")
print (" " + "python " + script_name + " png|bmp|csv [oscilloscope_IP [save_path]]")
print ()
print ("Usage examples:")
print (" " + "python " + script_name + " png")
print (" " + "python " + script_name + " csv 192.168.1.3")
print ()
print ("The following usage cases are not yet implemented:")
print (" " + "python " + script_name + " bmp 192.168.1.3 my_place_for_captures")
print ()
print ("This program captures either the waveform or the whole screen")
print (" of a Rigol DS1000Z series oscilloscope, then save it on the computer")
print (" as a CSV, PNG or BMP file with a timestamp in the file name.")
print ()
print (" The program is using LXI protocol, so the computer")
print (" must have LAN connection with the oscilloscope.")
print (" USB and/or GPIB connections are not used by this software.")
print ()
print (" No VISA, IVI or Rigol drivers are needed.")
print ()
# Read/verify file type
if len(sys.argv) <= 1:
print_help()
sys.exit("Warning - wrong command line parameters.")
elif sys.argv[1].lower() not in ["png", "bmp", "csv"]:
print_help()
print ("This file type is not supported: ", sys.argv[1])
sys.exit("ERROR")
file_format = sys.argv[1].lower()
# Read IP
if len(sys.argv) > 1:
IP_DS1104Z = sys.argv[2]
# Check network response (ping)
if platform.system() == "Windows":
response = os.system("ping -n 1 " + IP_DS1104Z + " > nul")
else:
response = os.system("ping -c 1 " + IP_DS1104Z + " > /dev/null")
if response != 0:
print ()
print ("WARNING! No response pinging " + IP_DS1104Z)
print ("Check network cables and settings.")
print ("You should be able to ping the oscilloscope.")
# Open a modified telnet session
# The default telnetlib drops 0x00 characters,
# so a modified library 'telnetlib_receive_all' is used instead
tn = Telnet(IP_DS1104Z, port)
instrument_id = command(tn, "*IDN?").decode() # ask for instrument ID
# Check if instrument is set to accept LAN commands
if instrument_id == "command error":
print ("Instrument reply:", instrument_id)
print ("Check the oscilloscope settings.")
print ("Utility -> IO Setting -> RemoteIO -> LAN must be ON")
sys.exit("ERROR")
# Check if instrument is indeed a Rigol DS1000Z series
id_fields = instrument_id.split(",")
if (id_fields[company] != "RIGOL TECHNOLOGIES") or \
(id_fields[model][:3] != "DS1") or (id_fields[model][-1] != "Z"):
print ("Found instrument model '{}' from '{}'".format(id_fields[model], id_fields[company]))
print ("WARNING: No Rigol from series DS1000Z found at", IP_DS1104Z)
print ()
typed = raw_input("ARE YOU SURE YOU WANT TO CONTINUE? (No/Yes):")
if typed != 'Yes':
sys.exit('Nothing done. Bye!')
print ("Instrument ID:", instrument_id)
# Prepare filename as C:\MODEL_SERIAL_YYYY-MM-DD_HH.MM.SS
timestamp = time.strftime("%Y-%m-%d_%H.%M.%S", time.localtime())
if len(sys.argv) > 3:
filename = sys.argv[3]
else:
filename = path_to_save + id_fields[model] + "_" + id_fields[serial] + "_" + timestamp + "." + file_format
if file_format in ["png", "bmp"]:
# Ask for an oscilloscope display print screen
print ("Receiving screen capture...")
if file_format == "png":
buff = command(tn, ":DISP:DATA? ON,OFF,PNG")
else:
buff = command(tn, ":DISP:DATA? ON,OFF,BMP8")
expectedBuffLen = expected_buff_bytes(buff)
# Just in case the transfer did not complete in the expected time, read the remaining 'buff' chunks
while len(buff) < expectedBuffLen:
logging.warning("Received LESS data then expected! (" +
str(len(buff)) + " out of " + str(expectedBuffLen) + " expected 'buff' bytes.)")
tmp = tn.read_until(b"\n", smallWait)
if len(tmp) == 0:
break
buff += tmp
logging.warning(str(len(tmp)) + " leftover bytes added to 'buff'.")
if len(buff) < expectedBuffLen:
logging.error("After reading all data chunks, 'buff' is still shorter then expected! (" +
str(len(buff)) + " out of " + str(expectedBuffLen) + " expected 'buff' bytes.)")
sys.exit("ERROR")
# Strip TMC Blockheader and keep only the data
tmcHeaderLen = tmc_header_bytes(buff)
expectedDataLen = expected_data_bytes(buff)
buff = buff[tmcHeaderLen: tmcHeaderLen+expectedDataLen]
# Write raw data to file
with open(filename, 'wb') as f:
f.write(buff)
print('Saved raw data to {}'.format(filename))
# TODO: Change WAV:FORM from ASC to BYTE
elif file_format == "csv":
# Put the scope in STOP mode - for the moment, deal with it by manually stopping the scope
# TODO: Add command line switch and code logic for 1200 vs ALL memory data points
# tn.write("stop")
# response = tn.read_until("\n", 1)
# Scan for displayed channels
chanList = []
for channel in ["CHAN1", "CHAN2", "CHAN3", "CHAN4", "MATH"]:
response = command(tn, ":" + channel + ":DISP?")
# If channel is active
if response == '1\n':
chanList += [channel]
# the meaning of 'max' is - will read only the displayed data when the scope is in RUN mode,
# or when the MATH channel is selected
# - will read all the acquired data points when the scope is in STOP mode
# TODO: Change mode to MAX
# TODO: Add command line switch for MAX/NORM
command(tn, ":WAV:MODE NORM")
command(tn, ":WAV:STAR 0")
command(tn, ":WAV:MODE NORM")
csv_buff = ""
# for each active channel
for channel in chanList:
print ()
# Set WAVE parameters
command(tn, ":WAV:SOUR " + channel)
command(tn, ":WAV:FORM ASC")
# MATH channel does not allow START and STOP to be set. They are always 0 and 1200
if channel != "MATH":
command(tn, ":WAV:STAR 1")
command(tn, ":WAV:STOP 1200")
buff = ""
print ("Data from channel '" + str(channel) + "', points " + str(1) + "-" + str(1200) + ": Receiving...")
buffChunk = command(tn, ":WAV:DATA?")
# Just in case the transfer did not complete in the expected time
while buffChunk[-1] != "\n":
logging.warning("The data transfer did not complete in the expected time of " +
str(smallWait) + " second(s).")
tmp = tn.read_until(b"\n", smallWait)
if len(tmp) == 0:
break
buffChunk += tmp
logging.warning(str(len(tmp)) + " leftover bytes added to 'buff_chunks'.")
# Append data chunks
# Strip TMC Blockheader and terminator bytes
buff += buffChunk[tmc_header_bytes(buffChunk):-1] + ","
# Strip the last \n char
buff = buff[:-1]
# Process data
buff_list = buff.split(",")
buff_rows = len(buff_list)
# Put read data into csv_buff
csv_buff_list = csv_buff.split(os.linesep)
csv_rows = len(csv_buff_list)
current_row = 0
if csv_buff == "":
csv_first_column = True
csv_buff = str(channel) + os.linesep
else:
csv_first_column = False
csv_buff = str(csv_buff_list[current_row]) + "," + str(channel) + os.linesep
for point in buff_list:
current_row += 1
if csv_first_column:
csv_buff += str(point) + os.linesep
else:
if current_row < csv_rows:
csv_buff += str(csv_buff_list[current_row]) + "," + str(point) + os.linesep
else:
csv_buff += "," + str(point) + os.linesep
# Save data as CSV
scr_file = open(filename, "wb")
scr_file.write(csv_buff)
scr_file.close()
print ("Saved file:", "'" + filename + "'")
tn.close()