YAnButton (Yoctopuce Java EE API 2.1.10736-SNAPSHOT API)

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

```
public class YAnButton
extends YFunction
```
YAnButton Class: analog input control interface, available for instance in the Yocto-Buzzer, the Yocto-Knob, the Yocto-MaxiBuzzer or the Yocto-MaxiDisplay The YAnButton class provide access to basic resistive inputs. Such inputs can be used to measure the state of a simple button as well as to read an analog potentiometer (variable resistance). This can be use for instance with a continuous rotating knob, a throttle grip or a joystick. The module is capable to calibrate itself on min and max values, in order to compute a calibrated value that varies proportionally with the potentiometer position, regardless of its total resistance.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`YAnButton.TimedReportCallback` TimedReportCallback for AnButton
`static interface`	`YAnButton.UpdateCallback` Deprecated UpdateCallback for AnButton

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`_analogCalibration`
`protected int`	`_calibratedValue`
`protected int`	`_calibrationMax`
`protected int`	`_calibrationMin`
`protected int`	`_inputType`
`protected int`	`_isPressed`
`protected long`	`_lastTimePressed`
`protected long`	`_lastTimeReleased`
`protected long`	`_pulseCounter`
`protected long`	`_pulseTimer`
`protected int`	`_rawValue`
`protected int`	`_sensitivity`
`protected YAnButton.UpdateCallback`	`_valueCallbackAnButton`
`static int`	`ANALOGCALIBRATION_INVALID`
`static int`	`ANALOGCALIBRATION_OFF` invalid analogCalibration value
`static int`	`ANALOGCALIBRATION_ON`
`static int`	`CALIBRATEDVALUE_INVALID` invalid calibratedValue value
`static int`	`CALIBRATIONMAX_INVALID` invalid calibrationMax value
`static int`	`CALIBRATIONMIN_INVALID` invalid calibrationMin value
`static int`	`INPUTTYPE_ANALOG_FAST` invalid inputType value
`static int`	`INPUTTYPE_ANALOG_SMOOTH`
`static int`	`INPUTTYPE_DIGITAL_FAST`
`static int`	`INPUTTYPE_DIGITAL4`
`static int`	`INPUTTYPE_INVALID`
`static int`	`ISPRESSED_FALSE` invalid isPressed value
`static int`	`ISPRESSED_INVALID`
`static int`	`ISPRESSED_TRUE`
`static long`	`LASTTIMEPRESSED_INVALID` invalid lastTimePressed value
`static long`	`LASTTIMERELEASED_INVALID` invalid lastTimeReleased value
`static long`	`PULSECOUNTER_INVALID` invalid pulseCounter value
`static long`	`PULSETIMER_INVALID` invalid pulseTimer value
`static int`	`RAWVALUE_INVALID` invalid rawValue value
`static int`	`SENSITIVITY_INVALID` invalid sensitivity 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 YAnButton(String func)

protected YAnButton(YAPIContext ctx, String func)

