1031 User Guide: Difference between revisions

From Phidgets Support
No edit summary
 
(20 intermediate revisions by 3 users not shown)
Line 1: Line 1:
__NOINDEX__
<metadesc>The PhidgetLED-64 controls the brightness and forward voltage of up to 64 LEDs. Connects to your computer via USB.</metadesc>
[[Category:UserGuide]]
[[Category:UserGuide]]
{{UserguideTOC|1031.jpg|1031}}
==Getting Started==
==Getting Started==
{{UGIntro|1031}}
*[{{SERVER}}/products.php?product_id=1031 1031 PhidgetLED-64]
*USB cable and computer
*power supply
*LEDs and cables


===Checking the Contents===
{{UGbox|
'''You should have received:'''
* A PhidgetLED-64 Advanced board
* A 12VDC 2 Amps power supply
* 16 4-wire cables (for LEDs)
* A Mini-USB Cable
|
'''In order to test your new Phidget you will also need:'''
* Some LEDs
||}}


===Connecting the Pieces===
Next, you will need to connect the pieces:
{{UGbox|
[[Image:1031_0_Connecting_The_Hardware.jpg|500px|right|link=]]
#Connect the power supply to the PhidgetLED using the barrel connector.
# Connect the power supply to the barrel jack. If your power supply does not have a jack, you can connect the wires to the power terminal beside it, making sure the polarity is correct.
# Cut one of the 4-wire cables to an appropriate length. Strip the wire ends and solder 2 LEDs to each cable. The longer lead of the LED (the anode) is connected to the red wire, and the shorter lead of the LED (the cathode, also marked with a notch in the base of the plastic case) is connected to the black wire. Insert the end of the 4-wire LED cable into the board connector.
# Connect LEDs to the PhidgetLED's outputs. You can slide the pins of an LED into the connector (short end to a black wire, and the long end to the red wire beside it), or you can cut the LED cable in half and solder the LED on.
# Connect the PhidgetLED to your computer using the MiniUSB cable.
# Connect the PhidgetLED to your computer using the USB cable.
|
[[File:1031_0_Connecting_The_Hardware.jpg|400px|link=]]
||}}


===Testing Using Windows 2000 / XP / Vista / 7===
<br clear="all">
{{UGIntroDone|1031}}


{{UGwin}}


===Running Phidgets Sample Program===
==Using the 1031==


{{UGwin2|'''LED-full'''}}
{{UGcontrolpanel|1031}}


{{UGbox|
{{ugDigitalOutputLED|1031}}
Double Click on the [[File:Ph.jpg|link=]] icon to activate the Phidget Control Panel and make sure that the  '''Phidget LED 64 Advanced''' is properly attached  to your PC.
|[[File:1031_0_Control_Panel_Screen.jpg|400px|link=]]
|
# Double Click on Phidget LED 64 Advanced in the Phidget Control Panel to bring up LED-full and check that the box labelled Attached contains the word True.
# Select the LED Index.  If you connected your LEDs at the same position as the ones in the picture on the previous page, select 18, 19, 22 or 23.
# Use the LED Brightness slider to increase or decrease the LED brightness.
# Select from the drop-down menu an appropriate anode voltage: 1.7V, 2.75V, 3.9V, or 5V.
# Select from the drop-down menu an appropriate current limit: 20mA, 40mA, 60mA, or 80mA.
|[[File:1031_0_LED_Screen.jpg|400px|link=]]
}}


===Testing Using Mac OS X===
{{ugAddressingInformation}}


{{UGmac|Phidget LED 64 Advanced |LED-full}}
{{ugUsingYourOwnProgram|1031}}
 
===Using Linux===
 
{{UGlinux}}
 
===Using Windows Mobile / CE 5.0 / CE 6.0===
 
{{UGce}}


==Technical Details==
==Technical Details==
 
===General===
The 1031 uses four controller chips that allow you to vary the current and voltage supplied to each channel. It does not use pulse-width modulation, another common control method for LEDs.
The 1031 uses four controller chips that allow you to vary the current and voltage supplied to each channel. It does not use pulse-width modulation, another common control method for LEDs.


===Multiple LEDs on a Single Channel===
===Multiple LEDs on a Single Channel===
You can have multiple LEDs hooked up to a single channel on the 1031, (for example, a short string of LEDs) to reduce the amount of wiring, although keep in mind that you'll lose control of the individual lights, and can only toggle or dim the entire string. When using multiple LEDs on a single channel, you'll need to increase the voltage limit for that channel. If the LEDs are too dim at the maximum voltage, you should spread them out to other channels.  
You can have multiple LEDs hooked up to a single channel on the 1031, (for example, a short string of LEDs) to reduce the amount of wiring, although keep in mind that you'll lose control of the individual lights, and can only toggle or dim the entire string. When using multiple LEDs on a single channel, you'll need to increase the voltage limit for that channel. If the LEDs are too dim at the maximum voltage, you should spread them out to other channels.  


