Merge branch 'colinoflynn:master' into master

Author: csi-bbio

.github/workflows/pypi.yaml

@@ -0,0 +1,31 @@
+# https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/
+name: Publish Python 🐍 distributions 📦 to PyPI and TestPyPI
+
+on:
+  - push
+
+jobs:
+  build-n-publish:
+    name: Build and publish Python 🐍 distributions 📦 to PyPI and TestPyPI
+    if: startsWith(github.ref, 'refs/tags')
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@master
+      with:
+        # https://github.com/actions/checkout#fetch-all-history-for-all-tags-and-branches
+        fetch-depth: 0
+    - name: Set up Python
+      uses: actions/setup-python@v1
+      with:
+        python-version: "3.10"
+    - name: Install pypa/build
+      run: python -m pip install build --user
+    - name: Build a binary wheel and a source tarball
+      run: python -m build --sdist --wheel --outdir dist/ .
+    - name: Publish distribution 📦 to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        user: __token__
+        password: ${{ secrets.PYPI_API_TOKEN }}
+        print_hash: true
+        verify_metadata: true

.github/workflows/test.yml

@@ -0,0 +1,29 @@
+name: Testing
+
+on:
+  push:
+    branches:
+        - main
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.7', '3.11']
+
+    steps:
+    - uses: actions/checkout@v1
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install flake8 numpy
+    - name: Test with tox
+      run: |
+        flake8 picoscope setup.py
+        flake8 examples/*

.travis.yml

@@ -46,6 +46,19 @@ python setup.py develop
 You will require the PicoScope DLLs for this package to work. The easiest method is to install the latest PicoScope software
 or SDK from https://www.picotech.com/downloads .
 
+You may need to add the PicoScope install directory to the path, especially if changing between versions. Be sure you have installed a matching 32-bit or 64-bit version for your Python install.
+
+```
+import os
+picoinstallpath = os.path.normpath(r"C:\Program Files\Pico Technology\PicoScope 7 T&M Early Access")
+if picoinstallpath not in os.environ['PATH']:
+    print("Adding Pico Install to Path")
+    os.environ['PATH'] = picoinstallpath + os.pathsep + os.environ['PATH']
+else:
+    print("Pico Install Already on Path")
+```
+
+
 #### Linux
 Install the PicoScope Beta for Linux version of PicoScope as describe under Getting DLL's (above).  Currently this is the only way to install the shared libraries (SDK)
 

README.md

@@ -1,45 +1,153 @@
-from picoscope import ps4000a
+# -*- coding: utf-8 -*-
+"""
+Testing the ps4000a Series.
+"""
+
+# Imports
 import matplotlib.pyplot as plt
 import numpy as np
+from picoscope import ps4000a
 import time
 
-ps = ps4000a.PS4000a()
 
-# rapid block mode
+def test_general_unit_calls(picoscope):
+    """Test general unit calls."""
+    picoscope.flashLed()
+    print(picoscope.getAllUnitInfo())
+    assert not picoscope.ping(), "Ping failed."
+    print("General unit calls test passed.")
+
+
+def test_timebase(ps):
+    """Test the timebase methods."""
+    # Preparation
+    ps.memorySegments(1)
+    # Tests
+    if ps.model == "4444":
+        data = ((20e-9, 3),
+                (40e-9, 4))
+    else:
+        data = ((25e-9, 1),
+                (100e-9, 7))
+    for (t, timebase) in data:
+        text = f"time {t} does not fit timebase {timebase}."
+        assert ps.getTimeBaseNum(t) == timebase, "timebasenum: " + text
+        assert ps.getTimestepFromTimebase(timebase) == t, "Timestep " + text
+        timestep, _ = ps._lowLevelGetTimebase(timebase, 10, None, 0)
+        assert timestep == t, f"lowLevel: {timestep} != {t}"
+    print("Timebase test passed.")
+
+
+def test_deviceResolution(ps):
+    """Test setting/getting device resolution."""
+    if ps.model == "4444":
+        ps.setResolution("12")
+        assert ps.resolution == "12", "Resolution was not set."
+        # assert ps.getResolution() == "12"  not implemented yet
+        print("Device resolution test passed.")
+    else:
+        print("Model does not support resolution.")
+
+
+def test_rapid_block_mode(ps,
+                          n_captures=100,
+                          sample_interval=100e-9,  # 100 ns
+                          sample_duration=2e-3,  # 1 ms
+                          ):
+    """Test the rapid block mode."""
+    # Configuration of Picoscope
+    ps.setChannel(channel="A", coupling="DC", VRange=1)
+    ps.setChannel(channel="B", enabled=False)
+
+    ps.setSamplingInterval(sample_interval, sample_duration)
+    ps.setSimpleTrigger("A", threshold_V=0.1, timeout_ms=1)
+
+    samples_per_segment = ps.memorySegments(n_captures)
+    ps.setNoOfCaptures(n_captures)
+
+    data = np.zeros((n_captures, samples_per_segment), dtype=np.int16)
+
+    # Measurement
+    t1 = time.time()
+
+    ps.runBlock()
+    ps.waitReady()
+
+    t2 = time.time()
+    print("Time to record data to scope: ", str(t2 - t1))
+
+    ps.getDataRawBulk(data=data)
+
+    t3 = time.time()
+    print("Time to copy to RAM: ", str(t3 - t2))
 
-ps.setChannel(channel="A", coupling="DC", VRange=1)
-ps.setChannel(channel="B", enabled=False)
-ps.setChannel(channel="C", enabled=False)
-ps.setChannel(channel="D", enabled=False)
+    plt.imshow(data[:, 0:ps.noSamples], aspect='auto', interpolation='none',
+               cmap=plt.cm.hot)
+    plt.colorbar()
+    plt.show()
+    print("Rapid block mode test passed.")
 
-n_captures = 100
-sample_interval = 100e-9  # 100 ns
-sample_duration = 2e-3  # 1 ms
-ps.setResolution('12')  # Resolution can only be set on the PS4444
-ps.setSamplingInterval(sample_interval, sample_duration)
-ps.setSimpleTrigger("A", threshold_V=0.1, timeout_ms=1)
 
-samples_per_segment = ps.memorySegments(n_captures)
-ps.setNoOfCaptures(n_captures)
+def data_ready(handle, status, noOfSamples, overflow, pParameter=None):
+    """Show the asynchronously received data."""
+    if status == 0:
+        print(f"{noOfSamples} samples received with overflow: {overflow}")
+        plt.plot(data)
+        plt.show()
+        print("Data reading asynchronously test passed.")
+    else:
+        print(f"Data receiving error {status}.")
 
-data = np.zeros((n_captures, samples_per_segment), dtype=np.int16)
 
-t1 = time.time()
+def test_read_async(handle=None, status=0, pParameter=None):
+    """Test reading data asynchronously."""
+    if status == 0:
+        print("Block is ready and can be read.")
+        channel, numSamples = config
+        global data
+        data = np.empty(numSamples, dtype=np.int16)
+        if not isinstance(channel, int):
+            channel = ps.CHANNELS[channel]
+        ps._lowLevelSetDataBuffer(channel, data, 0, 0)
+        ps._lowLevelGetValuesAsync(numSamples, 0, 1, 0, 0, data_ready, None)
+        print("Get values async started.")
+    else:
+        print("Data is not ready. RunBlock had an error.")
 
-ps.runBlock()
-ps.waitReady()
 
-t2 = time.time()
-print("Time to record data to scope: ", str(t2 - t1))
+def test_runBlock_async(picoscope, channel="A", sample_interval=100e-9,
+                        sample_duration=2e-3):
+    """Test running a block asynchronously."""
+    # Configuration of Picoscope
+    global ps
+    ps = picoscope
+    ps.setChannel(channel=channel, coupling="DC", VRange=1)
+    ps.memorySegments(1)
+    ps.setNoOfCaptures(1)
+    i, samples, m = ps.setSamplingInterval(sample_interval, sample_duration)
+    ps.setSimpleTrigger("A", threshold_V=0.1, timeout_ms=1)
 
-ps.getDataRawBulk(data=data)
+    global config
+    config = channel, samples
+    # Run the block
+    ps.runBlock(callback=test_read_async)
+    print("Run Block started, waiting 2 s.")
+    time.sleep(2)
+    print("Run block finished")
 
-t3 = time.time()
-print("Time to copy to RAM: ", str(t3 - t2))
 
-plt.imshow(data[:, 0:ps.noSamples], aspect='auto', interpolation='none',
-           cmap=plt.cm.hot)
-plt.colorbar()
-plt.show()
+if __name__ == "__main__":
+    """Run all the tests."""
+    # Initialize the picoscope
+    ps = ps4000a.PS4000a()
 
-ps.close()
+    try:
+        # Run tests.
+        test_general_unit_calls(ps)
+        test_deviceResolution(ps)
+        test_rapid_block_mode(ps)
+        test_runBlock_async(ps)
+    finally:
+        # Close the connection
+        ps.close()
+    print("All tests passed.")

examples/test_ps4000a.py

@@ -887,11 +887,11 @@ def setAWGSimple(self, waveform, duration, offsetVoltage=None,
 
         deltaPhase = self.getAWGDeltaPhase(sampling_interval)
 
-        actual_druation = self.setAWGSimpleDeltaPhase(
+        actual_duration = self.setAWGSimpleDeltaPhase(
             waveform, deltaPhase, offsetVoltage, pkToPk, indexMode, shots,
             triggerType, triggerSource)
 
-        return (actual_druation, deltaPhase)
+        return (actual_duration, deltaPhase)
 
     def setAWGSimpleDeltaPhase(self, waveform, deltaPhase, offsetVoltage=None,
                                pkToPk=None, indexMode="Single", shots=1,
@@ -1183,4 +1183,6 @@ def changePowerSource(self, powerstate):
                 powerstate = 0x119
             elif powerstate == "PICO_POWER_SUPPLY_NOT_CONNECTED":
                 powerstate = 0x11A
+            elif powerstate == "PICO_USB3_0_DEVICE_NON_USB3_0_PORT":
+                powerstate = 0x11E
         self._lowLevelChangePowerSource(powerstate)