yoctolib-esm
Version:
Yoctopuce library for TypeScript/JavaScript, as an ECMAScript 2015 module
355 lines • 14.3 kB
JavaScript
/*********************************************************************
*
* $Id: svn_id $
*
* Implements the high-level API for Compass functions
*
* - - - - - - - - - License information: - - - - - - - - -
*
* Copyright (C) 2011 and beyond by Yoctopuce Sarl, Switzerland.
*
* Yoctopuce Sarl (hereafter Licensor) grants to you a perpetual
* non-exclusive license to use, modify, copy and integrate this
* file into your software for the sole purpose of interfacing
* with Yoctopuce products.
*
* You may reproduce and distribute copies of this file in
* source or object form, as long as the sole purpose of this
* code is to interface with Yoctopuce products. You must retain
* this notice in the distributed source file.
*
* You should refer to Yoctopuce General Terms and Conditions
* for additional information regarding your rights and
* obligations.
*
* THE SOFTWARE AND DOCUMENTATION ARE PROVIDED 'AS IS' WITHOUT
* WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING
* WITHOUT LIMITATION, ANY WARRANTY OF MERCHANTABILITY, FITNESS
* FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO
* EVENT SHALL LICENSOR BE LIABLE FOR ANY INCIDENTAL, SPECIAL,
* INDIRECT OR CONSEQUENTIAL DAMAGES, LOST PROFITS OR LOST DATA,
* COST OF PROCUREMENT OF SUBSTITUTE GOODS, TECHNOLOGY OR
* SERVICES, ANY CLAIMS BY THIRD PARTIES (INCLUDING BUT NOT
* LIMITED TO ANY DEFENSE THEREOF), ANY CLAIMS FOR INDEMNITY OR
* CONTRIBUTION, OR OTHER SIMILAR COSTS, WHETHER ASSERTED ON THE
* BASIS OF CONTRACT, TORT (INCLUDING NEGLIGENCE), BREACH OF
* WARRANTY, OR OTHERWISE.
*
*********************************************************************/
import { YAPI, YFunction, YSensor } from './yocto_api.js';
//--- (YCompass class start)
/**
* YCompass Class: compass function control interface, available for instance in the Yocto-3D-V2
*
* The YCompass class allows you to read and configure Yoctopuce compass functions.
* It inherits from YSensor class the core functions to read measurements,
* to register callback functions, and to access the autonomous datalogger.
*/
//--- (end of YCompass class start)
export class YCompass extends YSensor {
//--- (end of YCompass attributes declaration)
constructor(yapi, func) {
//--- (YCompass constructor)
super(yapi, func);
this._bandwidth = YCompass.BANDWIDTH_INVALID;
this._axis = YCompass.AXIS_INVALID;
this._magneticHeading = YCompass.MAGNETICHEADING_INVALID;
this._valueCallbackCompass = null;
this._timedReportCallbackCompass = null;
// API symbols as object properties
this.BANDWIDTH_INVALID = YAPI.INVALID_UINT;
this.AXIS_X = 0;
this.AXIS_Y = 1;
this.AXIS_Z = 2;
this.AXIS_INVALID = -1;
this.MAGNETICHEADING_INVALID = YAPI.INVALID_DOUBLE;
this._className = 'Compass';
//--- (end of YCompass constructor)
}
//--- (YCompass implementation)
imm_parseAttr(name, val) {
switch (name) {
case 'bandwidth':
this._bandwidth = val;
return 1;
case 'axis':
this._axis = val;
return 1;
case 'magneticHeading':
this._magneticHeading = Math.round(val / 65.536) / 1000.0;
return 1;
}
return super.imm_parseAttr(name, val);
}
/**
* Returns the measure update frequency, measured in Hz.
*
* @return an integer corresponding to the measure update frequency, measured in Hz
*
* On failure, throws an exception or returns YCompass.BANDWIDTH_INVALID.
*/
async get_bandwidth() {
let res;
if (this._cacheExpiration <= this._yapi.GetTickCount()) {
if (await this.load(this._yapi.defaultCacheValidity) != this._yapi.SUCCESS) {
return YCompass.BANDWIDTH_INVALID;
}
}
res = this._bandwidth;
return res;
}
/**
* Changes the measure update frequency, measured in Hz. When the
* frequency is lower, the device performs averaging.
* Remember to call the saveToFlash()
* method of the module if the modification must be kept.
*
* @param newval : an integer corresponding to the measure update frequency, measured in Hz
*
* @return YAPI.SUCCESS if the call succeeds.
*
* On failure, throws an exception or returns a negative error code.
*/
async set_bandwidth(newval) {
let rest_val;
rest_val = String(newval);
return await this._setAttr('bandwidth', rest_val);
}
async get_axis() {
let res;
if (this._cacheExpiration <= this._yapi.GetTickCount()) {
if (await this.load(this._yapi.defaultCacheValidity) != this._yapi.SUCCESS) {
return YCompass.AXIS_INVALID;
}
}
res = this._axis;
return res;
}
/**
* Returns the magnetic heading, regardless of the configured bearing.
*
* @return a floating point number corresponding to the magnetic heading, regardless of the configured bearing
*
* On failure, throws an exception or returns YCompass.MAGNETICHEADING_INVALID.
*/
async get_magneticHeading() {
let res;
if (this._cacheExpiration <= this._yapi.GetTickCount()) {
if (await this.load(this._yapi.defaultCacheValidity) != this._yapi.SUCCESS) {
return YCompass.MAGNETICHEADING_INVALID;
}
}
res = this._magneticHeading;
return res;
}
/**
* Retrieves a compass function 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 compass function is online at the time
* it is invoked. The returned object is nevertheless valid.
* Use the method YCompass.isOnline() to test if the compass function is
* indeed online at a given time. In case of ambiguity when looking for
* a compass function 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.
*
* @param func : a string that uniquely characterizes the compass function, for instance
* Y3DMK002.compass.
*
* @return a YCompass object allowing you to drive the compass function.
*/
static FindCompass(func) {
let obj;
obj = YFunction._FindFromCache('Compass', func);
if (obj == null) {
obj = new YCompass(YAPI, func);
YFunction._AddToCache('Compass', func, obj);
}
return obj;
}
/**
* Retrieves a compass function 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 compass function is online at the time
* it is invoked. The returned object is nevertheless valid.
* Use the method YCompass.isOnline() to test if the compass function is
* indeed online at a given time. In case of ambiguity when looking for
* a compass function 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.
*
* @param yctx : a YAPI context
* @param func : a string that uniquely characterizes the compass function, for instance
* Y3DMK002.compass.
*
* @return a YCompass object allowing you to drive the compass function.
*/
static FindCompassInContext(yctx, func) {
let obj;
obj = YFunction._FindFromCacheInContext(yctx, 'Compass', func);
if (obj == null) {
obj = new YCompass(yctx, func);
YFunction._AddToCache('Compass', func, obj);
}
return obj;
}
/**
* 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.
*
* @param 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.
* @noreturn
*/
async registerValueCallback(callback) {
let val;
if (callback != null) {
await YFunction._UpdateValueCallbackList(this, true);
}
else {
await YFunction._UpdateValueCallbackList(this, false);
}
this._valueCallbackCompass = callback;
// Immediately invoke value callback with current value
if (callback != null && await this.isOnline()) {
val = this._advertisedValue;
if (!(val == '')) {
await this._invokeValueCallback(val);
}
}
return 0;
}
async _invokeValueCallback(value) {
if (this._valueCallbackCompass != null) {
try {
await this._valueCallbackCompass(this, value);
}
catch (e) {
this._yapi.imm_log('Exception in valueCallback:', e);
}
}
else {
await super._invokeValueCallback(value);
}
return 0;
}
/**
* 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.
*
* @param 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.
* @noreturn
*/
async registerTimedReportCallback(callback) {
let sensor;
sensor = this;
if (callback != null) {
await YFunction._UpdateTimedReportCallbackList(sensor, true);
}
else {
await YFunction._UpdateTimedReportCallbackList(sensor, false);
}
this._timedReportCallbackCompass = callback;
return 0;
}
async _invokeTimedReportCallback(value) {
if (this._timedReportCallbackCompass != null) {
try {
await this._timedReportCallbackCompass(this, value);
}
catch (e) {
this._yapi.imm_log('Exception in timedReportCallback:', e);
}
}
else {
await super._invokeTimedReportCallback(value);
}
return 0;
}
/**
* Continues the enumeration of compass functions started using yFirstCompass().
* Caution: You can't make any assumption about the returned compass functions order.
* If you want to find a specific a compass function, use Compass.findCompass()
* and a hardwareID or a logical name.
*
* @return a pointer to a YCompass object, corresponding to
* a compass function currently online, or a null pointer
* if there are no more compass functions to enumerate.
*/
nextCompass() {
let resolve = this._yapi.imm_resolveFunction(this._className, this._func);
if (resolve.errorType != YAPI.SUCCESS)
return null;
let next_hwid = this._yapi.imm_getNextHardwareId(this._className, resolve.result);
if (next_hwid == null)
return null;
return YCompass.FindCompassInContext(this._yapi, next_hwid);
}
/**
* Starts the enumeration of compass functions currently accessible.
* Use the method YCompass.nextCompass() to iterate on
* next compass functions.
*
* @return a pointer to a YCompass object, corresponding to
* the first compass function currently online, or a null pointer
* if there are none.
*/
static FirstCompass() {
let next_hwid = YAPI.imm_getFirstHardwareId('Compass');
if (next_hwid == null)
return null;
return YCompass.FindCompass(next_hwid);
}
/**
* Starts the enumeration of compass functions currently accessible.
* Use the method YCompass.nextCompass() to iterate on
* next compass functions.
*
* @param yctx : a YAPI context.
*
* @return a pointer to a YCompass object, corresponding to
* the first compass function currently online, or a null pointer
* if there are none.
*/
static FirstCompassInContext(yctx) {
let next_hwid = yctx.imm_getFirstHardwareId('Compass');
if (next_hwid == null)
return null;
return YCompass.FindCompassInContext(yctx, next_hwid);
}
}
// API symbols as static members
YCompass.BANDWIDTH_INVALID = YAPI.INVALID_UINT;
YCompass.AXIS_X = 0;
YCompass.AXIS_Y = 1;
YCompass.AXIS_Z = 2;
YCompass.AXIS_INVALID = -1;
YCompass.MAGNETICHEADING_INVALID = YAPI.INVALID_DOUBLE;
//# sourceMappingURL=yocto_compass.js.map