View source for 1054 User Guide

[[Category:UserGuide]]
{{UserguideTOC|1054.jpg|1054}}
==Getting Started==

===Checking the Contents===
{{UGbox|
'''You should have received:'''
* A PhidgetFrequencyCounter
* A Mini-USB cable
|
'''In order to test your new Phidget you will also need:'''
* A Frequency producing device such as a flow meter or tachometer
||}}

===Connecting the Pieces===
{{UGbox|
# Connect your sensor to the PhidgetFrequencyCounter channel 0. We are using a Flow Meter that requires an external +12V power supply.  The ground of the power supply, sensor and 1054 are all connected together.   If your sensor requires +5V, it can be powered directly by the 1054.
# Connect the PhidgetFrequencyCounter to your computer using the  Mini-USB cable.
|
[[File:1054_0_Connecting_The_Hardware.jpg|400px|link=]]
||}}

===Testing Using Windows 2000 / XP / Vista / 7===

{{UGwin}}

===Running Phidgets Sample Program===

{{UGwin2|'''FrequencyCounter-full'''}}

{{UGbox|
Double Click on the [[File:Ph.jpg|link=]] icon to activate the Phidget Control Panel and make sure that the '''PhidgetFrequencyCounter''' is properly attached  to your PC.
|[[File:1054_0_Control_Panel_Screen.jpg|400px|link=]]
|
# Double Click on '''PhidgetFrequencyCounter''' in the Phidget Control Panel to bring up FrequencyCounter-full and check that the box labelled Attached contains the word True.
# Select channel 0.
# Click in the box to enable the device.
# Select Logic Level or Zero Crossing, depending on your sensor.  See the Technical Section for help.
# The Timeout default of 1000 ms is fine for most applications.
# Count Events shows the number of pulses in the last measurement interval.
# Frequency is calculated from the number of pulses in the last measurement interval.
# Total count is the total number of pulses counted since the application started or the 1054 reset.
# Total Time is the elapsed time since the application started or the 1054 reset.
|[[File:1054_0_FrequencyCounter_Screen.jpg|400px|link=]]
}}

===Testing Using Mac OS X===

{{UGmac|PhidgetFrequencyCounter|FrequencyCounter-full}}

===Using Linux===

{{UGlinux}}

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

{{UGce}}

==Technical Details==

The PhidgetFrequencyCounter contains two channels to sense two different inputs.  Each channel has two different circuits to sense for logic level-frequencies or zero-centered frequencies.  The measurable frequency is accurate to 0.25% up to 1MHz.  The Frequency Counter may measure frequencies past 1 Mhz, but the input voltage specifications will not hold. The PhidgetFrequencyCounter can measure frequencies down to ~ 0.01Hz. However the response time of these measurements is directly related to the frequency, thus it could take 1 or 2 periods(100-200s) to detect the input frequency. 

===Logic-Level Frequencies===

The logic-level sensing circuit has a hysteresis range from 0.9V to 2.4V.  This will allow the circuit to count both 3.3V and 5V logic levels.  In addition to logic-level signals, this will also accept the pulses from sensors with open collector outputs. When the input signals are either 3.3V or 5V, the maximum sensed frequency is 1.5Mhz. Most digital sensors that are powered from a signal positive power supply will output a logic-level frequency.

===Zero-Centered Frequencies===
The zero-centered sensing circuit can be used for input signals where you want to count as it crosses zero volts. A hysteresis of 30mVpp filters noise.  At maximum frequency (1Mhz), a signal of 400mVPP is required for reliable counting. A common application that uses a zero centered frequency output is a simple magnetic tachometer, which produces a sine wave around 0 volts.

===Differential Inputs===
The PhidgetFrequencyCounter uses differential inputs - that is, the voltage being compared is the difference between the (+) and (-) inputs.  If your application has a slightly different ground from your USB ground, the common mode rejection in the 1054 will handle small differences in ground. For many applications, the signal being measured is single ended - that is, your sensor outputs only one signal, and you can directly connect the ground of the sensor to the ground of the 1054.  In this case, ensure the (-) input is tied to ground.  Never allow either input to be left unconnected.

===Output Voltage===
USB Voltage is passed directly to the +5V terminal on the green blocks.  

==API==
{{UGapih}}

===Enums===
{{UGapi|
'''enum <nowiki>{</nowiki>'''
::'''ZERO_CROSSING <nowiki>=</nowiki> 1,'''
::'''LOGIC_LEVEL'''
'''<nowiki>}</nowiki> FilterType'''
|Determines the signal type that the PhidgetFrequencyCounter responds to.
}}
===Functions===

{{UGapi|double Frequency(int ChannelIndex) [get]
|Gets the last calculated frequency on the specified channel, in Hz. This function will return 0 if The Timeout value elapses without detecting a signal. Frequency is recalculated up to 31.25 times a second, depending on the pulse rate.
}}

{{UGapi|int64 TotalCount(int ChannelIndex) [get]
|Gets the total number of pulses detected on the specified channel since the Phidget was opened, or since the last reset.
}}

{{UGapi|int64 TotalTime(int ChannelIndex) [get]
|Gets the total elapsed time since Phidget was opened, or since the last reset, in microseconds. This property complements the TotalCount property.
}}

{{UGapi|int Timeout[get,set]
|Gets or set the Timeout value, in microseconds. This value is used to set the time to wait without detecting a signal before reporting 0 Hz.  The valid range in 0.1 - 100 seconds (100,000 - 100,000,000 microseconds). 1/Timeout represents the lowest frequency that will be measurable.
}}

{{UGapi|int Filter(int ChannelIndex, FilterType filter) [get, set]
|Gets or set the channel filter mode. This controls the type of signal that the frequency counter will respond to - either a zero-centered signal, or a logic level signal.
}}

{{UGapi|bool Enabled(int ChannelIndex) [get, set]
|Gets or sets the enabled state on the specified channel. When a channel is disabled, it will no longer register counts. TotalTime and TotalCount properties will not be incremented until the channel is re-enabled.
}}
{{UGapi|void reset(int ChannelIndex)
|Resets the TotalCount and TotalTime counters to 0 for the specified channel.  For best precision/reliability, this should be called when the channel is disabled.
}}
===Events===

{{UGapi|Count(int ChannelIndex, int time, int counts) [event]
|An event that is issued whenever some counts have been detected. This event will fire at up to 31.25 times a second, depending on the pulse rate. The time is in microseconds and represents the amount of time in which the number of counts occurred. This event can be used to calculate frequency independently of the phidget21 library frequency implementation.

:This event will fire with a count of 0 once, after the Timeout time has elapsed with no counts for a channel, to indicate 0Hz.
}}
==Product History==
{{UGhist}}
{{UGrow|May 2011|0|100|Product Release}}
{{UGrow|May 2011|0|101|getLabelString fixed for labels longer than 7 characters}}