Language - Python Windows Visual Studio: Difference between revisions

From Phidgets Support
No edit summary
No edit summary
(18 intermediate revisions by 2 users not shown)
Line 1: Line 1:
==Use our examples==
[[Category:Language]]{{NoTitle}}
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.
{|
|style="vertical-align:middle; width: 60%;"|
<font size=6>'''Language - Python'''


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:
'''Windows with Visual Studio'''</font>
*{{SampleCode|Python|Python Examples}}


Welcome to using Phidgets with Python! By using Python, you will have access to the complete Phidget22 API, including events.


Next, create a new Python project:
Visual Studio is an IDE provided by Microsoft that can be used to develop code in a wide variety of programming languages, including Python.
[[Image:Python_vs_newproject.PNG|link=|center]]


|{{TOC limit|2}}
|}


Delete the Python file that was generated with the project:
{{Language_-_Python_Intro_Windows|
[[Image:Python_vs_delete.png|link=|center]]
{{Language_-_Python_Intro_Windows|
<tabber>
PIP=
The recommended way to install the '''Phidget22 Python module''' is using the '''PIP package manager'''.
<br><br>
You can install the Phidget22 libraries for your current Visual Studio project with PIP by opening '''View > Other Windows > Python Environments'''
[[File:VisualStudio_PythonEnvironments.png|link=|center|800px]]
<br><br>
Next, select '''Packages (PyPI)''' from the drop-down menu:
[[File:VisualStudio_PythonPackages.png|link=|center|800px]]
<br><br>
Type '''Phidget22''' into the search bar, then click '''Install Phidget22''':
[[File:VisualStudio_Install_Phidget22.png|link=|center|800px]]


Success! Your project now has access to Phidget22.
|-|
Manual Install=
To install the Phidget22 Python module without PIP, you will need to download the [{{SERVER}}/downloads/phidget22/libraries/any/Phidget22Python.zip Phidget22 Python module].


Add the example you just downloaded by right-clicking on the project and adding an existing item:
After unpacking the Phidget22 Python module, open the '''Command Prompt''' (press the Windows key and search for "cmd") Locate the folder where you downloaded the Python module and enter the following command:
[[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>
<syntaxhighlight lang=python>
python -V
python setup.py install
</syntaxhighlight>
</syntaxhighlight>


[[Image:Python_version.PNG|link=|center]]
This will build the module and install the Python module files into your site-packages directory.


You can view/edit your Python environment under the ''Python Environments'' tab:
[[File:Python_install.png|link=|center]]
[[Image:Python_vs_environment.png|link=|center]]  
</tabber>
 
}}}}
 
{{Finding Code Samples|Python}}
{{Edit_the_Examples}}


==Setting Up a New Project==
==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.
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 start, create a new Python project:
[[Image:Python_vs_newproject.PNG|link=|center|850px]]


To include the Phidget Python library, add the following line to your code:


<syntaxhighlight lang=python>
Then open the Python file that was generated with the project.
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:
[[Image:Python_vs_blank_project.png|link=|center|850px]]
 
<syntaxhighlight lang=python>
from Phidget22.Devices.DigitalInput import *
</syntaxhighlight>


The project now has access to Phidgets.
==Using the Code Samples==
Now that you have configured a project to use Phidgets, you can copy the code sample from the [{{server}}/?view=code_samples&lang=Python Code Samples] page into your project, and run it.


{{Language_Further_Reading}}
{{Language_Page_What's_Next}}

Revision as of 23:56, 28 November 2019

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.

Install Phidget Drivers for Windows

Before getting started with the guides below, ensure you have the following components installed on your machine:

  1. You will need the Phidgets Windows Drivers
  2. You will need a version of Python installed on your machine (2.7 and 3.6+ are compatible with Phidgets).


Install Phidget Drivers for Windows

Before getting started with the guides below, ensure you have the following components installed on your machine:

  1. You will need the Phidgets Windows Drivers
  2. You will need a version of Python installed on your machine (2.7 and 3.6+ are compatible with Phidgets).


The recommended way to install the Phidget22 Python module is using the PIP package manager.

You can install the Phidget22 libraries for your current Visual Studio project with PIP by opening View > Other Windows > Python Environments

VisualStudio PythonEnvironments.png



Next, select Packages (PyPI) from the drop-down menu:

VisualStudio PythonPackages.png



Type Phidget22 into the search bar, then click Install Phidget22:

VisualStudio Install Phidget22.png

Success! Your project now has access to Phidget22.

To install the Phidget22 Python module without PIP, you will need to download the Phidget22 Python module.

After unpacking the Phidget22 Python module, open the Command Prompt (press the Windows key and search for "cmd") Locate the folder where you downloaded the Python module and enter the following command:

python setup.py install

This will build the module and install the Python module files into your site-packages directory.

Python install.png

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.

Python sample code.jpg


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.

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:

Python vs newproject.PNG


Then open the Python file that was generated with the project.

Python vs blank project.png

Using the Code Samples

Now that you have configured a project to use Phidgets, you can copy the code sample from the Code Samples page into your project, and run it.

What's Next?

Now that you have set up Phidgets to work with your programming environment, we recommend you read our guide on Phidget Programming Basics to learn the fundamentals of programming with Phidgets.Next Arrow.png