Difference between revisions of "Language - Python"

From Phidgets Support
Jump to: navigation, search
(Getting Started with Python)
 
(15 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
[[Category:Language]]
 
[[Category:Language]]
__TOC__
+
__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.
  
== Quick Downloads ==
+
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.
  
=== Documentation ===
+
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.
  
*{{Phidget22API}} (Select Python from drop-down menu)
+
==Choose Your Development Environment:==
  
=== Example Code ===
+
{{Language_-_Python_Dev_Environment_Table}}
  
*{{SampleCode|Python|Python Examples}}
+
== Quick Downloads ==
  
=== Libraries ===
+
If you already know what you're doing and just need the files, you can find them all below.
  
{{AllQuickDownloads}}
+
=== Python Module ===
 +
* [{{SERVER}}/downloads/phidget22/libraries/any/Phidget22Python.zip Phidget Python module]
  
== Getting Started with Python ==
+
=== Documentation ===
Welcome to using Phidgets with Python! By using Python, you will have access to the complete {{Phidget22API}}, including events. We also provide example code in Python for all Phidget devices.
+
  
Phidget22 supports Python versions 2.7 and 3.2+.
+
*{{Phidget22API}}  (select Python from the drop-down menu)
  
If you are developing for Windows, keep reading. Otherwise, select your operating system to jump ahead:
+
=== Example Code ===
*[[#macOS | macOS]]
+
*[[#Linux | Linux]]
+
  
== Windows ==
 
{{Windows_Languages}}
 
 
===Install Phidget Python module for Windows===
 
Before getting started with the guides below, ensure you have [https://www.python.org/downloads/ Python] installed on your machine (both 2.7 and 3.6 are compatible with Phidgets). You will also need to download the [{{SERVER}}/downloads/phidget22/libraries/any/Phidget22Python.zip Phidget Python module].
 
 
After unpacking the Phidget Python module, open the command prompt at folder location and enter the following command:
 
<syntaxhighlight lang=python>
 
python setup.py install
 
</syntaxhighlight>
 
 
This will build the module and install the Python module files into your site-packages directory.
 
 
[[File:Python_install.png|link=|center]]
 
 
===Command line===
 
====Use our examples====
 
One of the best ways to start programming with Phidgets is to use our example code as a guide. Before we get started, make sure you have read [[#Install Phidget Python module for Windows | how to install the Phidget Python module]] section above.
 
 
 
Now that you have Python and the Phidget Python module installed, select an example that will work with your Phidget:
 
 
*{{SampleCode|Python|Python Examples}}
 
*{{SampleCode|Python|Python Examples}}
  
 
+
===Libraries===
Open the command prompt at the location of the example and enter the following command:
+
{{AllQuickDownloads}}
<syntaxhighlight lang=bash>
+
python example.py
+
</syntaxhighlight>
+
 
+
 
+
[[Image:Python_command_run.png|link=|center]]
+
 
+
 
+
You should now have the example up and running for your device. Play around with the device and experiment with some of the functionality. When you are ready, the next step is configuring your project and writing your own code!
+
 
+
====Configure your 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 Java library.
+
 
+
 
+
To include the Phidget Python library, add the following line to your code:
+
 
+
<syntaxhighlight lang=python>
+
from Phidget22.PhidgetException import *
+
from Phidget22.Phidget import *
+
</syntaxhighlight>
+
 
+
Then, you will also have to add a reference to your particular Phidget. For example, you would include the following line for a DigitalInput:
+
 
+
<syntaxhighlight lang=python>
+
from Phidget22.Devices.DigitalInput import *
+
</syntaxhighlight>
+
 
+
You can now compile the file as shown in the previous section.
+
 
+
 
+
The project now has access to Phidgets. Next, view the [[#Write Code | write your own code]] section located below.
+
 
+
===IDLE===
+
====Use our examples====
+
One of the best ways to start programming with Phidgets is to use our example code as a guide. Before we get started, make sure you have read [[#Install Phidget Python module for Windows| how to install the Phidget Python module]] section above.
+
 
+
 
+
Now that you have Python and the Phidget Python module installed, select an example that will work with your Phidget:
+
*{{SampleCode|Python|Python Examples}}
+
 
+
 
+
Right-click on the example and open it in IDLE:
+
[[Image:Python_idle_open.png|link=|center]]
+
 
+
 
+
To run the example, simply click on ''Run'' and select ''Run Module'':
+
[[Image:Python_idle_run.png|link=|center]]
+
 
+
 
+
 
+
You should now have the example up and running for your device. Play around with the device and experiment with some of the functionality. When you are ready, the next step is configuring your project and writing your own code!
+
 
+
====Configure your 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 Java library.
+
 
+
 
+
To include the Phidget Python library, add the following line to your code:
+
 
+
<syntaxhighlight lang=python>
+
from Phidget22.PhidgetException import *
+
from Phidget22.Phidget import *
+
</syntaxhighlight>
+
 
+
Then, you will also have to add a reference to your particular Phidget. For example, you would include the following line for a DigitalInput:
+
 
+
<syntaxhighlight lang=python>
+
from Phidget22.Devices.DigitalInput import *
+
</syntaxhighlight>
+
 
+
You can now compile the file as shown in the previous section.
+
 
+
 
+
The project now has access to Phidgets. Next, view the [[#Write Code | write your own code]] section located below.
+
 
+
===Visual Studio===
+
====Use our examples====
+
One of the best ways to start programming with Phidgets is to use our example code as a guide. Before we get started, make sure you have read [[#Install Phidget Python module for Windows| how to install the Phidget Python module]] section above. You will also need to download [https://www.visualstudio.com/ Microsoft Visual Studio] if you have not already.
+
 
+
Now that you have Python and the Phidget Python module installed, as well as Visual Studio, select an example that will work with your Phidget:
+
*{{SampleCode|Python|Python Examples}}
+
 
+
 
+
Next, create a new Python project:
+
[[Image:Python_vs_newproject.PNG|link=|center]]
+
 
+
 
+
Delete the Python file that was generated with the project:
+
[[Image:Python_vs_delete.png|link=|center]]
+
 
+
 
+
Add the example you just downloaded by right-clicking on the project and adding an existing item:
+
[[Image:Python_vs_addexisting.png|link=|center]]
+
 
+
 
+
Select the example as the startup file:
+
[[Image:Python_vs_startupproject.png|link=|center]]
+
 
+
 
+
Ensure that your Python environment is the same as the version you have installed. Enter the following command to view your Python version if you are unsure:
+
<syntaxhighlight lang=python>
+
python -V
+
</syntaxhighlight>
+
 
+
[[Image:Python_version.PNG|link=|center]]
+
 
+
 
+
You can view/edit your Python environment under the ''Python Environments'' tab:
+
[[Image:Python_vs_environment.png|link=|center]]
+
 
+
 
+
You should now have the example up and running for your device. Play around with the device and experiment with some of the functionality. When you are ready, the next step is configuring your project and writing your own code!
+
 
+
====Configure your 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 Java library.
+
 
+
 
+
To include the Phidget Python library, add the following line to your code:
+
 
+
<syntaxhighlight lang=python>
+
from Phidget22.PhidgetException import *
+
from Phidget22.Phidget import *
+
</syntaxhighlight>
+
 
+
Then, you will also have to add a reference to your particular Phidget. For example, you would include the following line for a DigitalInput:
+
 
+
<syntaxhighlight lang=python>
+
from Phidget22.Devices.DigitalInput import *
+
</syntaxhighlight>
+
 
+
You can now create your project as shown in the previous section.
+
 
+
 
+
The project now has access to Phidgets. Next, view the [[#Write Code | write your own code]] section located below.
+
 
+
===LiClipse===
+
====Use our examples====
+
One of the best ways to start programming with Phidgets is to use our example code as a guide. Before we get started, make sure you have read [[#Install Phidget Python module for Windows | how to install the Phidget Python module]] section above. You will also need to download [http://www.liclipse.com/ LiClipse] if you have not already.
+
 
+
Now that you have Python and the Phidget Python module installed, as well as LiClipse, select an example that will work with your Phidget:
+
*{{SampleCode|Python|Python Examples}}
+
 
+
 
+
Next, create a new Python project:
+
[[Image:Python_liclipse_newproject.PNG|link=|center]]
+
 
+
 
+
Add the example you just downloaded by dragging it into the project:
+
[[Image:Python_liclipse_import.png|link=|center]]
+
 
+
 
+
Finally, run the project:
+
[[Image:Python_liclipse_run.png|link=|center]]
+
 
+
 
+
You should now have the example up and running for your device. Play around with the device and experiment with some of the functionality. When you are ready, the next step is configuring your project and writing your own code!
+
 
+
====Configure your 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 Java library.
+
 
+
 
+
To include the Phidget Python library, add the following line to your code:
+
 
+
<syntaxhighlight lang=python>
+
from Phidget22.PhidgetException import *
+
from Phidget22.Phidget import *
+
</syntaxhighlight>
+
 
+
Then, you will also have to add a reference to your particular Phidget. For example, you would include the following line for a DigitalInput:
+
 
+
<syntaxhighlight lang=python>
+
from Phidget22.Devices.DigitalInput import *
+
</syntaxhighlight>
+
 
+
You can now create your project as shown in the previous section.
+
 
+
 
+
The project now has access to Phidgets. Next, view the [[#Write Code | write your own code]] section located below.
+
 
+
==macOS==
+
{{macOS_Languages}}
+
===Install Phidget Python module for macOS===
+
Before getting started with the guides below, ensure you have [https://www.python.org/downloads/ Python] installed on your machine (both 2.7 and 3.6 are compatible with Phidgets). You will also need to download the [{{SERVER}}/downloads/phidget22/libraries/any/Phidget22Python.zip Phidget Python module].
+
 
+
After unpacking the Phidget Python module, open the terminal at folder location and enter the following command:
+
<syntaxhighlight lang=python>
+
python setup.py install
+
</syntaxhighlight>
+
 
+
This will build the module and install the Python module files into your site-packages directory.
+
 
+
[[File:Python_mac_install.png|link=|center]]
+
 
+
===Terminal===
+
====Use our examples====
+
One of the best ways to start programming with Phidgets is to use our example code as a guide. Before we get started, make sure you have read [[#Install Phidget Python module for macOS| how to install the Phidget Python module]] section above.
+
 
+
 
+
Now that you have Python and the Phidget Python module installed, select an example that will work with your Phidget:
+
*{{SampleCode|Python|Python Examples}}
+
 
+
 
+
Open the terminal at the location of the example and enter the following command:
+
<syntaxhighlight lang=bash>
+
python example.py
+
</syntaxhighlight>
+
 
+
 
+
[[Image:Python_mac_terminal_run.png|link=|center]]
+
 
+
 
+
You should now have the example up and running for your device. Play around with the device and experiment with some of the functionality. When you are ready, the next step is configuring your project and writing your own code!
+
 
+
====Configure your 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 Java library.
+
 
+
 
+
To include the Phidget Python library, add the following line to your code:
+
 
+
<syntaxhighlight lang=python>
+
from Phidget22.PhidgetException import *
+
from Phidget22.Phidget import *
+
</syntaxhighlight>
+
 
+
Then, you will also have to add a reference to your particular Phidget. For example, you would include the following line for a DigitalInput:
+
 
+
<syntaxhighlight lang=python>
+
from Phidget22.Devices.DigitalInput import *
+
</syntaxhighlight>
+
 
+
You can now compile the file as shown in the previous section.
+
 
+
 
+
The project now has access to Phidgets. Next, view the [[#Write Code | write your own code]] section located below.
+
 
+
== Linux ==
+
{{Linux_Languages}}
+
===Install Phidget Python module for Linux===
+
Before getting started with the guides below, ensure you have [https://www.python.org/downloads/ Python] installed on your machine (both 2.7 and 3.6 are compatible with Phidgets). 
+
 
+
You will also need to download the [{{SERVER}}/downloads/phidget22/libraries/any/Phidget22Python.zip Phidget Python module].
+
 
+
After unpacking the Phidget Python module, open the terminal at folder location and enter the following command:
+
<syntaxhighlight lang=python>
+
python setup.py install
+
</syntaxhighlight>
+
 
+
This will build the module and install the Python module files into your site-packages directory.
+
 
+
[[File:Python_linux_install.PNG|link=|center]]
+
 
+
===Terminal===
+
====Use our examples====
+
One of the best ways to start programming with Phidgets is to use our example code as a guide. Before we get started, make sure you have read [[#Install Phidget Python module for Linux| how to install the Phidget Python module]] section above.
+
 
+
 
+
Now that you have Python and the Phidget Python module installed, select an example that will work with your Phidget:
+
*{{SampleCode|Python|Python Examples}}
+
 
+
 
+
Open the terminal at the location of the example and enter the following command:
+
<syntaxhighlight lang=bash>
+
python example.py
+
</syntaxhighlight>
+
 
+
 
+
[[Image:Python_linux_terminal_run.png|link=|center]]
+
 
+
 
+
You should now have the example up and running for your device. Play around with the device and experiment with some of the functionality. When you are ready, the next step is configuring your project and writing your own code!
+
====Configure your 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 Java library.
+
 
+
 
+
To include the Phidget Python library, add the following line to your code:
+
 
+
<syntaxhighlight lang=python>
+
from Phidget22.PhidgetException import *
+
from Phidget22.Phidget import *
+
</syntaxhighlight>
+
 
+
Then, you will also have to add a reference to your particular Phidget. For example, you would include the following line for a DigitalInput:
+
 
+
<syntaxhighlight lang=python>
+
from Phidget22.Devices.DigitalInput import *
+
</syntaxhighlight>
+
 
+
You can now create your project as shown in the previous section.
+
 
+
 
+
The project now has access to Phidgets. Next, view the [[#Write Code | write your own code]] section located below.
+
 
+
==Write Code==
+
{{WriteCode_Intro}}
+
 
+
=== Step One: Initialize and Open ===
+
You will need to declare your Phidget object in your code. For example, we can declare a digital input object like this:
+
<syntaxhighlight lang=python>
+
ch = DigitalInput()
+
</syntaxhighlight>
+
 
+
 
+
Next, we can open the Phidget object like this:
+
<syntaxhighlight lang=python>
+
ch.open()
+
</syntaxhighlight>
+
 
+
 
+
Although we are not including it on this page, you should handle the return values of all Phidget functions. Here is an example of the previous code with error handling:
+
<syntaxhighlight lang=python>
+
try:
+
  ch = DigitalInput()
+
except RuntimeError as e:
+
  print("Runtime Error: %s" % e.message)
+
try:
+
  ch.open()
+
except PhidgetException as e:
+
  print (“Phidget Exception %i: %s” % (e.code, e.details))
+
</syntaxhighlight>
+
 
+
 
+
=== Step Two: Wait for Attachment (plugging in) of the Phidget ===
+
Simply calling open does not guarantee you can use the Phidget immediately. To use a Phidget, it must be plugged in (attached). We can handle this by using event driven programming and tracking the attach events. Alternatively, we can modify our code so we wait for an attachment:
+
 
+
<syntaxhighlight lang=python>
+
ch = DigitalInput()
+
ch.openWaitForAttachment(5000)
+
</syntaxhighlight>
+
Waiting for attachment will block indefinitely until a connection is made, or until the timeout value is exceeded
+
 
+
 
+
 
+
To use events to handle attachments, we have to modify our code slightly:
+
<syntaxhighlight lang=python>
+
ch = DigitalInput()
+
ch.setOnAttachHandler(onAttachHandler)
+
ch.open()
+
</syntaxhighlight>
+
 
+
Next, we have to declare the function that will be called when an attach event is fired - in this case the function ''OnAttachedHandler'' will be called:
+
<syntaxhighlight lang=python>
+
def onAttachHandler(e):
+
    print("Phidget attached!")
+
</syntaxhighlight>
+
 
+
=== Step Three: Do Things with the Phidget ===
+
We recommend the use of event driven programming when working with Phidgets. In a similar way to handling an attach event as described above, we can also add an event handler for a state change event:
+
<syntaxhighlight lang=python>
+
ch = DigitalInput()
+
ch.setOnAttachHandler(onAttachHandler)
+
ch.setOnStateChangeHandler(onStateChangeHandler)
+
ch.open()
+
</syntaxhighlight>
+
 
+
This code will connect a function and an event. In this case, the ''onStateChangeHandler'' function will be called when there has been a change to the devices input. Next, we need to create the ''onStateChangeHandler'' function:
+
<syntaxhighlight lang=python>
+
def onStateChangeHandler(e, state):
+
    print("State %f" % state)
+
    return 0
+
</syntaxhighlight>
+
 
+
 
+
If events do not suit your needs, you can also poll the device directly for data using code like this:
+
<syntaxhighlight lang=python>
+
state = ch.getState()
+
print("State %f" % state)
+
</syntaxhighlight>
+
 
+
=== Step Four: Close and Delete ===
+
At the end of your program, be sure to close and delete your device:
+
<syntaxhighlight lang=python>
+
ch.close()
+
</syntaxhighlight>
+
 
+
== Further Reading ==
+
 
+
[[Phidget Programming Basics]] - Here you can find the basic concepts to help you get started with making your own programs that use Phidgets.
+
 
+
[[Data Interval/Change Trigger]] - Learn about these two properties that control how much data comes in from your sensors.
+
 
+
[[Using Multiple Phidgets]] - It can be difficult to figure out how to use more than one Phidget in your program. This page will guide you through the steps.
+
 
+
[[Polling vs. Events]] - Your program can gather data in either a polling-driven or event-driven manner. Learn the difference to determine which is best for your application.
+
 
+
[[Logging, Exceptions, and Errors]] - Learn about all the tools you can use to debug your program.
+
 
+
[[Phidget Network Server]] - Phidgets can be controlled and communicated with over your network- either wirelessly or over ethernet.
+

Latest revision as of 22:14, 28 February 2019


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.

Choose Your Development Environment:

Python Development Environments
OS - Windows Windows

PY PCH WIN.png PY PCH WIN on.png

PY CL WIN.png PY CL WIN on.png

PY LI WIN.png PY LI WIN on.png

PY VS WIN.png PY VS WIN on.png

PY IDLE WIN.png PY IDLE WIN on.png

OS - macOS macOS

PY CL MAC.png PY CL MAC on.png

OS - Linux Linux

PY CL LNX.png PY CL LNX on.png

OS - Linux Phidget SBC Linux

PY CL SBC.png PY CL SBC on.png

Quick Downloads

If you already know what you're doing and just need the files, you can find them all below.

Python Module

Documentation

Example Code

Libraries