Language - Python: Difference between revisions

From Phidgets Support
No edit summary
Line 1: Line 1:
[[Category:Language]]
__NOTOC__
__TOC__


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 ===
General information of how to use Phidgets with Python can be found in the '''Write Code''' section of each development environment page. This information is consistent across all pages.


*{{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.


If you are developing for Windows, keep reading. Otherwise, select your operating system to jump ahead:
*{{Phidget22API}} (select C from the drop-down menu)
*[[#macOS | macOS]]
*[[#Linux | Linux]]
== Windows ==
 
===Install Phidget Drivers and Python module for Windows===
Before getting started with the guides below, ensure you have the following components installed on your machine:
 
# You will need the [[OS_-_Windows#Quick_Downloads|Phidgets Windows Drivers]]
# You will need a version of [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.


=== Example Code ===


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>
 
Ensure that PhidgetHelperFunctions.py is in the same folder as the example.
 
[[Image:Python_command_run.png|link=|center]]
 
{{Edit_the_Examples}}
 
====Setting Up a New Script====
When you are building a script from scratch, or adding Phidget functionality to an existing script, you'll need to configure your program to properly link the Phidget Python 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.
 
===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]]
 
Ensure that PhidgetHelperFunctions.py is in the same folder as the example.
 
{{Edit_the_Examples}}
 
====Setting Up a New Script====
When you are building a script from scratch, or adding Phidget functionality to an existing script, you'll need to configure your program to properly link the Phidget Python 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.
 
===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]]
 
Add PhidgetHelperFunctions.py in the same as the example.
 
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]]
 
 
{{Edit_the_Examples}}
 
====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, you need to create your project as shown in the previous section.
 
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>
 
The project now has access to Phidgets.
 
===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]]
 
Add PhidgetHelperFunctions.py to the project by dragging it into the project.
 
Finally, run the project:
[[Image:Python_liclipse_run.png|link=|center]]
 
 
{{Edit_the_Examples}}
 
====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, you need to create your project as shown in the previous section.
 
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>
 
The project now has access to Phidgets.
 
==macOS==
 
===Install Phidget Drivers and Python module for macOS===
Before getting started with the guides below, ensure you have the following components installed on your machine:
 
# You will need the [[OS_-_macOS#Quick_Downloads|Phidgets macOS Drivers]]
# You will need a version of [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>
 
Ensure that PhidgetHelperFunctions.py is in the same folder as the example.
 
[[Image:Python_mac_terminal_run.png|link=|center]]
 
{{Edit_the_Examples}}
 
==== Setting Up a New Script====
When you are building a script from scratch, or adding Phidget functionality to an existing script, you'll need to configure your program to properly link the Phidget Python 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.
 
== Linux ==
 
===Install Phidget Drivers and Python module for Linux===
Before getting started with the guides below, ensure you have the following components installed on your machine:
 
# You will need the [[OS_-_Linux#Quick_Downloads|Phidgets Linux Drivers]]
# You will need a version of [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].
 
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>
 
Ensure that PhidgetHelperFunctions.py is in the same folder as the example.
 
[[Image:Python_linux_terminal_run.png|link=|center]]
 
{{Edit_the_Examples}}
 
====Setting Up a New Script====
When you are building a script from scratch, or adding Phidget functionality to an existing script, you'll need to configure your program to properly link the Phidget Python 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>
 
The script now has access to Phidgets.
 
== Editing the Examples==
 
To get our example code to run in a custom application, simply remove the calls to ''AskForDeviceParameters'' and ''PrintEventDescriptions'', and hard-code the addressing parameters for your application.
 
If you are unsure what values to use for the addressing parameters, check the [[Finding The Addressing Information]] page.
 
For instance:
<syntaxhighlight lang=python>
channelInfo = AskForDeviceParameters(ch)
       
ch.setDeviceSerialNumber(channelInfo.deviceSerialNumber)
ch.setHubPort(channelInfo.hubPort)
ch.setIsHubPortDevice(channelInfo.isHubPortDevice)
ch.setChannel(channelInfo.channel) 
       
if(channelInfo.netInfo.isRemote):
    ch.setIsRemote(channelInfo.netInfo.isRemote)
    if(channelInfo.netInfo.serverDiscovery):
        Net.enableServerDiscovery(PhidgetServerType.PHIDGETSERVER_DEVICEREMOTE)
    else:
        Net.addServer("Server", channelInfo.netInfo.hostname,
            channelInfo.netInfo.port, channelInfo.netInfo.password, 0)