Constructors
Modifier	Constructor and Description
`protected`	`YAnButton(String func)`
`protected`	`YAnButton(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 YAnButton`	`FindAnButton(String func)` Retrieves an analog input for a given identifier.
`static YAnButton`	`FindAnButtonInContext(YAPIContext yctx, String func)` Retrieves an analog input for a given identifier in a YAPI context.
`static YAnButton`	`FirstAnButton()` Starts the enumeration of analog inputs currently accessible.
`static YAnButton`	`FirstAnButtonInContext(YAPIContext yctx)` Starts the enumeration of analog inputs currently accessible.
`int`	`get_analogCalibration()` Tells if a calibration process is currently ongoing.
`int`	`get_calibratedValue()` Returns the current calibrated input value (between 0 and 1000, included).
`int`	`get_calibrationMax()` Returns the maximal value measured during the calibration (between 0 and 4095, included).
`int`	`get_calibrationMin()` Returns the minimal value measured during the calibration (between 0 and 4095, included).
`int`	`get_inputType()` Returns the decoding method applied to the input (analog or multiplexed binary switches).
`int`	`get_isPressed()` Returns true if the input (considered as binary) is active (closed contact), and false otherwise.
`long`	`get_lastTimePressed()` Returns the number of elapsed milliseconds between the module power on and the last time the input button was pressed (the input contact transitioned from open to closed).
`long`	`get_lastTimeReleased()` Returns the number of elapsed milliseconds between the module power on and the last time the input button was released (the input contact transitioned from closed to open).
`long`	`get_pulseCounter()` Returns the pulse counter value.
`long`	`get_pulseTimer()` Returns the timer of the pulses counter (ms).
`int`	`get_rawValue()` Returns the current measured input value as-is (between 0 and 4095, included).
`int`	`get_sensitivity()` Returns the sensibility for the input (between 1 and 1000) for triggering user callbacks.
`int`	`getAnalogCalibration()` Tells if a calibration process is currently ongoing.
`int`	`getCalibratedValue()` Returns the current calibrated input value (between 0 and 1000, included).
`int`	`getCalibrationMax()` Returns the maximal value measured during the calibration (between 0 and 4095, included).
`int`	`getCalibrationMin()` Returns the minimal value measured during the calibration (between 0 and 4095, included).
`int`	`getInputType()` Returns the decoding method applied to the input (analog or multiplexed binary switches).
`int`	`getIsPressed()` Returns true if the input (considered as binary) is active (closed contact), and false otherwise.
`long`	`getLastTimePressed()` Returns the number of elapsed milliseconds between the module power on and the last time the input button was pressed (the input contact transitioned from open to closed).
`long`	`getLastTimeReleased()` Returns the number of elapsed milliseconds between the module power on and the last time the input button was released (the input contact transitioned from closed to open).
`long`	`getPulseCounter()` Returns the pulse counter value.
`long`	`getPulseTimer()` Returns the timer of the pulses counter (ms).
`int`	`getRawValue()` Returns the current measured input value as-is (between 0 and 4095, included).
`int`	`getSensitivity()` Returns the sensibility for the input (between 1 and 1000) for triggering user callbacks.
`YAnButton`	`nextAnButton()` Continues the enumeration of analog inputs started using yFirstAnButton().
`int`	`registerValueCallback(YAnButton.UpdateCallback callback)` Registers the callback function that is invoked on every change of advertised value.
`int`	`resetCounter()` Returns the pulse counter value as well as its timer.
`int`	`set_analogCalibration(int newval)` Starts or stops the calibration process.
`int`	`set_calibrationMax(int newval)` Changes the maximal calibration value for the input (between 0 and 4095, included), without actually starting the automated calibration.
`int`	`set_calibrationMin(int newval)` Changes the minimal calibration value for the input (between 0 and 4095, included), without actually starting the automated calibration.
`int`	`set_inputType(int newval)` Changes the decoding method applied to the input (analog or multiplexed binary switches).
`int`	`set_pulseCounter(long newval)`
`int`	`set_sensitivity(int newval)` Changes the sensibility for the input (between 1 and 1000) for triggering user callbacks.
`int`	`setAnalogCalibration(int newval)` Starts or stops the calibration process.
`int`	`setCalibrationMax(int newval)` Changes the maximal calibration value for the input (between 0 and 4095, included), without actually starting the automated calibration.
`int`	`setCalibrationMin(int newval)` Changes the minimal calibration value for the input (between 0 and 4095, included), without actually starting the automated calibration.
`int`	`setInputType(int newval)` Changes the decoding method applied to the input (analog or multiplexed binary switches).
`int`	`setSensitivity(int newval)` Changes the sensibility for the input (between 1 and 1000) for triggering user callbacks.

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
  - CALIBRATEDVALUE_INVALID
```
public static final int CALIBRATEDVALUE_INVALID
```
    invalid calibratedValue value
    
    See Also:
    
    Constant Field Values
  - RAWVALUE_INVALID
```
public static final int RAWVALUE_INVALID
```
    invalid rawValue value
    
    See Also:
    
    Constant Field Values
  - ANALOGCALIBRATION_OFF
```
public static final int ANALOGCALIBRATION_OFF
```
    invalid analogCalibration value
    
    See Also:
    
    Constant Field Values
  - ANALOGCALIBRATION_ON
```
public static final int ANALOGCALIBRATION_ON
```
    See Also:
    
    Constant Field Values
  - ANALOGCALIBRATION_INVALID
