Merge branch 'master' into setuptools

Author: neil-hamilton

README.md

@@ -18,27 +18,37 @@ to install the required driver packages for your product.
 
 ### macOS
 
-macOS users should install PicoScope Beta for macOS, and then may find this [forum post](https://www.picotech.com/support/topic22221.html) helpful for installing the C 
-libraries.
+Please visit [our Downloads page](https://www.picotech.com/downloads) to download the PicoSDK C Libraries for MacOS.
 
 ## Installing the python driver bindings
 
 A `distutils` installer is provided. After you have installed the PicoSDK
-driver package (see above), the Python installer can be used as follows:
+driver package (see above), the Python package can be installed using the
+following command in the top-level directory:
+
+    pip install .
+
+If you are not using a virtualenv or are not elevated, use:
 
     python setup.py install
+	
+=======
+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:
 
-    python setup.py install --user
+    pip install . --user
 
 Within python, the library for `import` is called `picosdk`.
 
 ## Compatibility
 
-This code is written to be compatible with both python 2.7 and python 3 (any version).
+This code is written to be compatible with both Python 2.7 and Python 3 (any version).
 
 If you find a compatibility problem please raise an [Issue](https://www.picotech.com/tech-support), listing all the versions you can find (python, numpy, 
 picosdk commit hash, etc.) and your error message(s).
@@ -64,11 +74,10 @@ 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
 
-As well as depending on the C libraries, the Pythonic wrappers use some python libraries like `numpy`. Many of the
+As well as depending on the C libraries, the Python wrappers use some Python libraries like `numpy`. Many of the
 examples scripts also use the `matplotlib` plotting library. You can install these dependencies with pip as follows:
 
     pip install -r requirements.txt
@@ -77,7 +86,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/picosynth.py

@@ -11,7 +11,7 @@
 from picosdk.errors import ArgumentOutOfRangeError
 from picosdk.constants import make_enum
 
-class Picosynthlib(library):
+class Picosynthlib(Library):
     def __init__(self):
         super(Picosynthlib, self).__init__("picosynth")
 

picosdk/ps6000.py

@@ -637,6 +637,18 @@ class PS6000_TRIGGER_INFO (Structure):
 ps6000.make_symbol("_RunStreaming", "ps6000RunStreaming", c_uint32,
                    [c_int16, c_void_p, c_int32, c_uint32, c_uint32, c_int16, c_uint32, c_int32, c_uint32], doc)
 
+doc = """ void ps6000BlockReady
+    (
+        int16_t          handle,
+        PICO_STATUS      status,
+        void             *pParameter
+    ); """
+ps6000.BlockReadyType = C_CALLBACK_FUNCTION_FACTORY(None,
+                                                    c_int16,
+                                                    c_uint32,
+                                                    c_void_p)
+ps6000.BlockReadyType.__doc__ = doc
+
 doc = """ void ps6000StreamingReady
 	(
 		int16_t				handle,

picosdk/ps6000a.py

@@ -11,6 +11,7 @@
 from picosdk.library import Library
 from picosdk.ctypes_wrapper import C_CALLBACK_FUNCTION_FACTORY
 from picosdk.constants import make_enum
+from picosdk.PicoDeviceEnums import picoEnum as enums
 
 
 class Ps6000alib(Library):
@@ -19,6 +20,8 @@ def __init__(self):
 
 ps6000a = Ps6000alib()
 
+ps6000a.DEFAULT_RESOLUTION = enums.PICO_DEVICE_RESOLUTION["PICO_DR_8BIT"]
+
 doc = """ void ps6000aBlockReady
     (
         int16_t    handle,

picosynthExamples/picosynthFrequencySweepExample.py

@@ -0,0 +1,56 @@
+#
+# Copyright (C) 2022 Pico Technology Ltd. See LICENSE file for terms.
+#
+# PicoSource AS108 Agile Synthesizer Example
+# This example demonstrates how to use the PicoSource AS108 picosynth driver API functions to set up the signal generator to output a frequency sweep.
+#
+
+import ctypes
+from picosdk.picosynth import picosynth as ps
+import time
+from picosdk.functions import assert_pico_ok
+
+# setup needed variables
+status = {}
+chandle = ctypes.c_uint32()
+
+# open AS108 device
+status["openunit"] = ps.picosynthOpenUnit(ps.PICO_SOURCE_MODEL["PICO_SYNTH"], ctypes.byref(chandle),0)
+assert_pico_ok(status["openunit"])
+
+# set up a frequency sweep
+# handle = chandle
+startFreqHz = 300000 #Hz
+stopFreqHz = 1000000 #Hz
+startLevel = 2
+stopLevel = 2
+levelUnit = 1 # VoltsPkToPk
+dwellTimeUs = 100
+pointsInSweep = 1000
+mode = 0 #SweepAndFlyback
+triggerMode = 0 # InternalTrigger
+
+status["setFrequencyAndLevelSweep"] = ps.picosynthSetFrequencyAndLevelSweep(chandle,startFreqHz,stopFreqHz,startLevel,stopLevel,levelUnit,dwellTimeUs,pointsInSweep,mode,triggerMode)
+assert_pico_ok(status["setFrequencyAndLevelSweep"])
+
+time.sleep(10)
+
+# close AS108 device
+status["closeunit"] = ps.picosynthCloseUnit(chandle)
+assert_pico_ok(status["closeunit"])
+
+time.sleep(20)
+
+# open AS108 device
+status["openunit"] = ps.picosynthOpenUnit(ps.PICO_SOURCE_MODEL["PICO_SYNTH"], ctypes.byref(chandle),0)
+assert_pico_ok(status["openunit"])
+
+# set output off
+status["setOutputOff"] = ps.picosynthSetOutputOff(chandle)
+
+# close AS108 device
+status["closeunit"] = ps.picosynthCloseUnit(chandle)
+assert_pico_ok(status["closeunit"])
+
+# Displays the status returns
+print(status)

ps3000aExamples/ps3000aBlockMSOExample.py

@@ -98,7 +98,7 @@
                                                     0)
 assert_pico_ok(status["SetDataBuffers"])
 
-print "Starting data collection..."
+print ("Starting data collection...")
 
 # Starts the block capture
 # handle = chandle
@@ -143,7 +143,7 @@
 status["GetValues"] = ps.ps3000aGetValues(chandle, 0, ctypes.byref(cTotalSamples), 1, 0, 0, ctypes.byref(overflow))
 assert_pico_ok(status["GetValues"])
 
-print "Data collection complete."
+print ("Data collection complete.")
 
 # Obtain binary for Digital Port 0
 # The tuple returned contains the channels in order (D7, D6, D5, ... D0).
@@ -154,7 +154,7 @@
 
 # Plot the data from digital channels onto a graph
 
-print "Plotting data..."
+print ("Plotting data...")
 
 plt.figure(num='PicoScope 3000 Series (A API) MSO Block Capture Example')
 plt.title('Plot of Digital Port 0 digital channels vs. time')
@@ -171,7 +171,7 @@
 plt.legend(loc="upper right")
 plt.show()
 
-print "Close figure to stop the device and close the connection."
+print ("Close figure to stop the device and close the connection.")
 
 # Stops the scope
 # handle = chandle

ps3000aExamples/ps3000aRapidBlockExample.py

@@ -8,6 +8,7 @@
 import ctypes
 from picosdk.ps3000a import ps3000a as ps
 import numpy as np
+import matplotlib
 import matplotlib.pyplot as plt
 from picosdk.functions import adc2mV, assert_pico_ok
 
@@ -292,7 +293,9 @@
 Times = (ctypes.c_int16*10)()
 TimeUnits = ctypes.c_char()
 status["GetValuesTriggerTimeOffsetBulk"] = ps.ps3000aGetValuesTriggerTimeOffsetBulk64(chandle, ctypes.byref(Times), ctypes.byref(TimeUnits), 0, 9)
-assert_pico_ok(status["GetValuesTriggerTimeOffsetBulk"])
+
+print(Times[0:9])
+print(TimeUnits)
 
 # Finds the max ADC count
 # Handle = chandle
@@ -312,21 +315,25 @@
 adc2mVChAMax7 =  adc2mV(bufferAMax7, chARange, maxADC)
 adc2mVChAMax8 =  adc2mV(bufferAMax8, chARange, maxADC)
 adc2mVChAMax9 =  adc2mV(bufferAMax9, chARange, maxADC)
+assert_pico_ok(status["GetValuesTriggerTimeOffsetBulk"])
 
 # Creates the time data
 time = np.linspace(0, (cmaxSamples.value - 1) * timeIntervalns.value, cmaxSamples.value)
 
 # Plots the data from channel A onto a graph
-plt.plot(time, adc2mVChAMax[:])
-plt.plot(time, adc2mVChAMax1[:])
-plt.plot(time, adc2mVChAMax2[:])
-plt.plot(time, adc2mVChAMax3[:])
-plt.plot(time, adc2mVChAMax4[:])
-plt.plot(time, adc2mVChAMax5[:])
-plt.plot(time, adc2mVChAMax6[:])
-plt.plot(time, adc2mVChAMax7[:])
-plt.plot(time, adc2mVChAMax8[:])
-plt.plot(time, adc2mVChAMax9[:])
+
+plt.plot(time, adc2mVChAMax)
+print('test')
+plt.plot(time, adc2mVChAMax1)
+plt.plot(time, adc2mVChAMax2)
+plt.plot(time, adc2mVChAMax3)
+plt.plot(time, adc2mVChAMax4)
+plt.plot(time, adc2mVChAMax5)
+plt.plot(time, adc2mVChAMax6)
+plt.plot(time, adc2mVChAMax7)
+plt.plot(time, adc2mVChAMax8)
+plt.plot(time, adc2mVChAMax9)
+
 plt.xlabel('Time (ns)')
 plt.ylabel('Voltage (mV)')
 plt.show()

ps5000aExamples/ps5000aRapidBlockExample.py

@@ -80,7 +80,7 @@
 # MaxSamples = ctypes.byref(returnedMaxSamples)
 # Segement index = 0
 timeIntervalns = ctypes.c_float()
-returnedMaxSamples = ctypes.c_int16()
+returnedMaxSamples = ctypes.c_int32()
 status["GetTimebase"] = ps.ps5000aGetTimebase2(chandle, timebase, maxsamples, ctypes.byref(timeIntervalns), ctypes.byref(returnedMaxSamples), 0)
 assert_pico_ok(status["GetTimebase"])
 
@@ -288,7 +288,7 @@
 # Timeunits = TimeUnits = ctypes.c_char() = ctypes.byref(TimeUnits)
 # Fromsegmentindex = 0
 # Tosegementindex = 9
-Times = (ctypes.c_int16*10)()
+Times = (ctypes.c_int64*10)()
 TimeUnits = ctypes.c_char()
 status["GetValuesTriggerTimeOffsetBulk"] = ps.ps5000aGetValuesTriggerTimeOffsetBulk64(chandle, ctypes.byref(Times), ctypes.byref(TimeUnits), 0, 9)
 assert_pico_ok(status["GetValuesTriggerTimeOffsetBulk"])

ps6000Examples/ps6000SigGen.py

@@ -71,7 +71,7 @@
 triggerSource = ctypes.c_int32(0)
 
 status["SetSigGenBuiltIn"] = ps.ps6000SetSigGenBuiltIn(chandle, 0, 2000000, wavetype, 10000, 10000, 0, 1, sweepType, 0, 0, 0, triggertype, triggerSource, 1)
-assert_pico_ok(status["SetSignGenBuiltIn"])
+assert_pico_ok(status["SetSigGenBuiltIn"])
 
 # Pauses the script to show signal
 time.sleep(10)

ps6000aExamples/ps6000aBlockAdvancedTriggerExample.py

@@ -111,7 +111,7 @@
 action = clear|add # PICO_ACTION["PICO_CLEAR_WAVEFORM_CLEAR_ALL"] | PICO_ACTION["PICO_ADD"]  
 status["setDataBuffers"] = ps.ps6000aSetDataBuffers(chandle, channelA, ctypes.byref(bufferAMax), ctypes.byref(bufferAMin), nSamples, dataType, waveform, downSampleMode, action)
 assert_pico_ok(status["setDataBuffers"])
-status["setDataBuffers"] = ps.ps6000aSetDataBuffers(chandle, channelB, ctypes.byref(bufferBMax), ctypes.byref(bufferBMin), nSamples, dataType, waveform, downSampleMode, action)
+status["setDataBuffers"] = ps.ps6000aSetDataBuffers(chandle, channelB, ctypes.byref(bufferBMax), ctypes.byref(bufferBMin), nSamples, dataType, waveform, downSampleMode, add)
 assert_pico_ok(status["setDataBuffers"])
 
 # Run block capture