|
| virtual int | _invokeTimedReportCallback (YMeasure value) |
| |
| virtual int | _invokeValueCallback (string value) |
| |
| int | calibrate (double calibratedVal) |
| |
| Y_MEASURETYPE_enum | get_measureType (void) |
| |
| Y_MEASURETYPE_enum | measureType (void) |
| |
| YLightSensor * | next (void) |
| |
| YLightSensor * | nextLightSensor (void) |
| |
| virtual int | registerTimedReportCallback (YLightSensorTimedReportCallback callback) |
| |
| virtual int | registerValueCallback (YLightSensorValueCallback callback) |
| |
| int | set_currentValue (double newval) |
| |
| int | set_measureType (Y_MEASURETYPE_enum newval) |
| |
| int | setCurrentValue (double newval) |
| |
| int | setMeasureType (Y_MEASURETYPE_enum newval) |
| |
| | ~YLightSensor () |
| |
| virtual double | _applyCalibration (double rawValue) |
| |
| virtual double | _decodeAvg (int dw) |
| |
| virtual YMeasure | _decodeTimedReport (double timestamp, vector< int > report) |
| |
| virtual double | _decodeVal (int w) |
| |
| virtual string | _encodeCalibrationPoints (vector< double > rawValues, vector< double > refValues) |
| |
| virtual int | _parserHelper (void) |
| |
| Y_ADVMODE_enum | advMode (void) |
| |
| virtual int | calibrateFromPoints (vector< double > rawValues, vector< double > refValues) |
| |
| string | calibrationParam (void) |
| |
| double | currentRawValue (void) |
| |
| double | currentValue (void) |
| |
| Y_ADVMODE_enum | get_advMode (void) |
| |
| string | get_calibrationParam (void) |
| |
| double | get_currentRawValue (void) |
| |
| double | get_currentValue (void) |
| |
| virtual YDataLogger * | get_dataLogger (void) |
| |
| double | get_highestValue (void) |
| |
| string | get_logFrequency (void) |
| |
| double | get_lowestValue (void) |
| |
| virtual YDataSet | get_recordedData (s64 startTime, s64 endTime) |
| |
| string | get_reportFrequency (void) |
| |
| double | get_resolution (void) |
| |
| int | get_sensorState (void) |
| |
| string | get_unit (void) |
| |
| double | highestValue (void) |
| |
| virtual bool | isSensorReady (void) |
| |
| virtual int | loadCalibrationPoints (vector< double > &rawValues, vector< double > &refValues) |
| |
| string | logFrequency (void) |
| |
| double | lowestValue (void) |
| |
| YSensor * | next (void) |
| |
| YSensor * | nextSensor (void) |
| |
| virtual int | registerTimedReportCallback (YSensorTimedReportCallback callback) |
| |
| virtual int | registerValueCallback (YSensorValueCallback callback) |
| |
| string | reportFrequency (void) |
| |
| double | resolution (void) |
| |
| int | sensorState (void) |
| |
| int | set_advMode (Y_ADVMODE_enum newval) |
| |
| int | set_calibrationParam (const string &newval) |
| |
| int | set_highestValue (double newval) |
| |
| int | set_logFrequency (const string &newval) |
| |
| int | set_lowestValue (double newval) |
| |
| int | set_reportFrequency (const string &newval) |
| |
| int | set_resolution (double newval) |
| |
| int | setAdvMode (Y_ADVMODE_enum newval) |
| |
| int | setCalibrationParam (const string &newval) |
| |
| int | setHighestValue (double newval) |
| |
| int | setLogFrequency (const string &newval) |
| |
| int | setLowestValue (double newval) |
| |
| int | setReportFrequency (const string &newval) |
| |
| int | setResolution (double newval) |
| |
| virtual int | startDataLogger (void) |
| |
| virtual int | stopDataLogger (void) |
| |
| string | unit (void) |
| |
| | ~YSensor () |
| |
| void | _clearDataStreamCache () |
| |
| string | _decode_json_string (const string &json) |
| |
| string | _download (const string &url) |
| |
| YDataStream * | _findDataStream (YDataSet &dataset, const string &def) |
| |
| string | _get_json_path (const string &json, const string &path) |
| |
| vector< string > | _json_get_array (const string &json) |
| |
| string | _json_get_key (const string &json, const string &data) |
| |
| string | _json_get_string (const string &json) |
| |
| int | _parseEx (yJsonStateMachine &j) |
| |
| string | _parseString (yJsonStateMachine &j) |
| |
| string | _request (const string &request) |
| |
| string | _requestEx (int tcpchan, const string &request, yapiRequestProgressCallback callback, void *context) |
| |
| void | _throw (YRETCODE errType, string errMsg) |
| |
| YRETCODE | _upload (const string &path, const string &content) |
| |
| YRETCODE | _uploadWithProgress (const string &path, const string &content, yapiRequestProgressCallback callback, void *context) |
| |
| string | advertisedValue (void) |
| |
| void | clearCache () |
| |
| string | describe (void) |
| |
| string | errMessage (void) |
| |
| string | errorMessage (void) |
| |
| YRETCODE | errorType (void) |
| |
| YRETCODE | errType (void) |
| |
| YFUN_DESCR | functionDescriptor (void) |
| |
| string | get_advertisedValue (void) |
| |
| string | get_errorMessage (void) |
| |
| YRETCODE | get_errorType (void) |
| |
| virtual string | get_friendlyName (void) |
| |
| YFUN_DESCR | get_functionDescriptor (void) |
| |
| string | get_functionId (void) |
| |
| string | get_hardwareId (void) |
| |
| string | get_hubSerial () |
| |
| string | get_logicalName (void) |
| |
| YModule * | get_module (void) |
| |
| void * | get_userData (void) |
| |
| bool | isOnline (void) |
| |
| YRETCODE | load (int msValidity) |
| |
| virtual string | loadAttribute (string attrName) |
| |
| string | logicalName (void) |
| |
| YModule * | module (void) |
| |
| virtual int | muteValueCallbacks (void) |
| |
| YFunction * | next (void) |
| |
| YFunction * | nextFunction (void) |
| |
| virtual int | registerValueCallback (YFunctionValueCallback callback) |
| |
| int | set_advertisedValue (const string &newval) |
| |
| int | set_logicalName (const string &newval) |
| |
| void | set_userData (void *data) |
| |
| int | setAdvertisedValue (const string &newval) |
| |
| int | setLogicalName (const string &newval) |
| |
| void | setUserData (void *data) |
| |
| virtual int | unmuteValueCallbacks (void) |
| |
| void * | userData (void) |
| |
| virtual | ~YFunction () |
| |
YLightSensor Class: LightSensor function interface
The Yoctopuce class YLightSensor allows you to read and configure Yoctopuce light sensors. It inherits from YSensor class the core functions to read measurements, to register callback functions, to access the autonomous datalogger. This class adds the ability to easily perform a one-point linear calibration to compensate the effect of a glass or filter placed in front of the sensor. For some light sensors with several working modes, this class can select the desired working mode.
Definition at line 82 of file yocto_lightsensor.h.
| int YLightSensor::calibrate |
( |
double |
calibratedVal | ) |
|
Changes the sensor-specific calibration parameter so that the current value matches a desired target (linear scaling).
- Parameters
-
| calibratedVal | : the desired target value. |
Remember to call the saveToFlash() method of the module if the modification must be kept.
- Returns
- YAPI_SUCCESS if the call succeeds.
On failure, throws an exception or returns a negative error code.
Definition at line 107 of file yocto_lightsensor.cpp.
Retrieves a light 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 light sensor is online at the time it is invoked. The returned object is nevertheless valid. Use the method YLightSensor.isOnline() to test if the light sensor is indeed online at a given time. In case of ambiguity when looking for a light 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 light sensor |
- Returns
- a YLightSensor object allowing you to drive the light sensor.
Definition at line 202 of file yocto_lightsensor.cpp.
Changes the light sensor type used in the device. The measure can either approximate the response of the human eye, focus on a specific light spectrum, depending on the capabilities of the light-sensitive cell. Remember to call the saveToFlash() method of the module if the modification must be kept.
- Parameters
-
| newval | : a value among Y_MEASURETYPE_HUMAN_EYE, Y_MEASURETYPE_WIDE_SPECTRUM, Y_MEASURETYPE_INFRARED, Y_MEASURETYPE_HIGH_RATE and Y_MEASURETYPE_HIGH_ENERGY corresponding to the light sensor type used in the device |
- Returns
- YAPI_SUCCESS if the call succeeds.
On failure, throws an exception or returns a negative error code.
Definition at line 159 of file yocto_lightsensor.cpp.
Retrieves a light 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 light sensor is online at the time it is invoked. The returned object is nevertheless valid. Use the method YLightSensor.isOnline() to test if the light sensor is indeed online at a given time. In case of ambiguity when looking for a light 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 light sensor |
- Returns
- a YLightSensor object allowing you to drive the light sensor.
Definition at line 289 of file yocto_lightsensor.h.
Public Member Functions inherited from YSensor