Language - Python: Difference between revisions

From Phidgets Support
No edit summary
Line 1: Line 1:
{{#seo:|description=Learn how to use Phidget USB devices with Python.}}
[[Category:Language]]
[[Category:Language]]
__NOTOC__


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.
==Get Started==
With the Phidget22 Python library, it's easy to create Python applications that work with Phidget devices.


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.
==Python Libraries==
===pip Package===
The Phidget22 Python library is available as a [https://pypi.org/project/phidget22/ pip package]. Most development environments provide built-in tools to manage packages. View the [[#Development Environment Configuration | Development Environment Configuration]] section below for examples.  


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.
====macOS Considerations====
Phidget devices running a HID USB stack require the installation of the macOS libraries or the standalone Phidget Control Panel ([{{SERVER}}/docs/OS_-_macOS download here]).


== Setup Guide ==
To determine what USB stack your Phidget device is on, navigate to the product page and then to the specification tab, and look for the ''USB Stack'' specification. If you are using a VINT device, navigate to the product page for the VINT Hub you are using.


<div class="phd-deck-sequence">
[[Image:Javascript_networkserver_webusb_spec.png|center|600px|link=https://cdn.phidgets.com/docs/images/8/80/Javascript_networkserver_webusb_spec.png]]
{{PT3_PYTHON_CHOOSE}}{{PT3_PYTHON_WIN_PYCHARM}}{{PT3_PYTHON_WIN_PYCHARM_1}}{{PT3_PYTHON_WIN_PYCHARM_2}}{{PT3_PYTHON_WIN_PYCHARM_3}}{{PT3_PYTHON_WIN_CMD}}{{PT3_PYTHON_MAC_TRM}}{{PT3_PYTHON_LNX_TRM}}{{PT3_PYTHON_SBC_TRM}}{{PT3_PYTHON_WIN_LIC}}{{PT3_PYTHON_WIN_VS}}{{PT3_PYTHON_WIN_VS_1}}{{PT3_PYTHON_WIN_VS_2}}{{PT3_PYTHON_WIN_IDLE}}
</div>


====Linux Considerations====
If you would like to run your Python application from user space, you'll need to set [{{SERVER}}/docs/OS_-_Linux#Setting_UDev_Rules udev rules] on your machine.


== Quick Downloads ==
===Source Files===
The Phidget22 Python library source files are available [https://cdn.phidgets.com/downloads/phidget22/libraries/any/Phidget22Python.zip here].


If you already know what you're doing and just need the files, you can find them all below.
==Development Environment Configuration==
Most development environments provide built-in tools to manage Python interpreters, packages, and virtual environments. See the examples below for more information.
===Installing a Python Interpreter===
If you don't already have a Python interpreter installed, you can download and install one from [https://www.python.org/downloads/ python.org] or through package managers like [https://brew.sh/ Homebrew].


=== Python Package ===
===Visual Studio Code===
{| style="margin:auto;" class="table-no-border mw-collapsible mw-collapsed"
|+ '''Instructions'''
| Install the [https://marketplace.visualstudio.com/items?itemName=ms-python.python Python extension for Visual Studio Code].|| [[Image:Language_python_vscode_install.png|center|350px|link=https://wwwdev.int.phidgets.com/docs/images/f/f9/Language_python_vscode_install.png]]
|-
| Next, create a directory and open it in Visual Studio Code. You can do this by opening Visual Studio Code and selecting '''File > Open Folder...''' || [[Image:Language_python_vscode_newfolder.png|center|350px|link=https://wwwdev.int.phidgets.com/docs/images/f/f8/Language_python_vscode_newfolder.png]]
|-
| Open the Command Palette (Ctrl + Shift + P), type '''Python: Create Environment''', and press Enter. Select '''Venv''' when prompted. || [[Image:Language_python_vscode_newvenv.png|center|350px|link=https://wwwdev.int.phidgets.com/docs/images/a/a6/Language_python_vscode_newvenv.png]]
|-
| Next, select your preferred Python interpreter from the list. You may need to browse to find it. || [[Image:Language_python_vscode_selectinterpreter.png|center|350px|link=https://wwwdev.int.phidgets.com/docs/images/2/20/Language_python_vscode_selectinterpreter.png]]
|-
| Open a new terminal. You can do this through the Command Palette again (Ctrl + Shift + P), by typing '''Terminal: Create New Terminal'''. Install the Phidget22 pip package:
<syntaxhighlight lang=bash>
#Windows
py -m pip install phidget22


It is recommended to follow the instructions in the setup guide above and use PIP to install the python package, but if you need the source file, you can download it here.
#macOS
python3 -m pip install phidget22


* [https://cdn.phidgets.com/downloads/phidget22/libraries/any/Phidget22Python.zip Phidget Python Package]
#Linux (Debian)
python3 -m pip install phidget22
</syntaxhighlight>
|| [[Image:Language_python_vscode_installpackage.png|center|350px|link=https://wwwdev.int.phidgets.com/docs/images/a/a8/Language_python_vscode_installpackage.png]]
|-
| Finally, add your Python file and run it using the button in the top right corner.|| [[Image:Language_python_vscode_runcode.png|center|350px|link=https://wwwdev.int.phidgets.com/docs/images/9/96/Language_python_vscode_runcode.png]]
|-
|}


=== Documentation ===
===PyCharm===
{| style="margin:auto;" class="table-no-border mw-collapsible mw-collapsed"
|+ '''Instructions'''
| Create your PyCharm project and navigate to '''Settings''': || [[Image:Windows_pycharm_settings.jpg|center|350px|link=https://wwwdev.int.phidgets.com/docs/images/7/75/Windows_pycharm_settings.jpg]]
|-
| Next, navigate to '''Project > Project Interpreter''' and click on the '''+''' symbol: || [[Image:Windows_pycharm_addpackage.jpg|center|350px|link=https://wwwdev.int.phidgets.com/docs/images/6/6f/Windows_pycharm_addpackage.jpg]]
|-
| Search for '''phidget22''' and install the package: || [[Image:Windows_pycharm_installpackage.jpg|center|350px|link=https://wwwdev.int.phidgets.com/docs/images/a/ad/Windows_pycharm_installpackage.jpg]]
|-
| Finally, add your Python file and run it using the button at the top of the screen: || [[Image:Windows_pycharm_run.png|center|350px|link=https://wwwdev.int.phidgets.com/docs/images/0/0a/Windows_pycharm_run.png]]
|}


*{{Phidget22API}}  (select Python from the drop-down menu)
==Example Code==
Navigate to our [https://www.phidgets.com/?view=code_samples Code Sample Generator] and select Python to view and download code samples that are tailored to your specific device.


=== Example Code ===
[[Image:Language_python_codesample.png|center|600px|link=https://wwwdev.int.phidgets.com/docs/images/2/2d/Language_python_codesample.png]]


*{{SampleCode|Python|Python Examples}}
==API==
[{{SERVER}}/?view=api&lang=Python Phidget22 API]

Revision as of 21:57, 5 June 2025


Get Started

With the Phidget22 Python library, it's easy to create Python applications that work with Phidget devices.

Python Libraries

pip Package

The Phidget22 Python library is available as a pip package. Most development environments provide built-in tools to manage packages. View the Development Environment Configuration section below for examples.

macOS Considerations

Phidget devices running a HID USB stack require the installation of the macOS libraries or the standalone Phidget Control Panel (download here).

To determine what USB stack your Phidget device is on, navigate to the product page and then to the specification tab, and look for the USB Stack specification. If you are using a VINT device, navigate to the product page for the VINT Hub you are using.

Javascript networkserver webusb spec.png

Linux Considerations

If you would like to run your Python application from user space, you'll need to set udev rules on your machine.

Source Files

The Phidget22 Python library source files are available here.

Development Environment Configuration

Most development environments provide built-in tools to manage Python interpreters, packages, and virtual environments. See the examples below for more information.

Installing a Python Interpreter

If you don't already have a Python interpreter installed, you can download and install one from python.org or through package managers like Homebrew.

Visual Studio Code

Instructions
Install the Python extension for Visual Studio Code.
Language python vscode install.png
Next, create a directory and open it in Visual Studio Code. You can do this by opening Visual Studio Code and selecting File > Open Folder...
Language python vscode newfolder.png
Open the Command Palette (Ctrl + Shift + P), type Python: Create Environment, and press Enter. Select Venv when prompted.
Language python vscode newvenv.png
Next, select your preferred Python interpreter from the list. You may need to browse to find it.
Language python vscode selectinterpreter.png
Open a new terminal. You can do this through the Command Palette again (Ctrl + Shift + P), by typing Terminal: Create New Terminal. Install the Phidget22 pip package: 
#Windows
py -m pip install phidget22 

#macOS
python3 -m pip install phidget22 

#Linux (Debian)
python3 -m pip install phidget22
Language python vscode installpackage.png
Finally, add your Python file and run it using the button in the top right corner.
Language python vscode runcode.png

PyCharm

Instructions
Create your PyCharm project and navigate to Settings:
Windows pycharm settings.jpg
Next, navigate to Project > Project Interpreter and click on the + symbol:
Windows pycharm addpackage.jpg
Search for phidget22 and install the package:
Windows pycharm installpackage.jpg
Finally, add your Python file and run it using the button at the top of the screen:
Windows pycharm run.png

Example Code

Navigate to our Code Sample Generator and select Python to view and download code samples that are tailored to your specific device.

Language python codesample.png

API

Phidget22 API

Retrieved from "https://www.phidgets.com/docs/index.php?title=Language_-_Python&oldid=35252"