Skip to content

Latest commit

 

History

History
146 lines (86 loc) · 5.62 KB

README.md

File metadata and controls

146 lines (86 loc) · 5.62 KB
Raw

picosdk-python-wrappers

Welcome to the PicoSDK for Python. It allows you to control PicoScope devices in your own Python programs.

Getting started

To use this code you will need to install the PicoSDK C libraries.

Microsoft Windows

Please visit our Downloads page to download the 32-bit or 64-bit PicoSDK C Libraries for Windows. Please take care to match the "bitness" of your python to the PicoSDK.

Linux

Follow the instructions from our Linux Software & Drivers for Oscilloscopes and Data Loggers page to install the required driver packages for your product.

macOS

Please visit our Downloads page 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 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:

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).

If you find a compatibility problem please raise an Issue, listing all the versions you can find (python, numpy, picosdk commit hash, etc.) and your error message(s).

C interface

You can access C driver functions directly (ctypes calls) by their original C name, following the Programmer's Guides exactly. Examples are provided in the folders like psX000[a]Examples/.

Programmer's Guides

You can download Programmer's Guides providing a description of the API functions for the relevant PicoScope or PicoLog driver from our Documentation page.

Python interface

We are in the process of adding Pythonic wrappers around the C functions. If we haven't got to your feature yet or your device is listed as one of the unsupported models, let us know that you're waiting in an Issue

Unsupported models

The following drivers and devices are not yet supported:

  • plcm3 - PicoLog CM3 Current Data Logger
  • ps3000 - PicoScope 3204, 3205, 3206, 3223, 3224, 3423 & 3423

Dependencies

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
pip install -r requirements-for-examples.txt

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. These examples are currently not being developed further but are still avaliable to use and develop futher yourself.

Python Classes

Library

picosdk.library.Library contains a base class for each of the driver classes. It does the job of translating python types into C ones, and back again, and some unit conversions to get rid of nano, micro and milli-style prefixes. It also handles any differences in programming API between PicoScope driver versions.

Device

picosdk.device.Device contains the concrete class which represents a PicoScope with a valid handle. It caches some information about the device state, like the currently selected voltage ranges of the channels.

It is implemented in terms of the Library class' public interface, and deals almost entirely with python types. The main exception is its handling of numpy arrays - it (knowing the voltage ranges) is responsible for converting the raw ADC counts that the driver uses for amplitude into physical units.

Testing this code

Check which device driver your device uses, and check the constants at the top of test/test_helpers.py to enable the relevant drivers for connected-device tests. (most tests use this).

To check which driver your device uses, you can use picosdk.discover:

from picosdk.discover import find_all_units

scopes = find_all_units()

for scope in scopes:
    print(scope.info)
    scope.close()

You should then configure test/test_helpers.py's list of connected devices, so it can run all the tests we have on your device.

To run the unit tests, you will need to install nose (e.g. pip install nose.) Then, run nosetests in the root of the repo.

Obtaining support

Please visit our Support page to contact us directly or visit our Test and Measurement Forum to post questions.

Copyright and licensing

See LICENSE.md for license terms.

PicoScope, PicoLog and PicoSDK are registered trademarks of Pico Technology Ltd.

Windows is a registered trademark of Microsoft Corporation.

macOS is a registered trademark of Apple Inc.

Linux is the registered trademark of Linus Torvalds in the U.S. and other countries.

Copyright © 2018-2019 Pico Technology Ltd. All rights reserved.