#!/usr/bin/env python from telnetlib_receive_all import Telnet from Rigol_functions import * import time from PIL import Image import StringIO import sys import os import platform import logging __version__ = 'v1.0.0' __author__ = 'RoGeorge' # # TODO: Replace the fixed delay between commands with *OPC? (Operation Complete) query # TODO: Add debug mode # TODO: Add debug switch # TODO: Add Python and modules version # TODO: Add script version # TODO: Add message for csv data points: mdep (all) or 1200 (screen), depending on RUN/STOP state, MATH and WAV:MODE # TODO: Clarify info, warning, error, debug and print messages # TODO: Remove debugging print lines # TODO: Add .gitignore # """ # TODO: Use "waveform:data?" multiple times to extract the whole 12M points in order to overcome the "Memory lack in waveform reading!" screen message """ # TODO: Detect if the osc is in RUN or in STOP mode (looking at the length of data extracted) # 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') logging.info("New run started...") logging.info("Log message: INFO level set.") 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 expected_len = 1152068 TMC_header_len = 11 terminator_len = 3 big_wait = 10 small_wait = 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] # Create/check if 'path' exists # 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 "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?") # 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", id_fields[model], "instead of expected model, DS1*Z" print "ERROR: No Rigol from series DS1000Z found at ", IP_DS1104Z sys.exit("ERROR") print "Instrument ID:", print 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()) filename = path_to_save + id_fields[model] + "_" + id_fields[serial] + "_" + timestamp if file_format in ["png", "bmp"]: # Ask for an oscilloscope display print screen print "Receiving screen capture..." buff = command(tn, "display:data?") # Just in case the transfer did not complete in the expected time while len(buff) < expected_len: logging.warning("Received LESS data then expected! (" + str(len(buff)) + " out of " + str(expected_len) + " expected raw BMP bytes.)") tmp = tn.read_until("\n", small_wait) if len(tmp) == 0: break buff += tmp logging.warning(str(len(tmp)) + " leftover bytes added to 'buff'.") if len(buff) < expected_len: logging.error("Received LESS data then expected! (" + str(len(buff)) + " out of " + str(expected_len) + " expected raw BMP bytes.)") sys.exit("ERROR") # Strip TMC Blockheader and terminator bytes buff = buff[TMC_header_len:-terminator_len] # Save as PNG or BMP according to file_format im = Image.open(StringIO.StringIO(buff)) im.save(filename + "." + file_format, file_format) print "Saved file:", filename + "." + file_format elif file_format == "csv": # Put osc in STOP mode # tn.write("stop") # response = tn.read_until("\n", 1) # Scan for displayed channels channel_list = [] for channel in ["chan1", "chan2", "chan3", "chan4", "math"]: response = command(tn, channel + ":display?") # Strip '\n' terminator response = response[:-1] if response == '1': channel_list += [channel] csv_buff = "" depth = get_memory_depth(tn) # for each active channel for channel in channel_list: print # Set WAVE parameters command(tn, "waveform:source " + channel) command(tn, "waveform:form asc") # Maximum = only displayed data when osc. in RUN mode, or full memory data when STOPed # Always ONLY displayed data (1200 points) if MATH channel is selected command(tn, "waveform:mode max") # Get all possible data buff = "" data_available = True # max_chunk is dependent of the wav:mode and the oscilloscope type # if you get on the oscilloscope screen the error message # "Memory lack in waveform reading!", then decrease max_chunk value max_chunk = 100000 # tested for DS1104Z if max_chunk > depth: max_chunk = depth n1 = 1 n2 = max_chunk while data_available: display_n1 = n1 stop_point = is_waveform_from_to(tn, n1, n2) if stop_point == 0: logging.error("ERROR: Stop data point index is Zero while available data is True.") sys.exit("ERROR") elif stop_point < n1: break elif stop_point < n2: n2 = stop_point is_waveform_from_to(tn, n1, n2) data_available = False else: data_available = True n1 = n2 + 1 n2 += max_chunk print "Data from channel '" + str(channel) + "', points " +\ str(display_n1) + "-" + str(stop_point) + ": Receiving..." buff_chunks = command(tn, "waveform:data?") # Just in case the transfer did not complete in the expected time while buff_chunks[-1] != "\n": logging.warning("The data transfer did not complete in the expected time of " + str(small_wait) + " second(s).") tmp = tn.read_until("\n", small_wait) if len(tmp) == 0: break buff_chunks += tmp logging.warning(str(len(tmp)) + " leftover bytes added to 'buff_chunks'.") # Append data chunks # Strip TMC Blockheader and terminator bytes buff += buff_chunks[TMC_header_len:-1] + "," buff = buff[:-1] # Append each value to csv_buff # Process data buff_list = buff.split(",") buff_rows = len(buff_list) # Put red 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 + "." + file_format, "wb") scr_file.write(csv_buff) scr_file.close() print "Saved file: '", filename + "." + file_format + "'" tn.close()