public class YCurrent extends YSensor
Modifier and Type | Class and Description |
---|---|
static interface |
YCurrent.TimedReportCallback
TimedReportCallback for Current
|
static interface |
YCurrent.UpdateCallback
Deprecated UpdateCallback for Current
|
Modifier and Type | Field and Description |
---|---|
protected int |
_enabled |
protected YCurrent.TimedReportCallback |
_timedReportCallbackCurrent |
protected YCurrent.UpdateCallback |
_valueCallbackCurrent |
static int |
ENABLED_FALSE
invalid enabled value
|
static int |
ENABLED_INVALID |
static int |
ENABLED_TRUE |
_advMode, _calhdl, _calibrationParam, _calpar, _calraw, _calref, _caltyp, _currentRawValue, _currentValue, _decexp, _highestValue, _iresol, _logFrequency, _lowestValue, _offset, _prevTimedReport, _reportFrequency, _resolution, _scale, _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
_advertisedValue, _cacheExpiration, _className, _dataStreams, _func, _funId, _hwId, _lastErrorMsg, _lastErrorType, _logicalName, _serial, _userData, _valueCallbackFunction, _yapi, ADVERTISEDVALUE_INVALID, FUNCTIONDESCRIPTOR_INVALID, LOGICALNAME_INVALID
Modifier | Constructor and Description |
---|---|
protected |
YCurrent(String func) |
protected |
YCurrent(YAPIContext ctx,
String func) |
Modifier and Type | Method and Description |
---|---|
int |
_invokeTimedReportCallback(YMeasure value) |
int |
_invokeValueCallback(String value) |
protected void |
_parseAttr(com.yoctopuce.YoctoAPI.YJSONObject json_val) |
static YCurrent |
FindCurrent(String func)
Retrieves a current sensor for a given identifier.
|
static YCurrent |
FindCurrentInContext(YAPIContext yctx,
String func)
Retrieves a current sensor for a given identifier in a YAPI context.
|
static YCurrent |
FirstCurrent()
Starts the enumeration of current sensors currently accessible.
|
static YCurrent |
FirstCurrentInContext(YAPIContext yctx)
Starts the enumeration of current sensors currently accessible.
|
int |
get_enabled()
Returns the activation state of this input.
|
int |
getEnabled()
Returns the activation state of this input.
|
YCurrent |
nextCurrent()
Continues the enumeration of current sensors started using yFirstCurrent().
|
int |
registerTimedReportCallback(YCurrent.TimedReportCallback callback)
Registers the callback function that is invoked on every periodic timed notification.
|
int |
registerValueCallback(YCurrent.UpdateCallback callback)
Registers the callback function that is invoked on every change of advertised value.
|
int |
set_enabled(int newval)
Changes the activation state of this voltage input.
|
int |
setEnabled(int newval)
Changes the activation state of this voltage input.
|
_applyCalibration, _decodeAvg, _decodeTimedReport, _decodeVal, _encodeCalibrationPoints, _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
_AddToCache, _clearDataStreamCache, _download, _escapeAttr, _FindFromCache, _FindFromCacheInContext, _get_json_path_struct, _get_json_path, _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
public static final int ENABLED_FALSE
public static final int ENABLED_TRUE
public static final int ENABLED_INVALID
protected int _enabled
protected YCurrent.UpdateCallback _valueCallbackCurrent
protected YCurrent.TimedReportCallback _timedReportCallbackCurrent
protected YCurrent(YAPIContext ctx, String func)
func
- : functionidprotected YCurrent(String func)
func
- : functionidprotected void _parseAttr(com.yoctopuce.YoctoAPI.YJSONObject json_val) throws Exception
_parseAttr
in class YSensor
Exception
public int get_enabled() throws YAPI_Exception
YAPI_Exception
- on errorpublic int getEnabled() throws YAPI_Exception
YAPI_Exception
- on errorpublic int set_enabled(int newval) throws YAPI_Exception
newval
- : either YCurrent.ENABLED_FALSE or YCurrent.ENABLED_TRUE, according to the activation
state of this voltage inputYAPI_Exception
- on errorpublic int setEnabled(int newval) throws YAPI_Exception
newval
- : either Y_ENABLED_FALSE or Y_ENABLED_TRUE, according to the activation state of this
voltage inputYAPI_Exception
- on errorpublic static YCurrent FindCurrent(String func)
func
- : a string that uniquely characterizes the current sensor, for instance
YAMPMK01.current1.public static YCurrent FindCurrentInContext(YAPIContext yctx, String func)
yctx
- : a YAPI contextfunc
- : a string that uniquely characterizes the current sensor, for instance
YAMPMK01.current1.public int registerValueCallback(YCurrent.UpdateCallback callback)
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.public int _invokeValueCallback(String value)
_invokeValueCallback
in class YSensor
public int registerTimedReportCallback(YCurrent.TimedReportCallback callback)
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.public int _invokeTimedReportCallback(YMeasure value)
_invokeTimedReportCallback
in class YSensor
public YCurrent nextCurrent()
public static YCurrent FirstCurrent()
public static YCurrent FirstCurrentInContext(YAPIContext yctx)
yctx
- : a YAPI context.Copyright © 2020. All rights reserved.