Notice: This page contains information for the legacy Phidget21 Library. Phidget21 is out of support. Bugfixes may be considered on a case by case basis. Phidget21 does not support VINT Phidgets, or new USB Phidgets released after 2020. We maintain a selection of legacy devices for sale that are supported in Phidget21. We recommend that new projects be developed against the Phidget22 Library.
|
1002 User Guide: Difference between revisions
(→Events) |
No edit summary |
||
(32 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
__NOINDEX__ | |||
[[Category:UserGuide]] | |||
{{UserguideTOC|1002.jpg|1002}} | |||
==Getting Started== | ==Getting Started== | ||
===Checking the Contents=== | ===Checking the Contents=== | ||
{| | {{UGbox| | ||
'''You should have received:''' | |||
* A PhidgetAnalog 4-Output | * A PhidgetAnalog 4-Output | ||
* A Mini-USB cable | * A Mini-USB cable | ||
* A Hardware Mounting Kit | * A Hardware Mounting Kit | ||
| | |||
'''In order to test your new Phidget you will also need:''' | |||
* A device requiring a 0 to 10V signal | * A device requiring a 0 to 10V signal | ||
* A multimeter could also be used to monitor the output voltage | * A multimeter could also be used to monitor the output voltage | ||
|} | ||}} | ||
===Connecting the Pieces=== | ===Connecting the Pieces=== | ||
{ | {{UGbox| | ||
| | |||
#Connect your device to the PhidgetAnalog board using one of the terminal blocks. | #Connect your device to the PhidgetAnalog board using one of the terminal blocks. | ||
#Connect the PhidgetAnalog 4-Output to your computer using the Mini-USB cable. | #Connect the PhidgetAnalog 4-Output to your computer using the Mini-USB cable. | ||
| | | | ||
[[File:1002_0_Connecting_the_Hardware.jpg|400px|link=]] | |||
||}} | |||
|} | |||
===Testing Using Windows 2000 / XP / Vista / 7=== | ===Testing Using Windows 2000 / XP / Vista / 7=== | ||
{{UGwin}} | |||
===Running Phidgets Sample Program=== | ===Running Phidgets Sample Program=== | ||
{{UGwin2|Analog-full}} | |||
{{UGbox| | |||
If you | Double click on the [[File:Ph.jpg|link=]] icon to activate the Phidget Control Panel and make sure that the '''Phidget Analog 4-output''' is properly attached to your PC. | ||
| | |||
[[File:1002_0_Control_Panel_Screen.jpg|400px|link=]] | |||
| | |||
# Double click on '''Phidget Analog 4-output''' in the Phidget Control Panel to bring up Analog-full and check that the box labelled Attached contains the word True. | |||
# Enable the Channel to which your device is connected. | |||
# Use the slider to set the voltage. Your device should react according to the set voltage. If you are using a multimeter, it should display the voltage as set by the slider. | |||
| | |||
[[File:1002 0 Analog Screen.jpg|400px|link=]] | |||
}} | |||
===Testing Using Mac OS X=== | ===Testing Using Mac OS X=== | ||
{{UGmac|PhidgetAnalog 4-Output|Analog-full}} | |||
===Using Linux=== | ===Using Linux=== | ||
{{UGlinux}} | |||
===Using Windows Mobile / CE 5.0 / CE 6.0=== | ===Using Windows Mobile / CE 5.0 / CE 6.0=== | ||
{{UGce}} | |||
==Technical Details== | ==Technical Details== | ||
===General=== | |||
Produces a voltage over -10V to +10V. This voltage will be asserted up to +-20mA (short-circuit). An error will be reported when this current is exceeded, and the voltage the customer is getting is no longer accurate. The voltage is produced with 12 bit resolution (4.8mV). The update rate or frequency of the outputs is dependant on the speed of your system. | |||
===Connections=== | |||
The terminal blocks on this board are labelled on the underside to save space: | |||
[[File:1002_0_Under.jpg|link=|400px]] | |||
===Isolation=== | |||
The 1002 is not isolated. All 4 channels use the same ground. | |||
===Current=== | |||
The PhidgetAnalog board will limit the available current per channel at approximately 20mA. For reliable results, don’t approach this limit, as it will vary from channel to channel. For maximum accuracy, limit the current to 5mA. If more than +- 20mA of current is drawn, the device goes into a constant current supply mode. When this happens, the current will be held constant at it’s maximum value, and the output voltage will depend on the value of the load that the device is trying to drive. | |||
If your application requires a larger current source / sink, the analog output can be used as an input to a larger external amplifier circuit. | |||
All the power is supplied by the USB bus. | |||
===Further Reading=== | |||
For more information on analog outputs, see the [[Analog Output Primer]]. | |||
==API== | ==API== | ||
{{UGapih}} | |||
===Functions=== | |||
===Functions | {{UGapi|int OutputCount() [get]|Gets the number of analog outputs supported by the PhidgetAnalog.}} | ||
{{UGapi|double Voltage(int OutputIndex) [get, set]|Gets or sets the current voltage output setting for an analog output, in Volts. The range is VoltageMinVoltageMax. Voltage is not actually applied until Enabled is set to true.}} | |||
{{UGapi|double VoltageMin(int OutputIndex) [get]|Gets the minimum supported output voltage, for an output, in Volts.}} | |||
{{UGapi|double VoltageMax(int OutputIndex) [get]|Gets the maximum supported output voltage, for an output, in Volts.}} | |||
{{UGapi|bool Enabled(int OutputIndex) [get, set]|Gets the enabled state for an output. When enabled, the output drives at the set Voltage, up to 20mA. When disabled, the output is tied to ground via a 4K pull-down.}} | |||
===Events=== | |||
{{UGapi|OnError(int ErrorCode, String ErrorDescription)|The PhidgetAnalog will throw error events under certain circumstances:}} | |||
* '''ErrorCode = EEPHIDGET_OVERCURRENT''' | |||
:An overcurrent condition has occured on an output. Under this condition, the output is clamped to 20mA. | |||
* '''ErrorCode <nowiki>=</nowiki> EEPHIDGET_OVERTEMP''' | |||
:A Thermal Shutdown state has occured. The outputs will be shut down under this condition. | |||
When overcurrent or overtemperature state have ended, there will be an error event with the '''EEPHIDGET_OK''' code. | |||
See the ErrorDescription string for specific error details. | |||
==Product History== | ==Product History== | ||
{{UGhist}} | |||
{{UGrow|March 2011|0|100|Product Release, requires phidget21 2.1.8 or newer}} | |||
{{UGrow|May 2011 |0|101|getLabelString fix for lables > 7 characters}} |
Latest revision as of 14:26, 9 May 2018
Go to this device's product page |
Getting Started
Checking the Contents
You should have received:
|
In order to test your new Phidget you will also need:
| |
Connecting the Pieces
|
| |
Testing Using Windows 2000 / XP / Vista / 7
Make sure you have the current version of the Phidget library installed on your PC. If you don't, follow these steps:
- Go to the Quick Downloads section on the Windows page
- Download and run the Phidget21 Installer (32-bit, or 64-bit, depending on your system)
- You should see the icon on the right hand corner of the Task Bar.
Running Phidgets Sample Program
Double clicking on the icon loads the Phidget Control Panel; we will use this program to ensure that your new Phidget works properly.
The source code for the Analog-full sample program can be found in the quick downloads section on the C# Language Page. If you'd like to see examples in other languages, you can visit our Languages page.
Updating Device Firmware
If an entry in this list is red, it means the firmware for that device is out of date. Double click on the entry to be given the option of updating the firmware. If you choose not to update the firmware, you can still run the example for that device after refusing.
Double click on the icon to activate the Phidget Control Panel and make sure that the Phidget Analog 4-output is properly attached to your PC. |
| |
|
|
Testing Using Mac OS X
- Go to the Quick Downloads section on the Mac OS X page
- Download and run the Phidget OS X Installer
- Click on System Preferences >> Phidgets (under Other) to activate the Preference Pane
- Make sure that the PhidgetAnalog 4-Output is properly attached.
- Double Click on PhidgetAnalog 4-Output in the Phidget Preference Pane to bring up the Analog-full Sample program. This program will function in a similar way as the Windows version.
Using Linux
For a step-by-step guide on getting Phidgets running on Linux, check the Linux page.
Using Windows Mobile / CE 5.0 / CE 6.0
For a step-by-step guide on getting Phidgets running on Windows CE, check the Windows CE page.
Technical Details
General
Produces a voltage over -10V to +10V. This voltage will be asserted up to +-20mA (short-circuit). An error will be reported when this current is exceeded, and the voltage the customer is getting is no longer accurate. The voltage is produced with 12 bit resolution (4.8mV). The update rate or frequency of the outputs is dependant on the speed of your system.
Connections
The terminal blocks on this board are labelled on the underside to save space:
Isolation
The 1002 is not isolated. All 4 channels use the same ground.
Current
The PhidgetAnalog board will limit the available current per channel at approximately 20mA. For reliable results, don’t approach this limit, as it will vary from channel to channel. For maximum accuracy, limit the current to 5mA. If more than +- 20mA of current is drawn, the device goes into a constant current supply mode. When this happens, the current will be held constant at it’s maximum value, and the output voltage will depend on the value of the load that the device is trying to drive.
If your application requires a larger current source / sink, the analog output can be used as an input to a larger external amplifier circuit.
All the power is supplied by the USB bus.
Further Reading
For more information on analog outputs, see the Analog Output Primer.
API
We document API Calls specific to this product in this section. Functions common to all Phidgets and functions not applicable to this device are not covered here. This section is deliberately generic. For calling conventions under a specific language, refer to the associated API manual in the Quick Downloads section for that language. For exact values, refer to the device specifications.
Functions
int OutputCount() [get]
- Gets the number of analog outputs supported by the PhidgetAnalog.
double Voltage(int OutputIndex) [get, set]
- Gets or sets the current voltage output setting for an analog output, in Volts. The range is VoltageMinVoltageMax. Voltage is not actually applied until Enabled is set to true.
double VoltageMin(int OutputIndex) [get]
- Gets the minimum supported output voltage, for an output, in Volts.
double VoltageMax(int OutputIndex) [get]
- Gets the maximum supported output voltage, for an output, in Volts.
bool Enabled(int OutputIndex) [get, set]
- Gets the enabled state for an output. When enabled, the output drives at the set Voltage, up to 20mA. When disabled, the output is tied to ground via a 4K pull-down.
Events
OnError(int ErrorCode, String ErrorDescription)
- The PhidgetAnalog will throw error events under certain circumstances:
- ErrorCode = EEPHIDGET_OVERCURRENT
- An overcurrent condition has occured on an output. Under this condition, the output is clamped to 20mA.
- ErrorCode = EEPHIDGET_OVERTEMP
- A Thermal Shutdown state has occured. The outputs will be shut down under this condition.
When overcurrent or overtemperature state have ended, there will be an error event with the EEPHIDGET_OK code. See the ErrorDescription string for specific error details.
Product History
Date | Board Revision | Device Version | Comment |
---|---|---|---|
March 2011 | 0 | 100 | Product Release, requires phidget21 2.1.8 or newer |
May 2011 | 0 | 101 | getLabelString fix for lables > 7 characters |