com.yoctopuce.YoctoAPI

Class YArithmeticSensor

java.lang.Object

com.yoctopuce.YoctoAPI.YFunction

com.yoctopuce.YoctoAPI.YSensor

com.yoctopuce.YoctoAPI.YArithmeticSensor

public class YArithmeticSensor
extends YSensor

YArithmeticSensor Class: arithmetic sensor control interface, available for instance in the Yocto-MaxiMicroVolt-Rx The YArithmeticSensor class allows some Yoctopuce devices to compute in real-time values based on an arithmetic formula involving one or more measured signals as well as the temperature. As for any physical sensor, the computed values can be read by callback and stored in the built-in datalogger.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	YArithmeticSensor.TimedReportCallback TimedReportCallback for ArithmeticSensor
static interface	YArithmeticSensor.UpdateCallback Deprecated UpdateCallback for ArithmeticSensor

Field Summary

Fields

Modifier and Type	Field and Description
protected String	_command
protected String	_description
protected YArithmeticSensor.TimedReportCallback	_timedReportCallbackArithmeticSensor
protected YArithmeticSensor.UpdateCallback	_valueCallbackArithmeticSensor
static String	COMMAND_INVALID invalid command value
static String	DESCRIPTION_INVALID invalid description value

Fields inherited from class com.yoctopuce.YoctoAPI.YSensor

_advMode, _cal, _calibrationParam, _currentRawValue, _currentValue, _highestValue, _iresol, _logFrequency, _lowestValue, _prevTR, _reportFrequency, _resolution, _sensorState, _timedReportCallbackSensor, _unit, _valueCallbackSensor, ADVMODE_IMMEDIATE, ADVMODE_INVALID, ADVMODE_PERIOD_AVG, ADVMODE_PERIOD_MAX, ADVMODE_PERIOD_MIN, CALIBRATIONPARAM_INVALID, CURRENTRAWVALUE_INVALID, CURRENTVALUE_INVALID, HIGHESTVALUE_INVALID, LOGFREQUENCY_INVALID, LOWESTVALUE_INVALID, REPORTFREQUENCY_INVALID, RESOLUTION_INVALID, SENSORSTATE_INVALID, UNIT_INVALID

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	YArithmeticSensor(String func)
protected	YArithmeticSensor(YAPIContext ctx, String func)

Method Summary

Modifier and Type	Method and Description
int	_invokeTimedReportCallback(YMeasure value)
int	_invokeValueCallback(String value)
protected void	_parseAttr(com.yoctopuce.YoctoAPI.YJSONObject json_val)
int	defineAuxiliaryFunction(String name, ArrayList<Double> inputValues, ArrayList<Double> outputValues) Defines a auxiliary function by means of a table of reference points.
double	defineExpression(String expr, String descr) Defines the arithmetic function by means of an algebraic expression.
static YArithmeticSensor	FindArithmeticSensor(String func) Retrieves an arithmetic sensor for a given identifier.
static YArithmeticSensor	FindArithmeticSensorInContext(YAPIContext yctx, String func) Retrieves an arithmetic sensor for a given identifier in a YAPI context.
static YArithmeticSensor	FirstArithmeticSensor() Starts the enumeration of arithmetic sensors currently accessible.
static YArithmeticSensor	FirstArithmeticSensorInContext(YAPIContext yctx) Starts the enumeration of arithmetic sensors currently accessible.
String	get_command()
String	get_description() Returns a short informative description of the formula.
String	getDescription() Returns a short informative description of the formula.
int	loadAuxiliaryFunction(String name, ArrayList<Double> inputValues, ArrayList<Double> outputValues) Retrieves the reference points table defining an auxiliary function previously configured using the defineAuxiliaryFunction function.
String	loadExpression() Retrieves the algebraic expression defining the arithmetic function, as previously configured using the defineExpression function.
YArithmeticSensor	nextArithmeticSensor() Continues the enumeration of arithmetic sensors started using yFirstArithmeticSensor().
int	registerTimedReportCallback(YArithmeticSensor.TimedReportCallback callback) Registers the callback function that is invoked on every periodic timed notification.
int	registerValueCallback(YArithmeticSensor.UpdateCallback callback) Registers the callback function that is invoked on every change of advertised value.
int	set_command(String newval)
int	set_unit(String newval) Changes the measuring unit for the arithmetic sensor.
int	setUnit(String newval) Changes the measuring unit for the arithmetic sensor.