```
public static final int ANALOGCALIBRATION_INVALID
```
    See Also:
    
    Constant Field Values
  - CALIBRATIONMAX_INVALID
```
public static final int CALIBRATIONMAX_INVALID
```
    invalid calibrationMax value
    
    See Also:
    
    Constant Field Values
  - CALIBRATIONMIN_INVALID
```
public static final int CALIBRATIONMIN_INVALID
```
    invalid calibrationMin value
    
    See Also:
    
    Constant Field Values
  - SENSITIVITY_INVALID
```
public static final int SENSITIVITY_INVALID
```
    invalid sensitivity value
    
    See Also:
    
    Constant Field Values
  - ISPRESSED_FALSE
```
public static final int ISPRESSED_FALSE
```
    invalid isPressed value
    
    See Also:
    
    Constant Field Values
  - ISPRESSED_TRUE
```
public static final int ISPRESSED_TRUE
```
    See Also:
    
    Constant Field Values
  - ISPRESSED_INVALID
```
public static final int ISPRESSED_INVALID
```
    See Also:
    
    Constant Field Values
  - LASTTIMEPRESSED_INVALID
```
public static final long LASTTIMEPRESSED_INVALID
```
    invalid lastTimePressed value
    
    See Also:
    
    Constant Field Values
  - LASTTIMERELEASED_INVALID
```
public static final long LASTTIMERELEASED_INVALID
```
    invalid lastTimeReleased value
    
    See Also:
    
    Constant Field Values
  - PULSECOUNTER_INVALID
```
public static final long PULSECOUNTER_INVALID
```
    invalid pulseCounter value
    
    See Also:
    
    Constant Field Values
  - PULSETIMER_INVALID
```
public static final long PULSETIMER_INVALID
```
    invalid pulseTimer value
    
    See Also:
    
    Constant Field Values
  - INPUTTYPE_ANALOG_FAST
```
public static final int INPUTTYPE_ANALOG_FAST
```
    invalid inputType value
    
    See Also:
    
    Constant Field Values
  - INPUTTYPE_DIGITAL4
```
public static final int INPUTTYPE_DIGITAL4
```
    See Also:
    
    Constant Field Values
  - INPUTTYPE_ANALOG_SMOOTH
```
public static final int INPUTTYPE_ANALOG_SMOOTH
```
    See Also:
    
    Constant Field Values
  - INPUTTYPE_DIGITAL_FAST
```
public static final int INPUTTYPE_DIGITAL_FAST
```
    See Also:
    
    Constant Field Values
  - INPUTTYPE_INVALID
```
public static final int INPUTTYPE_INVALID
```
    See Also:
    
    Constant Field Values
  - _calibratedValue
```
protected int _calibratedValue
```
  - _rawValue
```
protected int _rawValue
```
  - _analogCalibration
```
protected int _analogCalibration
```
  - _calibrationMax
```
protected int _calibrationMax
```
  - _calibrationMin
```
protected int _calibrationMin
```
  - _sensitivity
```
protected int _sensitivity
```
  - _isPressed
```
protected int _isPressed
```
  - _lastTimePressed
```
protected long _lastTimePressed
```
  - _lastTimeReleased
```
protected long _lastTimeReleased
```
  - _pulseCounter
```
protected long _pulseCounter
```
  - _pulseTimer
```
protected long _pulseTimer
```
  - _inputType
```
protected int _inputType
```
  - _valueCallbackAnButton
```
protected YAnButton.UpdateCallback _valueCallbackAnButton
```
- Constructor Detail
  - YAnButton
```
protected YAnButton(YAPIContext ctx,
                    String func)
```
    Parameters:
    
    func - : functionid
  - YAnButton
```
protected YAnButton(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_calibratedValue
```
public int get_calibratedValue()
                        throws YAPI_Exception
```
    Returns the current calibrated input value (between 0 and 1000, included).
    
    Returns:
    
    an integer corresponding to the current calibrated input value (between 0 and 1000, included)
    
    Throws:
    
    YAPI_Exception - on error
  - getCalibratedValue
```
public int getCalibratedValue()
                       throws YAPI_Exception
```
    Returns the current calibrated input value (between 0 and 1000, included).
    
    Returns:
    
    an integer corresponding to the current calibrated input value (between 0 and 1000, included)
    
    Throws:
    
    YAPI_Exception - on error
  - get_rawValue
```
public int get_rawValue()
                 throws YAPI_Exception