===High-Current Considerations===
===High-Current Considerations===
If you're using high-current LEDs, you should spread your load evenly across the board to avoid having one of the controller chips overheat. There are four controller chips, each controlling the channels on a quarter of the board.  
If you're using high-current LEDs, you should spread your load evenly across the board to avoid having one of the controller chips overheat. There are four controller chips, each controlling the channels on a quarter of the board.  
{| class ="wikitable"
| align="center" style="background:#f0f0f0;"|'''Controller'''
| align="center" style="background:#f0f0f0;"|'''Channels '''
|-
|align=center| 1
|align=center| 0, 1, 2, 3, 4, 5, 6, 7, 24, 25, 26, 27, 28, 29, 30, 31
|-
|align=center| 2
|align=center| 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23
|-
|align=center| 3
|align=center| 32, 33, 34, 35, 36, 37, 38, 39, 56, 57, 58, 59, 60, 61, 62, 63
|-
|align=center| 4
|align=center| 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55
|}


'''Controller 1:''' 0, 1, 2, 3, 4, 5, 6, 7, 24, 25, 26, 27, 28, 29, 30, 31
===Board Connector Diagram===
[[File:1031_0_Connector_Drawing.jpg|400px|link=|center]]


'''Controller 2:''' 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23


'''Controller 3:''' 32, 33, 34, 35, 36, 37, 38, 39, 56, 57, 58, 59, 60, 61, 62, 63
The connector used on the 1031 LED board is a Molex 70543-0003. The mating connector used on our LED cables is the Molex 50-57-9404.
 
'''Controller 4:''' 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55
 
===Board Connector Diagram===
 
[[File:1031_0_Connector_Drawing.jpg|400px|link=]]


===Further Reading===
===Further Reading===
For more information, take a look at the [[LED Guide]].


For more information, take a look at the [[LED Primer]].
{{UGnext|}}
 
==API==
{{UGapih}}
 
===Functions===
{{UGapi|int LEDCount() [get] : Constant
|Returns the number of LEDs that this board can drive. This may not correspond to the actual number of LEDs attached.
}}
 
{{UGapi|int DiscreteLED(int LEDIndex) [get,set]
|Sets/Gets the brightness of an LED. Valid values are 0-100, with 0 being off and 100 being the brightest. This 0-100 value is converted internally to an 7-bit value (0-127).
}}
 
{{UGapi|int CurrentLimit() [get,set]
|Sets/Gets the current limit. Valid current limits are 20mA, 40mA, 60mA and 80mA, these will generally be delimited with an enumerator where possible, or an integer where not. The default current limit is 20mA.
}}
 
{{UGapi|int Voltage() [get,set]
|Sets/Gets the output voltage. Valid voltages are 1.7V, 2.75V, 3.9V and 5V, these will generally be delimited with an enumerator where possible, or an integer where not. The default voltage is 2.75V.
}}
 
===Events===
{{UGapi|Error(String errorDescription, int errorCode) [event]
|1031 uses the generic error event to stream back fault conditions. The fault can be identified by the errorDescriptionstring. The only fault currently reported is Thermal Shutdown (TSD).
}}
 
==Product History==
{{UGhist}}
{{UGrow|March 2010|0|100|Product Release}}
{{UGrow|May 2011|0|101|getLabelString fix for labels > 7 characters}}

Latest revision as of 17:04, 1 June 2023


Getting Started

Welcome to the 1031 user guide! In order to get started, make sure you have the following hardware on hand:


Next, you will need to connect the pieces:

1031 0 Connecting The Hardware.jpg
  1. Connect the power supply to the barrel jack. If your power supply does not have a jack, you can connect the wires to the power terminal beside it, making sure the polarity is correct.
  2. Connect LEDs to the PhidgetLED's outputs. You can slide the pins of an LED into the connector (short end to a black wire, and the long end to the red wire beside it), or you can cut the LED cable in half and solder the LED on.
  3. Connect the PhidgetLED to your computer using the USB cable.


Now that you have everything together, let's start using the 1031!


Using the 1031

Phidget Control Panel

In order to demonstrate the functionality of the 1031, the Phidget Control Panel running on a Windows machine will be used.


