Skip to content

Rohanberiwal/pslab-python

 
 

Repository files navigation

PSLab Python Library

The Python library for the Pocket Science Lab from FOSSASIA.

Build Status Gitter Codacy Badge Mailing List Twitter Follow

This repository hosts the Python library for seamless communication with the Pocket Science Lab open hardware platform (PSLab). Through this library, users can interact with PSLab using straightforward Python code. Additionally, the Python library serves as a vital backend component for the PSLab GUI.

PSLab aims to create an Open Source hardware device, open on all layers, alongside software applications tailored for experiments by educators, students, and scientists. The pocket lab provides various measurement tools, including an oscilloscope, waveform generator, logic analyzer, programmable voltage and current source, and a component for controlling robots with up to four servos. For more information see https://pslab.io.

Features

Features Highlight the key features and capabilities of the PSLab Python Library, such as: Communication with PSLab for various experiments. Integration with the PSLab GUI. Support for measurement tools including an oscilloscope, waveform generator, logic analyzer, programmable voltage, current source, and servo control. Open-source nature and collaboration with the PSLab project.

Buy

Installation

pslab-python can be installed from PyPI:

$ pip install pslab

Note: Linux users must either install a udev rule by running 'pslab install' as root, or be part of the 'dialout' group in order for pslab-python to be able to communicate with the PSLab device.

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

Validate installation

  1. Plug in the PSLab device and check that both the LEDs light up.
  2. The following piece of code should run without errors:
from pslab import ScienceLab
psl = ScienceLab()
capacitance = psl.multimeter.measure_capacitance()
print(capacitance)

Communication

Wherever we interact, we strive to follow the FOSSASIA Code of Conduct.

Contributing

See CONTRIBUTING.md to get started.

License

Copyright (C) 2014-2021 FOSSASIA

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 3.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Social Media and Community Engagement

Twitter Follow Mailing List Gitter Chat

Communication and Support

Encourage users to report any bugs they encounter through the issue tracker. Highlight the available support channels, such as the Gitter chat and the mailing list.

About

Python Library for PSLab Desktop: https://pslab.io

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 100.0%