Phidgets Support - Recent changes [en]

Language - C

2026-06-11T21:08:33Z

C Libraries

← Older revision		Revision as of 21:08, 11 June 2026
Line 6:		Line 6:

	== C Libraries ==		== C Libraries ==
	If you've installed the Phidget drivers for [[OS - Windows\|Windows]], [[OS - macOS\|~~MacOS~~]], or [[OS - Linux\|Linux]], then you already have the files you need for your C project.		If you've installed the Phidget drivers for [[OS - Windows\|Windows]], [[OS - macOS\|macOS]], or [[OS - Linux\|Linux]], then you already have the files you need for your C project.

	==== Windows Considerations ====		==== Windows Considerations ====

Using XLights with Phidgets

2026-06-10T22:23:16Z

Mparadis moved page Using XLights with Phidgets to Using xLights with Phidgets

New page

[[Category: Project]]
{{TOC limit|3}}
{{#seo:|keywords=xLights, ws2812, christmas lights}}
{{#seo:|description=Learn how to use a Phidgets addressable LED controller with xLights software.}}
==Introduction==
[[Image:xLights.png|400px|thumb|link=]]
xLights is a free and open-source comprehensive light control platform that helps create small or large light displays quickly, without the need for coding. This guide will walk you through how to add the Addressable LED Phidget as a controller in xLights.

== Demonstration ==
<center>{{#ev:youtube|G6JIiXuTe18|rel=0}}</center>

==Hardware==
This project uses the following parts:
* [{{SERVER}}/?prodid=969 PhidgetSBC4 (SBC3003_0)]
* [{{SERVER}}/?prodid=1368 Addressable LED Phidget (LED0100_0)]
* [{{SERVER}}/?tier=2&catid=28&pcid=24 USB Cable]
* [{{SERVER}}/?tier=1&catid=61&pcid=54 12V Power Supply for PhidgetSBC]
* [{{SERVER}}/?prodid=1011&pcid=77 Ethernet cable]
* 16x16 Addressable LED Array
* 5V 3.5A Power Supply for LEDs
* Windows, macOS or Linux computer

==Assembly==
[[Image:xL_setup.png|link=|700px]]

Assemble the system following these steps:
* Connect your LED array to the Addressable LED Phidget
* Connect the Addressable LED Phidget to the PhidgetSBC4 using a USB cable
* Connect the PhidgetSBC4 to your network router or switch with an ethernet cable
* Connect the 12V power supply to the PhidgetSBC
* Connect the LED power supply to the Addressable LED Phidget. Here, our LED array requires 5V.

== Server Setup ==

=== SBC Web Configuration ===
In this project, we'll be using a client (our desktop computer) and a server (the PhidgetSBC4).

To start, we need prepare the PhidgetSBC4 with the required packages and configurations. Log into the SBC's web interface by double clicking on its control panel entry:

[[Image:xL_controlpanel.png|link=|center]]

Next, follow these steps:
#Log in and navigate to '''System -> Packages'''.
#Install the '''C/C++ Development Tools/Headers'''.
#'''Refresh Available Packages''' and '''Upgrade All Packages'''

[[Image:xL_packages.png|link=|center]]

Finally, go to '''Network -> Settings''' and enable the SSH server if it isn't already enabled.

=== Installing the Server ===

Now that SSH is enabled, we can remote in with SSH software (we recommend [https://www.chiark.greenend.org.uk/~sgtatham/putty/ PuTTY]). Or, you can plug a monitor and keyboard into the SBC4 and complete the rest of this section in the terminal directly.

If you don't already have '''git''' installed, you can get it with the following commands:
<syntaxhighlight lang=bash>
apt update
apt install git
</syntaxhighlight>

If you don't already have the '''make''' command installed, you can get it with:
<syntaxhighlight lang=bash>
apt install build-essential
</syntaxhighlight>

Navigate to '''/usr/userapps/''' (you'll have to create the userapps directory if this is the first project on this SBC) and use the following command to download the server project files:
<syntaxhighlight lang=bash>
git clone https://github.com/PhidgetsInc/openpixelcontrol-ph22.git
</syntaxhighlight>

All of the files and folders for the server code will be added in a folder named '''openpixelcontrol-ph22'''.

If you're not experienced with the terminal, we recommend switching back to the SBC web interface at this point. Go to the '''Projects''' tab and you should see the project folder. Click on the folder to open it.

[[Image:xL_project1.png|link=|center]]

Scroll down and click the '''make''' button to build the project.

[[Image:xL_make.png|link=|center]]

Once it's done building you can test the server by returning to your SSH terminal and typing '''./bin/Phidget_server''' from the project folder. If it's successful, you should see this:

[[Image:xL_serverRunning.png|link=|center]]

Once the server is running, we can configure our client.

== Client Setup ==

To begin, install [https://xlights.org/ xLights] on your client computer.

=== Controller Configuration ===

Open xLights and add a new ethernet controller under the controllers tab:

[[Image:xL_controller.png|link=|center]]

* The '''Protocol''' should be set to 'OPC'.
* The '''Message Data Size''' should be equal to the number of LEDs in your display multiplied by the number of color channels. This project uses a 16x16 grid of RGB lights, so the data size is 768. For a strand of 100 RGBW lights, the data size would be 400.
* The '''IP address''' needs to be set to the SBC's IP, which you can find in the Phidget Control Panel:

[[Image:xL_IP.png|link=|center]]

=== Layout Configuration ===

The layout lets you accurately model your lights in xLights. For a simple LED strip click on "Single Line", and for a grid, use "Matrix". Then click and drag in the black space to create the model.
[[Image:xL_layout.png|link=|center]]

Once it's created, click on your model to access the options.
[[Image:xL_layoutOptions.png|link=|center]]

We won't be going in depth on all the layout options in this article, but you can find more information in xLights' official documentation. For now, the important thing is to select '''Use Start Channel''' for the controller. Next, click on start channel and click on the '...' that appears. For '''Universe number''' select the IP address of the SBC.
[[Image:xL_universe.png|link=|center]]

In order to have our 16x16 grid display properly, the Strings, Nodes/String, and Strands/String must be set to 4, 64, and 4. This is because the LEDs are laid out in a zig-zag pattern. If you're using a strip, you can just set it to 1, N, 1, where N is the number of lights in your strip.

=== Sequencer ===

Once your controller and layout are set up, you can move to the sequencer tab and do '''File -> New Sequence'''. Select 'Animation', '40fps', and 'Quick Start'.

Now you can choose one of the effects from the effects bar and drag it into the row in the timeline corresponding to the layout you created. Drag it out so it lasts longer than a few seconds. Click on the play button, and you should see the effect play out on the preview in the bottom left. You can play with the Effect Settings and Colors windows to customize the effect.
[[Image:xL_timeline.png|link=|center]]

Further details on creating sequences fall outside of the scope of this article, but you can see the official xLights documentation for more information.

Now that your sequence is set up, you can click the lightbulb icon to attempt to connect to the SBC's server.
[[Image:xL_bulb.png|link=|center]]

If it's successful, you'll see the IP address of your client appear in your SSH terminal:
[[Image:xL_sshConnect.png|link=|center]]

When you hit play, you should see your lights activate.

[[Image:animation.gif|link=|center]]

== Running the Project on Boot ==

Now that you've confirmed the server and client work using SSH or a local terminal, we can set the program to launch on boot as a daemon.

Open the SBC web interface again and navigate to your project. Scroll down to '''Startup Settings''' and enable it, selecting '''bin/Phidget_server''' as the executable and clicking the save button below.

[[Image:xL_startup.png|link=|center]]

The next time you power cycle the SBC, the server will run and you should be able to connect with your xLights client.

== Running Autonomously on the SBC ==

You may find that having a second computer running the xLights app 24/7 is a bit overkill for the size and scope of your project. If you just want the SBC to run a few patterns on a loop all by itself, but you still want to use xLights to design the pattern, you can have the SBC act as both client and server for the OPC stream.

Open an SSH connection and go back to the /userapps/ directory on your SBC. Run the following command:
<syntaxhighlight lang=bash>
git clone https://github.com/PhidgetsInc/opcdecode-ph22.git
</syntaxhighlight>

This project requires '''libzstd''' to run. Install it with the following command:
<syntaxhighlight lang=bash>
apt install libzstd-dev
</syntaxhighlight>

You should now have a second project visible in the SBC web interface:

[[Image:xL_project2.png|link=|center]]

Click on openpixelcontrol-ph22 and start the project:

[[Image:xL_startProj.png|link=|center]]

Then go back and do the same for opcdecode-ph22. You should see your lights turn on and display the default pattern.

You can now configure both projects to run on boot as we did in the previous section, which will cause the pattern to display autonomously on boot, even if the SBC isn't connected to any network. You can design and save your own sequence in xLights and copy the .fseq file to the SBC to customize the pattern.

Using XLights with Phidgets

2026-06-10T22:11:43Z

Created page with "Category: Project {{TOC limit|3}} {{#seo:|keywords=xLights, ws2812, christmas lights}} {{#seo:|description=Learn how to use a Phidgets addressable LED controller with xLights software.}} ==Introduction== 400px|thumb|link= xLights is a free and open-source comprehensive light control platform that helps create small or large light displays quickly, without the need for coding. This guide will walk you through how to add the Addressable LED Phidge..."

New page

File:XL startProj.png

2026-06-10T22:11:03Z

Mparadis uploaded File:XL startProj.png

New page

File:XL project2.png

2026-06-10T22:10:48Z

Mparadis uploaded File:XL project2.png

New page

File:XL startup.png

2026-06-10T22:10:36Z

Mparadis uploaded File:XL startup.png

New page

File:Animation.gif

2026-06-10T22:10:25Z

Mparadis uploaded File:Animation.gif

New page

File:XL sshConnect.png

2026-06-10T22:10:17Z

Mparadis uploaded File:XL sshConnect.png

New page

File:XL bulb.png

2026-06-10T22:10:06Z

Mparadis uploaded File:XL bulb.png

New page

File:XL timeline.png

2026-06-10T22:09:56Z

Mparadis uploaded File:XL timeline.png

New page

File:XL universe.png

2026-06-10T22:09:46Z

Mparadis uploaded File:XL universe.png

New page

File:XL layoutOptions.png

2026-06-10T22:09:38Z

Mparadis uploaded File:XL layoutOptions.png

New page

File:XL layout.png

2026-06-10T22:09:25Z

Mparadis uploaded File:XL layout.png

New page

File:XL IP.png

2026-06-10T22:09:17Z

Mparadis uploaded File:XL IP.png

New page

File:XL controller.png

2026-06-10T22:08:28Z

Mparadis uploaded File:XL controller.png

New page

File:XL serverRunning.png

2026-06-10T22:08:16Z

Mparadis uploaded File:XL serverRunning.png

New page

File:XL make.png

2026-06-10T22:08:07Z

Mparadis uploaded File:XL make.png

New page

File:XL project1.png

2026-06-10T22:07:52Z

Mparadis uploaded File:XL project1.png

New page

File:XL packages.png

2026-06-10T22:07:41Z

Mparadis uploaded File:XL packages.png

New page

File:XL controlpanel.png

2026-06-10T22:07:20Z

Mparadis uploaded File:XL controlpanel.png

New page

File:XL setup.png

2026-06-10T22:07:11Z

Mparadis uploaded File:XL setup.png

New page

File:XLights.png

2026-06-10T22:06:46Z

Mparadis uploaded File:XLights.png

New page

Language - JavaScript

2026-06-10T17:35:18Z

← Older revision		Revision as of 17:35, 10 June 2026
Line 14:		Line 14:

	===Node.js Applications===		===Node.js Applications===
	For Node.js applications, a [https://www.npmjs.com/package/phidget22 npm package] is available and can be installed with the following command:		For Node.js applications, an [https://www.npmjs.com/package/phidget22 npm package] is available and can be installed with the following command:
	<syntaxhighlight lang=javascript>		<syntaxhighlight lang=javascript>
	npm install phidget22		npm install phidget22

Language - Swift

2026-06-10T17:34:21Z

← Older revision		Revision as of 17:34, 10 June 2026
(One intermediate revision by the same user not shown)
Line 5:		Line 5:
	With the Phidget22 library, it's easy to create Swift applications that work with Phidget devices.		With the Phidget22 library, it's easy to create Swift applications that work with Phidget devices.

	== Swift ~~Libraries~~ ==		== Swift Library ==
	~~If you've installed the Phidget drivers~~ for ~~[[OS -~~ macOS~~\|macOS]] or [[OS~~ - ~~iOS\|iOS]], then you already have~~ the ~~files you need for your project~~.		===SwiftPM===
			The Swift library for macOS and iOS is available via Swift Package Manager (SwiftPM) here:
			<syntaxhighlight>https://www.phidgets.com/git/phidget22-swift.git</syntaxhighlight>

			Note that the old CocoaPods release has been discontinued.

	====macOS Considerations====		====macOS Considerations====

Language - Max

2026-06-01T16:28:12Z

← Older revision		Revision as of 16:28, 1 June 2026
(One intermediate revision by the same user not shown)
Line 6:		Line 6:

	==Max Libraries==		==Max Libraries==
	To develop on Max with Phidgets, ~~you'll need~~ the [https://www.phidgets.com/downloads/phidget22/libraries/windows/Phidget22MaxMSP.zip ~~Phidgets~~ Max ~~Library~~].		To develop on Max with Phidgets, download the Max externals:
			* [https://www.phidgets.com/downloads/phidget22/libraries/windows/Phidget22MaxMSP.zip Max externals for Windows]
			* [https://www.phidgets.com/downloads/phidget22/libraries/macos/Phidget22MaxMSP.zip Max externals for macOS]

	Unpack the zip file and copy the appropriate folder:		Unpack the zip file and copy the appropriate folder:
	* For 32-bit Max, copy the '''x86''' folder.		* For 32-bit Max on Windows, copy the '''x86''' folder.
	* For 64-bit Max, copy the '''x64''' folder.		* For 64-bit Max on Windows, copy the '''x64''' folder.
			* For macOS, copy the '''externals''' folder.

	The folder you copied needs to be placed in a specific location for Max to reference it. Open Max and navigate to '''Options -> File Preferences'''.		The folder you copied needs to be placed in a specific location for Max to reference it. Open Max and navigate to '''Options -> File Preferences'''.

Language - C

2026-05-27T19:58:04Z

GCC

← Older revision		Revision as of 19:58, 27 May 2026
Line 62:		Line 62:
	After running the commands above for either Cygwin or MinGW, an executable file called example.exe will be created. Enter the following command to run the program:		After running the commands above for either Cygwin or MinGW, an executable file called example.exe will be created. Enter the following command to run the program:
	<syntaxhighlight lang=bash>		<syntaxhighlight lang=bash>
	example.exe		./example.exe
	</syntaxhighlight>		</syntaxhighlight>
	{{hiddenh4\|MacOS}}		{{hiddenh4\|MacOS}}

Template:DCMotor ESTOP

2026-05-26T21:45:15Z

← Older revision		Revision as of 21:45, 26 May 2026
Line 15:		Line 15:

	The E-Stop input is shorted with a jumper wire by default. If you would like to implement an E-Stop system, we recommend connecting a normally-closed (NC) switch to the E-Stop input.		The E-Stop input is shorted with a jumper wire by default. If you would like to implement an E-Stop system, we recommend connecting a normally-closed (NC) switch to the E-Stop input.

			[[Image:Multi_estop.png\|link=\|thumb\|A 3PST E-stop switch\|100px]]
			====Multiple Motor Controllers====

			If your project uses multiple motor controllers with E-Stops, we recommend wiring them separately because wiring them together can cause ground loops that introduce instability. The best solution is to buy a multi-throw E-Stop switch that provides a separate circuit for each controller.

			You can search for on an electronics retailer like Digikey for a DPST-NC switch for two controllers, or 3PST/4PST for three or four.

	====Other Considerations====		====Other Considerations====
	The E-Stop circuit does not physically interact with the supply voltage or the motor connection. You should not wire your motor, or your supply voltage to this circuit.		The E-Stop circuit does not physically interact with the supply voltage or the motor connection. You should not wire your motor, or your supply voltage to this circuit.

File:Multi estop.png

2026-05-26T21:42:37Z

Mparadis uploaded File:Multi estop.png

New page

BLDCMotor API Guide

2026-05-26T19:37:17Z

← Older revision		Revision as of 19:37, 26 May 2026
Line 20:		Line 20:
	\|-\|		\|-\|
	DCC1100=		DCC1100=
	[[Image:DCC1100_0.jpg\|link=https://cdn.phidgets.com/docs/images/8/87/DCC1100_0.jpg\|thumb\|200px\|[https://www.phidgets.com/?prodid=~~1013~~ Brushless DC Motor Phidget (~~DCC1100_0~~)]]]		[[Image:DCC1100_0.jpg\|link=https://cdn.phidgets.com/docs/images/8/87/DCC1100_0.jpg\|thumb\|200px\|[https://www.phidgets.com/?prodid=1391 Brushless DC Motor Phidget (DCC1100_1)]]]
	[https://www.phidgets.com/?prodid=~~1013~~ Brushless DC Motor Phidget (~~DCC1100_0~~)] considerations:		[https://www.phidgets.com/?prodid=1391 Brushless DC Motor Phidget (DCC1100_1)] considerations:
	* Stall Velocity is not covered in this guide. Information on this topic is available in the device API.		* Stall Velocity is not covered in this guide. Information on this topic is available in the device API.
	\|-\|		\|-\|

OS - Android

2026-05-25T21:52:16Z

Direct USB Connection

← Older revision		Revision as of 21:52, 25 May 2026
Line 19:		Line 19:

	The best way to know before getting your hands on a device is to check its specifications for whether it can serve as a USB host. Alternately, a quick way to figure out if your device can serve as a USB host is to try plugging other devices (such as a mouse, or USB memory stick) into your Android device.		The best way to know before getting your hands on a device is to check its specifications for whether it can serve as a USB host. Alternately, a quick way to figure out if your device can serve as a USB host is to try plugging other devices (such as a mouse, or USB memory stick) into your Android device.

			To allow the use of the network and/or USB connections, the following lines must be added to your AndroidManifest.xml file:
			<syntaxhighlight>
			<!-- Required for network access -->
			<uses-permission android:name="android.permission.INTERNET" />

			<!-- Required for USB access -->
			<uses-feature android:name="android.hardware.usb.host" />
			</syntaxhighlight>

			You'll need to initialize the method that the Android device can use to communicate with the Phidget.

			<syntaxhighlight lang="Java">
			//Allow direct USB connection of Phidgets
			com.phidget22.usb.Manager.Initialize(this);
			</syntaxhighlight>

			Once the device is closed, to completely clean up after using Phidgets, you must uninitialize the USB connection as follows:

			<syntaxhighlight lang="Java">
			//Disable USB connection to Phidgets
			com.phidget22.usb.Manager.Uninitialize();
			</syntaxhighlight>

	==Network Server==		==Network Server==