Yoctopuce Yocto-Display, User Manual

Page: 331 / 424

22. High-level API Reference
www.yoctopuce.com 325
anbutton
→
get_errorMessage()
Returns the error message of the latest error with the analog input.
anbutton
→
get_errorType()
Returns the numerical error code of the latest error with the analog input.
anbutton
→
get_friendlyName()
Returns a global identifier of the analog input in the format
MODULE_NAME.FUNCTION_NAME
.
anbutton
→
get_functionDescriptor()
Returns a unique identifier of type
YFUN_DESCR
corresponding to the function.
anbutton
→
get_functionId()
Returns the hardware identifier of the analog input, without reference to the module.
anbutton
→
get_hardwareId()
Returns the unique hardware identifier of the analog input in the form
SERIAL.FUNCTIONID
.
anbutton
→
get_isPressed()
Returns true if the input (considered as binary) is active (closed contact), and false otherwise.
anbutton
→
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).
anbutton
→
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).
anbutton
→
get_logicalName()
Returns the logical name of the analog input.
anbutton
→
get_module()
Gets the
YModule
object for the device on which the function is located.
anbutton
→
get_module_async( callback , context )
Gets the
YModule
object for the device on which the function is located (asynchronous version).
anbutton
→
get_pulseCounter()
Returns the pulse counter value.
anbutton
→
get_pulseTimer()
Returns the timer of the pulses counter (ms).
anbutton
→
get_rawValue()
Returns the current measured input value as-is (between 0 and 4095, included).
anbutton
→
get_sensitivity()
Returns the sensibility for the input (between 1 and 1000) for triggering user callbacks.
anbutton
→
get_userData()
Returns the value of the userData attribute, as previously stored using method set_userData .
anbutton
→
isOnline()
Checks if the analog input is currently reachable, without raising any error.
anbutton
→
isOnline_async( callback , context )
Checks if the analog input is currently reachable, without raising any error (asynchronous version).
anbutton
→
load( msValidity )
Preloads the analog input cache with a specified validity duration.
anbutton
→
loadAttribute( attrName )
Returns the current value of a single function attribute, as a text string, as quickly as possible but without using
the cached value.
anbutton
→
load_async( msValidity , callback , context )