Yoctopuce Yocto-GPS, User Manual

Page: 334 / 572

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