Language - Python
We provide support for Python in all major operating systems. We also provide instructions on how to get your project started in a number of common development environments. Select your operating system and preferred development environment below, and follow the instructions to get your project running with Phidgets.
If you do not know which development environment you want to use, or your development environment of choice is not listed, we recommend starting with command line or terminal as the simplest path to getting your code running.
Once you have set up your development environment to run with Phidgets, we recommend you follow our guide on Phidget Programming Basics. The guide will showcase the fundamentals of programming with Phidgets, with examples in Python.
Setup Guide
Python - Select Development Environment
Select your Development Environment:
Windows
MacOS
Linux
PhidgetSBC
Language - Python
Windows with Pycharm
Welcome to using Phidgets with Python! By using Python, you will have access to the complete Phidget22 API, including events.
PyCharm is an integrated development environment for Python by JetBrains.
Installing the Phidget Python Module
First, install Python3 if you haven't already.
Next, select your preferred installation method below:
PIP Install
PIP Global Install
Language - Python
Installing the Phidget Python Module
You can install the Phidget22 libraries for your current PyCharm project with PIP by opening File > Settings
Installing the Phidget Python Module
Next, navigate to Project > Project Interpreter and click on the + symbol located on the right:
Installing the Phidget Python Module
Type Phidget22 into the search bar, select the package named Phidget22 and click Install Package:
Finding Code Samples
To find the code sample to use for your Phidget, navigate to the Code Samples page and select your device from the drop-down menu.
Once you select your device, the code sample generator will give you a working code sample, and a selection of options to customize it to your needs.
Using the Code Samples
Click the Download Example button to download the sample code:
Using the Code Samples
Add the example you just downloaded by dragging it into the project:
Using the Code Samples
Finally, run the project:
The project is now running with Phidgets!
What's Next?
Now that you've set up Phidgets in your programming environment, you should read our guide on Phidget Programming Basics to learn the fundamentals of programming with Phidgets.
Language - Python
Installing the Phidget Python Module
Python 3.4+ includes PIP by default. To install the Phidget22 Python module with PIP, simply open the Command Prompt (press the Windows key and search for cmd), and enter the command:
python -m pip install Phidget22
Installing the Phidget Python Module
To use the global Phidget22 library in your PyCharm project, select Inherit global site-packages when creating a new project.
Finding Code Samples
To find the code sample to use for your Phidget, navigate to the Code Samples page and select your device from the drop-down menu.
Once you select your device, the code sample generator will give you a working code sample, and a selection of options to customize it to your needs.
Using the Code Samples
Click the Download Example button to download the sample code:
Using the Code Samples
Add the example you just downloaded by dragging it into the project:
Using the Code Samples
Finally, run the project:
The project is now running with Phidgets!
What's Next?
Now that you've set up Phidgets in your programming environment, you should read our guide on Phidget Programming Basics to learn the fundamentals of programming with Phidgets.
Language - Python
Installing the Phidget Python Module
To install the Phidget22 Python module without PIP, you need to download it here:
Unpack the Phidget22 Python module and open the Command Prompt (press the Windows key and search for cmd). Find the folder where you downloaded the Python module and enter this command:
python setup.py install
This will build the module and install the Python module files into your site-packages directory.
Finding Code Samples
To find the code sample to use for your Phidget, navigate to the Code Samples page and select your device from the drop-down menu.
Once you select your device, the code sample generator will give you a working code sample, and a selection of options to customize it to your needs.
Using the Code Samples
Click the Download Example button to download the sample code:
Using the Code Samples
Add the example you just downloaded by dragging it into the project:
Using the Code Samples
Finally, run the project:
The project is now running with Phidgets!
What's Next?
Now that you've set up Phidgets in your programming environment, you should read our guide on Phidget Programming Basics to learn the fundamentals of programming with Phidgets.
Language - Python
Windows with Command Line
Welcome to using Phidgets with Python! By using Python, you will have access to the complete Phidget22 API, including events.
The command line is the default environment to make Python programs in Windows, since it's available immediately after installing Python.
Installing the Phidget Python Module
First, install Python3 if you haven't already.
Python 3.4+ includes PIP by default. To install the Phidget22 Python module with PIP, simply open the Command Prompt (press the Windows key and search for cmd), and enter the command:
python -m pip install Phidget22
Finding Code Samples
To find the code sample to use for your Phidget, navigate to the Code Samples page and select your device from the drop-down menu.
Once you select your device, the code sample generator will give you a working code sample, and a selection of options to customize it to your needs.
Using the Code Samples
Click the Download Example button to download the sample code:
Using the Code Samples
To run the example, open the command prompt at the location of the example and enter the following command:
python example.py
The script is now running with Phidgets!
What's Next?
Now that you've set up Phidgets in your programming environment, you should read our guide on Phidget Programming Basics to learn the fundamentals of programming with Phidgets.
Language - Python
MacOS with Terminal
Welcome to using Phidgets with Python! By using Python, you will have access to the complete Phidget22 API, including events.
The terminal is the default environment to make Python programs in macOS, since it's available immediately after installing Python.
Requirements
First, install Python3 if you haven't already.
If you plan on using any USB Phidgets that use the HID stack, you'll need to install the Phidget drivers for MacOS. You can check which stack your USB Phidgets use by checking the 'USB Stack' in the product specifications. If all of your Phidgets use the PHIDUSB stack, you can skip installing the drivers.
Installing the Phidget Python Module
To install the Phidgets Python Module, you'll need PIP, which is included in Python 3.4+ by default. To install the Phidget22 Python module with PIP, simply open the Terminal and enter the command:
python pip install Phidget22
Finding Code Samples
To find the code sample to use for your Phidget, navigate to the Code Samples page and select your device from the drop-down menu.
Once you select your device, the code sample generator will give you a working code sample, and a selection of options to customize it to your needs.
Using the Code Samples
Click the Download Example button to download a Java file with the sample code:
Using the Code Samples
To run the example, open the command prompt at the location of the example and enter the following command:
python example.py
Success! Your program is now running with Phidgets!
What's Next?
Now that you've set up Phidgets in your programming environment, you should read our guide on Phidget Programming Basics to learn the fundamentals of programming with Phidgets.
Language - Python
Linux with Terminal
Welcome to using Phidgets with Python! By using Python, you will have access to the complete Phidget22 API, including events.
The terminal is the default environment to make Python programs in Linux, since it's available immediately after installing Python.
Installing the Phidget Python Module
First, install Python3 if you haven't already.
Python 3.4+ includes PIP by default. To install the Phidget22 Python module with PIP, simply open the Terminal and enter the command:
pip3 install Phidget22
Setting UDev Rules
By default, Linux will not allow regular users to access physical hardware, as a security feature. This means that you must grant yourself root privileges via sudo to run Phidgets code.
sudo python3 Python_Example.py
To avoid having to use sudo every time, you can set up a rules file to allow it automatically using the vendor code for Phidget USB devices. Create a text file called 99-libphidget22.rules containing the following line:
SUBSYSTEMS=="usb", ACTION=="add", ATTRS{idVendor}=="06c2", ATTRS{idProduct}=="00[3-a][0-f]", MODE="666"
Mode 666 means every user has permission to read and write to the specified devices. Next, move this file to /etc/udev/rules.d. Now you can run code that uses Phidgets as a regular user without sudo.
Finding Code Samples
To find the code sample to use for your Phidget, navigate to the Code Samples page and select your device from the drop-down menu.
Once you select your device, the code sample generator will give you a working code sample, and a selection of options to customize it to your needs.
Using the Code Samples
Click the Download Example button to download a Java file with the sample code:
Using the Code Samples
To run the example, open the command prompt at the location of the example and enter the following command:
python3 Python_Example.py
Success! Your program is now running with Phidgets!
What's Next?
Now that you've set up Phidgets in your programming environment, you should read our guide on Phidget Programming Basics to learn the fundamentals of programming with Phidgets.
Language - Python
PhidgetSBC with Python
Welcome to using Phidgets with Python! By using Python, you will have access to the complete Phidget22 API, including events.
Requirements
If you haven't already, check out the user guide in order to set up the following:
● Connection to local Network
● Administrator password
This guide will cover development using an external machine. For development using the SBC itself, go back and select Terminal - Linux as your environment.
Installing Python
The quickest way to install Python is through the SBC web interface. Open the Phidget Control Panel on your external machine and click on the Network Phidgets tab.
Double click on your SBC in the device list.
Installing Python
Once you're logged in to the web interface, click on System and Packages.
It may take a minute or two to load this page.
Installing Python
Finally, click on the Install button next to Python Support.
It will take a few minutes to install. Once it's complete you can click on the Back button.
Developing With An External Computer
There are two main ways in which you can access your SBC from an external computer:
● SBC Web Interface
● Secure Shell (SSH)
Since the SBC OS Guide covers the web interface in detail, this guide will cover SSH.
SSH
If you are unfamiliar with SSH, it is a simple yet powerful tool that allows you to log into a remote machine in order to execute commands. You can also transfer files using the associated SCP tool.
In order to use SSH, you need the following:
● The SBC's IP address (e.g. 192.168.3.195) or the link local address (e.g. phidgetsbc.local)
● The administrator password
● SSH enabled on the SBC
SSH
You can enable SSH on the SBC Web Interface as shown below:
SSH on Windows
To use SSH on Windows, we recommend PuTTY. Use the images below as a guide for configuring PuTTY (use the IP address or the link local address interchangeably):
SSH on Windows
After clicking open, simply login as root and provide the administrator password:
To transfer files between your SBC and Windows machine, we recommend either of these programs:
● WinSCP
You will follow a similar process to access the SBC as described for SSH.
SSH on Linux and macOS
SSH is available on Linux and macOS by default. To run SSH, open the terminal and type:
ssh root@phidgetsbc.local
Or, something like this (you will need to know the IP address of your SBC):
ssh root@192.168.3.195
You will then be prompted for the password in order to gain access to the SBC:
SSH on Linux and macOS
To copy a file from the SBC to your development machine using SCP, open the terminal and type:
scp root@phidgetsbc.local:/path/to/source /path/to/destination
You can reverse this if you want to transfer a file from your development machine to your SBC:
scp /path/to/source root@phidgetsbc.local:/path/to/destination
Finding Code Samples
To find the code sample to use for your Phidget, navigate to the Code Samples page and select your device from the drop-down menu.
Once you select your device, the code sample generator will give you a working code sample, and a selection of options to customize it to your needs.
Using the Code Samples
If it's unclear what any of the options do, click on the nearby '?' for more info.
Once you've made your selections, click the Download Example button under Downloads.
Setting up a New Project
When developing on an external computer, you should write and test your programs on that machine. When you are ready, upload your program to the SBC.
Setting up a New Project
Once your code is written, follow these steps to get your program running on the SBC:
1. Using the SBC Web Interface, create a new project:
Setting up a New Project
2. Transfer all the project files from the development machine to the SBC, either using the SBC Web Interface or a tool like WinSCP.
The project directory will be:
/usr/userapps/ProjectName
Setting up a New Project
3. Use SSH to access the SBC terminal and go to the project folder:
cd /usr/userapps/ProjectName
You can now run the program with the command:
python ExampleName.py
Success! The program is running on your SBC.
Running a Program Automatically
To run a Python script as a standalone application or to run it in the web interface, you will need to add a line to the top of the script with the path to your Python executable. If you have followed the steps in this guide, it will be:
#!/usr/bin/python
Click on the sections below for various automation options:
-----
To quickly test whether a program can be run automatically, you can try starting it from the SBC Web Interface.
1. To start the program, navigate to Projects->ProjectName->Startup Settings in the SBC Web Interface.
2. Select your program in the drop-down menu labeled Executable/Class Name
.
3. Click the Start button on the SBC web interface.
4. You'll note that as it runs, there are two links below the Stop button which can be used to view the program output:
- stdout: view the program output like you would in a terminal or command prompt
- stderr: view the program error output
Running on boot ensures that your program will never miss an event. As long as the SBC is running, your code will be running. This section assumes you have written and compiled your program on an external computer, and have uploaded it to the SBC Web Interface.
To have your program run on boot, navigate to Projects->ProjectName->Startup Settings in the SBC Web Interface. After selecting your project, copy the settings from the image below:
We will review some of the options that are shown in the image above:
- Startup Order: lower numbers boot first. Booting later means more programs are available for use, booting earlier means other programs can use your program.
- Run as a daemon: starts the program as a daemon. Unless you have explicitly written your program as a daemon, leave this checked, or else your SBC may hang on boot.
- Executable/Class name: your main Java class or C file.
- Arguments: any command line arguments the program needs.
After saving your changes, your program will run automatically whenever your SBC boots.
Running your program on a schedule allows you to perform your task once a week, or once a minute without worrying about memory management issues or instability problems that may arise. It executes, and then gets cleaned up. To run your program on a schedule, we recommend using Cron. Cron can automatically schedule programs (known as jobs, or cron jobs). Cron simply reads a crontab file and runs whatever programs are listed, with whatever timing they are listed with. Cron runs continuously in the background, but the cron jobs only run as long as they naturally would, and then they exit.
Let's set up your first cron job. We will use nano to edit the crontab file, but feel free to use whatever editor you prefer.
First, set your editor to nano:
export EDITOR=nano
Next, edit your crontab file:
crontab -e
Finally, schedule your cron job:
#cron job that will run at 5AM every week:
0 5 * * 1 /root/code/myprogram argument1
After entering your task, simply save and exit the file.
What's Next?
Now that you've set up Phidgets in your programming environment, you should read our guide on Phidget Programming Basics to learn the fundamentals of programming with Phidgets.
Language - Python
Windows with LiClipse
Welcome to using Phidgets with Python! By using Python, you will have access to the complete Phidget22 API, including events.
LiClipse is a closed-source development environment based on Eclipse, with support for Python.
Installing the Phidget Python Module
First, install Python3 if you haven't already.
Python 3.4+ includes PIP by default. To install the Phidget22 Python module with PIP, simply open the Command Prompt (press the Windows key and search for cmd), and enter the command:
python -m pip install Phidget22
Setting Up a New Project
When you are building a project from scratch, or adding Phidget functionality to an existing project, you'll need to configure your development environment to properly link the Phidget Python library.
To start, create a new Python project:
Setting Up a New Project
Next, add a new file to the project:
Finding Code Samples
To find the code sample to use for your Phidget, navigate to the Code Samples page and select your device from the drop-down menu.
Once you select your device, the code sample generator will give you a working code sample, and a selection of options to customize it to your needs.
Using the Code Samples
If it's unclear what any of the options do, click on the nearby '?' for more info.
Once you've made your selections, click the copy button and paste the code into your new project.
What's Next?
Now that you've set up Phidgets in your programming environment, you should read our guide on Phidget Programming Basics to learn the fundamentals of programming with Phidgets.
Language - Python
Windows with Visual Studio
Welcome to using Phidgets with Python! By using Python, you will have access to the complete Phidget22 API, including events.
Visual Studio is an IDE provided by Microsoft that can be used to develop code in a wide variety of programming languages, including Python.
Installing the Phidget Python Module
First, install Python3 if you haven't already.
You can install the Phidget22 libraries and python module for your current Visual Studio project with PIP by opening View > Other Windows > Python Environments
Installing the Phidget Python Module
Next, select Packages (PyPI) from the drop-down menu:
Installing the Phidget Python Module
Type Phidget22 into the search bar, then click Install Phidget22:
Success! Your project now has access to Phidget22.
Setting Up a New Project
When you are building a project from scratch, or adding Phidget functionality to an existing project, you'll need to configure your development environment to properly link the Phidget Python library.
To start, create a new Python project:
Setting Up a New Project
Then open the Python file that was generated with the project.
Finding Code Samples
To find the code sample to use for your Phidget, navigate to the Code Samples page and select your device from the drop-down menu.
Once you select your device, the code sample generator will give you a working code sample, and a selection of options to customize it to your needs.
Using the Code Samples
If it's unclear what any of the options do, click on the nearby '?' for more info.
Once you've made your selections, click the copy button and paste the code into your new project.
What's Next?
Now that you've set up Phidgets in your programming environment, you should read our guide on Phidget Programming Basics to learn the fundamentals of programming with Phidgets.
Language - Python
Installing the Phidget Python Module
You can install the Phidget22 libraries for your current Visual Studio project with PIP by opening View > Other Windows > Python Environments
Installing the Phidget Python Module
Next, select Packages (PyPI) from the drop-down menu:
Installing the Phidget Python Module
Type Phidget22 into the search bar, then click Install Phidget22:
Success! Your project now has access to Phidget22.
Setting Up a New Project
When you are building a project from scratch, or adding Phidget functionality to an existing project, you'll need to configure your development environment to properly link the Phidget Python library.
To start, create a new Python project:
Setting Up a New Project
Then open the Python file that was generated with the project.
Finding Code Samples
To find the code sample to use for your Phidget, navigate to the Code Samples page and select your device from the drop-down menu.
Once you select your device, the code sample generator will give you a working code sample, and a selection of options to customize it to your needs.
Using the Code Samples
If it's unclear what any of the options do, click on the nearby '?' for more info.
Once you've made your selections, click the copy button and paste the code into your new project.
What's Next?
Now that you've set up Phidgets in your programming environment, you should read our guide on Phidget Programming Basics to learn the fundamentals of programming with Phidgets.
Language - Python
Installing the Phidget Python Module
To install the Phidget22 Python module without PIP, you need to download it here:
Unpack the Phidget22 Python module and open the Command Prompt (press the Windows key and search for cmd). Find the folder where you downloaded the Python module and enter this command:
python setup.py install
This will build the module and install the Python module files into your site-packages directory.
Setting Up a New Project
When you are building a project from scratch, or adding Phidget functionality to an existing project, you'll need to configure your development environment to properly link the Phidget Python library.
To start, create a new Python project:
Setting Up a New Project
Then open the Python file that was generated with the project.
Finding Code Samples
To find the code sample to use for your Phidget, navigate to the Code Samples page and select your device from the drop-down menu.
Once you select your device, the code sample generator will give you a working code sample, and a selection of options to customize it to your needs.
Using the Code Samples
If it's unclear what any of the options do, click on the nearby '?' for more info.
Once you've made your selections, click the copy button and paste the code into your new project.
What's Next?
Now that you've set up Phidgets in your programming environment, you should read our guide on Phidget Programming Basics to learn the fundamentals of programming with Phidgets.
Language - Python
Windows with IDLE
Welcome to using Phidgets with Python! By using Python, you will have access to the complete Phidget22 API, including events.
IDLE is a cross-platform development environment for Python targeted at newcomers to the language.
WARNING: We do not recommend using Idle with Phidgets. It has known problems dealing with multiple threads, which is a required feature if your program uses events.
Installing the Phidget Python Module
First, install Python3 if you haven't already.
Python 3.4+ includes PIP by default. To install the Phidget22 Python module with PIP, simply open the Command Prompt (press the Windows key and search for cmd), and enter the command:
python -m pip install Phidget22
Finding Code Samples
To find the code sample to use for your Phidget, navigate to the Code Samples page and select your device from the drop-down menu.
Once you select your device, the code sample generator will give you a working code sample, and a selection of options to customize it to your needs.
Using the Code Samples
If it's unclear what any of the options do, click on the nearby '?' for more info.
Once you've made your selections, click the copy button.
Using the Code Samples
Paste the sample code into a new Python script file in IDLE:
Using the Code Samples
To run the example, simply click on Run and select Run Module:
What's Next?
Now that you've set up Phidgets in your programming environment, you should read our guide on Phidget Programming Basics to learn the fundamentals of programming with Phidgets.
Quick Downloads
If you already know what you're doing and just need the files, you can find them all below.
Python Module
Documentation
- Phidget22 API (select Python from the drop-down menu)