com.yoctopuce.YoctoAPI

Class YCarbonDioxide

java.lang.Object

com.yoctopuce.YoctoAPI.YFunction

com.yoctopuce.YoctoAPI.YSensor

com.yoctopuce.YoctoAPI.YCarbonDioxide

public class YCarbonDioxide
extends YSensor

YCarbonDioxide Class: CO2 sensor control interface, available for instance in the Yocto-CO2-V2 The YCarbonDioxide class allows you to read and configure Yoctopuce CO2 sensors. It inherits from YSensor class the core functions to read measurements, to register callback functions, and to access the autonomous datalogger. This class adds the ability to perform manual calibration if required.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	YCarbonDioxide.TimedReportCallback TimedReportCallback for CarbonDioxide
static interface	YCarbonDioxide.UpdateCallback Deprecated UpdateCallback for CarbonDioxide

Field Summary

Fields

Modifier and Type	Field and Description
protected int	_abcPeriod
protected String	_command
protected YCarbonDioxide.TimedReportCallback	_timedReportCallbackCarbonDioxide
protected YCarbonDioxide.UpdateCallback	_valueCallbackCarbonDioxide
static int	ABCPERIOD_INVALID invalid abcPeriod value
static String	COMMAND_INVALID invalid command 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	YCarbonDioxide(String func)
protected	YCarbonDioxide(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)
static YCarbonDioxide	FindCarbonDioxide(String func) Retrieves a CO2 sensor for a given identifier.
static YCarbonDioxide	FindCarbonDioxideInContext(YAPIContext yctx, String func) Retrieves a CO2 sensor for a given identifier in a YAPI context.
static YCarbonDioxide	FirstCarbonDioxide() Starts the enumeration of CO2 sensors currently accessible.
static YCarbonDioxide	FirstCarbonDioxideInContext(YAPIContext yctx) Starts the enumeration of CO2 sensors currently accessible.
int	get_abcPeriod() Returns the Automatic Baseline Calibration period, in hours.
String	get_command()
int	getAbcPeriod() Returns the Automatic Baseline Calibration period, in hours.
YCarbonDioxide	nextCarbonDioxide() Continues the enumeration of CO2 sensors started using yFirstCarbonDioxide().
int	registerTimedReportCallback(YCarbonDioxide.TimedReportCallback callback) Registers the callback function that is invoked on every periodic timed notification.
int	registerValueCallback(YCarbonDioxide.UpdateCallback callback) Registers the callback function that is invoked on every change of advertised value.
int	set_abcPeriod(int newval) Changes Automatic Baseline Calibration period, in hours.
int	set_command(String newval)
int	setAbcPeriod(int newval) Changes Automatic Baseline Calibration period, in hours.
int	triggerBaselineCalibration() Triggers a baseline calibration at standard CO2 ambiant level (400ppm).
int	triggerForcedCalibration(double refVal) Triggers a forced calibration of the sensor at a given CO2 level, specified between 400ppm and 2000ppm.
int	triggerZeroCalibration() Triggers a zero calibration of the sensor on carbon dioxide-free air - for use with first generation Yocto-CO2 only.
int	triggetBaselineCalibration()
int	triggetZeroCalibration()

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

ABCPERIOD_INVALID

public static final int ABCPERIOD_INVALID

invalid abcPeriod value

See Also:

Constant Field Values

COMMAND_INVALID

public static final String COMMAND_INVALID

invalid command value

See Also:

Constant Field Values

_abcPeriod

protected int _abcPeriod

_command

protected String _command

_valueCallbackCarbonDioxide

protected YCarbonDioxide.UpdateCallback _valueCallbackCarbonDioxide

_timedReportCallbackCarbonDioxide

protected YCarbonDioxide.TimedReportCallback _timedReportCallbackCarbonDioxide

Constructor Detail

YCarbonDioxide

protected YCarbonDioxide(YAPIContext ctx,
                         String func)

Parameters:

func - : functionid

YCarbonDioxide

