OS - Linux: Difference between revisions

From Phidgets Support
No edit summary
 
(46 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<metadesc>Communicate over USB with sensors, controllers and relays with Phidgets! Program in Linux using a wide variety of programming languages.</metadesc>
[[Category:OS]]
[[Category:OS]]
__TOC__
{|
==Quick Downloads==
|style="vertical-align:middle; width: 60%;"|
Already know what you're doing? Here you go:
*[{{SERVER}}/downloads/phidget22/libraries/linux/libphidget22.tar.gz libphidget22]
*[{{SERVER}}/downloads/phidget22/libraries/linux/libphidget22extra.tar.gz libphidget22extra]
*[{{SERVER}}/downloads/phidget22/libraries/linux/libphidget22java.tar.gz libphidget22java]
*[{{SERVER}}/downloads/phidget22/libraries/linux/phidget22networkserver.tar.gz phidget22networkserver]
*[{{SERVER}}/downloads/phidget22/libraries/linux/phidget22admin.tar.gz phidget22admin]
 
If you need older versions of the Linux libraries, [{{SERVER}}/downloads/phidget22/libraries/linux/libphidget22/ click here].
 
==Getting Started with Linux==
==Getting Started with Linux==
Welcome to using Phidgets with Linux. If you haven't already, check out the [[:Category:UserGuide|user guide]] for your device. If you are ready to go, the first step in creating Linux applications with Phidgets is installing the Phidget libraries!
Welcome to using Phidgets with Linux!  
 
===Installing===
If your Linux machine is running Debian, keep reading. For all other Linux distributions, jump ahead to [[#Generic Install | generic installs]].
====Debian Install====
To install the Phidget libraries on Debian, follow theses steps:
 
1. Enter the following command in the terminal:
<syntaxhighlight lang=bash>
wget -qO- http://www.phidgets.com/gpgkey/pubring.gpg | apt-key add -
</syntaxhighlight>
 
2. If you are running jessie (Debian 8), enter the following command:
<syntaxhighlight lang=bash>
echo 'deb http://www.phidgets.com/debian jessie main' > /etc/apt/sources.list.d/phidgets.list
</syntaxhighlight>
We also support squeeze (Debian 6), and wheezy (Debian 7). If you are running one of these older releases, simply replace ''jessie'' in the command above with your release.
 
3. Next, update your package lists:
<syntaxhighlight lang=bash>
apt-get update
</syntaxhighlight>
 
4. Finally, install the recommended packages by entering the command below:
<syntaxhighlight lang=bash>
apt-get install libphidget22 libphidget22-dev phidget22networkserver libphidget22java phidget22admin
</syntaxhighlight>
 
 
You have finished installing the Phidget libraries onto your Debian machine. Next, we will verify everything is working properly. Jump ahead to [[#Verify | verifying]].


====Generic Install====
If you are ready to go, the first step in creating Linux applications with Phidgets is installing our libraries.
To install the Phidget libraries, follow these steps:
|{{TOC limit|3}}
|}
===Install===
The first step to using Phidgets with Linux is installing the Phidget22 libraries.
{{LinuxSupport}}
If you're running one of the supported distros, we recommend using the '''Package Install'''. For other systems, you can use the '''Source Install'''.


1. Install libusb-1.0 development libraries by entering the command into the terminal:
<div class="bigTabs">
<syntaxhighlight lang=bash>
<tabber>
apt-get install libusb-1.0-0-dev
Package Install=
</syntaxhighlight>
====Install Script====
To run the install script and install phidget22, enter the following command in the terminal:


2. Download and unpack the following files:
{{LinuxInstallScript}}
*[{{SERVER}}/downloads/phidget22/libraries/linux/libphidget22.tar.gz libphidget22]
*[{{SERVER}}/downloads/phidget22/libraries/linux/libphidget22extra.tar.gz libphidget22extra]
*[{{SERVER}}/downloads/phidget22/libraries/linux/libphidget22java.tar.gz libphidget22java]
*[{{SERVER}}/downloads/phidget22/libraries/linux/phidget22networkserver.tar.gz phidget22networkserver]
*[{{SERVER}}/downloads/phidget22/libraries/linux/phidget22admin.tar.gz phidget22admin]


====Manual Install====
To install our package repository manually, enter the following command in the terminal, replacing ''distro'' with your distro codename:


3. Open the README file that is included at the top of each directory. This file will give you important information about how to properly install the files.
{{LinuxGetKey}}


We support Debian releases from 6 to current, and Ubuntu LTS releases from 14.04 to current. If you are using another flavour of Linux (such as Mint), which is based on Ubuntu or Debian, use the corresponding Ubuntu or Debian codename.


You have finished installing the Phidget libraries onto your Linux machine. Next, we will verify everything is working properly.
Update your package lists:
{{LinuxAptUpdate}}


===Verify===
Finally, install the Phidget package by entering the command below:
The best way to verify that your libraries are installed and your Phidget is working is to compile and run the [{{SERVER}}/downloads/phidget22/examples/c/Manager/Phidget22_HelloWorld_C_Ex.zip HelloWorld C example]. To compile and run the example, follow these steps:
{{LinuxAptInstall}}


====Additional Packages====
You may also want to apt-get install the following optional packages:
* '''libphidget22-dev''': The C development libraries for Phidget22
* '''libphidget22extra''': Extra runtime library required for the Network Server and Admin tools
* '''phidget22networkserver''': The [[Phidget Network Server]], which enables use of Phidgets over your network
* '''libphidget22java''': The Java libraries for Phidget22
* [[Phidget22admin Guide|'''phidget22admin''']]: An administrator utility for listing Phidgets and upgrading firmware
* '''phidget22wwwjs''': The JavaScript libraries for Phidget22. This package also installs the HTML examples which can be accessed through the web interface


1. Unpack the C examples and open a terminal window at this location


2. Compile the HelloWorld.c example:
The libraries are now installed on your machine. Next, set up the UDev rules below.


|-|
Source Install=
====Source Install====
To install our libraries, first install libusb-1.0 development libraries. The exact command and package name will vary depending on distribution. For Debian based distributions, including Ubuntu and Mint, the command would be:
<syntaxhighlight lang=bash>
<syntaxhighlight lang=bash>
gcc HelloWorld.c -o HelloWorld -lphidget22
apt-get install libusb-1.0-0-dev
</syntaxhighlight>
</syntaxhighlight>


3. Run the HelloWorld example:
<syntaxhighlight lang=bash>
./HelloWorld
</syntaxhighlight>
Your terminal should look something like this:
[[File:linux_helloworld.PNG|link=|center]]


Next, download and unpack the following files:
*[https://cdn.phidgets.com/downloads/phidget22/libraries/linux/libphidget22.tar.gz libphidget22] (Mandatory)
*[https://cdn.phidgets.com/downloads/phidget22/libraries/linux/libphidget22extra.tar.gz libphidget22extra] (Optional - needed by NetworkServer and Admin)
*[https://cdn.phidgets.com/downloads/phidget22/libraries/linux/libphidget22java.tar.gz libphidget22java] (Optional - Java Libraries)
*[https://cdn.phidgets.com/downloads/phidget22/servers/linux/phidget22networkserver.tar.gz phidget22networkserver] (Optional - [[Phidget Network Server]])
*[https://cdn.phidgets.com/downloads/phidget22/tools/linux/phidget22admin.tar.gz phidget22admin] (Optional - Phidget Admin Tool)
Open the README file that is included at the top of each directory. This file will give you important information about how to properly install the files.


The HelloWorld program will simply communicate when a Phidget has been attached or detached, as can be seen in the image above.


Libraries are installed in /usr/local/lib by default. If you run into trouble finding the libraries during linking or at runtime, this probably means that /usr/local/lib is not on the library path for your distribution.


Your Phidget is now able to communicate with your development machine. The next step is selecting a programming language so you can start to write some code!
You can handle this in a number of ways:


===Programming===
Specify a different install folder during compile
Ready to write some code? Select one of the programming languages below:
<syntaxhighlight lang=bash>./configure --prefix=/usr && make && sudo make install</syntaxhighlight>
OR Add /usr/local/lib to the system-wide library path
<syntaxhighlight lang=bash>echo /usr/local/lib >> /etc/ld.so.conf && sudo ldconfig</syntaxhighlight>
OR Add /usr/local/lib in your local shell every time
<syntaxhighlight lang=bash>export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/local/lib</syntaxhighlight>


''Great choices for beginners:''
The libraries are now installed on your machine. Next, you should set the UDev Rules.
*[[Language - C/C++|C/C++]]
</tabber>
*[[Language - Java | Java]]
</div>
*[[Language - Python | Python]]
''Also supported:''
*[[Language - C Sharp | C#]]
*[[Language - Visual Basic .NET | VB.Net]]
*[[Language - JavaScript | JavaScript]]


==Phidget Network Server==
=== Setting UDev Rules ===
The Phidget Network Server is an extremely useful feature of Phidgets that allows you to remotely control Phidgets over your network. If you haven't already, check out the [[Phidget Network Server]] page for a complete overview.
By default, Linux will not grant permission to regular users to access physical hardware as a security feature.  This means that in order to run Phidgets code from user space you must grant yourself root privileges via sudo. For example:


===Try it out!===
sudo ./HelloWorld
In order to try the Phidget Network Server out, you will need a host computer, and a client computer with the Phidget libraries installed:
*Host computer: the computer that is physically connected to the Phidgets via USB and is running the Phidget Network Server.
*Client computer: a computer running a Phidgets application that accesses Phidgets connected to the host computer.
If you only have one computer, don't worry, your machine can act as both a host and a client.


You can grant access manually or, more commonly, set up a rules file to do it automatically keying off of the vendor code for Phidget USB devices.  To do this, create a text file called "99-libphidget22.rules" with the following contents:


Next, follow these steps:
# All current and future Phidgets - Vendor = 0x06c2, Product = 0x0030 - 0x00af
SUBSYSTEMS=="usb", ACTION=="add", ATTRS{idVendor}=="06c2", ATTRS{idProduct}=="00[3-a][0-f]", MODE="666"


1. Open the terminal on the host computer and type in the following command to run the Network Server in the terminal:
Where mode 666 means every user has permission to read and write to the specified file/device.  You need to then move this file to "/etc/udev/rules.d".  Now you can run Phidget related code as a regular user without the OS denying permission. 
<syntaxhighlight lang=bash>
phidget22networkserver
</syntaxhighlight>


Or, as a daemon:
===Verify===
<syntaxhighlight lang=bash>
The best way to verify that your libraries are working properly is to compile and run an example program.
phidget22networkserver -D
</syntaxhighlight>
 
 
[[File:Linux_networkserver.PNG|link=|center]]




The Network Server is now running on your machine with the default configuration. If you would like to change the Network Server configuration, you can do so by modifying the following file:
First, download and unpack this C example:
*/etc/phidgets/phidget22networkserver.pc
*[https://cdn.phidgets.com/downloads/phidget22/examples/c/Manager/Phidget22_HelloWorld_C_Ex.zip HelloWorld C example]


'''Note:''' If using the Debian intallation methods, you will need to install the '''libphidget22-dev''' package to use the C libraries for Phidget22


You can also simply point towards your own configuration file with the following command:
Next, open the terminal at the example location. Compile the example by entering the following command:
<syntaxhighlight lang=bash>
<syntaxhighlight lang=bash>
phidget22networkserver -c /path/to/configuration/file
gcc HelloWorld.c -o HelloWorld -lphidget22
</syntaxhighlight>
</syntaxhighlight>




Now that you have the Network Server running on your host computer, the next step will be accessing the Phidgets connected to your host computer from your client computer. Follow the steps below:
Run the HelloWorld example:
 
 
1. Open the terminal on the client computer and type in the following command (if you are using a single machine, simply open a new terminal session and continue):
<syntaxhighlight lang=bash>
<syntaxhighlight lang=bash>
phidget22admin -s
./HelloWorld
</syntaxhighlight>
</syntaxhighlight>




[[File:Linux_networkserver_phidgetadmin.PNG|link=|center]]
Your terminal should look something like this:
[[File:linux_helloworld.PNG|link=|center]]




This will list all of the Phidget Servers on your network. Confirm that you can see the Network Server running on your host computer.
The HelloWorld program will simply communicate when a Phidget has been attached or detached, as can be seen in the image above.




2. After you have confirmed your Network Server is running, type in the following command:
Your Phidget is now able to communicate with your development machine. The next step is selecting a programming language so you can start to write some code!
<syntaxhighlight lang=bash>
phidget22admin -R -d
</syntaxhighlight>


This command will list all remote Phidgets on the network. Confirm that you can see the Phidgets attached to your host computer. The next step will be running a program that uses the Network Server, luckily, every programming language we support comes with example code on how to do this! Jump to [[#Programming|programming languages]] above.
==Programming==
 
Ready to write some code? Select one of the programming languages below:
 
[[File:Linux_networkserver_phidadminlist.PNG|link=|center]]
 
===Run Network Server on boot===
If you would like the Network Server to run automatically when your computer boots, take a look at [{{SERVER}}/?view=articles&article=Daemon1 this project].
 
 
==Advanced Information==
 
===Setting udev Rules===
 
If you don't want to be using {{Code|sudo}} to run Phidget programs (including the Network Server) forever, you will want to create a {{Code|udev}} rule to allow yourself access to the Phidget when you are not root.
 
Udev has an easy way to set the owner and permissions of the USB interface of the Phidget - it finds all devices that match a given set of rules, and applies new traits to them.  But you need to give udev something to match in order to apply the new settings.  Here, we will tell udev to match the vendor code for Phidgets, Inc. 


We recommend that you use the rules file included in the library download you have already installed.  Check the README file included in that download for information on how exactly to install it, or continue reading here. 
{{Programming_Languages_Table}}


The rules for udev are kept in files in {{Code|/etc/udev/rules.d/}} and are traditionally grouped into order of running (10 runs before 20, 30, etc) and device type (cd, network, etc).  There should be one or more files in there already. Simply find the file named {{Code|99-libphidget22.rules}} included with our library files, and move it into {{Code|/etc/udev/rules.d/}}.
==Older Versions==
If you need older versions of the Phidget22 Linux libraries, [{{SERVER}}/downloads/phidget22/libraries/linux/libphidget22/ click here].


Strictly speaking, the files run in lexical order (i.e. the order they're listed when you use {{Code|ls}}).  A device can match many rules, and all will apply (if possible).  If conflicting rules are found, the first rule found is followed.
If you need Phidget21 Linux Libraries, [{{SERVER}}/downloads/phidget21/libraries/linux/libphidget/ click here].

Latest revision as of 15:45, 9 September 2024

Getting Started with Linux

Welcome to using Phidgets with Linux!

If you are ready to go, the first step in creating Linux applications with Phidgets is installing our libraries.

Install

The first step to using Phidgets with Linux is installing the Phidget22 libraries.

Supported Distros / Archs
Debian 6 (Squeeze) i386 armel
Debian 7 (Wheezy)
Debian 8 (Jessie) armhf
Debian 9 (Stretch)
Debian 10 (Buster) amd64 arm64
Debian 11 (Bullseye)
Debian 12 (Bookworm)
Ubuntu Xenial 16.04 LTS i386 armhf
Ubuntu Bionic 18.04 LTS amd64 arm64
Ubuntu Focal 20.04 LTS
Ubuntu Jammy 22.04 LTS
Ubuntu Noble 24.04 LTS

If you're running one of the supported distros, we recommend using the Package Install. For other systems, you can use the Source Install.

Install Script

To run the install script and install phidget22, enter the following command in the terminal: 

curl -fsSL https://www.phidgets.com/downloads/setup_linux | bash -
apt-get install -y libphidget22


curl -fsSL https://www.phidgets.com/downloads/setup_linux | sudo -E bash -
sudo apt-get install -y libphidget22

Manual Install

To install our package repository manually, enter the following command in the terminal, replacing distro with your distro codename: 

wget -qO /usr/share/keyrings/phidgets.gpg \
  https://www.phidgets.com/gpgkey/pubring.gpg
echo deb [signed-by=/usr/share/keyrings/phidgets.gpg] \
  http://www.phidgets.com/debian distro main \
  > /etc/apt/sources.list.d/phidgets.list


sudo wget -qO /usr/share/keyrings/phidgets.gpg \
  https://www.phidgets.com/gpgkey/pubring.gpg
echo deb [signed-by=/usr/share/keyrings/phidgets.gpg] \
  http://www.phidgets.com/debian distro main | sudo tee \
  /etc/apt/sources.list.d/phidgets.list > /dev/null

We support Debian releases from 6 to current, and Ubuntu LTS releases from 14.04 to current. If you are using another flavour of Linux (such as Mint), which is based on Ubuntu or Debian, use the corresponding Ubuntu or Debian codename.

Update your package lists: 

apt-get update


sudo apt-get update

Finally, install the Phidget package by entering the command below: 

apt-get install libphidget22


sudo apt-get install libphidget22

Additional Packages

You may also want to apt-get install the following optional packages:

  • libphidget22-dev: The C development libraries for Phidget22
  • libphidget22extra: Extra runtime library required for the Network Server and Admin tools
  • phidget22networkserver: The Phidget Network Server, which enables use of Phidgets over your network
  • libphidget22java: The Java libraries for Phidget22
  • phidget22admin: An administrator utility for listing Phidgets and upgrading firmware
  • phidget22wwwjs: The JavaScript libraries for Phidget22. This package also installs the HTML examples which can be accessed through the web interface


The libraries are now installed on your machine. Next, set up the UDev rules below.

Source Install

To install our libraries, first install libusb-1.0 development libraries. The exact command and package name will vary depending on distribution. For Debian based distributions, including Ubuntu and Mint, the command would be: 

apt-get install libusb-1.0-0-dev


Next, download and unpack the following files:

Open the README file that is included at the top of each directory. This file will give you important information about how to properly install the files.


Libraries are installed in /usr/local/lib by default. If you run into trouble finding the libraries during linking or at runtime, this probably means that /usr/local/lib is not on the library path for your distribution.

You can handle this in a number of ways:

Specify a different install folder during compile 

./configure --prefix=/usr && make && sudo make install

OR Add /usr/local/lib to the system-wide library path 

echo /usr/local/lib >> /etc/ld.so.conf && sudo ldconfig

OR Add /usr/local/lib in your local shell every time 

export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/local/lib

The libraries are now installed on your machine. Next, you should set the UDev Rules.

Setting UDev Rules

By default, Linux will not grant permission to regular users to access physical hardware as a security feature. This means that in order to run Phidgets code from user space you must grant yourself root privileges via sudo. For example:

sudo ./HelloWorld

You can grant access manually or, more commonly, set up a rules file to do it automatically keying off of the vendor code for Phidget USB devices. To do this, create a text file called "99-libphidget22.rules" with the following contents:

  1. All current and future Phidgets - Vendor = 0x06c2, Product = 0x0030 - 0x00af

SUBSYSTEMS=="usb", ACTION=="add", ATTRS{idVendor}=="06c2", ATTRS{idProduct}=="00[3-a][0-f]", MODE="666"

Where mode 666 means every user has permission to read and write to the specified file/device. You need to then move this file to "/etc/udev/rules.d". Now you can run Phidget related code as a regular user without the OS denying permission.

Verify

The best way to verify that your libraries are working properly is to compile and run an example program.


First, download and unpack this C example:

Note: If using the Debian intallation methods, you will need to install the libphidget22-dev package to use the C libraries for Phidget22

Next, open the terminal at the example location. Compile the example by entering the following command: 

 gcc HelloWorld.c -o HelloWorld -lphidget22


Run the HelloWorld example: 

./HelloWorld


Your terminal should look something like this:

Linux helloworld.PNG


The HelloWorld program will simply communicate when a Phidget has been attached or detached, as can be seen in the image above.


Your Phidget is now able to communicate with your development machine. The next step is selecting a programming language so you can start to write some code!

Programming

Ready to write some code? Select one of the programming languages below:

Core Languages Mobile Languages Other Languages
C Sharp C# Objective C Objective C LabVIEW LabVIEW
C/C++ C/C++ Swift Swift Max/MSP Max/MSP
Python Python Android Android Java
Java Java
Visual Basic .NET Visual Basic .NET
JavaScript JavaScript

Older Versions

If you need older versions of the Phidget22 Linux libraries, click here.

If you need Phidget21 Linux Libraries, click here.

Retrieved from "https://www.phidgets.com/docs/index.php?title=OS_-_Linux&oldid=34500"