|
| virtual int | _invokeTimedReportCallback (YMeasure value) |
| |
| virtual int | _invokeValueCallback (string value) |
| |
| int | abcPeriod (void) |
| |
| string | command (void) |
| |
| int | get_abcPeriod (void) |
| |
| string | get_command (void) |
| |
| YCarbonDioxide * | next (void) |
| |
| YCarbonDioxide * | nextCarbonDioxide (void) |
| |
| virtual int | registerTimedReportCallback (YCarbonDioxideTimedReportCallback callback) |
| |
| virtual int | registerValueCallback (YCarbonDioxideValueCallback callback) |
| |
| int | set_abcPeriod (int newval) |
| |
| int | set_command (const string &newval) |
| |
| int | setAbcPeriod (int newval) |
| |
| int | setCommand (const string &newval) |
| |
| virtual int | triggerBaselineCalibration (void) |
| |
| virtual int | triggerZeroCalibration (void) |
| |
| virtual int | triggetBaselineCalibration (void) |
| |
| virtual int | triggetZeroCalibration (void) |
| |
| | ~YCarbonDioxide () |
| |
| 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 () |
| |
YCarbonDioxide Class: CarbonDioxide function interface
The Yoctopuce class YCarbonDioxide allows you to read and configure Yoctopuce CO2 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 perform manual calibration if reuired.
Definition at line 70 of file yocto_carbondioxide.h.
Retrieves a CO2 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 CO2 sensor is online at the time it is invoked. The returned object is nevertheless valid. Use the method YCarbonDioxide.isOnline() to test if the CO2 sensor is indeed online at a given time. In case of ambiguity when looking for a CO2 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 CO2 sensor |
- Returns
- a YCarbonDioxide object allowing you to drive the CO2 sensor.
Definition at line 207 of file yocto_carbondioxide.cpp.
| int YCarbonDioxide::set_abcPeriod |
( |
int |
newval | ) |
|
Changes Automatic Baseline Calibration period, in hours. If you need to disable automatic baseline calibration (for instance when using the sensor in an environment that is constantly above 400ppm CO2), set the period to -1. Remember to call the saveToFlash() method of the module if the modification must be kept.
- Parameters
-
| newval | : an integer corresponding to Automatic Baseline Calibration period, in hours |
- Returns
- YAPI_SUCCESS if the call succeeds.
On failure, throws an exception or returns a negative error code.
Definition at line 126 of file yocto_carbondioxide.cpp.
| int YCarbonDioxide::triggerBaselineCalibration |
( |
void |
| ) |
|
|
virtual |
Triggers a baseline calibration at standard CO2 ambiant level (400ppm). It is normally not necessary to manually calibrate the sensor, because the built-in automatic baseline calibration procedure will automatically fix any long-term drift based on the lowest level of CO2 observed over the automatic calibration period. However, if you disable automatic baseline calibration, you may want to manually trigger a calibration from time to time. Before starting a baseline calibration, make sure to put the sensor in a standard environment (e.g. outside in fresh air) at around 400ppm.
- Returns
- YAPI_SUCCESS if the call succeeds.
On failure, throws an exception or returns a negative error code.
Definition at line 316 of file yocto_carbondioxide.cpp.
| int YCarbonDioxide::triggerZeroCalibration |
( |
void |
| ) |
|
|
virtual |
Triggers a zero calibration of the sensor on carbon dioxide-free air. It is normally not necessary to manually calibrate the sensor, because the built-in automatic baseline calibration procedure will automatically fix any long-term drift based on the lowest level of CO2 observed over the automatic calibration period. However, if you disable automatic baseline calibration, you may want to manually trigger a calibration from time to time. Before starting a zero calibration, you should circulate carbon dioxide-free air within the sensor for a minute or two, using a small pipe connected to the sensor. Please contact suppo.nosp@m.rt@y.nosp@m.octop.nosp@m.uce..nosp@m.com for more details on the zero calibration procedure.
- Returns
- YAPI_SUCCESS if the call succeeds.
On failure, throws an exception or returns a negative error code.
Definition at line 342 of file yocto_carbondioxide.cpp.
Retrieves a CO2 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 CO2 sensor is online at the time it is invoked. The returned object is nevertheless valid. Use the method YCarbonDioxide.isOnline() to test if the CO2 sensor is indeed online at a given time. In case of ambiguity when looking for a CO2 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 CO2 sensor |
- Returns
- a YCarbonDioxide object allowing you to drive the CO2 sensor.
Definition at line 300 of file yocto_carbondioxide.h.
Public Member Functions inherited from YSensor