protected YCarbonDioxide(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

get_abcPeriod

public int get_abcPeriod()
                  throws YAPI_Exception

Returns the Automatic Baseline Calibration period, in hours. A negative value means that automatic baseline calibration is disabled.

Returns:

an integer corresponding to the Automatic Baseline Calibration period, in hours

Throws:

YAPI_Exception - on error

getAbcPeriod

public int getAbcPeriod()
                 throws YAPI_Exception

Returns the Automatic Baseline Calibration period, in hours. A negative value means that automatic baseline calibration is disabled.

Returns:

an integer corresponding to the Automatic Baseline Calibration period, in hours

Throws:

YAPI_Exception - on error

set_abcPeriod

public int set_abcPeriod(int newval)
                  throws YAPI_Exception

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 400 ppm CO2), set the period to -1. For the Yocto-CO2-V2, the only possible values are 24 and -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.

Throws:

YAPI_Exception - on error

setAbcPeriod

public int setAbcPeriod(int newval)
                 throws YAPI_Exception

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 400 ppm CO2), set the period to -1. For the Yocto-CO2-V2, the only possible values are 24 and -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.

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

FindCarbonDioxide

public static YCarbonDioxide FindCarbonDioxide(String func)

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, for instance YCO2MK02.carbonDioxide.

Returns:

a YCarbonDioxide object allowing you to drive the CO2 sensor.

FindCarbonDioxideInContext

public static YCarbonDioxide FindCarbonDioxideInContext(YAPIContext yctx,
                                                        String func)

Retrieves a CO2 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 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.

Parameters:

yctx - : a YAPI context

func - : a string that uniquely characterizes the CO2 sensor, for instance YCO2MK02.carbonDioxide.

Returns:

a YCarbonDioxide object allowing you to drive the CO2 sensor.

registerValueCallback

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

triggerForcedCalibration

public int triggerForcedCalibration(double refVal)
                             throws YAPI_Exception

Triggers a forced calibration of the sensor at a given CO2 level, specified between 400ppm and 2000ppm. Before invoking this command, the sensor must have been maintained within the specified CO2 density during at least two minutes.

Parameters:

refVal - : reference CO2 density for the calibration

Returns:

YAPI.SUCCESS if the call succeeds.

Throws:

YAPI_Exception - on error

triggerBaselineCalibration

public int triggerBaselineCalibration()
                               throws YAPI_Exception

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 automatic baseline calibration is disabled, 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 400 ppm for at least two minutes.

Returns:

YAPI.SUCCESS if the call succeeds.

Throws:

YAPI_Exception - on error

triggetBaselineCalibration

public int triggetBaselineCalibration()
                               throws YAPI_Exception

Throws:

YAPI_Exception

triggerZeroCalibration

public int triggerZeroCalibration()
                           throws YAPI_Exception

Triggers a zero calibration of the sensor on carbon dioxide-free air - for use with first generation Yocto-CO2 only. 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 support@yoctopuce.com for more details on the zero calibration procedure.

Returns:

YAPI.SUCCESS if the call succeeds.

Throws:

YAPI_Exception - on error

triggetZeroCalibration

public int triggetZeroCalibration()
                           throws YAPI_Exception

Throws:

YAPI_Exception

nextCarbonDioxide

public YCarbonDioxide nextCarbonDioxide()

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

Returns:

a pointer to a YCarbonDioxide object, corresponding to a CO2 sensor currently online, or a null pointer if there are no more CO2 sensors to enumerate.

FirstCarbonDioxide

public static YCarbonDioxide FirstCarbonDioxide()

Starts the enumeration of CO2 sensors currently accessible. Use the method YCarbonDioxide.nextCarbonDioxide() to iterate on next CO2 sensors.

Returns:

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

FirstCarbonDioxideInContext

public static YCarbonDioxide FirstCarbonDioxideInContext(YAPIContext yctx)

Starts the enumeration of CO2 sensors currently accessible. Use the method YCarbonDioxide.nextCarbonDioxide() to iterate on next CO2 sensors.

Parameters:

yctx - : a YAPI context.

Returns:

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