YThreshold (Yoctopuce Java API 2.1.11632-SNAPSHOT API)

java.lang.Object
- com.yoctopuce.YoctoAPI.YFunction
- - com.yoctopuce.YoctoAPI.YThreshold

```
public class YThreshold
extends YFunction
```
YThreshold Class: Control interface to define a threshold The Threshold class allows you define a threshold on a Yoctopuce sensor to trigger a predefined action, on specific devices where this is implemented.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`YThreshold.TimedReportCallback` TimedReportCallback for Threshold
`static interface`	`YThreshold.UpdateCallback` Deprecated UpdateCallback for Threshold

Field Summary

Fields
Modifier and Type	Field and Description
`protected double`	`_alertLevel`
`protected double`	`_safeLevel`
`protected String`	`_targetSensor`
`protected int`	`_thresholdState`
`protected YThreshold.UpdateCallback`	`_valueCallbackThreshold`
`static double`	`ALERTLEVEL_INVALID` invalid alertLevel value
`static double`	`SAFELEVEL_INVALID` invalid safeLevel value
`static String`	`TARGETSENSOR_INVALID` invalid targetSensor value
`static int`	`THRESHOLDSTATE_ALERT`
`static int`	`THRESHOLDSTATE_INVALID`
`static int`	`THRESHOLDSTATE_SAFE` invalid thresholdState value

Fields inherited from class com.yoctopuce.YoctoAPI.YFunction
_advertisedValue, _cacheExpiration, _className, _dataStreams, _func, _funId, _hwId, _lastErrorMsg, _lastErrorType, _logicalName, _serial, _userData, _valueCallbackFunction, _yapi, ADVERTISEDVALUE_INVALID, FUNCTIONDESCRIPTOR_INVALID, LOGICALNAME_INVALID

Constructor Summary

Constructors
Modifier Constructor and Description

protected YThreshold(String func)

protected YThreshold(YAPIContext ctx, String func)

