1047 User Guide: Difference between revisions

From Phidgets Support
No edit summary
 
(28 intermediate revisions by 4 users not shown)
Line 1: Line 1:
__NOINDEX__
<metadesc>The PhidgetEncoder HighSpeed 4-Input reads up to four encoders simultaneously. Includes 4 digital inputs for reading limit switches.</metadesc>
[[Category:UserGuide]]
[[Category:UserGuide]]
{{UserguideTOC|1047.jpg|1047}}
==Getting Started==
==Getting Started==
{{UGIntro|1047}}
*[{{SERVER}}/products.php?product_id=1047 1047 Encoder Phidget]
*USB cable and computer
*{{CT|Encoder|Encoder}}


===Checking the Contents===
{{UGbox|
'''You should have received:'''
* A PhidgetEncoder Highspeed 4-Input
* A Mini-USB cable
* Four 5-wire encoder cables
|
'''In order to test your new Phidget you will also need:'''
* An incremental encoder with quadrature output and known pinout
* A piece of wire to test the digital input
||}}


===Connecting the Pieces===
Next, you will need to connect the pieces:
{{UGbox|
[[Image:1047_0_Connecting_The_Hardware.jpg|500px|right|link=]]
# Connect the encoder to the PhidgetEncoder Highspeed 4-Input board using one of the 5-wire cables.
# Connect the encoder to the 1047 Encoder Phidget using an encoder cable (Soldering may be required).
# Connect the PhidgetEncoder board to the PC using the Mini-USB cable.
# Connect your device to your computer using the USB cable.
|
[[File:1047_0_Connecting_The_Hardware.jpg|400px|link=]]
||}}


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


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


===Running Phidgets Sample Program===
{{UGEncoderENABLE|1047}}


{{UGwin2|'''Encoder-full'''}}
{{ugDigitalInput|1047|{{UGDigitalInputActiveLow}}}}


{{UGbox|
{{ugAddressingInformation}}
Double Click on the [[File:Ph.jpg|link=]] icon to activate the Phidget Control Panel and make sure that the '''Phidget High Speed Encoder 4-Input''' is properly attached  to your PC.
|[[File:1047_0_Control_Panel_Screen.jpg|400px|link=]]
|
# Double Click on Phidget High Speed Encoder 4-Input in the Phidget Control Panel to bring up the Encoder-full example and check that the box labelled Attached contains the word True. Please note that this is an example program and is not intended to be used in applications. It is meant to show how the API calls can be used and can be a starting point for your own application.
# Make sure your encoder is connected to the Encoder-0 input and select encoder 0 from the dropdown menu.
# Enable the encoder by checking the Enabled check box.
# Rotate the encoder and the relative change will display positive when rotated clockwise and will display negative when rotated counter-clockwise.
# The example will display the time in microseconds that has elapsed since the last position change update received from the device.
# Encoder position will display the absolute position of the encoder since it was initially enabled. Position will increase when the encoder is rotated clockwise and decrease when rotated counterclockwise.
# Index position will display the absolute position that the encoder was in when the last index was reached.
# Counts/second displays the current velocity of the encoder measured in pulses per second.
# Insert a piece of wire connecting ground and Digital Input 3 and a tick mark should appear in the Input3 box.
|[[File:1047_0_Encoder_Screen.jpg|400px|link=]]
}}


===Testing Using Mac OS X===
{{ugUsingYourOwnProgram|1047}}


{{UGmac|Phidget High Speed Encoder 4-Input|Encoder-full}}
==Technical Details==
===General===
The 1047 can be used with a wide assortment of mechanical and optical encoders. The encoder should be of quadrature output type, indicating that there will be two quadrature output channels (usually labeled A and B)  and a third output channel (only on some encoders) to signal when the index pin (a reference point for zero position or a complete revolution) has been reached.


===Using Linux===


{{UGlinux}}
The 1047 is able to read four encoders simultaneously. Encoders are not powered up until all initialization of the device is complete. It is possible to enable some or all encoders, depending on how many of the channels are being used. This can also be used to reduce power consumption when certain encoders are not needed.


===Using Windows Mobile / CE 5.0 / CE 6.0===


{{UGce}}
The 1047 has the added ability to time the duration between a group of quadrature changes.  The time is returned in microseconds. This time value can be used to calculate velocity and acceleration with very high precision.


==Technical Details==


