1002 User Guide: Difference between revisions

From Phidgets Support
No edit summary
 
(39 intermediate revisions by 5 users not shown)
Line 1: Line 1:
__NOINDEX__
<metadesc>The Phidget Analog 4-Output produces a voltage from -10V to +10V and connects to your computer via USB.</metadesc>
[[Category:UserGuide]]
[[Category:UserGuide]]
{{UserguideTOC|1002.jpg|1002}}
==Getting Started==
==Getting Started==
{{UGIntro|1002}}
*[{{SERVER}}/products.php?product_id=1002 1002 PhidgetAnalog 4-Output]
*USB cable and computer
*something to use with the 1002 (multimeter, oscilloscope, device with voltage input, etc.)


===Checking the Contents===
{{UGbox|
'''You should have received:'''
* A PhidgetAnalog 4-Output
* A Mini-USB cable
* A Hardware Mounting Kit
|
'''In order to test your new Phidget you will also need:'''
* A device requiring a 0 to 10V signal
* A multimeter could also be used to monitor the output voltage
||}}


===Connecting the Pieces===
Next, you will need to connect the pieces:
{{UGbox|
[[Image:1002_0_Connecting_the_Hardware.jpg|600px|right|link=]]
#Connect your device to the PhidgetAnalog board using one of the terminal blocks.
#Connect the output of the 1002 to your device. Note the polarity on the underside of the 1002.
#Connect the PhidgetAnalog 4-Output to your computer using the Mini-USB cable.
#Connect the 1002 to your computer using the USB cable.
|
[[File:1002_0_Connecting_the_Hardware.jpg|400px|link=]]
||}}


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


{{UGwin}}
==Using the 1002==
{{UGcontrolpanel|1002}}


===Running Phidgets Sample Program===
{{UgVoltageOutput|1002|}}
*Enable/disable the output voltage by toggling the ''Enable'' button.


{{UGwin2|Analog-full}}
{{ugAddressingInformation}}


{{UGbox|
{{ugUsingYourOwnProgram|1002}}
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===
{{UGmac|PhidgetAnalog 4-Output|Analog-full}}
 
===Using Linux===
{{UGlinux}}
 
===Using Windows Mobile / CE 5.0 / CE 6.0===
{{UGce}}


==Technical Details==
==Technical Details==
===Connections===
The terminal blocks on this board are labelled on the underside to save space:


===General===
[[File:1002_0_Under.jpg|link=|500px|center]]
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.


===Isolation===
===Isolation===
The 1002 is not isolated. All 4 channels use the same ground.
The 1002 is not isolated. All four channels use the same ground.


===Current===
===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.   
The 1002 will limit the available current per channel at ±20mA.  
 
*For reliable results, don’t approach this limit, as it will vary from channel to channel.  
If your application requires a larger current source / sink, the analog output can be used as an input to a larger external amplifier circuit.
*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.   
All the power is supplied by the USB bus.
*If your application requires a larger current source / sink, the 1002 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==
{{UGapih}}
 
===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==
{{UGnext|}}
{{UGhist}}
{{UGrow|March 2011|0|100|Product Release, requires phidget21 2.1.8 or newer}}

Latest revision as of 21:58, 18 November 2024


Getting Started

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

  • 1002 PhidgetAnalog 4-Output
  • USB cable and computer
  • something to use with the 1002 (multimeter, oscilloscope, device with voltage input, etc.)


Next, you will need to connect the pieces:

1002 0 Connecting the Hardware.jpg
  1. Connect the output of the 1002 to your device. Note the polarity on the underside of the 1002.
  2. Connect the 1002 to your computer using the USB cable.


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

Using the 1002

Phidget Control Panel

In order to demonstrate the functionality of the 1002, 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 1002.

First Look

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

1002 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.

Voltage Output

Double-click on the Voltage Output object in order to run the example:

1002 VoltageOutput 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:

  • Set the output voltage by dragging the Voltage slider.
  • Enable/disable the output voltage by toggling the Enable button.

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

Connections

The terminal blocks on this board are labelled on the underside to save space:

1002 0 Under.jpg

Isolation

The 1002 is not isolated. All four channels use the same ground.

Current

The 1002 will limit the available current per channel at ±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 1002 can be used as an input to a larger external amplifier circuit.
  • All the power is supplied by the USB bus.

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=1002_User_Guide&oldid=34690"