yoctolib-esm

/********************************************************************* * * $Id: svn_id $ * * Implements the high-level API for Tilt 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 { YAPIContext, YSensor, YMeasure } from './yocto_api.js'; /** * YTilt Class: tilt sensor control interface, available for instance in the Yocto-3D-V2 or the Yocto-Inclinometer * * The YSensor class is the parent class for all Yoctopuce sensor types. It can be * used to read the current value and unit of any sensor, read the min/max * value, configure autonomous recording frequency and access recorded data. * It also provides a function to register a callback invoked each time the * observed value changes, or at a predefined interval. Using this class rather * than a specific subclass makes it possible to create generic applications * that work with any Yoctopuce sensor, even those that do not yet exist. * Note: The YAnButton class is the only analog input which does not inherit * from YSensor. */ export declare class YTilt extends YSensor { _className: string; _bandwidth: number; _axis: YTilt.AXIS; _valueCallbackTilt: YTilt.ValueCallback | null; _timedReportCallbackTilt: YTilt.TimedReportCallback | null; readonly BANDWIDTH_INVALID: number; readonly AXIS_X: YTilt.AXIS; readonly AXIS_Y: YTilt.AXIS; readonly AXIS_Z: YTilt.AXIS; readonly AXIS_INVALID: YTilt.AXIS; static readonly BANDWIDTH_INVALID: number; static readonly AXIS_X: YTilt.AXIS; static readonly AXIS_Y: YTilt.AXIS; static readonly AXIS_Z: YTilt.AXIS; static readonly AXIS_INVALID: YTilt.AXIS; constructor(yapi: YAPIContext, func: string); imm_parseAttr(name: string, val: any): number; /** * 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 YTilt.BANDWIDTH_INVALID. */ get_bandwidth(): Promise<number>; /** * 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. */ set_bandwidth(newval: number): Promise<number>; get_axis(): Promise<YTilt.AXIS>; /** * Retrieves a tilt sensor 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 tilt sensor is online at the time * it is invoked. The returned object is nevertheless valid. * Use the method YTilt.isOnline() to test if the tilt sensor is * indeed online at a given time. In case of ambiguity when looking for * a tilt sensor 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 tilt sensor, for instance * Y3DMK002.tilt1. * * @return a YTilt object allowing you to drive the tilt sensor. */ static FindTilt(func: string): YTilt; /** * Retrieves a tilt sensor 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 tilt sensor is online at the time * it is invoked. The returned object is nevertheless valid. * Use the method YTilt.isOnline() to test if the tilt sensor is * indeed online at a given time. In case of ambiguity when looking for * a tilt sensor 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 tilt sensor, for instance * Y3DMK002.tilt1. * * @return a YTilt object allowing you to drive the tilt sensor. */ static FindTiltInContext(yctx: YAPIContext, func: string): YTilt; /** * 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 */ registerValueCallback(callback: YTilt.ValueCallback | null): Promise<number>; _invokeValueCallback(value: string): Promise<number>; /** * 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 */ registerTimedReportCallback(callback: YTilt.TimedReportCallback | null): Promise<number>; _invokeTimedReportCallback(value: YMeasure): Promise<number>; /** * Performs a zero calibration for the tilt measurement (Yocto-Inclinometer only). * When this method is invoked, a simple shift (translation) * is applied so that the current position is reported as a zero angle. * Be aware that this shift will also affect the measurement boundaries. * * @return YAPI.SUCCESS if the call succeeds. * * On failure, throws an exception or returns a negative error code. */ calibrateToZero(): Promise<number>; /** * Cancels any previous zero calibration for the tilt measurement (Yocto-Inclinometer only). * This function restores the factory zero calibration. * * @return YAPI.SUCCESS if the call succeeds. * * On failure, throws an exception or returns a negative error code. */ restoreZeroCalibration(): Promise<number>; /** * Continues the enumeration of tilt sensors started using yFirstTilt(). * Caution: You can't make any assumption about the returned tilt sensors order. * If you want to find a specific a tilt sensor, use Tilt.findTilt() * and a hardwareID or a logical name. * * @return a pointer to a YTilt object, corresponding to * a tilt sensor currently online, or a null pointer * if there are no more tilt sensors to enumerate. */ nextTilt(): YTilt | null; /** * Starts the enumeration of tilt sensors currently accessible. * Use the method YTilt.nextTilt() to iterate on * next tilt sensors. * * @return a pointer to a YTilt object, corresponding to * the first tilt sensor currently online, or a null pointer * if there are none. */ static FirstTilt(): YTilt | null; /** * Starts the enumeration of tilt sensors currently accessible. * Use the method YTilt.nextTilt() to iterate on * next tilt sensors. * * @param yctx : a YAPI context. * * @return a pointer to a YTilt object, corresponding to * the first tilt sensor currently online, or a null pointer * if there are none. */ static FirstTiltInContext(yctx: YAPIContext): YTilt | null; } export declare namespace YTilt { const enum AXIS { X = 0, Y = 1, Z = 2, INVALID = -1 } interface ValueCallback { (func: YTilt, value: string): void; } interface TimedReportCallback { (func: YTilt, measure: YMeasure): void; } }