com.yoctopuce.YoctoAPI

Class YAltitude

java.lang.Object

com.yoctopuce.YoctoAPI.YFunction

com.yoctopuce.YoctoAPI.YSensor

com.yoctopuce.YoctoAPI.YAltitude

public class YAltitude
extends YSensor

YAltitude Class: altimeter control interface, available for instance in the Yocto-Altimeter-V2 or the Yocto-GPS-V2 The YAltitude class allows you to read and configure Yoctopuce altimeters. 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 configure the barometric pressure adjusted to sea level (QNH) for barometric sensors.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	YAltitude.TimedReportCallback TimedReportCallback for Altitude
static interface	YAltitude.UpdateCallback Deprecated UpdateCallback for Altitude

Field Summary

Fields

Modifier and Type	Field and Description
protected double	_qnh
protected String	_technology
protected YAltitude.TimedReportCallback	_timedReportCallbackAltitude
protected YAltitude.UpdateCallback	_valueCallbackAltitude
static double	QNH_INVALID invalid qnh value
static String	TECHNOLOGY_INVALID invalid technology 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	YAltitude(String func)
protected	YAltitude(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 YAltitude	FindAltitude(String func) Retrieves an altimeter for a given identifier.
static YAltitude	FindAltitudeInContext(YAPIContext yctx, String func) Retrieves an altimeter for a given identifier in a YAPI context.
static YAltitude	FirstAltitude() Starts the enumeration of altimeters currently accessible.
static YAltitude	FirstAltitudeInContext(YAPIContext yctx) Starts the enumeration of altimeters currently accessible.
double	get_qnh() Returns the barometric pressure adjusted to sea level used to compute the altitude (QNH).
String	get_technology() Returns the technology used by the sesnor to compute altitude.
double	getQnh() Returns the barometric pressure adjusted to sea level used to compute the altitude (QNH).
String	getTechnology() Returns the technology used by the sesnor to compute altitude.
YAltitude	nextAltitude() Continues the enumeration of altimeters started using yFirstAltitude().
int	registerTimedReportCallback(YAltitude.TimedReportCallback callback) Registers the callback function that is invoked on every periodic timed notification.
int	registerValueCallback(YAltitude.UpdateCallback callback) Registers the callback function that is invoked on every change of advertised value.
int	set_currentValue(double newval) Changes the current estimated altitude.
int	set_qnh(double newval) Changes the barometric pressure adjusted to sea level used to compute the altitude (QNH).
int	setCurrentValue(double newval) Changes the current estimated altitude.
int	setQnh(double newval) Changes the barometric pressure adjusted to sea level used to compute the altitude (QNH).

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

QNH_INVALID

public static final double QNH_INVALID

invalid qnh value

See Also:

Constant Field Values

TECHNOLOGY_INVALID

public static final String TECHNOLOGY_INVALID

invalid technology value

See Also:

Constant Field Values

_qnh

protected double _qnh

_technology

protected String _technology

_valueCallbackAltitude

protected YAltitude.UpdateCallback _valueCallbackAltitude

_timedReportCallbackAltitude

protected YAltitude.TimedReportCallback _timedReportCallbackAltitude

Constructor Detail

YAltitude

protected YAltitude(YAPIContext ctx,
                    String func)

Parameters:

func - : functionid

YAltitude

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

set_currentValue

public int set_currentValue(double newval)
                     throws YAPI_Exception

Changes the current estimated altitude. This allows one to compensate for ambient pressure variations and to work in relative mode. Remember to call the saveToFlash() method of the module if the modification must be kept.

Parameters:

newval - : a floating point number corresponding to the current estimated altitude

Returns:

YAPI.SUCCESS if the call succeeds.

Throws:

YAPI_Exception - on error

setCurrentValue

public int setCurrentValue(double newval)
                    throws YAPI_Exception

Changes the current estimated altitude. This allows one to compensate for ambient pressure variations and to work in relative mode. Remember to call the saveToFlash() method of the module if the modification must be kept.

Parameters:

newval - : a floating point number corresponding to the current estimated altitude

Returns:

YAPI.SUCCESS if the call succeeds.

Throws:

YAPI_Exception - on error

set_qnh

public int set_qnh(double newval)
            throws YAPI_Exception

Changes the barometric pressure adjusted to sea level used to compute the altitude (QNH). This enables you to compensate for atmospheric pressure changes due to weather conditions. Applicable to barometric altimeters only. Remember to call the saveToFlash() method of the module if the modification must be kept.

Parameters:

newval - : a floating point number corresponding to the barometric pressure adjusted to sea level used to compute the altitude (QNH)

Returns:

YAPI.SUCCESS if the call succeeds.

Throws:

YAPI_Exception - on error

setQnh

public int setQnh(double newval)
           throws YAPI_Exception

Changes the barometric pressure adjusted to sea level used to compute the altitude (QNH). This enables you to compensate for atmospheric pressure changes due to weather conditions. Applicable to barometric altimeters only. Remember to call the saveToFlash() method of the module if the modification must be kept.

Parameters:

newval - : a floating point number corresponding to the barometric pressure adjusted to sea level used to compute the altitude (QNH)

Returns:

YAPI.SUCCESS if the call succeeds.

Throws:

YAPI_Exception - on error

get_qnh

public double get_qnh()
               throws YAPI_Exception

Returns the barometric pressure adjusted to sea level used to compute the altitude (QNH). Applicable to barometric altimeters only.

Returns:

a floating point number corresponding to the barometric pressure adjusted to sea level used to compute the altitude (QNH)

Throws:

YAPI_Exception - on error

getQnh

public double getQnh()
              throws YAPI_Exception

Returns the barometric pressure adjusted to sea level used to compute the altitude (QNH). Applicable to barometric altimeters only.

Returns:

a floating point number corresponding to the barometric pressure adjusted to sea level used to compute the altitude (QNH)

Throws:

YAPI_Exception - on error

get_technology

public String get_technology()
                      throws YAPI_Exception

Returns the technology used by the sesnor to compute altitude. Possibles values are "barometric" and "gps"

Returns:

a string corresponding to the technology used by the sesnor to compute altitude

Throws:

YAPI_Exception - on error

getTechnology

public String getTechnology()
                     throws YAPI_Exception

Returns the technology used by the sesnor to compute altitude. Possibles values are "barometric" and "gps"

Returns:

a string corresponding to the technology used by the sesnor to compute altitude

Throws:

YAPI_Exception - on error

FindAltitude

public static YAltitude FindAltitude(String func)

Retrieves an altimeter 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 altimeter is online at the time it is invoked. The returned object is nevertheless valid. Use the method YAltitude.isOnline() to test if the altimeter is indeed online at a given time. In case of ambiguity when looking for an altimeter 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 altimeter, for instance YALTIMK2.altitude.

Returns:

a YAltitude object allowing you to drive the altimeter.

FindAltitudeInContext

public static YAltitude FindAltitudeInContext(YAPIContext yctx,
                                              String func)

Retrieves an altimeter 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 altimeter is online at the time it is invoked. The returned object is nevertheless valid. Use the method YAltitude.isOnline() to test if the altimeter is indeed online at a given time. In case of ambiguity when looking for an altimeter 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 altimeter, for instance YALTIMK2.altitude.

Returns:

a YAltitude object allowing you to drive the altimeter.

registerValueCallback

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

nextAltitude

public YAltitude nextAltitude()

Continues the enumeration of altimeters started using yFirstAltitude(). Caution: You can't make any assumption about the returned altimeters order. If you want to find a specific an altimeter, use Altitude.findAltitude() and a hardwareID or a logical name.

Returns:

a pointer to a YAltitude object, corresponding to an altimeter currently online, or a null pointer if there are no more altimeters to enumerate.

FirstAltitude

public static YAltitude FirstAltitude()

Starts the enumeration of altimeters currently accessible. Use the method YAltitude.nextAltitude() to iterate on next altimeters.

Returns:

a pointer to a YAltitude object, corresponding to the first altimeter currently online, or a null pointer if there are none.

FirstAltitudeInContext

public static YAltitude FirstAltitudeInContext(YAPIContext yctx)

Starts the enumeration of altimeters currently accessible. Use the method YAltitude.nextAltitude() to iterate on next altimeters.

Parameters:

yctx - : a YAPI context.

Returns:

a pointer to a YAltitude object, corresponding to the first altimeter currently online, or a null pointer if there are none.