public class YCarbonDioxide extends YSensor
Modifier and Type | Class and Description |
---|---|
static interface |
YCarbonDioxide.TimedReportCallback
TimedReportCallback for CarbonDioxide
|
static interface |
YCarbonDioxide.UpdateCallback
Deprecated UpdateCallback for CarbonDioxide
|
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
|
_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 |
YCarbonDioxide(String func) |
protected |
YCarbonDioxide(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 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() |
_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 ABCPERIOD_INVALID
public static final String COMMAND_INVALID
protected int _abcPeriod
protected String _command
protected YCarbonDioxide.UpdateCallback _valueCallbackCarbonDioxide
protected YCarbonDioxide.TimedReportCallback _timedReportCallbackCarbonDioxide
protected YCarbonDioxide(YAPIContext ctx, String func)
func
- : functionidprotected YCarbonDioxide(String func)
func
- : functionidprotected void _parseAttr(com.yoctopuce.YoctoAPI.YJSONObject json_val) throws Exception
_parseAttr
in class YSensor
Exception
public int get_abcPeriod() throws YAPI_Exception
YAPI_Exception
- on errorpublic int getAbcPeriod() throws YAPI_Exception
YAPI_Exception
- on errorpublic int set_abcPeriod(int newval) throws YAPI_Exception
newval
- : an integer corresponding to Automatic Baseline Calibration period, in hoursYAPI_Exception
- on errorpublic int setAbcPeriod(int newval) throws YAPI_Exception
newval
- : an integer corresponding to Automatic Baseline Calibration period, in hoursYAPI_Exception
- on errorpublic String get_command() throws YAPI_Exception
YAPI_Exception
public int set_command(String newval) throws YAPI_Exception
YAPI_Exception
public static YCarbonDioxide FindCarbonDioxide(String func)
func
- : a string that uniquely characterizes the CO2 sensor, for instance
YCO2MK02.carbonDioxide.public static YCarbonDioxide FindCarbonDioxideInContext(YAPIContext yctx, String func)
yctx
- : a YAPI contextfunc
- : a string that uniquely characterizes the CO2 sensor, for instance
YCO2MK02.carbonDioxide.public int registerValueCallback(YCarbonDioxide.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(YCarbonDioxide.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 int triggerForcedCalibration(double refVal) throws YAPI_Exception
refVal
- : reference CO2 density for the calibrationYAPI_Exception
- on errorpublic int triggerBaselineCalibration() throws YAPI_Exception
YAPI_Exception
- on errorpublic int triggetBaselineCalibration() throws YAPI_Exception
YAPI_Exception
public int triggerZeroCalibration() throws YAPI_Exception
YAPI_Exception
- on errorpublic int triggetZeroCalibration() throws YAPI_Exception
YAPI_Exception
public YCarbonDioxide nextCarbonDioxide()
public static YCarbonDioxide FirstCarbonDioxide()
public static YCarbonDioxide FirstCarbonDioxideInContext(YAPIContext yctx)
yctx
- : a YAPI context.Copyright © 2023. All rights reserved.