Data Interval/Change Trigger: Difference between revisions
No edit summary |
No edit summary |
||
Line 5: | Line 5: | ||
Phidget device channels are initialized with a <code>DataInterval</code> specific to the device channel, and a <code>ChangeTrigger</code> of zero when they are attached. See the {{Phidget22API}} for more information. | Phidget device channels are initialized with a <code>DataInterval</code> specific to the device channel, and a <code>ChangeTrigger</code> of zero when they are attached. See the {{Phidget22API}} for more information. | ||
==Data Interval== | ==Data Interval and Data Rate== | ||
The <code>DataInterval</code> property of a channel determines the rate at which the device channel will | The <code>DataInterval</code> property of a channel determines the rate at which the device channel will report data back to your program. If a channel is open in more than one program (i.e. with remote connections over the [[Phidget Network Server]]), all instances of that channel will share one data interval, and changing it in one program will change it in all others. When this change occurs, a <code>PropertyChange</code> event will be triggered in each of the other programs so they can adjust accordingly if needed. | ||
The | The minimum, maximum and default DataInterval varies for each device. Refer to the {{Phidget22API}} and check the <code>MinDataInterval</code> and <code>MaxDataInterval</code> properties for your device to see the limits. In most cases, you will probably want to set the DataInterval to the minimum value to get as much data as possible. However, in some applications such as long-run data logging, you may want to increase DataInterval to make the resulting data set more manageable. You may also want to increase the DataInterval if you're using a PhidgetSBC or HUB5000, since they can be overwhelmed if too many channels are running at the minimum DataInterval. | ||
== Change Trigger == | == Change Trigger == |
Revision as of 20:11, 21 July 2023
Phidget devices often send streams of sensor and state data to attached channels. The rate at which that data is delivered can be controlled by setting the DataInterval
property of a channel. A threshold can be set to filter data that does not vary by more than a defined amount by setting the ChangeTrigger
property of a channel.
Phidget device channels are initialized with a DataInterval
specific to the device channel, and a ChangeTrigger
of zero when they are attached. See the Phidget22 API for more information.
Data Interval and Data Rate
The DataInterval
property of a channel determines the rate at which the device channel will report data back to your program. If a channel is open in more than one program (i.e. with remote connections over the Phidget Network Server), all instances of that channel will share one data interval, and changing it in one program will change it in all others. When this change occurs, a PropertyChange
event will be triggered in each of the other programs so they can adjust accordingly if needed.
The minimum, maximum and default DataInterval varies for each device. Refer to the Phidget22 API and check the MinDataInterval
and MaxDataInterval
properties for your device to see the limits. In most cases, you will probably want to set the DataInterval to the minimum value to get as much data as possible. However, in some applications such as long-run data logging, you may want to increase DataInterval to make the resulting data set more manageable. You may also want to increase the DataInterval if you're using a PhidgetSBC or HUB5000, since they can be overwhelmed if too many channels are running at the minimum DataInterval.
Change Trigger
The ChangeTrigger
property of a channel enables a filter that only passes data when that data has changed by an amount greater than or equal to the ChangeTrigger
. For example, if the DataInterval
was set to 0.7, new data would only be delivered to the channel when that new data differed from the previously delivered data by at least 0.7.
It is often useful to set a change trigger to reduce the apparent noise on a channel, or to only receive data change events when meaningful thresholds are reached. For example, an application that displayed temperature on an LCD may only be interested on 0.5°C changes. By setting the ChangeTrigger
to 0.5, the only data that would be receive would be data of interest.
In most cases, it is likely that you'll simply use these properties as follows:
- Keep the
ChangeTrigger
at zero and select theDataInterval
based on how often you want your program to receive data. This configuration is useful in data logging applications and when data will be represented in a graph. - Keep the
DataInterval
at a minimal interval, and set theChangeTrigger
to the lowest relevant value for the quality you are measuring. This is useful for applications were you want to ignore values below a certain threshold or are displaying sensor values.
Advanced Topics
In some complex situations, you may want to set both the ChangeTrigger
and the DataInterval
to non-trivial values. This will result in expected behavior: The channel will check at the DataInterval
whether or not the new data differs from the last delivered data by an amount greater than or equal to the ChangeTrigger
. If the data passes the change trigger filter, that data will be delivered, if the data does not, the channel will wait until the next data interval and check again.
The only complication is when you consider a situation where the value has spiked by a large amount and then returned to the baseline, in-between intervals. For example, suppose you have a voltage sensor and you've set the DataInterval to 5 milliseconds an the VoltageChangeTrigger to 3mV. The way this is handled depends on whether you're using a USB Phidget or a VINT Phidget:
In this example, the blue data points represent the real value of the voltage at any given time. The thick black bars represent the sampling interval, which is 5 milliseconds. When a USB Phidget samples at a slower rate than its default, it will average the last interval worth of samples together and report that value on each interval. This average is represented by the orange data point that lands on each interval line. It is this average that is compared against the change trigger to decide whether or not a data event fires or not. Let's step through each interval:
Interval 1 (0-5ms): The voltage stays mostly stable throughout this interval. The average at the end of the interval is 20mV, which is no different than our first sample. Since our change trigger is 3mV, an event does not fire at the 5ms mark.
Interval 2 (5-10ms): In this interval, the voltage spikes to 30mV and then drops back down. The average for this interval is 23mV, which is 3mV higher than our last event at 0ms. Thus, the change is sufficient to cause a data even to fire at 10ms.
Interval 3 (10-15ms): In this interval, the voltage drops down to 10mV and then rises close to 30mV. The average for this interval is 21mV, which is only 2mV off from our last event. Since this does not meet our change trigger, an event does not fire.
Interval 4 (15-20ms): In this interval, the voltage remains relatively stable at around 28mV. However, the average for this interval is 29mV, which is much higher than our last data event (23mV). This change of 6mV is greater than our change trigger, so an event fires.
Let's see how a VINT devices behaves in the same example. Now, instead of averaging all of the values in the past interval, the VINT device goes to sleep to save power. That means it only cares about the data values on each interval line, and ignores all others.
Interval 1 (0-5ms): The device wakes up and sees a value of 20mV, which is no different than the starting value of 20mV. No event is fired.
Interval 2 (5-10ms): The device wakes up and sees 22mV, which does not differ enough from the last event of 20mV, as our change trigger is 3mV. No event is fired.
Interval 3 (10-15ms): The device wakes up and sees 29mV, which is enough of a change to fire a data event.
Interval 4 (15-20ms): The device wakes up and sees 30mV, which is only 1mV off from the last event, which is not sufficient to trigger a new event.
Further Reading
Phidget Programming Basics - Here you can find the basic concepts to help you get started with making your own programs that use Phidgets.
Polling vs. Events - Your program can gather data in either a polling-driven or event-driven manner. Learn the difference to determine which is best for your application.
Using Multiple Phidgets - Learn how to use more than one Phidget in your program. This page will guide you through the steps.
Logging, Exceptions, and Errors - Learn about all the tools you can use to debug your program.
Phidget Network Server - Phidgets can be controlled and communicated with over your network- either wirelessly or over ethernet.
Best Phidgets Practices - Good programming habits that will save you from common problems when writing code for your Phidgets.