Constructors
Modifier	Constructor and Description
`protected`	`YThreshold(String func)`
`protected`	`YThreshold(YAPIContext ctx, String func)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`_invokeValueCallback(String value)`
`protected void`	`_parseAttr(com.yoctopuce.YoctoAPI.YJSONObject json_val)`
`static YThreshold`	`FindThreshold(String func)` Retrieves a threshold function for a given identifier.
`static YThreshold`	`FindThresholdInContext(YAPIContext yctx, String func)` Retrieves a threshold function for a given identifier in a YAPI context.
`static YThreshold`	`FirstThreshold()` Starts the enumeration of threshold functions currently accessible.
`static YThreshold`	`FirstThresholdInContext(YAPIContext yctx)` Starts the enumeration of threshold functions currently accessible.
`double`	`get_alertLevel()` Returns the sensor alert level, triggering the threshold function.
`double`	`get_safeLevel()` Returns the sensor acceptable level for disabling the threshold function.
`String`	`get_targetSensor()` Returns the name of the sensor monitored by the threshold function.
`int`	`get_thresholdState()` Returns current state of the threshold function.
`double`	`getAlertLevel()` Returns the sensor alert level, triggering the threshold function.
`double`	`getSafeLevel()` Returns the sensor acceptable level for disabling the threshold function.
`String`	`getTargetSensor()` Returns the name of the sensor monitored by the threshold function.
`int`	`getThresholdState()` Returns current state of the threshold function.
`YThreshold`	`nextThreshold()` Continues the enumeration of threshold functions started using yFirstThreshold().
`int`	`registerValueCallback(YThreshold.UpdateCallback callback)` Registers the callback function that is invoked on every change of advertised value.
`int`	`set_alertLevel(double newval)` Changes the sensor alert level triggering the threshold function.
`int`	`set_safeLevel(double newval)` Changes the sensor acceptable level for disabling the threshold function.
`int`	`setAlertLevel(double newval)` Changes the sensor alert level triggering the threshold function.
`int`	`setSafeLevel(double newval)` Changes the sensor acceptable level for disabling the threshold function.

Methods inherited from class com.yoctopuce.YoctoAPI.YFunction
_AddToCache, _clearDataStreamCache, _decode_json_int, _decode_json_string, _download, _escapeAttr, _FindFromCache, _FindFromCacheInContext, _get_json_path_struct, _get_json_path, _is_valid_pass, _json_get_array, _json_get_key, _json_get_string, _parse, _parserHelper, _setAttr, _throw, _UpdateTimedReportCallbackList, _UpdateValueCallbackList, _upload, _upload, _uploadEx, clearCache, describe, errMessage, errorMessage, errorType, errType, FindFunction, FindFunctionInContext, FirstFunction, FirstFunctionInContext, functionDescriptor, get_advertisedValue, get_errorMessage, get_errorType, get_friendlyName, get_functionDescriptor, get_functionId, get_hardwareId, get_logicalName, get_module, get_serialNumber, get_userData, getAdvertisedValue, getErrorMessage, getErrorType, getFriendlyName, getFunctionDescriptor, getFunctionId, getHardwareId, getLogicalName, getModule, getUserData, isOnline, isReadOnly, load, loadAttribute, module, muteValueCallbacks, nextFunction, registerValueCallback, set_advertisedValue, set_logicalName, set_userData, setLogicalName, setUserData, toString, unmuteValueCallbacks, userData

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - THRESHOLDSTATE_SAFE
```
public static final int THRESHOLDSTATE_SAFE
```
    invalid thresholdState value
    
    See Also:
    
    Constant Field Values
  - THRESHOLDSTATE_ALERT
```
public static final int THRESHOLDSTATE_ALERT
```
    See Also:
    
    Constant Field Values
  - THRESHOLDSTATE_INVALID
```
public static final int THRESHOLDSTATE_INVALID
```
    See Also:
    
    Constant Field Values
  - TARGETSENSOR_INVALID
```
public static final String TARGETSENSOR_INVALID
```
    invalid targetSensor value
    
    See Also:
    
    Constant Field Values
  - ALERTLEVEL_INVALID
```
public static final double ALERTLEVEL_INVALID
```
    invalid alertLevel value
    
    See Also:
    
    Constant Field Values
  - SAFELEVEL_INVALID
```
public static final double SAFELEVEL_INVALID
```
    invalid safeLevel value
    
    See Also:
    
    Constant Field Values
  - _thresholdState
```
protected int _thresholdState
```
  - _targetSensor
```
protected String _targetSensor
```
  - _alertLevel
```
protected double _alertLevel
```
  - _safeLevel
```
protected double _safeLevel
```
  - _valueCallbackThreshold
```
protected YThreshold.UpdateCallback _valueCallbackThreshold
```
- Constructor Detail
  - YThreshold
```
protected YThreshold(YAPIContext ctx,
                     String func)
```
    Parameters:
    
    func - : functionid
  - YThreshold
```
protected YThreshold(String func)
```
    Parameters:
    
    func - : functionid
- Method Detail
  - _parseAttr
```
protected void _parseAttr(com.yoctopuce.YoctoAPI.YJSONObject json_val)
                   throws Exception
```
    Overrides:
    
    _parseAttr in class YFunction
    
    Throws:
    
    Exception
  - get_thresholdState
```
public int get_thresholdState()
                       throws YAPI_Exception
```
    Returns current state of the threshold function.
    
    Returns:
    
    either YThreshold.THRESHOLDSTATE_SAFE or YThreshold.THRESHOLDSTATE_ALERT, according to current state of the threshold function
    
    Throws:
    
    YAPI_Exception - on error
  - getThresholdState
```
public int getThresholdState()
                      throws YAPI_Exception
```
    Returns current state of the threshold function.
    
    Returns:
    
    either YThreshold.THRESHOLDSTATE_SAFE or YThreshold.THRESHOLDSTATE_ALERT, according to current state of the threshold function
    
    Throws:
    
    YAPI_Exception - on error
  - get_targetSensor
```
public String get_targetSensor()
                        throws YAPI_Exception
