Merge branch 'picotech:master' into setuptools

Author: ksunden

.gitignore

@@ -14,4 +14,6 @@
 build/
 
 # venv directory
-venv/
+venv/
+
+.bak/

picosdk/PicoDeviceEnums.py

@@ -236,7 +236,7 @@ def _define_action():
 
 picoEnum.PICO_ACTION = _define_action()
 
-picoEnum.Pico_TRIGGER_STATE = make_enum([
+picoEnum.PICO_TRIGGER_STATE = make_enum([
     "PICO_CONDITION_DONT_CARE",
     "PICO_CONDITION_TRUE",
     "PICO_CONDITION_FALSE"

picosdk/PicoDeviceStructs.py

@@ -8,6 +8,7 @@
 """
 
 from ctypes import *
+from picosdk.library import Library
 
 class PicoStructlib(Library):
     def __init__(self):

picosdk/discover.py

@@ -10,6 +10,7 @@
 from picosdk.ps4000a import ps4000a
 from picosdk.ps5000a import ps5000a
 from picosdk.ps6000 import ps6000
+from picosdk.ps6000a import ps6000a
 
 
 # the A drivers are faster to enumerate devices, so search them first.
@@ -18,6 +19,7 @@
     ps3000a,
     ps4000a,
     ps5000a,
+    ps6000a,
     ps6000,
     ps2000,
     ps3000,
@@ -47,4 +49,4 @@ def find_all_units():
         devices.append(device)
     if not devices:
         raise DeviceNotFoundError("Could not find any devices on any drivers.")
-    return devices
+    return devices

picosdk/picosynth.py

@@ -0,0 +1,171 @@
+#
+# Copyright (C) 2022 Pico Technology Ltd. See LICENSE file for terms.
+#
+"""
+This is a Python module defining the functions from the picosynth.h C header file
+for the PicoSource AS108 Agile Synthesizer using the picosynth driver API functions.
+"""
+
+from ctypes import *
+from picosdk.library import Library
+from picosdk.errors import ArgumentOutOfRangeError
+from picosdk.constants import make_enum
+
+class Picosynthlib(library):
+    def __init__(self):
+        super(Picosynthlib, self).__init__("picosynth")
+        
+picosynth = Picosynthlib()
+
+picosynth.PICO_SOURCE_MODEL = make_enum([
+    "PICO_NONE_SPECIFIED",
+    "PICO_SYNTH",
+])
+
+doc = """ PICO_STATUS picosynthOpenUnit
+    (
+        PICO_SOURCE_MODEL  model,
+        uint32_t  *handle,
+        unit8_t  *serialNumber
+    );"""
+picosynth.make_symbol("_OpenUnit","picosynthOpenUnit",c_uint32,[c_uint32, c_void_p, c_void_p],doc)
+
+doc = """ PICO_STATUS picosynthEnumerateUnits
+    (
+        PICO_SOURCE_MODEL  model,
+        uint8_t  *serials,
+        unit16_t  *serialLth
+    );"""
+picosynth.make_symbol("_EnumerateUnits","picosynthEnumerateUnits",c_uint32,[c_uint32, c_void_p, c_void_p],doc)
+
+doc = """ PICO_STATUS picosynthGetUnitInfo
+    (
+        int8_t  *string,
+        unit16_t  stringLength,
+        uint16_t  *requiredSize,
+        PICO_INFO  deviceInfo
+    );"""
+picosynth.make_symbol("_GetUnitInfo","picosynthGetUnitInfo",c_uint32,[c_uint32, c_void_p, c_uint16, c_void_p, c_uint32],doc)
+
+doc = """ PICO_STATUS picosynthPingUnit
+    (
+        uint32_t  *handle,
+    );"""
+picosynth.make_symbol("_PingUnit","picosynthPingUnit",c_uint32,[c_uint32],doc)
+
+doc = """ PICO_STATUS picosynthCloseUnit
+    (
+        uint32_t  *handle,
+    );"""
+picosynth.make_symbol("_CloseUnit","picosynthCloseUnit",c_uint32,[c_uint32],doc)
+
+doc = """ PICO_STATUS picosynthSetOutputOff
+    (
+        uint32_t  *handle,
+    );"""
+picosynth.make_symbol("_SetOutputOff","picosynthSetOutputOff",c_uint32,[c_uint32],doc)
+
+doc = """ PICO_STATUS picosynthSetFrequency
+    (
+        uint32_t  *handle,
+        double  frequencyHz,
+        double  powerLeveldBm
+    );"""
+picosynth.make_symbol("_SetFrequency","picosynthSetFrequency",c_uint32,[c_uint32, c_double, c_double],doc)
+
+doc = """ PICO_STATUS picosynthSetPhase
+    (
+        uint32_t  handle,
+        double  phaseDeg
+    );"""
+picosynth.make_symbol("_SetPhase", "picosynthSetPhase", c_uint32,[c_uint32, c_double], doc)
+
+doc = """ PICO_STATUS picosynthSetAmplitudeModulation
+    (
+        uint32_t  handle,
+        double  frequencyHz,
+        double  powerLeveldBm,
+        double  modulationDepthPercent,
+        double  modulationRateHz,
+        MODULATION_SOURCE  modulationSource,
+        int16_t  enabled
+    );"""
+picosynth.make_symbol("_SetAmplitudeModulation","picosynthSetAmplitudeModulation", c_uint32,[c_uint32,c_double,c_double,c_double,c_double,c_uint32,c_int16],doc)
+
+doc = """ PICO_STATUS picosynthSetFrequencyModulation
+    (
+        uint32_t  handle,
+        double  frequencyHz,
+        double  powerLeveldBm,
+        double  modulationDeviationHz,
+        double  modulationRateHz,
+        MODULATION_SOURCE  modulationSource,
+        int16_t  enabled
+    );"""
+picosynth.make_symbol("_SetFrequencyModulation","picosynthSetFrequencyModulation",c_uint32,[c_uint32,c_double,c_double,c_double,c_double,c_uint32,c_int16],doc)
+
+doc = """ PICO_STATUS picosynthSetPhaseModulation
+    (
+        uint32_t  handle,
+        double  frequencyHz,
+        double  powerLeveldBm,
+        double  modulationDeviationHz,
+        double  modulationRateHz,
+        MODULATION_SOURCE  modulationSource,
+        int16_t  enabled
+    );"""
+picosynth.make_symbol("_SetPhaseModulation","picosynthSetPhaseModulation",c_uint32,[c_uint32,c_double,c_double,c_double,c_double,c_uint32,c_int16],doc)
+
+doc = """ PICO_STATUS picosynthSetFrequencyAndLevelSweep
+    (
+        uint32_t  handle,
+        double  startFrequencyHz,
+        double  stopFrequencyHz,
+        double  startLevel,
+        double  stopLevel,
+        LEVEL_UNIT  levelUnit,
+        double  dwellTimeUs,
+        int32_t  pointsInSweep,
+        SWEEP_HOP_MODE  mode,
+        TRIGGER_MODE  triggerMode
+    );"""
+picosynth.make_symbol("_SetFrequencyAndLevelSweep","picosynthSetFrequencyAndLevelSweep", c_uint32,[c_uint32,c_double,c_double,c_double,c_double,c_uint32,c_double,c_int32,c_uint32,c_uint32],doc)
+
+doc = """ PICO_STATUS picosynthSetPhaseAndLevelSweep
+    (
+        uint32_t  handle,
+        double  frequencyHz,
+        double  startPhaseDeg,
+        double  stopPhaseDeg,
+        double  startLevel,
+        double  stopLevel,
+        LEVEL_UNIT levelUnit,
+        double  dwellTimeUs,
+        int32_t  pointsInSweep,
+        SWEEP_HOP_MODE  mode,
+        TRIGGER_MODE  triggerMode
+    );"""
+picosynth.make_symbol("_SetPhaseAndLevelSweep","picosynthSetPhaseAndLevelSweep", c_uint32,[c_uint32,c_double,c_double,c_double,c_double,c_double,c_uint32,c_double,c_int32,c_uint32,c_uint32],doc)
+
+doc = """ PICO_STATUS picosynthSetArbitraryPhaseAndLevel
+    (
+        uint32_t  handle,
+        double  frequencyHz,
+        double  *arbitraryPhaseDeg,
+        double  *arbitraryPowerLeveldBm,
+        int32_t  numberOfPoints,
+        double  dwellTimeUs,
+        TRIGGER_MODE  triggerMode
+    );"""
+picosynth.make_symbol("_SetArbitraryPhaseAndLevel","picosynthSetArbitraryPhaseAndLevel",c_uint32,[c_uint32,c_double,c_double,c_double,c_int32,c_double,c_uint32],doc)
+
+doc = """ PICO_STATUS picosynthSetArbitraryFrequencyAndLevel
+    (
+        uint32_t  handle,
+        double  *arbitraryFrequencyHz,
+        double  *arbitraryPowerLeveldBm,
+        int32_t  numberOfPoints,
+        double  dwellTimeUs,
+        TRIGGER_MODE  triggerMode
+    );"""
+picosynth.make_symbol("_SetArbitraryFrequencyAndLevel","picosynthSetArbitraryFrequencyAndLevel",c_uint32,[c_uint32,c_double,c_double,c_int32,c_double,c_uint32],doc)

picosdk/ps2000a.py

@@ -846,3 +846,19 @@ class PS2000A_TRIGGER_CHANNEL_PROPERTIES(Structure):
 ps2000a.make_symbol("_GetMaxSegments", "ps2000aGetMaxSegments", c_uint32, [c_int16, c_void_p], doc)
 
 ps2000a.INI_LOGIC_VOLTS = 1.5
+
+doc = """ void *ps2000aBlockReady
+    (
+        int16_t    handle,
+        PICO_STATUS    status,
+        void    *pParameter
+    );
+    define a python function which accepts the correct arguments, and pass it to the constructor of this type.
+    """
+    
+ps2000a.BlockReadyType = C_CALLBACK_FUNCTION_FACTORY(None,
+                                                     c_int16,
+                                                     c_uint32,
+                                                     c_void_p)
+
+ps2000a.BlockReadyType.__doc__ = doc

picosdk/ps3000a.py

@@ -146,7 +146,7 @@ def _define_digital_port():
 
 ps3000a.PS3000A_THRESHOLD_DIRECTION = make_enum([
     ("PS3000A_ABOVE", "PS3000A_INSIDE"),
-    ("PS3000A_BELOW", "PS3000A_OUTSIDE"),
+    ("PS3000A_BELOW", "PS3000A_OUTSIDE","PS3000A_NONE"),
     ("PS3000A_RISING", "PS3000A_ENTER"),
     ("PS3000A_FALLING", "PS3000A_EXIT"),
     ("PS3000A_RISING_OR_FALLING", "PS3000A_ENTER_OR_EXIT"),
@@ -155,8 +155,7 @@ def _define_digital_port():
     "PS3000A_RISING_LOWER",
     "PS3000A_FALLING_LOWER"
     "PS3000A_POSITIVE_RUNT",
-    "PS3000A_NEGATIVE_RUNT",
-    "PS3000A_NONE"
+    "PS3000A_NEGATIVE_RUNT"
     ])
 
 ps3000a.PS3000A_THRESHOLD_MODE = make_enum([

picosdk/ps4000a.py

@@ -28,24 +28,23 @@ def __init__(self):
 ps4000a.PICO_COUPLING = {k[-2:]: v for k, v in ps4000a.PS4000A_COUPLING.items()}
 
 # A tuple in an enum like this is 2 names for the same value.
-ps4000a.PS4000A_CHANNEL = make_enum([
-    "PS4000A_CHANNEL_A",
-    "PS4000A_CHANNEL_B",
-    "PS4000A_CHANNEL_C",
-    "PS4000A_CHANNEL_D",
-    ("PS4000A_CHANNEL_E", "PS4000A_MAX_4_CHANNELS"),
-    "PS4000A_CHANNEL_F",
-    "PS4000A_CHANNEL_G",
-    "PS4000A_CHANNEL_H",
-    ("PS4000A_MAX_CHANNELS", "PS4000A_EXTERNAL"),
-    "PS4000A_TRIGGER_AUX",
-    "PS4000A_MAX_TRIGGER_SOURCES",
-])
+ps4000a.PS4000A_CHANNEL = {
+    "PS4000A_CHANNEL_A" : 0,
+    "PS4000A_CHANNEL_B" : 1,
+    "PS4000A_CHANNEL_C" : 2,
+    "PS4000A_CHANNEL_D" : 3,
+    ("PS4000A_CHANNEL_E", "PS4000A_MAX_4_CHANNELS") : 4,
+    "PS4000A_CHANNEL_F" : 5,
+    "PS4000A_CHANNEL_G" : 6 ,
+    "PS4000A_CHANNEL_H" : 7,
+    ("PS4000A_MAX_CHANNELS", "PS4000A_EXTERNAL") : 8,
+    "PS4000A_TRIGGER_AUX" : 9,
+    "PS4000A_MAX_TRIGGER_SOURCES" : 10,
+    "PS4000A_PULSE_WIDTH_SOURCE" : 0x10000000
+}
 
-ps4000a.PS4000A_CHANNEL["PS4000A_PULSE_WIDTH_SOURCE"] = 0x10000000
+ps4000a.PICO_CHANNEL = {k[19:]: v for k, v in ps4000a.PS4000A_CHANNEL.items()}
 
-# only include the normal analog channels for now:
-ps4000a.PICO_CHANNEL = {k[-1]: v for k, v in ps4000a.PS4000A_CHANNEL.items() if "PS4000A_CHANNEL_" in k}
 
 
 # The voltage ranges for this driver are so oddly defined, that it is easier to describe them as a literal than trying
@@ -257,6 +256,70 @@ def process_enum(enum):
 	'PS4000A_PRBS',
 ])
 
+ps4000a.PS4000A_CONDITIONS_INFO = make_enum([
+    'PS4000A_CLEAR',
+    'PS4000A_ADD',
+])
+
+ps4000a.PS4000A_THRESHOLD_DIRECTION = make_enum([
+    ("PS4000A_ABOVE", "PS4000A_INSIDE"),
+    ("PS4000A_BELOW", "PS4000A_OUTSIDE"),
+    ("PS4000A_RISING", "PS4000A_ENTER", "PS4000A_NONE"),
+    ("PS4000A_FALLING", "PS4000A_EXIT"),
+    ("PS4000A_RISING_OR_FALLING", "PS4000A_ENTER_OR_EXIT"),
+    "PS4000A_ABOVE_LOWER",
+    "PS4000A_BELOW_LOWER",
+    "PS4000A_RISING_LOWER",
+    "PS4000A_FALLING_LOWER",
+    "PS4000A_POSITIVE_RUNT",
+    "PS4000A_NEGATIVE_RUNT",
+])
+
+ps4000a.PS4000A_THRESHOLD_MODE = make_enum([
+    "PS4000A_LEVEL",
+    "PS4000A_WINDOW"
+])
+
+ps4000a.PS4000A_TRIGGER_STATE = make_enum([
+    "PS4000A_DONT_CARE",
+    "PS4000A_TRUE",
+    "PS4000A_FALSE"
+])
+
+ps4000a.PS4000A_PULSE_WIDTH_TYPE = make_enum([
+    "PW_TYPE NONE",
+    "PW_TYPE_LESS_THAN",
+    "PW_TYPE_GREATER_THAN",
+    "PW_TYPE_IN_RANGE",
+    "PW_TYPE_OUT_OF_RANGE"
+])
+
+class PS4000A_CONDITION (Structure):
+	_pack_ = 1
+	_fields_ = [("source", c_int32),
+				("condition", c_int16)]
+                
+ps4000a.PS4000A_CONDITION = PS4000A_CONDITION
+
+class PS4000A_DIRECTION(Structure):
+    _pack_ = 1
+    _fields_ = [("channel", c_int32),
+                ("direction", c_int32),
+                ("mode", c_int32)]
+                
+ps4000a.PS4000A_DIRECTION = PS4000A_DIRECTION
+
+class PS4000A_TRIGGER_CHANNEL_PROPERTIES(Structure):
+    _pack_ = 1
+    _fields_ = [("thresholdUpper", c_int16),
+                ("thresholdUpperHysteresis", c_uint16),
+                ("thresholdLower", c_int16),
+                ("thresholdLowerHysteresis", c_uint16),
+                ("channel", c_int32),
+                ("thresholdMode", c_int32)]
+                
+ps4000a.PS4000A_TRIGGER_CHANNEL_PROPERTIES = PS4000A_TRIGGER_CHANNEL_PROPERTIES
+
 doc = """ PICO_STATUS ps4000aOpenUnit
     (
         int16_t *handle,
@@ -994,4 +1057,4 @@ def process_enum(enum):
 	    int16_t    handle,
 		PS4000A_DEVICE_RESOLUTION    resolution
 	); """
-ps4000a.make_symbol("_SetResolution", "ps4000aSetDeviceResolution", c_uint32, [c_int16, c_int32], doc)
+ps4000a.make_symbol("_SetResolution", "ps4000aSetDeviceResolution", c_uint32, [c_int16, c_int32], doc)