Methods inherited from class com.yoctopuce.YoctoAPI.YSensor

_applyCalibration, _decodeAvg, _decodeTimedReport, _decodeVal, _encodeCalibrationPoints, _parseCalibStr, _parserHelper, calibrateFromPoints, FindSensor, FindSensorInContext, FirstSensor, FirstSensorInContext, get_advMode, get_calibrationParam, get_currentRawValue, get_currentValue, get_dataLogger, get_highestValue, get_logFrequency, get_lowestValue, get_recordedData, get_reportFrequency, get_resolution, get_sensorState, get_unit, getAdvMode, getCurrentRawValue, getCurrentValue, getHighestValue, getLogFrequency, getLowestValue, getReportFrequency, getResolution, getSensorState, getUnit, isSensorReady, loadCalibrationPoints, nextSensor, registerTimedReportCallback, registerValueCallback, set_advMode, set_calibrationParam, set_highestValue, set_logFrequency, set_lowestValue, set_reportFrequency, set_resolution, setAdvMode, setHighestValue, setLogFrequency, setLowestValue, setReportFrequency, setResolution, startDataLogger, stopDataLogger

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, _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

DESCRIPTION_INVALID

public static final String DESCRIPTION_INVALID

invalid description value

See Also:

Constant Field Values

COMMAND_INVALID

public static final String COMMAND_INVALID

invalid command value

See Also:

Constant Field Values

_description

protected String _description

_command

protected String _command

_valueCallbackArithmeticSensor

protected YArithmeticSensor.UpdateCallback _valueCallbackArithmeticSensor

_timedReportCallbackArithmeticSensor

protected YArithmeticSensor.TimedReportCallback _timedReportCallbackArithmeticSensor

Constructor Detail

YArithmeticSensor

protected YArithmeticSensor(YAPIContext ctx,
                            String func)

Parameters:

func - : functionid

YArithmeticSensor

protected YArithmeticSensor(String func)

Parameters:

func - : functionid

Method Detail

_parseAttr

protected void _parseAttr(com.yoctopuce.YoctoAPI.YJSONObject json_val)
                   throws Exception

Overrides:

_parseAttr in class YSensor

Throws:

Exception

set_unit

public int set_unit(String newval)
             throws YAPI_Exception

Changes the measuring unit for the arithmetic sensor. Remember to call the saveToFlash() method of the module if the modification must be kept.

Parameters:

newval - : a string corresponding to the measuring unit for the arithmetic sensor

Returns:

YAPI.SUCCESS if the call succeeds.

Throws:

YAPI_Exception - on error

setUnit

public int setUnit(String newval)
            throws YAPI_Exception

Changes the measuring unit for the arithmetic sensor. Remember to call the saveToFlash() method of the module if the modification must be kept.

Parameters:

newval - : a string corresponding to the measuring unit for the arithmetic sensor

Returns:

YAPI.SUCCESS if the call succeeds.

Throws:

YAPI_Exception - on error

get_description

public String get_description()
                       throws YAPI_Exception

Returns a short informative description of the formula.

Returns:

a string corresponding to a short informative description of the formula

Throws:

YAPI_Exception - on error

getDescription

public String getDescription()
                      throws YAPI_Exception

Returns a short informative description of the formula.

Returns:

a string corresponding to a short informative description of the formula

Throws:

YAPI_Exception - on error

get_command

public String get_command()
                   throws YAPI_Exception

Throws:

YAPI_Exception

set_command

public int set_command(String newval)
                throws YAPI_Exception

Throws:

YAPI_Exception

FindArithmeticSensor

public static YArithmeticSensor FindArithmeticSensor(String func)

Retrieves an arithmetic sensor 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 arithmetic sensor is online at the time it is invoked. The returned object is nevertheless valid. Use the method YArithmeticSensor.isOnline() to test if the arithmetic sensor is indeed online at a given time. In case of ambiguity when looking for an arithmetic sensor 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 arithmetic sensor, for instance RXUVOLT1.arithmeticSensor1.

Returns:

a YArithmeticSensor object allowing you to drive the arithmetic sensor.

FindArithmeticSensorInContext

public static YArithmeticSensor FindArithmeticSensorInContext(YAPIContext yctx,
                                                              String func)