```
    Returns the name of the sensor monitored by the threshold function.
    
    Returns:
    
    a string corresponding to the name of the sensor monitored by the threshold function
    
    Throws:
    
    YAPI_Exception - on error
  - getTargetSensor
```
public String getTargetSensor()
                       throws YAPI_Exception
```
    Returns the name of the sensor monitored by the threshold function.
    
    Returns:
    
    a string corresponding to the name of the sensor monitored by the threshold function
    
    Throws:
    
    YAPI_Exception - on error
  - set_alertLevel
```
public int set_alertLevel(double newval)
                   throws YAPI_Exception
```
    Changes the sensor alert level triggering the threshold function. Remember to call the matching module saveToFlash() method if you want to preserve the setting after reboot.
    
    Parameters:
    
    newval - : a floating point number corresponding to the sensor alert level triggering the threshold function
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setAlertLevel
```
public int setAlertLevel(double newval)
                  throws YAPI_Exception
```
    Changes the sensor alert level triggering the threshold function. Remember to call the matching module saveToFlash() method if you want to preserve the setting after reboot.
    
    Parameters:
    
    newval - : a floating point number corresponding to the sensor alert level triggering the threshold function
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - get_alertLevel
```
public double get_alertLevel()
                      throws YAPI_Exception
```
    Returns the sensor alert level, triggering the threshold function.
    
    Returns:
    
    a floating point number corresponding to the sensor alert level, triggering the threshold function
    
    Throws:
    
    YAPI_Exception - on error
  - getAlertLevel
```
public double getAlertLevel()
                     throws YAPI_Exception
```
    Returns the sensor alert level, triggering the threshold function.
    
    Returns:
    
    a floating point number corresponding to the sensor alert level, triggering the threshold function
    
    Throws:
    
    YAPI_Exception - on error
  - set_safeLevel
```
public int set_safeLevel(double newval)
                  throws YAPI_Exception
```
    Changes the sensor acceptable level for disabling the threshold function. Remember to call the matching module saveToFlash() method if you want to preserve the setting after reboot.
    
    Parameters:
    
    newval - : a floating point number corresponding to the sensor acceptable level for disabling the threshold function
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setSafeLevel
```
public int setSafeLevel(double newval)
                 throws YAPI_Exception
```
    Changes the sensor acceptable level for disabling the threshold function. Remember to call the matching module saveToFlash() method if you want to preserve the setting after reboot.
    
    Parameters:
    
    newval - : a floating point number corresponding to the sensor acceptable level for disabling the threshold function
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - get_safeLevel
```
public double get_safeLevel()
                     throws YAPI_Exception
```
    Returns the sensor acceptable level for disabling the threshold function.
    
    Returns:
    
    a floating point number corresponding to the sensor acceptable level for disabling the threshold function
    
    Throws:
    
    YAPI_Exception - on error
  - getSafeLevel
```
public double getSafeLevel()
                    throws YAPI_Exception
```
    Returns the sensor acceptable level for disabling the threshold function.
    
    Returns:
    
    a floating point number corresponding to the sensor acceptable level for disabling the threshold function
    
    Throws:
    
    YAPI_Exception - on error
  - FindThreshold
```
public static YThreshold FindThreshold(String func)
```
    Retrieves a threshold function for a given identifier. The identifier can be specified using several formats:
    - FunctionLogicalName
    - ModuleSerialNumber.FunctionIdentifier
    - ModuleSerialNumber.FunctionLogicalName
    - ModuleLogicalName.FunctionIdentifier
    - ModuleLogicalName.FunctionLogicalName
    This function does not require that the threshold function is online at the time it is invoked. The returned object is nevertheless valid. Use the method YThreshold.isOnline() to test if the threshold function is indeed online at a given time. In case of ambiguity when looking for a threshold function by logical name, no error is notified: the first instance found is returned. The search is performed first by hardware name, then by logical name. If a call to this object's is_online() method returns FALSE although you are certain that the matching device is plugged, make sure that you did call registerHub() at application initialization time.
    Parameters:
    
    func - : a string that uniquely characterizes the threshold function, for instance MyDevice.threshold1.
    
    Returns:
    
    a YThreshold object allowing you to drive the threshold function.
  - FindThresholdInContext
```
public static YThreshold FindThresholdInContext(YAPIContext yctx,
                                                String func)
