OS - Linux: Difference between revisions

From Phidgets Support
No edit summary
No edit summary
Line 10: Line 10:
|}
|}
===Install===
===Install===
The first step to using Phidgets with Linux is installing the Phidget22 libraries. If your Linux machine is running 32-bit Debian, select the '''Debian Install''' tab below.
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 '''Install Script'''. If you aren't a fan of curl scripts, you can manually use the '''Debian Install''' packages. For other systems, you can use the '''Source Install'''.  


<div class="bigTabs">
<div class="bigTabs">
<tabber>
<tabber>
Generic Install=
Install Script=
====Generic Install====
====Install Script====
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:
To run the install script, enter the following command in the terminal:
<syntaxhighlight lang=bash>
apt-get install libusb-1.0-0-dev
</syntaxhighlight>


{{LinuxInstallScript}}


Next, download and unpack the following files:
You may also want to apt-get install the following optional packages:
*[{{SERVER}}/downloads/phidget22/libraries/linux/libphidget22.tar.gz libphidget22] (Mandatory)
* '''libphidget22-dev''': The C development libraries for Phidget22
*[{{SERVER}}/downloads/phidget22/libraries/linux/libphidget22extra.tar.gz libphidget22extra] (Optional - needed by NetworkServer and Admin)
* '''libphidget22extra''': Extra runtime library required for the Network Server and Admin tools
*[{{SERVER}}/downloads/phidget22/libraries/linux/libphidget22java.tar.gz libphidget22java] (Optional - Java Libraries)
* '''phidget22networkserver''': The [[Phidget Network Server]], which enables use of Phidgets over your network
*[{{SERVER}}/downloads/phidget22/servers/linux/phidget22networkserver.tar.gz phidget22networkserver] (Optional - [[Phidget Network Server]])
* '''libphidget22java''': The Java libraries for Phidget22
*[{{SERVER}}/downloads/phidget22/tools/linux/phidget22admin.tar.gz phidget22admin] (Optional - Phidget Admin Tool)
* '''phidget22admin''': An administrator utility which helps keep track of who is connected to your Phidgets over the network server
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.
* '''phidget22wwwjs''': The JavaScript libraries for Phidget22. This package also installs the HTML examples which can be accessed through the web interface




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.
The libraries are now installed on your machine. Next, let's verify that they are working properly.
 
|-|
You can handle this in a number of ways:
Debian Install=
 
====Debian Install====
Specify a different install folder during compile
To install our libraries on Debian, first enter the following command in the terminal if you are running Debian ''buster'':
<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>


The libraries are now installed on your machine. Next, let's verify that they are working properly. Jump ahead to [[#Verify | verifying]].
{{LinuxGetKey}}
|-|
Debian Install (Root)=
====Debian Install (Root)====
To install our libraries on Debian from the root account, first enter the following command in the terminal if you are running Debian ''buster'':
<syntaxhighlight lang=bash>
wget -qO- http://www.phidgets.com/gpgkey/pubring.gpg | apt-key add - && echo 'deb http://www.phidgets.com/debian buster main' > /etc/apt/sources.list.d/phidgets.list
</syntaxhighlight>


If you are running ''squeeze'' (Debian 6), ''wheezy'' (Debian 7), ''jessie'' (Debian 8), or ''stretch'' (Debian 9) simply replace ''buster'' in the command above with your release. If you are running Ubuntu 16.04, replace ''buster'' with ''xenial''.
If you are running ''squeeze'' (Debian 6), ''wheezy'' (Debian 7), ''jessie'' (Debian 8), or ''stretch'' (Debian 9) simply replace ''buster'' in the command above with your release. If you are running Ubuntu 16.04, replace ''buster'' with ''xenial''.


Update your package lists:
Update your package lists:
<syntaxhighlight lang=bash>
{{LinuxAptUpdate}}
apt-get update
</syntaxhighlight>
 


Finally, install the Phidget package by entering the command below:
Finally, install the Phidget package by entering the command below:
<syntaxhighlight lang=bash>
{{LinuxAptInstall}}
apt-get install libphidget22
</syntaxhighlight>


You may also want to apt-get install the following optional packages:
You may also want to apt-get install the following optional packages:
Line 75: Line 58:
The libraries are now installed on your machine. Next, let's verify that they are working properly.
The libraries are now installed on your machine. Next, let's verify that they are working properly.
|-|
|-|
Debian Install (Non-Root)=
Source Install=
====Debian Install (Non-Root)====
====Source Install====
To install our libraries on Debian from any account other than root, first enter the following command in the terminal if you are running Debian ''buster'':
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>
wget -qO- http://www.phidgets.com/gpgkey/pubring.gpg | sudo apt-key add - && sudo bash -c "echo 'deb http://www.phidgets.com/debian buster main' > /etc/apt/sources.list.d/phidgets.list"
apt-get install libusb-1.0-0-dev
</syntaxhighlight>
</syntaxhighlight>


If you are running ''squeeze'' (Debian 6), ''wheezy'' (Debian 7), ''jessie'' (Debian 8), or ''stretch'' (Debian 9) simply replace ''buster'' in the command above with your release. If you are running Ubuntu 16.04, replace ''buster'' with ''xenial''.


Update your package lists:
Next, download and unpack the following files:
<syntaxhighlight lang=bash>
*[{{SERVER}}/downloads/phidget22/libraries/linux/libphidget22.tar.gz libphidget22] (Mandatory)
sudo apt-get update
*[{{SERVER}}/downloads/phidget22/libraries/linux/libphidget22extra.tar.gz libphidget22extra] (Optional - needed by NetworkServer and Admin)
</syntaxhighlight>
*[{{SERVER}}/downloads/phidget22/libraries/linux/libphidget22java.tar.gz libphidget22java] (Optional - Java Libraries)
*[{{SERVER}}/downloads/phidget22/servers/linux/phidget22networkserver.tar.gz phidget22networkserver] (Optional - [[Phidget Network Server]])
*[{{SERVER}}/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.




Finally, install the Phidget package by entering the command below:
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.
<syntaxhighlight lang=bash>
sudo apt-get install libphidget22
</syntaxhighlight>


You may also want to apt-get install the following optional packages:
You can handle this in a number of ways:
* '''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 which helps keep track of who is connected to your Phidgets over the network server
* '''phidget22wwwjs''': The JavaScript libraries for Phidget22. This package also installs the HTML examples which can be accessed through the web interface


