com.yoctopuce.YoctoAPI
public class YLightSensor extends YSensor
Modifier and Type | Class and Description |
---|---|
static interface |
YLightSensor.TimedReportCallback
TimedReportCallback for LightSensor
|
static interface |
YLightSensor.UpdateCallback
Deprecated UpdateCallback for LightSensor
|
Modifier and Type | Field and Description |
---|---|
protected YLightSensor.TimedReportCallback |
_timedReportCallbackLightSensor |
protected YLightSensor.UpdateCallback |
_valueCallbackLightSensor |
_calhdl, _calibrationParam, _calpar, _calraw, _calref, _caltyp, _currentRawValue, _currentValue, _decexp, _highestValue, _iresol, _isScal, _logFrequency, _lowestValue, _offset, _prevTimedReport, _reportFrequency, _resolution, _scale, _timedReportCallbackSensor, _unit, _valueCallbackSensor, CALIBRATIONPARAM_INVALID, CURRENTRAWVALUE_INVALID, CURRENTVALUE_INVALID, HIGHESTVALUE_INVALID, LOGFREQUENCY_INVALID, LOWESTVALUE_INVALID, REPORTFREQUENCY_INVALID, RESOLUTION_INVALID, UNIT_INVALID
_advertisedValue, _cacheExpiration, _className, _dataStreams, _func, _funId, _hwId, _lastErrorMsg, _lastErrorType, _logicalName, _serial, _userData, _valueCallbackFunction, ADVERTISEDVALUE_INVALID, FUNCTIONDESCRIPTOR_INVALID, LOGICALNAME_INVALID
Modifier | Constructor and Description |
---|---|
protected |
YLightSensor(String func) |
Modifier and Type | Method and Description |
---|---|
int |
_invokeTimedReportCallback(YMeasure value) |
int |
_invokeValueCallback(String value) |
protected void |
_parseAttr(org.json.JSONObject json_val) |
int |
calibrate(double calibratedVal)
Changes the sensor-specific calibration parameter so that the current value
matches a desired target (linear scaling).
|
static YLightSensor |
FindLightSensor(String func)
Retrieves a light sensor for a given identifier.
|
static YLightSensor |
FirstLightSensor()
Starts the enumeration of light sensors currently accessible.
|
YLightSensor |
nextLightSensor()
Continues the enumeration of light sensors started using yFirstLightSensor().
|
int |
registerTimedReportCallback(YLightSensor.TimedReportCallback callback)
Registers the callback function that is invoked on every periodic timed notification.
|
int |
registerValueCallback(YLightSensor.UpdateCallback callback)
Registers the callback function that is invoked on every change of advertised value.
|
int |
set_currentValue(double newval) |
int |
setCurrentValue(double newval) |
_applyCalibration, _decodeAvg, _decodeTimedReport, _decodeVal, _encodeCalibrationPoints, _parserHelper, calibrateFromPoints, FindSensor, FirstSensor, get_calibrationParam, get_currentRawValue, get_currentValue, get_highestValue, get_logFrequency, get_lowestValue, get_recordedData, get_reportFrequency, get_resolution, get_unit, getCalibrationParam, getCurrentRawValue, getCurrentValue, getHighestValue, getLogFrequency, getLowestValue, getReportFrequency, getResolution, getUnit, loadCalibrationPoints, nextSensor, registerTimedReportCallback, registerValueCallback, set_calibrationParam, set_highestValue, set_logFrequency, set_lowestValue, set_reportFrequency, set_resolution, setCalibrationParam, setHighestValue, setLogFrequency, setLowestValue, setReportFrequency, setResolution
_AddToCache, _devRequest, _download, _FindFromCache, _json_get_array, _json_get_key, _json_get_string, _parse, _setAttr, _throw, _UpdateTimedReportCallbackList, _UpdateValueCallbackList, _upload, _upload, describe, errMessage, errorMessage, errorType, errType, FindFunction, FirstFunction, functionDescriptor, get_advertisedValue, get_errorMessage, get_errorType, get_friendlyName, get_functionDescriptor, get_functionId, get_hardwareId, get_logicalName, get_module, get_userData, getAdvertisedValue, getErrorMessage, getErrorType, getFriendlyName, getFunctionDescriptor, getFunctionId, getHardwareId, getLogicalName, getModule, getUserData, isOnline, load, module, nextFunction, registerValueCallback, set_logicalName, set_userData, setLogicalName, setUserData, toString, userData
protected YLightSensor.UpdateCallback _valueCallbackLightSensor
protected YLightSensor.TimedReportCallback _timedReportCallbackLightSensor
protected YLightSensor(String func)
func
- : functionidprotected void _parseAttr(org.json.JSONObject json_val) throws org.json.JSONException
_parseAttr
in class YSensor
org.json.JSONException
public int set_currentValue(double newval) throws YAPI_Exception
YAPI_Exception
public int setCurrentValue(double newval) throws YAPI_Exception
YAPI_Exception
public int calibrate(double calibratedVal) throws YAPI_Exception
calibratedVal
- : the desired target value.
Remember to call the saveToFlash() method of the module if the
modification must be kept.YAPI_Exception
- on errorpublic static YLightSensor FindLightSensor(String func)
func
- : a string that uniquely characterizes the light sensorpublic int registerValueCallback(YLightSensor.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(YLightSensor.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 YLightSensor nextLightSensor()
public static YLightSensor FirstLightSensor()
Copyright © 2014. All rights reserved.