```
    Retrieves a threshold function for a given identifier in a YAPI context. The identifier can be specified using several formats:
    - FunctionLogicalName
    - ModuleSerialNumber.FunctionIdentifier
    - ModuleSerialNumber.FunctionLogicalName
    - ModuleLogicalName.FunctionIdentifier
    - ModuleLogicalName.FunctionLogicalName
    This function does not require that the threshold function is online at the time it is invoked. The returned object is nevertheless valid. Use the method YThreshold.isOnline() to test if the threshold function is indeed online at a given time. In case of ambiguity when looking for a threshold function by logical name, no error is notified: the first instance found is returned. The search is performed first by hardware name, then by logical name.
    Parameters:
    
    yctx - : a YAPI context
    
    func - : a string that uniquely characterizes the threshold function, for instance MyDevice.threshold1.
    
    Returns:
    
    a YThreshold object allowing you to drive the threshold function.
  - registerValueCallback
```
public int registerValueCallback(YThreshold.UpdateCallback callback)
```
    Registers the callback function that is invoked on every change of advertised value. The callback is invoked only during the execution of ySleep or yHandleEvents. This provides control over the time when the callback is triggered. For good responsiveness, remember to call one of these two functions periodically. To unregister a callback, pass a null pointer as argument.
    
    Parameters:
    
    callback - : the callback function to call, or a null pointer. The callback function should take two arguments: the function object of which the value has changed, and the character string describing the new advertised value.
  - _invokeValueCallback
```
public int _invokeValueCallback(String value)
```
    Overrides:
    
    _invokeValueCallback in class YFunction
  - nextThreshold
```
public YThreshold nextThreshold()
```
    Continues the enumeration of threshold functions started using yFirstThreshold(). Caution: You can't make any assumption about the returned threshold functions order. If you want to find a specific a threshold function, use Threshold.findThreshold() and a hardwareID or a logical name.
    
    Returns:
    
    a pointer to a YThreshold object, corresponding to a threshold function currently online, or a null pointer if there are no more threshold functions to enumerate.
  - FirstThreshold
```
public static YThreshold FirstThreshold()
```
    Starts the enumeration of threshold functions currently accessible. Use the method YThreshold.nextThreshold() to iterate on next threshold functions.
    
    Returns:
    
    a pointer to a YThreshold object, corresponding to the first threshold function currently online, or a null pointer if there are none.
  - FirstThresholdInContext
```
public static YThreshold FirstThresholdInContext(YAPIContext yctx)
```
    Starts the enumeration of threshold functions currently accessible. Use the method YThreshold.nextThreshold() to iterate on next threshold functions.
    
    Parameters:
    
    yctx - : a YAPI context.
    
    Returns:
    
    a pointer to a YThreshold object, corresponding to the first threshold function currently online, or a null pointer if there are none.

Class YThreshold

Nested Class Summary

Field Summary

Fields inherited from class com.yoctopuce.YoctoAPI.YFunction

Constructor Summary

Method Summary

Methods inherited from class com.yoctopuce.YoctoAPI.YFunction

Methods inherited from class java.lang.Object

Field Detail

THRESHOLDSTATE_SAFE

THRESHOLDSTATE_ALERT

THRESHOLDSTATE_INVALID

TARGETSENSOR_INVALID

ALERTLEVEL_INVALID

SAFELEVEL_INVALID

_thresholdState

_targetSensor

_alertLevel

_safeLevel

_valueCallbackThreshold

Constructor Detail

YThreshold

YThreshold

Method Detail

_parseAttr

get_thresholdState

getThresholdState

get_targetSensor

getTargetSensor

set_alertLevel

setAlertLevel

get_alertLevel

getAlertLevel

set_safeLevel

setSafeLevel

get_safeLevel

getSafeLevel

FindThreshold

FindThresholdInContext

registerValueCallback

_invokeValueCallback

nextThreshold

FirstThreshold

FirstThresholdInContext