The PhidgetEncoder Highspeed 4-Input can be used with a wide assortment of mechanical and optical encoders. The encoder should be of quadrature output type, indicating that there will be two quadrature output channels (usually labeled A and B)  and a third output channel (only on some encoders) to signal when the index pin (a reference point for zero position or a complete revolution) has been reached.
If the number of quadrature counts per revolution is unknown for a particular encoder, this value can be determined by using the index signal. In addition, it is possible to monitor how many counts have occurred since the last index. The index signal is an output only on certain encoders. Refer to the encoder’s description to check if this third output channel exists or not. If the encoder does not have this signal, it is still possible to use it with the 1046, but an event for the index will never get triggered.  


The PhidgetEncoder Highspeed 4-Input is able to read four encoders simultaneously.  Encoders are not powered up until all initialization of the device is complete.  It is possible to enable some or all encoders, depending on how many of the channels are being used.  This can also be used to reduce power consumption when certain encoders are not needed.


The PhidgetEncoder Highspeed 4-Input has the added ability to time the duration between a group of quadrature changes. The time is returned in microseconds. This time value can be used to calculate velocity and acceleration with very high precision.  
The maximum rate of the 1046 is specified at 250,000 quadrature cycles per second. Since this device counts pulses rather than cycles, you could also say that it counts a maximum of 1,000,000 pulses per second (since there are four pulses in a cycle). In your application, these numbers relate directly to the number of revolutions per second you wish to measure, and the number of counts per revolution specified for your encoder. If your encoder's wheel has 1000 counts per revolution, then the limit on measurable revolutions per second is 250, or 15,000 rpm (which, for the 1047, corresponds to 1000 position changes in software per second).


If the number of quadrature counts per revolution is unknown for a particular encoder, this value can be determined by using the index signal.  In addition, it is possible to monitor how many counts have occurred since the last index.  The index signal is an output only on certain encoders.  Refer to the encoder’s description to check if this third output channel exists or not.  If the encoder does not have this signal, it is still possible to use it with the PhidgetEncoder Highspeed 4-Input, but an event for the index will never get triggered.


The maximum rate of the PhidgetEncoder Highspeed 4-Input is specified at 250,000 quadrature cycles per second. Since this device counts pulses rather than cycles, you could also say that it counts a maximum of 1,000,000 pulses per second (since there are four pulses in a cycle). In your application, these numbers relate directly to the number of revolutions per second you wish to measure, and the number of counts per revolution specified for your encoder. If your encoder's wheel has 1000 counts per revolution, then the limit on measurable revolutions per second is 250, or 15,000rpm (which, for the 1047, corresponds to 1000 position changes in software per second).
One of the most common problems encountered with connecting encoders to a 1047 is a strange ''jitter'' characterized by the encoder position appearing to switch back and forth between 0 and 1 or -1 and nothing else. This is usually indicative of a bad connection on either the A or B channel. You should check that the wiring is sound and try again.


One of the most common problems encountered with connecting encoders to a 1047 is a strange "jitter" characterized by the encoder position appearing to switch back and forth between 0 and 1 or -1 and nothing else. This is usually indicative of a bad connection on either the A or B channel.  You should check that the wiring is sound and try again.
===Choosing Encoders===
The 1046 incorporates a 10 kOhm pull-up resistor on each line from the encoder input connector. If your encoder is mechanical, these pull-up resistors eliminate the requirement to add your own external pull-up resistors.


===Choosing Encoders===
Some optical encoders will have a simple photo-transistor/open-collector output. The 10 kOhm pull-up resistor may have to be augmented with a stronger parallel resistor if your optical encoder datasheet calls for itSome open-collector outputs will not be strong enough to pull this resistor to ground. These encoders are not compatible with the 1047, and may only work initially, or not at all. If you have any doubts, please contact us.
The PhidgetEncoder Highspeed 4-Input incorporates a 10 kOhm pull-up resistor on each line from the encoder input connectorIf your encoder is mechanical, these pull-up resistors eliminate the requirement to add your own external pull-up resistors.


Some optical encoders will have a simple photo-transistor / open-collector output.  The 10 kOhm pull-up resistor may have to be augmented with a stronger parallel resistor if your optical encoder datasheet calls for it.  Some open-collector outputs will not be strong enough to pull this resistor to ground.  These encoders are not compatible with the 1047, and may only work initially, or not at all.  If you have any doubts, please contact us.


Most optical encoders have a push-pull output, and the pull-up resistor is irrelevant, but weak enough not cause problems.
Most optical encoders have a push-pull output, and the pull-up resistor is irrelevant, but weak enough not cause problems.