```
    Returns the current measured input value as-is (between 0 and 4095, included).
    
    Returns:
    
    an integer corresponding to the current measured input value as-is (between 0 and 4095, included)
    
    Throws:
    
    YAPI_Exception - on error
  - getRawValue
```
public int getRawValue()
                throws YAPI_Exception
```
    Returns the current measured input value as-is (between 0 and 4095, included).
    
    Returns:
    
    an integer corresponding to the current measured input value as-is (between 0 and 4095, included)
    
    Throws:
    
    YAPI_Exception - on error
  - get_analogCalibration
```
public int get_analogCalibration()
                          throws YAPI_Exception
```
    Tells if a calibration process is currently ongoing.
    
    Returns:
    
    either YAnButton.ANALOGCALIBRATION_OFF or YAnButton.ANALOGCALIBRATION_ON
    
    Throws:
    
    YAPI_Exception - on error
  - getAnalogCalibration
```
public int getAnalogCalibration()
                         throws YAPI_Exception
```
    Tells if a calibration process is currently ongoing.
    
    Returns:
    
    either YAnButton.ANALOGCALIBRATION_OFF or YAnButton.ANALOGCALIBRATION_ON
    
    Throws:
    
    YAPI_Exception - on error
  - set_analogCalibration
```
public int set_analogCalibration(int newval)
                          throws YAPI_Exception
```
    Starts or stops the calibration process. Remember to call the saveToFlash() method of the module at the end of the calibration if the modification must be kept.
    
    Parameters:
    
    newval - : either YAnButton.ANALOGCALIBRATION_OFF or YAnButton.ANALOGCALIBRATION_ON
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setAnalogCalibration
```
public int setAnalogCalibration(int newval)
                         throws YAPI_Exception
```
    Starts or stops the calibration process. Remember to call the saveToFlash() method of the module at the end of the calibration if the modification must be kept.
    
    Parameters:
    
    newval - : either YAnButton.ANALOGCALIBRATION_OFF or YAnButton.ANALOGCALIBRATION_ON
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - get_calibrationMax
```
public int get_calibrationMax()
                       throws YAPI_Exception
```
    Returns the maximal value measured during the calibration (between 0 and 4095, included).
    
    Returns:
    
    an integer corresponding to the maximal value measured during the calibration (between 0 and 4095, included)
    
    Throws:
    
    YAPI_Exception - on error
  - getCalibrationMax
```
public int getCalibrationMax()
                      throws YAPI_Exception
```
    Returns the maximal value measured during the calibration (between 0 and 4095, included).
    
    Returns:
    
    an integer corresponding to the maximal value measured during the calibration (between 0 and 4095, included)
    
    Throws:
    
    YAPI_Exception - on error
  - set_calibrationMax
```
public int set_calibrationMax(int newval)
                       throws YAPI_Exception
```
    Changes the maximal calibration value for the input (between 0 and 4095, included), without actually starting the automated calibration. Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : an integer corresponding to the maximal calibration value for the input (between 0 and 4095, included), without actually starting the automated calibration
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setCalibrationMax
```
public int setCalibrationMax(int newval)
                      throws YAPI_Exception
```
    Changes the maximal calibration value for the input (between 0 and 4095, included), without actually starting the automated calibration. Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : an integer corresponding to the maximal calibration value for the input (between 0 and 4095, included), without actually starting the automated calibration
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - get_calibrationMin
```
public int get_calibrationMin()
                       throws YAPI_Exception
```
    Returns the minimal value measured during the calibration (between 0 and 4095, included).
    
    Returns:
    
    an integer corresponding to the minimal value measured during the calibration (between 0 and 4095, included)
    
    Throws:
    
    YAPI_Exception - on error
  - getCalibrationMin
```
public int getCalibrationMin()
                      throws YAPI_Exception
```
    Returns the minimal value measured during the calibration (between 0 and 4095, included).
    
    Returns:
    
    an integer corresponding to the minimal value measured during the calibration (between 0 and 4095, included)
    
    Throws:
    
    YAPI_Exception - on error
  - set_calibrationMin
```
public int set_calibrationMin(int newval)
                       throws YAPI_Exception