Specify a different install folder during compile
<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>


The libraries are now installed on your machine. Next, let's verify that they are working properly.
The libraries are now installed on your machine. Next, let's verify that they are working properly. Jump ahead to [[#Verify | verifying]].
</tabber>
</tabber>
</div>
</div>

Revision as of 18:10, 4 March 2021

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 Install Script. If you aren't a fan of curl scripts, you can manually use the Debian Install packages. For other systems, you can use the Source Install.

Install Script

To run the install script, 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

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 which helps keep track of who is connected to your Phidgets over the network server
  • 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, let's verify that they are working properly.

Debian Install

To install our libraries on Debian, first enter the following command in the terminal if you are running Debian buster:

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

If you are running squeeze (Debian 6), wheezy (Debian 7), jessie (Debian 8), or stretch (Debian 9) simply replace buster in the command above with your release. If you are running Ubuntu 16.04, replace buster with xenial.

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

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 which helps keep track of who is connected to your Phidgets over the network server
  • 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, let's verify that they are working properly.

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, let's verify that they are working properly. Jump ahead to verifying.

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

Advanced Information

Setting udev Rules

If you don't want to be using sudo to run Phidget programs (including the Network Server) forever, you will want to create a 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.

The rules for udev are kept in files in /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 99-libphidget22.rules included with our library files, and move it into /etc/udev/rules.d.

Strictly speaking, the files run in lexical order (i.e. the order they're listed when you use the ls command). A device can match many rules, and all will apply (if possible). If conflicting rules are found, the first rule found is followed.

Older Versions

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

If you need Phidget21 Linux Libraries, click here.