Merge branch 'master' into jude-changes

Author: neil-hamilton

.gitignore

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

README.md

@@ -30,6 +30,15 @@ following command in the top-level directory:
     pip install .
 
 If you are not using a virtualenv or are not elevated, use:
+=======
+For using the AS108 you will need to use the following as well:
+
+	python setupPicosynth.py install
+	
+
+On macOS and Linux you will either need to use `sudo` with this command, to
+install into the system folders, or to install for the current user only you
+can use:
 
     pip install . --user
 
@@ -63,7 +72,6 @@ The following drivers and devices are not yet supported:
 
 * `plcm3` - PicoLog CM3 Current Data Logger
 * `ps3000` - PicoScope 3204, 3205, 3206, 3223, 3224, 3423 & 3423
-* `usbpt104` - PT-104 Platinum Resistance Data Logger
 
 ### Dependencies
 
@@ -76,7 +84,8 @@ examples scripts also use the `matplotlib` plotting library. You can install the
 ### Driver-agnostic examples
 
 The `anyScopeExamples` folder contains examples in pure python which do the same thing as the C-style examples, but
-in a driver-generic way.
+in a driver-generic way.  These examples are currently not being developed further but are still avaliable to use 
+and develop futher yourself.
 
 ### Python Classes
 

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([