Yoctopuce Yocto-GPS, User Manual

Page: 387 / 572

20. High-level API Reference
20.6. Altitude function interface
The Yoctopuce class YAltitude allows you to read and configure Yoctopuce altitude sensors. It inherits
from the YSensor class the core functions to read measurements, to register callback functions, to
access the autonomous datalogger. This class adds the ability to configure the barometric pressure
adjusted to sea level (QNH) for barometric sensors.
In order to use the functions described here, you should include:
js
<script type='text/javascript' src='yocto_altitude.js'></script>
nodejs
var yoctolib = require('yoctolib');
var YAltitude = yoctolib.YAltitude;
cpp
#include "yocto_altitude.h"
m
#import "yocto_altitude.h"
pas
uses yocto_altitude;
vb
yocto_altitude.vb
cs
yocto_altitude.cs
java
import com.yoctopuce.YoctoAPI.YAltitude;
uwp
import com.yoctopuce.YoctoAPI.YAltitude;
py
from yocto_altitude import *
php
require_once('yocto_altitude.php');
es
in HTML: <script src="../../lib/yocto_altitude.js"></script>
in node.js: require('yoctolib-es2017/yocto_altitude.js');
Global functions
yFindAltitude( func )
Retrieves an altimeter for a given identifier.
yFindAltitudeInContext( yctx , func )
Retrieves an altimeter for a given identifier in a YAPI context.
yFirstAltitude()
Starts the enumeration of altimeters currently accessible.
yFirstAltitudeInContext( yctx )
Starts the enumeration of altimeters currently accessible.
YAltitude
methods
altitude
→
calibrateFromPoints( rawValues , refValues )
Configures error correction data points, in particular to compensate for a possible perturbation of the measure
caused by an enclosure.
altitude
→
clearCache()
Invalidates the cache.
altitude
→
describe()
Returns a short text that describes unambiguously the instance of the altimeter in the form
TYPE(NAME)=SERIAL.FUNCTIONID .
altitude
→
get_advertisedValue()
Returns the current value of the altimeter (no more than 6 characters).
altitude
→
get_currentRawValue()
Returns the uncalibrated, unrounded raw value returned by the sensor, in meters, as a floating point number.
altitude
→
get_currentValue()
Returns the current value of the altitude, in meters, as a floating point number.
altitude
→
get_errorMessage()
Returns the error message of the latest error with the altimeter.
www.yoctopuce.com 381