Retrieves an arithmetic sensor 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 arithmetic sensor is online at the time it is invoked. The returned object is nevertheless valid. Use the method YArithmeticSensor.isOnline() to test if the arithmetic sensor is indeed online at a given time. In case of ambiguity when looking for an arithmetic sensor 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 arithmetic sensor, for instance RXUVOLT1.arithmeticSensor1.

Returns:

a YArithmeticSensor object allowing you to drive the arithmetic sensor.

registerValueCallback

public int registerValueCallback(YArithmeticSensor.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 YSensor

registerTimedReportCallback

public int registerTimedReportCallback(YArithmeticSensor.TimedReportCallback callback)

Registers the callback function that is invoked on every periodic timed notification. 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 an YMeasure object describing the new advertised value.

_invokeTimedReportCallback

public int _invokeTimedReportCallback(YMeasure value)

Overrides:

_invokeTimedReportCallback in class YSensor

defineExpression

public double defineExpression(String expr,
                               String descr)
                        throws YAPI_Exception

Defines the arithmetic function by means of an algebraic expression. The expression may include references to device sensors, by their physical or logical name, to usual math functions and to auxiliary functions defined separately.

Parameters:

expr - : the algebraic expression defining the function.

descr - : short informative description of the expression.

Returns:

the current expression value if the call succeeds.

Throws:

YAPI_Exception - on error

loadExpression

public String loadExpression()
                      throws YAPI_Exception

Retrieves the algebraic expression defining the arithmetic function, as previously configured using the defineExpression function.

Returns:

a string containing the mathematical expression.

Throws:

YAPI_Exception - on error

defineAuxiliaryFunction

public int defineAuxiliaryFunction(String name,
                                   ArrayList<Double> inputValues,
                                   ArrayList<Double> outputValues)
                            throws YAPI_Exception

Defines a auxiliary function by means of a table of reference points. Intermediate values will be interpolated between specified reference points. The reference points are given as pairs of floating point numbers. The auxiliary function will be available for use by all ArithmeticSensor objects of the device. Up to nine auxiliary function can be defined in a device, each containing up to 96 reference points.

Parameters:

name - : auxiliary function name, up to 16 characters.

inputValues - : array of floating point numbers, corresponding to the function input value.

outputValues - : array of floating point numbers, corresponding to the output value desired for each of the input value, index by index.

Returns:

YAPI.SUCCESS if the call succeeds.

Throws:

YAPI_Exception - on error

loadAuxiliaryFunction

public int loadAuxiliaryFunction(String name,
                                 ArrayList<Double> inputValues,
                                 ArrayList<Double> outputValues)
                          throws YAPI_Exception

Retrieves the reference points table defining an auxiliary function previously configured using the defineAuxiliaryFunction function.

Parameters:

name - : auxiliary function name, up to 16 characters.

inputValues - : array of floating point numbers, that is filled by the function with all the function reference input value.

outputValues - : array of floating point numbers, that is filled by the function output value for each of the input value, index by index.

Returns:

YAPI.SUCCESS if the call succeeds.

Throws:

YAPI_Exception - on error

nextArithmeticSensor

public YArithmeticSensor nextArithmeticSensor()

Continues the enumeration of arithmetic sensors started using yFirstArithmeticSensor(). Caution: You can't make any assumption about the returned arithmetic sensors order. If you want to find a specific an arithmetic sensor, use ArithmeticSensor.findArithmeticSensor() and a hardwareID or a logical name.

Returns:

a pointer to a YArithmeticSensor object, corresponding to an arithmetic sensor currently online, or a null pointer if there are no more arithmetic sensors to enumerate.

FirstArithmeticSensor

public static YArithmeticSensor FirstArithmeticSensor()

Starts the enumeration of arithmetic sensors currently accessible. Use the method YArithmeticSensor.nextArithmeticSensor() to iterate on next arithmetic sensors.

Returns:

a pointer to a YArithmeticSensor object, corresponding to the first arithmetic sensor currently online, or a null pointer if there are none.

FirstArithmeticSensorInContext

public static YArithmeticSensor FirstArithmeticSensorInContext(YAPIContext yctx)

Starts the enumeration of arithmetic sensors currently accessible. Use the method YArithmeticSensor.nextArithmeticSensor() to iterate on next arithmetic sensors.

Parameters:

yctx - : a YAPI context.

Returns:

a pointer to a YArithmeticSensor object, corresponding to the first arithmetic sensor currently online, or a null pointer if there are none.