```
    Changes the minimal calibration value for the input (between 0 and 4095, included), without actually starting the automated calibration. Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : an integer corresponding to the minimal calibration value for the input (between 0 and 4095, included), without actually starting the automated calibration
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setCalibrationMin
```
public int setCalibrationMin(int newval)
                      throws YAPI_Exception
```
    Changes the minimal calibration value for the input (between 0 and 4095, included), without actually starting the automated calibration. Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : an integer corresponding to the minimal calibration value for the input (between 0 and 4095, included), without actually starting the automated calibration
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - get_sensitivity
```
public int get_sensitivity()
                    throws YAPI_Exception
```
    Returns the sensibility for the input (between 1 and 1000) for triggering user callbacks.
    
    Returns:
    
    an integer corresponding to the sensibility for the input (between 1 and 1000) for triggering user callbacks
    
    Throws:
    
    YAPI_Exception - on error
  - getSensitivity
```
public int getSensitivity()
                   throws YAPI_Exception
```
    Returns the sensibility for the input (between 1 and 1000) for triggering user callbacks.
    
    Returns:
    
    an integer corresponding to the sensibility for the input (between 1 and 1000) for triggering user callbacks
    
    Throws:
    
    YAPI_Exception - on error
  - set_sensitivity
```
public int set_sensitivity(int newval)
                    throws YAPI_Exception
```
    Changes the sensibility for the input (between 1 and 1000) for triggering user callbacks. The sensibility is used to filter variations around a fixed value, but does not preclude the transmission of events when the input value evolves constantly in the same direction. Special case: when the value 1000 is used, the callback will only be thrown when the logical state of the input switches from pressed to released and back. Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : an integer corresponding to the sensibility for the input (between 1 and 1000) for triggering user callbacks
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setSensitivity
```
public int setSensitivity(int newval)
                   throws YAPI_Exception
```
    Changes the sensibility for the input (between 1 and 1000) for triggering user callbacks. The sensibility is used to filter variations around a fixed value, but does not preclude the transmission of events when the input value evolves constantly in the same direction. Special case: when the value 1000 is used, the callback will only be thrown when the logical state of the input switches from pressed to released and back. Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : an integer corresponding to the sensibility for the input (between 1 and 1000) for triggering user callbacks
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - get_isPressed
```
public int get_isPressed()
                  throws YAPI_Exception
```
    Returns true if the input (considered as binary) is active (closed contact), and false otherwise.
    
    Returns:
    
    either YAnButton.ISPRESSED_FALSE or YAnButton.ISPRESSED_TRUE, according to true if the input (considered as binary) is active (closed contact), and false otherwise
    
    Throws:
    
    YAPI_Exception - on error
  - getIsPressed
```
public int getIsPressed()
                 throws YAPI_Exception
```
    Returns true if the input (considered as binary) is active (closed contact), and false otherwise.
    
    Returns:
    
    either YAnButton.ISPRESSED_FALSE or YAnButton.ISPRESSED_TRUE, according to true if the input (considered as binary) is active (closed contact), and false otherwise
    
    Throws:
    
    YAPI_Exception - on error
  - get_lastTimePressed
```
public long get_lastTimePressed()
                         throws YAPI_Exception
```
    Returns the number of elapsed milliseconds between the module power on and the last time the input button was pressed (the input contact transitioned from open to closed).
    
    Returns:
    
    an integer corresponding to the number of elapsed milliseconds between the module power on and the last time the input button was pressed (the input contact transitioned from open to closed)
    
    Throws:
    
    YAPI_Exception - on error
  - getLastTimePressed
```
public long getLastTimePressed()
                        throws YAPI_Exception
```
    Returns the number of elapsed milliseconds between the module power on and the last time the input button was pressed (the input contact transitioned from open to closed).
    
    Returns:
    
    an integer corresponding to the number of elapsed milliseconds between the module power on and the last time the input button was pressed (the input contact transitioned from open to closed)
    
    Throws:
    
    YAPI_Exception - on error
  - get_lastTimeReleased
```
public long get_lastTimeReleased()
                          throws YAPI_Exception
