Data filters parameters

id

Required

string

Unique identifier for the data filter.

Allowed value: any string identifier

absoluteDeadband

Optional

double

Specifies the absolute change in data value between the current value and the last sent value that the current value must exceed to pass the filter test.

When the current value exceeds the absoluteDeadband value, both the current value and last sent value are sent.

For example, when starting from the 0 event with absoluteDeadband value set to 10, the adapter does not post events until the source tag moves to 11. When that occurs, both 10 and 11 events are sent. This continues until the source tag shows 22, at which time both the 21 and 22 events are sent.

Note: You must specify AbsoluteDeadband or PercentChange.You cannot specify both parameters.

Allowed value: double value representing absolute deadband number.
Default value: null

percentChange

Optional

double

Specifies the percent change from previous value that should cause the current value to pass the filter test.

Note: You must specify AbsoluteDeadband or PercentChange.You cannot specify both parameters.

Allowed value: Double value representing percent change
Default value: null

expirationPeriod

Optional

timespan

The length in time that can elapse after an event before automatically sending the next event, regardless of whether the next event passes the filter or not. The expected format is HH:MM:SS.### or SSS.*

Note: For example, "ExpirationPeriod": 5:00 and "ExpirationPeriod": 300 both specify an expiration period of 5 minutes and 0 seconds.

Allowed value: any timespan
Default value: null