Yoctopuce Yocto-RangeFinder, User Manual, Page: 301 / 497

21. High-level API Reference
temperature
→
get_errorType()
Returns the numerical error code of the latest error with the temperature sensor.
temperature
→
get_friendlyName()
Returns a global identifier of the temperature sensor in the format MODULE_NAME.FUNCTION_NAME .
temperature
→
get_functionDescriptor()
Returns a unique identifier of type YFUN_DESCR corresponding to the function.
temperature
→
get_functionId()
Returns the hardware identifier of the temperature sensor, without reference to the module.
temperature
→
get_hardwareId()
Returns the unique hardware identifier of the temperature sensor in the form
SERIAL.FUNCTIONID
.
temperature
→
get_highestValue()
Returns the maximal value observed for the temperature since the device was started.
temperature
→
get_logFrequency()
Returns the datalogger recording frequency for this function, or "OFF" when measures are not stored in the
data logger flash memory.
temperature
→
get_logicalName()
Returns the logical name of the temperature sensor.
temperature
→
get_lowestValue()
Returns the minimal value observed for the temperature since the device was started.
temperature
→
get_module()
Gets the YModule object for the device on which the function is located.
temperature
→
get_module_async( callback , context )
Gets the YModule object for the device on which the function is located (asynchronous version).
temperature
→
get_recordedData( startTime , endTime )
Retrieves a DataSet object holding historical data for this sensor, for a specified time interval.
temperature
→
get_reportFrequency()
Returns the timed value notification frequency, or "OFF" if timed value notifications are disabled for this
function.
temperature
→
get_resolution()
Returns the resolution of the measured values.
temperature
→
get_sensorState()
Returns the sensor health state code, which is zero when there is an up-to-date measure available or a
positive code if the sensor is not able to provide a measure right now.
temperature
→
get_sensorType()
Returns the temperature sensor type.
temperature
→
get_signalUnit()
Returns the measuring unit of the electrical signal used by the sensor.
temperature
→
get_signalValue()
Returns the current value of the electrical signal measured by the sensor.
temperature
→
get_unit()
Returns the measuring unit for the temperature.
temperature
→
get_userData()
Returns the value of the userData attribute, as previously stored using method set_userData .
temperature
→
isOnline()
Checks if the temperature sensor is currently reachable, without raising any error.
temperature
→
isOnline_async( callback , context )
www.yoctopuce.com 295