```
    Returns the number of elapsed milliseconds between the module power on and the last time the input button was released (the input contact transitioned from closed to open).
    
    Returns:
    
    an integer corresponding to the number of elapsed milliseconds between the module power on and the last time the input button was released (the input contact transitioned from closed to open)
    
    Throws:
    
    YAPI_Exception - on error
  - getLastTimeReleased
```
public long getLastTimeReleased()
                         throws YAPI_Exception
```
    Returns the number of elapsed milliseconds between the module power on and the last time the input button was released (the input contact transitioned from closed to open).
    
    Returns:
    
    an integer corresponding to the number of elapsed milliseconds between the module power on and the last time the input button was released (the input contact transitioned from closed to open)
    
    Throws:
    
    YAPI_Exception - on error
  - get_pulseCounter
```
public long get_pulseCounter()
                      throws YAPI_Exception
```
    Returns the pulse counter value. The value is a 32 bit integer. In case of overflow (>=2^32), the counter will wrap. To reset the counter, just call the resetCounter() method.
    
    Returns:
    
    an integer corresponding to the pulse counter value
    
    Throws:
    
    YAPI_Exception - on error
  - getPulseCounter
```
public long getPulseCounter()
                     throws YAPI_Exception
```
    Returns the pulse counter value. The value is a 32 bit integer. In case of overflow (>=2^32), the counter will wrap. To reset the counter, just call the resetCounter() method.
    
    Returns:
    
    an integer corresponding to the pulse counter value
    
    Throws:
    
    YAPI_Exception - on error
  - set_pulseCounter
```
public int set_pulseCounter(long newval)
                     throws YAPI_Exception
```
    Throws:
    
    YAPI_Exception
  - get_pulseTimer
```
public long get_pulseTimer()
                    throws YAPI_Exception
```
    Returns the timer of the pulses counter (ms).
    
    Returns:
    
    an integer corresponding to the timer of the pulses counter (ms)
    
    Throws:
    
    YAPI_Exception - on error
  - getPulseTimer
```
public long getPulseTimer()
                   throws YAPI_Exception
```
    Returns the timer of the pulses counter (ms).
    
    Returns:
    
    an integer corresponding to the timer of the pulses counter (ms)
    
    Throws:
    
    YAPI_Exception - on error
  - get_inputType
```
public int get_inputType()
                  throws YAPI_Exception
```
    Returns the decoding method applied to the input (analog or multiplexed binary switches).
    
    Returns:
    
    a value among YAnButton.INPUTTYPE_ANALOG_FAST, YAnButton.INPUTTYPE_DIGITAL4, YAnButton.INPUTTYPE_ANALOG_SMOOTH and YAnButton.INPUTTYPE_DIGITAL_FAST corresponding to the decoding method applied to the input (analog or multiplexed binary switches)
    
    Throws:
    
    YAPI_Exception - on error
  - getInputType
```
public int getInputType()
                 throws YAPI_Exception
```
    Returns the decoding method applied to the input (analog or multiplexed binary switches).
    
    Returns:
    
    a value among YAnButton.INPUTTYPE_ANALOG_FAST, YAnButton.INPUTTYPE_DIGITAL4, YAnButton.INPUTTYPE_ANALOG_SMOOTH and YAnButton.INPUTTYPE_DIGITAL_FAST corresponding to the decoding method applied to the input (analog or multiplexed binary switches)
    
    Throws:
    
    YAPI_Exception - on error
  - set_inputType
```
public int set_inputType(int newval)
                  throws YAPI_Exception
```
    Changes the decoding method applied to the input (analog or multiplexed binary switches). Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : a value among YAnButton.INPUTTYPE_ANALOG_FAST, YAnButton.INPUTTYPE_DIGITAL4, YAnButton.INPUTTYPE_ANALOG_SMOOTH and YAnButton.INPUTTYPE_DIGITAL_FAST corresponding to the decoding method applied to the input (analog or multiplexed binary switches)
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setInputType
```
public int setInputType(int newval)
                 throws YAPI_Exception