The Phidget Control Panel is available for use on both macOS and Windows machines.

Windows

To open the Phidget Control Panel on Windows, find the Ph.jpg icon in the taskbar. If it is not there, open up the start menu and search for Phidget Control Panel

Windows PhidgetTaskbar.PNG

macOS

To open the Phidget Control Panel on macOS, open Finder and navigate to the Phidget Control Panel in the Applications list. Double click on the Ph.jpg icon to bring up the Phidget Control Panel.


For more information, take a look at the getting started guide for your operating system:


Linux users can follow the getting started with Linux guide and continue reading here for more information about the 1031.

First Look

After plugging the 1031 into your computer and opening the Phidget Control Panel, you will see something like this:

1031 Panel.jpg


The Phidget Control Panel will list all connected Phidgets and associated objects, as well as the following information:

  • Serial number: allows you to differentiate between similar Phidgets.
  • Channel: allows you to differentiate between similar objects on a Phidget.
  • Version number: corresponds to the firmware version your Phidget is running. If your Phidget is listed in red, your firmware is out of date. Update the firmware by double-clicking the entry.


The Phidget Control Panel can also be used to test your device. Double-clicking on an object will open an example.

Digital Output (LED)

Double-click on a Digital Output object, labelled LED Driver, in order to run the example:

1031 DigitalOutputLED Example.jpg


General information about the selected object will be displayed at the top of the window. You can also experiment with the following functionality:

  • From the Forward Voltage drop-down menu, select the appropriate voltage for your LED. It is recommended to set the forward voltage to the first setting above the maximum voltage specified by your LED's datasheet.
  • Use the Current Limit slider to set an appropriate limit for your LED. The current limit will be specified in your LED's datasheet.
  • Use the large button to toggle power to the LED.
  • Use the Duty Cycle slider to precisely control the amount of power supplied to the LED.


Finding The Addressing Information

Before you can access the device in your own code, and from our examples, you'll need to take note of the addressing parameters for your Phidget. These will indicate how the Phidget is physically connected to your application. For simplicity, these parameters can be found by clicking the button at the top of the Control Panel example for that Phidget.

The locate Phidget button is found in the device information box

In the Addressing Information window, the section above the line displays information you will need to connect to your Phidget from any application. In particular, note the Channel Class field as this will be the API you will need to use with your Phidget, and the type of example you should use to get started with it. The section below the line provides information about the network the Phidget is connected on if it is attached remotely. Keep track of these parameters moving forward, as you will need them once you start running our examples or your own code.

All the information you need to address your Phidget

Using Your Own Program

You are now ready to start writing your own code for the device. The best way to do that is to start from our Code Samples.

Select your programming language of choice from the drop-down list to get an example for your device. You can use the options provided to further customize the example to best suit your needs.

Code Sample Choose Language.png


Once you have your example, you will need to follow the instructions on the page for your programming language to get it running. To find these instructions, select your programming language from the Programming Languages page.

Technical Details

General

The 1031 uses four controller chips that allow you to vary the current and voltage supplied to each channel. It does not use pulse-width modulation, another common control method for LEDs.

Multiple LEDs on a Single Channel

You can have multiple LEDs hooked up to a single channel on the 1031, (for example, a short string of LEDs) to reduce the amount of wiring, although keep in mind that you'll lose control of the individual lights, and can only toggle or dim the entire string. When using multiple LEDs on a single channel, you'll need to increase the voltage limit for that channel. If the LEDs are too dim at the maximum voltage, you should spread them out to other channels.

High-Current Considerations

If you're using high-current LEDs, you should spread your load evenly across the board to avoid having one of the controller chips overheat. There are four controller chips, each controlling the channels on a quarter of the board.

Controller Channels
1 0, 1, 2, 3, 4, 5, 6, 7, 24, 25, 26, 27, 28, 29, 30, 31
2 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23
3 32, 33, 34, 35, 36, 37, 38, 39, 56, 57, 58, 59, 60, 61, 62, 63
4 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55

Board Connector Diagram

1031 0 Connector Drawing.jpg


The connector used on the 1031 LED board is a Molex 70543-0003. The mating connector used on our LED cables is the Molex 50-57-9404.

Further Reading

For more information, take a look at the LED Guide.

What to do Next

  • Programming Languages - Find your preferred programming language here and learn how to write your own code with Phidgets!
  • Phidget Programming Basics - Once you have set up Phidgets to work with your programming environment, we recommend you read our page on to learn the fundamentals of programming with Phidgets.


Retrieved from "https://www.phidgets.com/docs/index.php?title=1031_User_Guide&oldid=33664"