Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,18 @@ pslab-python can be installed from PyPI:

$ pip install pslab

**On Debian/Ubuntu:**

sudo apt-get install python3 python3-pip

**On macOS:**

brew install python3

**Other platforms:**

Visit https://www.python.org/downloads/

**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**: Windows users who use the PSLab v6 device must download and install the CP210x Windows Drivers from the [Silicon Labs website](https://www.silabs.com/developers/usb-to-uart-bridge-vcp-drivers?tab=downloads) in order for pslab-python to be able to communicate with the PSLab device.
Expand Down
52 changes: 52 additions & 0 deletions pslab/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
##Troubleshooting

Installation Issues
Error: "ModuleNotFoundError: No module named 'pslab'"

Solution: Make sure you ran pip3 install -e . (with -e flag for development)

Error: "Permission denied" on Linux

Solution: Run pip3 install --user -e . or use sudo

Error: "python3" command not found

Ubuntu/Debian:

sudo apt-get install python3 python3-pip

macOS:

brew install python3

Windows:

Download from https://www.python.org/downloads/

Run installer and check "Add Python to PATH"

Connection Issues
"Device not found"

Ensure PSLab hardware is connected via USB

Check USB port: ls /dev/ttyUSB* on Linux

Quick Start Examples
1. Connect to Your PSLab Device
text
from pslab import ScienceLab

# Connect to the device
I = ScienceLab()
print("✅ Connected to PSLab!")
2. Read a Voltage Measurement
text
# Measure voltage on Channel 1 (CH1)
voltage = I.get_average_voltage('CH1')
print(f"Voltage on CH1: {voltage} V")
3. Generate a Signal
text
# Generate 1kHz sine wave on output W1
I.set_sine1(1000)
print("Sine wave generated at 1 kHz")