Added Tek5k7k70k_CheckClippingStatus example

Examples/Oscilloscopes/PerformanceScopes/README.md

@@ -14,7 +14,7 @@ MSO/DPO5000/B, DPO7000/C, DSA70000/B/C/D, MSO70000/C/DX and DPO70000SX Series Os
 | **[Fetch Waveform Data Example](./src/FetchWaveformDataExample)** | [![Python 3.7](https://img.shields.io/badge/python-3.7-&?labelColor=3E434A&colorB=006281&logo=python)](https://www.python.org/downloads/release/python-370/) |
 | **[Curve Query (Fetch Waveform) Windows Forms Example](../TekSeriesScopes_HighSpeedDigitizers/src/CSharpCurveQueryWinforms)** | [![C Sharp](https://img.shields.io/badge/-C%20Sharp-&?labelColor=3E434A&colorB=73BF44&logo=Microsoft)](https://github.com/dotnet/roslyn) |
 | **[DPO70000SX Ultrasync Time-Sync Mode Control Example](./src/DPO70000SX_UltrasyncTimeSyncModeControlExample)** | [![Python 3.11](https://img.shields.io/badge/python-3.11-&?labelColor=3E434A&colorB=006281&logo=python)](https://www.python.org/downloads/release/python-3118/) |
-
+| **[Check Clipping Status - 5k 7k 70k Series](./src/Tek5k7k70k_CheckClippingStatus)** | [![Python 3.11](https://img.shields.io/badge/python-3.11-&?labelColor=3E434A&colorB=006281&logo=python)](https://www.python.org/downloads/release/python-3118/) |
 
 
 #### MSO5000B Examples 

Examples/Oscilloscopes/PerformanceScopes/src/Tek5k7k70k_CheckClippingStatus/README.md

@@ -0,0 +1,35 @@
+# Check Clipping Status - 5k 7k 70k Series
+This script provides a function for checking the clipping status of a channel on a MSO/DPO5000 B, DPO7000 C, MSO/DPO70000 B C D DX, or DPO70000SX Series oscilloscope.
+
+Original Author: Dave W. - Tektronix Applications
+
+## Development Environment:
+Python 3.11, PyVisa 1.14, NI-VISA 2023 Q4, Windows 10
+
+## Compatible Instruments:
+* MSO/DPO5000/B Series Oscilloscopes
+* DPO7000/C Series Oscilloscopes
+* MSO/DPO70000/B/C/D/DX Series Oscilloscopes
+* DPO70000SX Series Oscilloscopes
+
+## Compatible Interfaces:
+* USB
+* Ethernet
+
+## Changelog:
+### 2024-05-28:
+Original Revision
+
+
+<!-- markdown-link-check-disable -->
+Resources
+---------
+* MSO/DPO5000/B, DPO7000/C, MSO/DPO70000/B/C/DX, DPO70000SX Series Programmer's Manual:
+  * https://www.tek.com/en/oscilloscope/dpo70000-mso70000-manual/dpo70000sx-mso-dpo70000dx-mso-dpo70000c-dpo7000c-mso5000-b-1
+* Python: https://www.python.org/
+* PyVISA: https://pyvisa.readthedocs.io
+* NI-VISA: https://www.ni.com/en/support/downloads/drivers/download.ni-visa.html
+
+Disclaimer
+----------
+Tektronix provides the following example "AS IS" with no support or warranty.

Examples/Oscilloscopes/PerformanceScopes/src/Tek5k7k70k_CheckClippingStatus/Tek5k7k70k_CheckClippingStatus.py

@@ -0,0 +1,80 @@
+# Title:
+#   Check Clipping Status - 5k 7k 70k Series
+#
+# Description:
+#   This script provides a function for checking the clipping status of a channel on
+#   a MSO/DPO5000/B, DPO7000/C, MSO/DPO70000/B/C/D/DX, or DPO70000SX Series oscilloscope.
+#
+# Author: David Wyban
+# Created:  2024-05-28
+#
+# Development Environment:
+#    Python 3.11, PyVisa 1.14, NI-VISA 2023 Q4, Windows 10
+# 
+# Compatible Instruments:
+#     MSO/DPO5000/B Series Oscilloscopes
+#     DPO7000/C Series Oscilloscopes
+#     MSO/DPO5000/B/C/D/DX Series Oscilloscopes
+#     DPO70000SX Series Oscilloscopes
+#
+# Compatible Interfaces:
+#     USB
+#     Ethernet
+#
+# Tektronix provides the following example "AS IS" with no support or warranty.
+#
+#-------------------------------------------------------------------------------
+
+from enum import Enum
+import pyvisa as visa # https://pyvisa.readthedocs.io/en/latest/
+
+class ClippingStatus(Enum):
+	NotClipping = 0
+	Both = 1
+	Positive = 2
+	Negative = 3
+
+
+def Tek5k7k70k_CheckClipping(vi : visa.resources.MessageBasedResource, channel : str = 'CH1') -> tuple[bool, ClippingStatus]:
+    '''Returns True if the signal is clipping and False if it is not.'''
+
+    # Setup status model so that measurement warnings will output to event status queue
+    vi.write('DESE 16') # Enables execution errors to be reported in the event status register and queue
+    vi.write('*ESE 16') # Enables execution errors to be reported in the status byte register
+
+    vi.write('*CLS')
+    vi.write(f':MEASU:IMM:TYPE PK2PK;SOUR1 {channel};')
+    measVal = vi.query('MEASU:IMM:VAL?')
+    esr = int(vi.query('*ESR?'))
+
+    if esr != 0:
+        eventMessages = vi.query('ALLEV?').strip()
+        print(eventMessages)
+        eventParts = eventMessages.split(',')
+
+        errCode = int(eventParts[0])
+        if errCode == 547:
+            return True, ClippingStatus.Both
+        if errCode == 548:
+            return True, ClippingStatus.Positive
+        if errCode == 549:
+            return True, ClippingStatus.Negative
+
+    return False, ClippingStatus.NotClipping
+
+
+def CheckClippingExample():
+    rm = visa.ResourceManager()
+    scope : visa.resources.MessageBasedResource = rm.open_resource('TCPIP::192.168.1.103::inst0::INSTR')
+    print(scope.query('*IDN?'))
+
+    print('Checking Clipping Status...')
+    isClipping = Tek5k7k70k_CheckClipping(scope, 'CH1')
+    print(f'Clipping?: {isClipping}')
+
+    scope.close()
+    rm.close()
+
+# Only run the example if this script is the main script being run
+if __name__ == '__main__':
+	CheckClippingExample()