Language - Python: Difference between revisions

From Phidgets Support
No edit summary
(176 intermediate revisions by 8 users not shown)
Line 1: Line 1:
[[Category:Language]]
[[Category:Language]]
[[File:icon-Python.png|64x64px|link=|alt=Python]] Python is an object oriented programming language developed by the [http://www.python.org/psf/summary/ Python Software Foundation], is powerful and easy to learn.
__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.


==Introduction==
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.


{{LanguageSupport|Python|the complete Phidget API, including events|all Phidget devices.|Windows, Mac OS X and Linux. We provide instructions on how to set up your environment for [[#IDLE | IDLE]], and [[#Eclipse with PyDev | Eclipse with PyDev]]|}}
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.


==Quick Downloads==
==Choose Your Development Environment:==


Just need the Python documentation, drivers, libraries, and examples?  Here they are:
{{Language_-_Python_Dev_Environment_Table}}


API Documentation:
== Quick Downloads ==
*[http://www.phidgets.com/documentation/PythonDoc.zip API Manual]


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


*[http://www.phidgets.com/downloads/examples/Python_2.1.8.20120131.zip Example Code]
=== Python Module ===
* [{{SERVER}}/downloads/phidget22/libraries/any/Phidget22Python.zip Phidget Python module]


Libraries and Drivers:
=== Documentation ===
*[http://www.phidgets.com/downloads/libraries/PhidgetsPython_2.1.8.20120131.zip Python Library]
*[http://www.phidgets.com/downloads/libraries/Phidget-x86_2.1.8.20111220.exe 32-bit Windows Drivers Installer]
*[http://www.phidgets.com/downloads/libraries/Phidget-x64_2.1.8.20111220.exe 64-bit Windows Drivers Installer]
*[http://www.phidgets.com/downloads/libraries/libphidget_2.1.8.20111028.tar.gz Linux Source]
*[http://www.phidgets.com/downloads/libraries/Phidget_2.1.8.20111103.dmg General Mac OS X Drivers Installer]


==Getting started with Python==
*{{Phidget22API}}  (select Python from the drop-down menu)


If you are new to writing code for Phidgets, we recommend starting by running, then modifying existing examples. This will allow you to:
=== Example Code ===
{{ExampleCodeReasons}}


Instructions are divided up by operating system. Choose:
*{{SampleCode|Python|Python Examples}}
*[[#Windows(2000/XP/Vista/7)|Windows 2000 / XP / Vista / 7]]
*[[#Mac OS X |Mac OS X]]
*[[#Linux | Linux]] (including PhidgetSBC)


==Windows(2000/XP/Vista/7)==
===Libraries===
 
{{AllQuickDownloads}}
===Description of Library===
C# programs on Windows depend on the following files, which the installers above put onto your system:
* <b>{{Code|phidget21.dll}}</b> contains the actual Phidgets library, which is used at run-time.  By default, it is placed in {{Code|C:\Windows\System32}}.
* <b>{{Code|Phidgets Python Module}}</b> is the Phidgets library for Python <i><b>2.5</b></i> or higher. It is to be placed in the <Python Install Directory>\Lib\site-packages directory. More information will be provided in the Use Our Examples section for your environment.
 
If you do not want to use our installer, you can download the [http://www.phidgets.com/downloads/libraries/Phidget21-windevel_2.1.8.20111220.zip {{Code|phidget21.dll}}].
 
 
Running the examples and writing your own code can be fairly compiler-specific, so we include instructions for each compiler below.
 
===IDLE===
 
=====Use Our Examples=====
 
Please start by downloading [http://www.phidgets.com/downloads/libraries/PhidgetsPython_2.1.8.20120131.zip Phidgets Python Module]. Extract the file, you will find a directory named{{Code|Phidgets}}. Copy this directory over to the {{Code|<Python Install Directory>\Lib\site-packages}} directory.
 
Next, download the [http://www.phidgets.com/downloads/examples/Python_2.1.8.20120131.zip examples] and unpack them into a foler.  While these examples were written in Python 3.0, they are also compatible with Python and 2.5 and 2.6.
 
If you aren't sure what the software example for your device is called, check the software object listed in the [[Device List | Getting Started guide for your device]]. Open the example in the IDLE editor
 
The only thing left to do is to run the examples! Click on Run &rarr; Run Module
 
[[File:Python IDLE Run.PNG|link=|alt=Run‎]]
 
Once you have the Python examples running, we have a [[#Follow The Examples|teaching]] section below to help you follow them.
 
=====Write Your Own Code=====
 
When you are building a project from scratch, or adding Phidget function calls to an existing project, you'll need to configure your environment to properly link the Phidget Python libraries. Please see the [[#Use Our Examples 2 | Use Our Examples ]] section for instructions.
 
Then, in your code, you will need to reference to the Phidgets Python library.
 
<div class="source">
<syntaxhighlight lang=python>
from Phidgets.PhidgetException import PhidgetErrorCodes, PhidgetException
from Phidgets.Events.Events import AttachEventArgs, DetachEventArgs, ErrorEventArgs, InputChangeEventArgs, OutputChangeEventArgs, SensorChangeEventArgs
from Phidgets.Devices.InterfaceKit import *
</syntaxhighlight>
</div>
 
The project now has access to the Phidget21 function calls and you are ready to begin coding.
 
The same [[#Follow The Examples|teaching ]] section which describes the examples also has further resources for programming your Phidget.
 
===Eclipse with PyDev===
 
=====Use Our Examples=====
 
Please start by downloading [http://www.phidgets.com/downloads/libraries/PhidgetsPython_2.1.8.20120131.zip Phidgets Python Module]. Extract the file, you will find a directory named{{Code|Phidgets}}. Copy this directory over to the {{Code|<Python Install Directory>\Lib\site-packages}} directory.
 
Next, download the [http://www.phidgets.com/downloads/examples/Python_2.1.8.20120131.zip examples] and unpack them into a foler.  While these examples were written in Python 3.0, they are also compatible with Python and 2.5 and 2.6.
 
If you aren't sure what the software example for your device is called, check the software object listed in the [[Device List | Getting Started guide for your device]]. Open the example in the IDLE editor
 
Next, a new project will need to be created. Generate a new PyDev project with a descriptive name such as PhidgetTest
 
[[File:Python PyDev New Project.PNG|link=|alt=New Project]]
 
To import the example program into your project, create a new {{Code|.py}} file in the project.
 
[[File:Python PyDev New File.PNG|link=|alt=New File]]
 
Copy and paste the contents of the example {{Code|.py}} into the new file
 
The only thing left to do is to run the examples! Click on Run &rarr; Run Module
 
[[File:Python PyDev Run As.PNG|link=|alt=Run‎]]
 
Once you have the Python examples running, we have a [[#Follow The Examples|teaching]] section below to help you follow them.
 
=====Write Your Own Code=====
 
When you are building a project from scratch, or adding Phidget function calls to an existing project, you'll need to configure your development environment to properly link the Phidget Python libraries. Please see the [[#Use Our Examples 2 | Use Our Examples ]] section for instructions.
 
Then, in your code, you will need to include the Phidget library:
<div class="source">
<syntaxhighlight lang=python>
from Phidgets.PhidgetException import *
from Phidgets.Events.Events import *
from Phidgets.Devices.InterfaceKit import
</syntaxhighlight>
</div>
 
The project now has access to the Phidget21 function calls and you are ready to begin coding.
 
The same [[#Follow The Examples|teaching]] section which describes the examples also has further resources for programming your Phidget.
 
==Mac OS X==
 
Python has excellent support on Mac OS X.
 
The first step in using Python on Mac is to install the Phidget libraries.  Compile and install them as explained on the [[Device List|getting started guide for your device]].  Then, the [[OS - Mac OS X]] page also describes the different Phidget files, their installed locations, and their roles....
 
==Linux==
 
Python has support on Linux. 
 
The first step in using Python on Linux is to install the Phidget libraries.  Compile and install them as explained on the main [[OS - Linux | Linux page]].  That Linux page also describes the different Phidget files, their installed locations, and their roles.
 
==Follow The Examples==
 
By following the instructions for your operating system and compiler above, you probably now have a working example and want to understand it better so you can change it to do what you want.  This teaching section has resources for you to learn from the examples and write your own.
 
Next, comes our API information.  These resources outline the Python Phidget functions:
 
{{UsingAPhidgetInCodeGeneral|both of which are available in Python|[http://www.phidgets.com/documentation/PythonDoc.zip Python API]}}
 
===Example Flow===
 
{{ExamplePseudocode|In Python, you can name these '''event''' functions whatever you like.  You will then pass them as function pointers to the Phidget library below in the Main Code section.  This hooks them into the actual events when they occur. <br>
In the example code, the event functions common to all Phidgets are called things like '''AttachHandler()''' and '''DetachHandler()''', etc.<br><br>
Some event functions will be specific to each device, like when a tag is read on an RFID board, or when a sensor value changes on an Interface Kit.
Other functions are given in the examples to show you more detail on using your Phidget.  For example, '''DeviceInitialize()''' will show what needs to be set up for your Phidget before using it.
|Creating a Phidget software object in Python is specific to the Phidget.  For a Phidget Spatial, for example, this would involve creating a {{Code|Spatial}} object.  The examples show how to do this and other API functions.<br><br>
The object provides device specific methods and properties which are available from the API for your specific Phidget.|
[http://www.phidgets.com/documentation/PythonDoc.zip Python API]}}
 
==Code Snippets==
 
==Common Problems and Solutions/Workarounds==
 
Here you can put various frequent problems and our recommended solutions.

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