We have reviewed the following encoders, and found that they can be used with the PhidgetEncoder Highspeed 4-Input. This is not meant to be a comprehensive list but should be used as examples of the type of encoders that can be used with the 1047.
We have reviewed the following encoders, and found that they can be used with the PhidgetEncoder Highspeed 4-Input. This is not meant to be a comprehensive list but should be used as examples of the type of encoders that can be used with the 1047.




{| style="border:1px solid darkgray;" cellpadding="7px;"
{|class = "wikitable"
|-style="background: #f0f0f0" align=center
| align="center" style="background:#f0f0f0;"|'''Manufacturer '''
! Manufacturer || Web Page || Part Number
| align="center" style="background:#f0f0f0;"|'''Web Page'''
| align="center" style="background:#f0f0f0;"|'''Part Number'''
|-
|-
|style="background: #F8F8F8" align=left| Grayhill
|align=center| Grayhill
|style="background: #F8F8F8" align=left| [http://www.Grayhill.com www.Grayhill.com]
|align=center| [http://www.Grayhill.com www.Grayhill.com]
|style="background: #F8F8F8" align=left| Series 63R, Series 61R Series 63Q TTL Output
|align=center| Series 63R, Series 61R Series 63Q TTL Output
|-
|-
|style="background: #F8F8F8" align=left| US Digital (Recommended)
|align=center| US Digital (Recommended)
|style="background: #F8F8F8" align=left| [http://www.USDigital.com www.USDigital.com]
|align=center| [http://www.USDigital.com www.USDigital.com]
|style="background: #F8F8F8" align=left| S4, S5, E2, E3, E4, E4P, etc.
|align=center| S4, S5, E2, E3, E4, E4P, etc.
|-
|-
|style="background: #F8F8F8" align=left| Avago Technologies (Formerly Agilent)
|align=center| Avago Technologies (Formerly Agilent)
|style="background: #F8F8F8" align=left| [http://www.avagotech.com www.avagotech.com]
|align=center| [http://www.avagotech.com www.avagotech.com]
|style="background: #F8F8F8" align=left| HEDS 5500
|align=center| HEDS 5500
|-
|-
|style="background: #F8F8F8" align=left| CUI Inc.
|align=center| CUI Inc.
|style="background: #F8F8F8" align=left| [http://www.cui.com www.cui.com]
|align=center| [http://www.cui.com www.cui.com]
|style="background: #F8F8F8" align=left| AMT103-V
|align=center| AMT103-V
|-
|-
|}
|}
Line 109: Line 86:




{| style="border:1px solid darkgray;" cellpadding="7px;"
{|class = "wikitable"
|-style="background: #f0f0f0" align=center
| align="center" style="background:#f0f0f0;"|'''Manufacturer '''
! Manufacturer || Part Number || Description
| align="center" style="background:#f0f0f0;"|'''Part Number'''
| align="center" style="background:#f0f0f0;"|'''Description'''
|-
|-
|style="background: #F8F8F8" align=left| Molex
|align=center| Molex
|style="background: #F8F8F8" align=left| 50-57-9405
|align=center| 50-57-9405
|style="background: #F8F8F8" align=left| 5 Position Cable Connector
|align=center| 5 Position Cable Connector
|-
|-
|style="background: #F8F8F8" align=left| Molex
|align=center| Molex
|style="background: #F8F8F8" align=left| 16-02-0102
|align=center| 16-02-0102
|style="background: #F8F8F8" align=left| Wire Crimp Insert for Cable Connector
|align=center| Wire Crimp Insert for Cable Connector
|-
|-
|style="background: #F8F8F8" align=left| Molex
|align=center| Molex
|style="background: #F8F8F8" align=left| 70543-0004
|align=center| 70543-0004
|style="background: #F8F8F8" align=left| 5 Position Vertical PCB Connector
|align=center| 5 Position Vertical PCB Connector
|-
|-
|style="background: #F8F8F8" align=left| Molex
|align=center| Molex
|style="background: #F8F8F8" align=left| 70553-0004
|align=center| 70553-0004
|style="background: #F8F8F8" align=left| 5 Position Right-Angle PCB Connector (Gold)
|align=center| 5 Position Right-Angle PCB Connector (Gold)
|-
|-
|style="background: #F8F8F8" align=left| Molex
|align=center| Molex
|style="background: #F8F8F8" align=left| 70553-0039
|align=center| 70553-0039
|style="background: #F8F8F8" align=left| 5 Position Right-Angle PCB Connector (Tin)
|align=center| 5 Position Right-Angle PCB Connector (Tin)
|-
|-
|style="background: #F8F8F8" align=left| Molex
|align=center| Molex
|style="background: #F8F8F8" align=left| 15-91-2055
|align=center| 15-91-2055
|style="background: #F8F8F8" align=left| 5 Position Right-Angle PCB Connector - Surface Mount
|align=center| 5 Position Right-Angle PCB Connector - Surface Mount
|-
|-
|}
|}
Line 143: Line 121:


===Further Reading===
===Further Reading===
If you want to know more about encoders, check out the [[Encoder Guide]]. If you'd like to know more about the digital inputs on the 1047, visit the [[Digital Input Guide]].


If you want to know more about encoders, check out the [[Encoder Primer]].
{{UGnext|}}
 
If you'd like to know more about the digital inputs on the 1047, visit the [[Digital Input Primer]].
 
==API==
{{UGapih}}
 
===Functions===
 
{{UGapi|int InputCount() [get] : Constant
|Returns the number of digital inputs supported by this PhidgetEncoder.  On the 1047, there are 4 digital inputs.
}}
 
{{UGapi|bool InputState (int EncoderIndex) [get]
|Returns the state of a particular digital input.
}}
 
{{UGapi|int EncoderCount() [get] : Constant
|Returns the number of encoders supported by this PhidgetEncoder Highspeed 4-Input.  The 1047 supports up to four optical quadrature encoders. 
}}
 
{{UGapi|int Position(int EncoderIndex) [get,set]
|Returns/sets the position of an encoder. This is an absolute position as calculated since the encoder was plugged in.  Dividing position by the number of increments per revolution will give the number of rotations the encoder has travelled. Encoder position is returned in number of pulses, which is equivalent to four-times the number of encoder counts.
 
:Position can be set, typically used when an encoder has reached an identifiable (through external means, such as a limit switch) home position. This call does not send information to the device, as an absolute position is maintained only in the library. After this call, position changes from the encoder will use the new value to calculate absolute position.
}}
 
{{UGapi|int IndexPosition(int EncoderIndex) [get]
|Returns the index position of an enabled encoder. This will typically return the same value as Position(int EncoderIndex) except for on the event that an index has occurred, where it will return the exact position at which the encoder index was triggered.
}}
 
{{UGapi|bool Enabled(int EncoderIndex) [get,set]
|Returns true if the requested encoder is enabled; returns false if the requested encoder is disabled. Can be set true or false to decide whether the encoder is turned on or off. Disabled encoders will not draw power, detect position changes or trigger index events. Enabled encoders will draw power and trigger any requested events.
}}
 
===Events===
 
{{UGapi|OnPositionChange(int EncoderIndex, int Time, int PositionChange) [event]
|An event that is issued whenever a change in encoder position occurs on an enabled encoder.  This event returns the length of time that the change took (in microseconds), and the amount of change (positive/negative encoder increments) for that particular encoder.
}}
 
{{UGapi|OnInputChange(int InputIndex, bool State) [event]
|An event that is issued whenever the state of a digital input changes.
}}
 
<span style="color:#ff0000">'''C and .NET based APIs only:'''</span>
 
{{UGapi|OnIndexChange(int EncoderIndex, int IndexPosition) [event]
|An event that is issued whenever there is a pulse on the index pin. (Note: Many encoders do not support the index channel and leave the index pin unconnected)
}}
 
==Product History==
{{UGhist}}
{{UGrow2|1047_0|June 2010  |0|100|Product Release}}
{{UGrow2|1047_0|May 2011    |0|101|getLabelString fixed for labels of length >7}}
{{UGrow2|1047_0|January 2012|0|102|Fixed initial power state of channels 3 and 4}}
{{UGrow2|1047_1|June 2012  |1|102|Replaced power switches for added stability}}

Latest revision as of 19:39, 1 June 2023


Getting Started

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


Next, you will need to connect the pieces:

1047 0 Connecting The Hardware.jpg
  1. Connect the encoder to the 1047 Encoder Phidget using an encoder cable (Soldering may be required).
  2. Connect your device to your computer using the USB cable.


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

Using the 1047

Phidget Control Panel

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

First Look

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

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

Encoder

Double-click on the Encoder object, labelled Encoder Input, in order to run the example:

1047 Encoder 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:

  • Toggle the Enabled checkbox to enable/disable the 1047.
  • Specify a counts per revolution (CPR) value to enable velocity calculation.
  • Position Change: the number of ticks (or quadrature cycles) that have occurred since the last change event.
  • Time Change: the amount of time in milliseconds that has elapsed since the last change event.
  • Position: the total position in ticks relative to where the encoder was when the window was opened.
  • Index Position: the position where the index channel was last encountered. Some encoders do not support index, check your encoder's datasheet for more information.
  • Velocity: the average velocity in rotations per second. A CPR must be specified to enable this functionality.


Digital Input

Double-click on a Digital Input object in order to run the example:

1047 DigitalInput 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:

  • This is an active-low device, therefore, it will be true when connected to ground, and false when connected to a high voltage.

For more information about Digital Inputs, take a look at the Digital Input Primer

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 1047 can be used with a wide assortment of mechanical and optical encoders. The encoder should be of quadrature output type, indicating that there will be two quadrature output channels (usually labeled A and B) and a third output channel (only on some encoders) to signal when the index pin (a reference point for zero position or a complete revolution) has been reached.


The 1047 is able to read four encoders simultaneously. Encoders are not powered up until all initialization of the device is complete. It is possible to enable some or all encoders, depending on how many of the channels are being used. This can also be used to reduce power consumption when certain encoders are not needed.


The 1047 has the added ability to time the duration between a group of quadrature changes. The time is returned in microseconds. This time value can be used to calculate velocity and acceleration with very high precision.


If the number of quadrature counts per revolution is unknown for a particular encoder, this value can be determined by using the index signal. In addition, it is possible to monitor how many counts have occurred since the last index. The index signal is an output only on certain encoders. Refer to the encoder’s description to check if this third output channel exists or not. If the encoder does not have this signal, it is still possible to use it with the 1046, but an event for the index will never get triggered.


The maximum rate of the 1046 is specified at 250,000 quadrature cycles per second. Since this device counts pulses rather than cycles, you could also say that it counts a maximum of 1,000,000 pulses per second (since there are four pulses in a cycle). In your application, these numbers relate directly to the number of revolutions per second you wish to measure, and the number of counts per revolution specified for your encoder. If your encoder's wheel has 1000 counts per revolution, then the limit on measurable revolutions per second is 250, or 15,000 rpm (which, for the 1047, corresponds to 1000 position changes in software per second).


One of the most common problems encountered with connecting encoders to a 1047 is a strange jitter characterized by the encoder position appearing to switch back and forth between 0 and 1 or -1 and nothing else. This is usually indicative of a bad connection on either the A or B channel. You should check that the wiring is sound and try again.

Choosing Encoders

The 1046 incorporates a 10 kOhm pull-up resistor on each line from the encoder input connector. If your encoder is mechanical, these pull-up resistors eliminate the requirement to add your own external pull-up resistors.

Some optical encoders will have a simple photo-transistor/open-collector output. The 10 kOhm pull-up resistor may have to be augmented with a stronger parallel resistor if your optical encoder datasheet calls for it. Some open-collector outputs will not be strong enough to pull this resistor to ground. These encoders are not compatible with the 1047, and may only work initially, or not at all. If you have any doubts, please contact us.


Most optical encoders have a push-pull output, and the pull-up resistor is irrelevant, but weak enough not cause problems.


We have reviewed the following encoders, and found that they can be used with the PhidgetEncoder Highspeed 4-Input. This is not meant to be a comprehensive list but should be used as examples of the type of encoders that can be used with the 1047.


Manufacturer Web Page Part Number
Grayhill www.Grayhill.com Series 63R, Series 61R Series 63Q TTL Output
US Digital (Recommended) www.USDigital.com S4, S5, E2, E3, E4, E4P, etc.
Avago Technologies (Formerly Agilent) www.avagotech.com HEDS 5500
CUI Inc. www.cui.com AMT103-V

Connectors

Each Input uses a 5-pin, 0.100 inch pitch locking connector. The connectors are commonly available - refer to the Table below for manufacturer part numbers.


Manufacturer Part Number Description
Molex 50-57-9405 5 Position Cable Connector
Molex 16-02-0102 Wire Crimp Insert for Cable Connector
Molex 70543-0004 5 Position Vertical PCB Connector
Molex 70553-0004 5 Position Right-Angle PCB Connector (Gold)
Molex 70553-0039 5 Position Right-Angle PCB Connector (Tin)
Molex 15-91-2055 5 Position Right-Angle PCB Connector - Surface Mount


Note: Most of the above components can be bought at Digikey.

Further Reading

If you want to know more about encoders, check out the Encoder Guide. If you'd like to know more about the digital inputs on the 1047, visit the Digital Input 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.