</syntaxhighlight>
 
Might become:
 
<syntaxhighlight lang=python>
ch.setDeviceSerialNumber(370114)
ch.setHubPort(2)
ch.setIsHubPortDevice(1)
</syntaxhighlight>
 
Notice that you can leave out any parameter not relevant to your application for simplicity.
 
You can then manipulate the rest of the code as your application requires. A more in-depth description of programming with Phidgets follows in the [[#Write Code| Write Code]] section.
 
==Write Code==
{{WriteCode_Intro|Python|Python}}
 
=== Step One: Create and Address===
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 address which Phidget we want to connect to by setting parameters such as ''DeviceSerialNumber''.
 
<syntaxhighlight lang=python>
ch.setDeviceSerialNumber(496911)
</syntaxhighlight>
 
Although we are not including it on this page, you should handle exceptions 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.setDeviceSerialNumber(496911)
except PhidgetException as e:
  print (“Phidget Exception %i: %s” % (e.code, e.details))
</syntaxhighlight>
 
=== Step Two: Open and Wait for Attachment===
 
After we have specified which Phidget to connect to, we can open the Phidget object like this:
<syntaxhighlight lang=python>
ch.openWaitForAttachment(5000)
</syntaxhighlight>
 
To use a Phidget, it must be plugged in (attached). We can handle this by calling ''openWaitForAttachment'', which will block indefinitely until a connection is made, or until the timeout value is exceeded. Simply calling ''open'' does not guarantee you can use the Phidget immediately.
 
Alternately, you could verify the device is attached by using event driven programming and tracking the attach events.
 
To use events to handle attachments, we have to modify our code slightly:
<syntaxhighlight lang=python>
ch = DigitalInput()
ch.setOnAttachHandler(onAttachHandler)
ch.openWaitForAttachment(5000)
</syntaxhighlight>
 
Next, we have to declare the function that will be called when an attach event is fired - in this case the function ''onAttachHandler'' will be called:
<syntaxhighlight lang=python>
def onAttachHandler(e):
    print("Phidget attached!")
</syntaxhighlight>
 
We recommend using this attach handler to set any initialization parameters for the channel such as DataInterval and ChangeTrigger from within the AttachHandler, so the parameters are set as soon as the device becomes available.
 
=== 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.openWaitForAttachment(5000)
</syntaxhighlight>
 
This code will connect a function to an event. In this case, the ''onStateChangeHandler'' function will be called when there has been a change to the channel's input. Next, we need to create the ''onStateChangeHandler'' function:
<syntaxhighlight lang=python>
def onStateChangeHandler(self, state):
    print("State %f" % state)
    return 0
</syntaxhighlight>
 
If you are using multiple Phidgets in your program, check out our page on [[Using_Multiple_Phidgets]] for information on how to properly address them and use them in events.
 
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>
 
'''Important Note:''' There will be a period of time between the attachment of a Phidget sensor and the availability of the first data from the device. Any attempts to get this data before it is ready will result in an exception. See more information on this on our page for [[Unknown Values]].
 
====Enumerations====
 
Some Phidget devices have functions that deal with specific predefined values called enumerations. Enumerations commonly provide readable names to a set of numbered options.
 
Enumerations with Phidgets in Python will take the form of '''EnumerationType.ENUMERATION_NAME'''.
 
For example, specifying a SensorType to use the 1142 for a voltage input would look like:
<syntaxhighlight lang=python>
VoltageSensorType.SENSOR_TYPE_1142
</syntaxhighlight>
and specifying a K-Type thermocouple for a temperature sensor would be:
<syntaxhighlight lang=python>
ThermocoupleType.THERMOCOUPLE_TYPE_K
</syntaxhighlight>
The Phidget error code for timing out could be specified as:
<syntaxhighlight lang=python>
ErrorCode.EPHIDGET_TIMEOUT
</syntaxhighlight>
 
You can find the Enumeration Type under the ''Enumerations'' section of the {{Phidget22API}} for your device, and the Enumeration Name in the drop-down list within.
 
=== 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.

Revision as of 21:03, 5 July 2018


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.

General information of how to use Phidgets with Python can be found in the Write Code section of each development environment page. This information is consistent across all pages.

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

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