PSLab Python Library

The Python library for the Pocket Science Lab from FOSSASIA.

This repository hosts the python library for communicating with the Pocket Science Lab open hardware platform (PSLab). This can be installed on a Linux or Windows system. Using this library you can communicate with the PSLab using simple Python code. The Python library is also used in the PSLab desktop application as a backend component. The goal of PSLab is to create an Open Source hardware device (open on all layers) and software applications that can be used for experiments by teachers, students and scientists. Our tiny pocket lab provides an array of instruments for doing science and engineering experiments. It provides functions of numerous measurement tools including an oscilloscope, a waveform generator, a frequency counter, a programmable voltage, current source and even a component to control robots with up to four servos. The website is at: https://pslab.io

Buy

You can get a Pocket Science Lab device from the FOSSASIA Shop.
More resellers are listed on the PSLab website.

Communication

The PSLab chat channel is on Gitter.
Please also join us on the PSLab Mailing List.

Installation

To install PSLab on Debian based GNU/Linux system, the following dependencies must be installed.

Dependencies

Python 3.6 or higher Link to Official download page
Pip Support package installer
NumPy For numerical calculations
PySerial For device connection
iPython-qtconsole Optional

Note: If you are only interested in using PSLab as an acquisition device without a display/GUI, only one repository pslab-python needs to be installed. If you like a GUI, install the pslab-desktop app and follow the instructions of the Readme in that repo.

How To Install on Linux

As root (or with sudo):

# pip install git+https://github.com/fossasia/pslab-python@master

Done!

How to Install on Windows

Step 1: Install the latest Python version on your computer and configure PATH variable to have both Python installation directory and the Scripts directory to access pip tools. In Windows, Python is installed in C: drive by default. We can set $PATH by opening the Environment variables dialog box by following the steps below:

[Right click on My Computer]
Select "Properties"
Open "System Properties"
Click "Advanced" tab
Click "Environment Variables" button
Look for "PATH" in "System Variables" section and click on it and press "Edit" button
To the end of "Variable value" text box, append "C:\Python34\;C:\Python34\Scripts\;" (without quotes and 34 may differ depending on the python version installed. It could be 35, 37 ...)
Click "OK" twice to save and move out from path windows

Step 2: Open up command prompt and execute the following commands to install the required dependencies.

$ pip install pyserial
$ pip install numpy

Validate

Download the PSLab-Python library from this repository and extract it to a directory.
Browse in to that directory and create a new file named test-pslab-libs.py
Paste the following code into that file and save it.

from PSL import sciencelab
I = sciencelab.connect()
capacitance = I.get_capacitance()
print(capacitance)

Plug in the PSLab device and check if both the LEDs are turned on.
Now run this file by typing python test-pslab-libs.py on a command prompt and observe a numerical value printed on the screen along with PSLab device version and the port it is connected to.

How to Setup the Development Environment

To set up the development environment, install the packages mentioned in dependencies. For building GUI's you can use Qt Designer or create a frontend using any other compatible technology. The PSLab desktop app is using Electron for example.

How to Build the Documentation Website

First install sphinx by running following command

pip install -U Sphinx

Then go to pslab/docs and run the following command

$ make html

License

The library is free and open source software licensed under the GPL v3. The copyright is owned by FOSSASIA.

iamvpa/pslab-python