Intermediary commit before push

.gitignore

@@ -0,0 +1,98 @@
+# *** START section for manually edited lines
+
+# ignore debugging log generated by this project
+*.py.log
+
+# *** STOP section for manually edited lines
+
+
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+.hypothesis/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# IPython Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# dotenv
+.env
+
+# virtualenv
+venv/
+ENV/
+
+# Spyder project settings
+.spyderproject
+
+# Rope project settings
+.ropeproject

OscScreenGrabLAN.py

@@ -1,6 +1,30 @@
 #!/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
@@ -15,14 +39,12 @@ __author__ = 'RoGeorge'
 # TODO: Add browse and custom filename selection
 # TODO: Create executable distributions
 #
-from telnetlib_receive_all import Telnet
-from Rigol_functions import *
-import time
-from PIL import Image
-import StringIO
-import sys
-import os
-import platform
+
+# 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("Log message: INFO level set.")
 
 # Update the next lines for your own default settings:
 path_to_save = "captures/"
@@ -106,8 +128,7 @@ if response != 0:
 # The default telnetlib drops 0x00 characters,
 #   so a modified library 'telnetlib_receive_all' is used instead
 tn = Telnet(IP_DS1104Z, port)
-tn.write("*idn?")  # ask for instrument ID
-instrument_id = tn.read_until("\n", 1)
+instrument_id = command(tn, "*idn?")    # ask for instrument ID
 
 # Check if instrument is set to accept LAN commands
 if instrument_id == "command error":
@@ -137,16 +158,23 @@ filename = path_to_save + id_fields[model] + "_" + id_fields[serial] + "_" + tim
 
 if file_format in ["png", "bmp"]:
     # Ask for an oscilloscope display print screen
-    tn.write("display:data?")
     print "Receiving screen capture..."
-    buff = tn.read_until("\n", big_wait)
+    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]
@@ -164,8 +192,7 @@ elif file_format == "csv":
     # Scan for displayed channels
     channel_list = []
     for channel in ["chan1", "chan2", "chan3", "chan4", "math"]:
-        tn.write(channel + ":display?")
-        response = tn.read_until("\n", 1)
+        response = command(tn, channel + ":display?")
 
         # Strip '\n' terminator
         response = response[:-1]
@@ -182,15 +209,12 @@ elif file_format == "csv":
         print
 
         # Set WAVE parameters
-        tn.write("waveform:source " + channel)
-        time.sleep(1)
+        command(tn, "waveform:source " + channel)
+        command(tn, "waveform:form asc")
 
-        tn.write("waveform:form asc")
-        time.sleep(1)
-
-        # Maximum - only displayed data when osc. in RUN mode, or full memory data when STOPed
-        tn.write("waveform:mode max")
-        time.sleep(1)
+        # 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 = ""
@@ -199,22 +223,27 @@ elif file_format == "csv":
         # 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.0  # tested for DS1104Z
+        max_chunk = 100000      # tested for DS1104Z
+        print "max_chunk=", max_chunk
+        print "depth=", depth
+        print "max_chunk > depth:", max_chunk > depth
         if max_chunk > depth:
             max_chunk = depth
 
-        n1 = 1.0
+        print "max_chunk=", max_chunk
+        n1 = 1
         n2 = max_chunk
-        data_available = True
-
+        print "n2=", n2
         while data_available:
             display_n1 = n1
+            print
+            print "n1=", n1
+            print "n2=", n2
             stop_point = is_waveform_from_to(tn, n1, n2)
+            print "stop_point=", stop_point
             if stop_point == 0:
-                data_available = False
-                print "ERROR: Stop data point index lower then start data point index"
-                print
                 print_running_Python_versions()
+                logging.error("ERROR: Stop data point index is Zero while available data is True.")
                 sys.exit("ERROR")
             elif stop_point < n1:
                 break
@@ -227,18 +256,20 @@ elif file_format == "csv":
                 n1 = n2 + 1
                 n2 += max_chunk
 
-            tn.write("waveform:data?")
-
-            print "Data from channel " + str(channel) + ", points " +\
-                  str(int(display_n1)) + "-" + str(int(stop_point)) + ": Receiving..."
-            buff_chunks = tn.read_until("\n", big_wait)
+            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
@@ -280,6 +311,6 @@ elif file_format == "csv":
     scr_file.write(csv_buff)
     scr_file.close()
 
-    print "Saved file:", filename + "." + file_format
+    print "Saved file: '", filename + "." + file_format + "'"
 
 tn.close()