```
    Changes the decoding method applied to the input (analog or multiplexed binary switches). Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : a value among YAnButton.INPUTTYPE_ANALOG_FAST, YAnButton.INPUTTYPE_DIGITAL4, YAnButton.INPUTTYPE_ANALOG_SMOOTH and YAnButton.INPUTTYPE_DIGITAL_FAST corresponding to the decoding method applied to the input (analog or multiplexed binary switches)
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - FindAnButton
```
public static YAnButton FindAnButton(String func)
```
    Retrieves an analog input 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 analog input is online at the time it is invoked. The returned object is nevertheless valid. Use the method YAnButton.isOnline() to test if the analog input is indeed online at a given time. In case of ambiguity when looking for an analog input 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 analog input, for instance YBUZZER2.anButton1.
    
    Returns:
    
    a YAnButton object allowing you to drive the analog input.
  - FindAnButtonInContext
```
public static YAnButton FindAnButtonInContext(YAPIContext yctx,
                                              String func)
```
    Retrieves an analog input 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 analog input is online at the time it is invoked. The returned object is nevertheless valid. Use the method YAnButton.isOnline() to test if the analog input is indeed online at a given time. In case of ambiguity when looking for an analog input 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 analog input, for instance YBUZZER2.anButton1.
    
    Returns:
    
    a YAnButton object allowing you to drive the analog input.
  - registerValueCallback
```
public int registerValueCallback(YAnButton.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
  - resetCounter
```
public int resetCounter()
                 throws YAPI_Exception
```
    Returns the pulse counter value as well as its timer.
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - nextAnButton
```
public YAnButton nextAnButton()
```
    Continues the enumeration of analog inputs started using yFirstAnButton(). Caution: You can't make any assumption about the returned analog inputs order. If you want to find a specific an analog input, use AnButton.findAnButton() and a hardwareID or a logical name.
    
    Returns:
    
    a pointer to a YAnButton object, corresponding to an analog input currently online, or a null pointer if there are no more analog inputs to enumerate.
  - FirstAnButton
```
public static YAnButton FirstAnButton()
```
    Starts the enumeration of analog inputs currently accessible. Use the method YAnButton.nextAnButton() to iterate on next analog inputs.
    
    Returns:
    
    a pointer to a YAnButton object, corresponding to the first analog input currently online, or a null pointer if there are none.
  - FirstAnButtonInContext
```
public static YAnButton FirstAnButtonInContext(YAPIContext yctx)
```
    Starts the enumeration of analog inputs currently accessible. Use the method YAnButton.nextAnButton() to iterate on next analog inputs.
    
    Parameters:
    
    yctx - : a YAPI context.
    
    Returns:
    
    a pointer to a YAnButton object, corresponding to the first analog input currently online, or a null pointer if there are none.

Class YAnButton

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

CALIBRATEDVALUE_INVALID

RAWVALUE_INVALID

ANALOGCALIBRATION_OFF

ANALOGCALIBRATION_ON

ANALOGCALIBRATION_INVALID

CALIBRATIONMAX_INVALID

CALIBRATIONMIN_INVALID

SENSITIVITY_INVALID

ISPRESSED_FALSE

ISPRESSED_TRUE

ISPRESSED_INVALID

LASTTIMEPRESSED_INVALID

LASTTIMERELEASED_INVALID

PULSECOUNTER_INVALID

PULSETIMER_INVALID

INPUTTYPE_ANALOG_FAST

INPUTTYPE_DIGITAL4

INPUTTYPE_ANALOG_SMOOTH

INPUTTYPE_DIGITAL_FAST

INPUTTYPE_INVALID

_calibratedValue

_rawValue

_analogCalibration

_calibrationMax

_calibrationMin

_sensitivity

_isPressed

_lastTimePressed

_lastTimeReleased

_pulseCounter

_pulseTimer

_inputType

_valueCallbackAnButton

Constructor Detail

YAnButton

YAnButton

Method Detail

_parseAttr

get_calibratedValue

getCalibratedValue

get_rawValue

getRawValue

get_analogCalibration

getAnalogCalibration

set_analogCalibration

setAnalogCalibration

get_calibrationMax

getCalibrationMax

set_calibrationMax

setCalibrationMax

get_calibrationMin

getCalibrationMin

set_calibrationMin

setCalibrationMin

get_sensitivity

getSensitivity

set_sensitivity

setSensitivity

get_isPressed

getIsPressed

get_lastTimePressed

getLastTimePressed

get_lastTimeReleased

getLastTimeReleased

get_pulseCounter

getPulseCounter

set_pulseCounter

get_pulseTimer

getPulseTimer

get_inputType

getInputType