Rigol_functions.py

@@ -3,6 +3,7 @@ __author__ = 'RoGeorge'
 import time
 import pip
 import sys
+import logging
 
 
 def print_running_Python_versions():
@@ -18,29 +19,43 @@ def print_running_Python_versions():
     print
 
 
+def command(tn, SCPI):
+    logging.info("SCPI to be sent: " + SCPI)
+    answer_wait_s = 1
+    response = ""
+    while response != "1\n":
+        tn.write("*OPC?")  # previous operation(s) has completed ?
+        logging.info("Send SCPI: *OPC?")
+        response = tn.read_until("\n", 1)  # wait max 1s for an answer
+        logging.info("Received response: " + response)
+
+    tn.write(SCPI)
+    logging.info("Sent SCPI: " + SCPI)
+    response = tn.read_until("\n", answer_wait_s)
+    logging.info("Received response: " + response)
+    return response
+
+
 def get_memory_depth(tn):
     # Define number of horizontal grid divisions for DS1054Z
     h_grid = 12
 
     # ACQuire:MDEPth
-    tn.write("ACQ:MDEP?")
-    mdep = tn.read_until("\n", 1)
+    mdep = command(tn, "ACQ:MDEP?")
 
     # if mdep is "AUTO"
     if mdep == "AUTO\n":
         # ACQuire:SRATe
-        tn.write("ACQ:SRAT?")
-        srate = tn.read_until("\n", 1)
+        srate = command(tn, "ACQ:SRAT?")
 
         # TIMebase[:MAIN]:SCALe
-        tn.write("TIM:SCAL?")
-        scal = tn.read_until("\n", 1)
+        scal = command(tn, "TIM:SCAL?")
 
         # mdep = h_grid * scal * srate
-        mdep = h_grid * float(scal) * float(srate)
+        mdep = h_grid * scal * srate
 
     # return mdep
-    return float(mdep)
+    return int(mdep)
 
 
 # return maximum achieved stop point, or 0 for wrong input parameters
@@ -48,12 +63,10 @@ def get_memory_depth(tn):
 def is_waveform_from_to(tn, n1_d, n2_d):
     # read current
     # WAVeform:STARt
-    tn.write("WAV:STAR?")
-    n1_c = float(tn.read_until("\n", 1))
+    n1_c = int(command(tn, "WAV:STAR?"))
 
     # WAVeform:STOP
-    tn.write("WAV:STOP?")
-    n2_c = float(tn.read_until("\n", 1))
+    n2_c = int(command(tn, "WAV:STOP?"))
 
     if (n1_d > n2_d) or (n1_d < 1) or (n2_d < 1):
         # wrong parameters
@@ -61,21 +74,19 @@ def is_waveform_from_to(tn, n1_d, n2_d):
 
     elif n2_d < n1_c:
         # first set n1_d then set n2_d
-        tn.write("WAV:STAR " + str(n1_d))
-        time.sleep(1)
-        tn.write("WAV:STOP " + str(n2_d))
-        time.sleep(1)
+
+        print "a ", "n1_d=", n1_d, "n2_d=", n2_d
+        command(tn, "WAV:STAR " + str(n1_d))
+        command(tn, "WAV:STOP " + str(n2_d))
 
     else:
         # first set n2_d then set n1_d
-        tn.write("WAV:STOP " + str(n2_d))
-        time.sleep(1)
-        tn.write("WAV:STAR " + str(n1_d))
-        time.sleep(1)
+        print "b ", "n2_d", n2_d, "n1_d=", n1_d
+        command(tn, "WAV:STOP " + str(n2_d))
+        command(tn, "WAV:STAR " + str(n1_d))
 
     # read achieved n2
-    tn.write("WAV:STOP?")
-    n2_a = float(tn.read_until("\n", 1))
+    n2_a = int(command(tn, "WAV:STOP?"))
 
     if n2_a < n2_d:
         # restore n1_c, n2_c

captures/.gitignore

@@ -0,0 +1,12 @@
+# *** START section for manually edited lines
+
+# 'captures' is a mandatory directory for this project,
+#     but git can add only files, and can not add an empty directory.
+# We want to preserve 'captures' in the repository tree structure,
+#     so we will ignore everything except the 'captures/.gitignore' file.
+#     This trick will always add the 'captures' directory in the repository,
+#     even when there are no other files in 'captures'.
+*
+!.gitignore
+
+# *** STOP section for manually edited lines