yoctolib-esm

/********************************************************************* * * $Id: svn_id $ * * Implements the high-level API for LightSensor 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'; /** * YLightSensor Class: light sensor control interface, available for instance in the Yocto-Light-V4, * the Yocto-Proximity or the Yocto-RangeFinder * * The YLightSensor class allows you to read and configure Yoctopuce light sensors. * It inherits from YSensor class the core functions to read measures, * to register callback functions, and to access the autonomous datalogger. * This class adds the ability to easily perform a one-point linear calibration * to compensate the effect of a glass or filter placed in front of the sensor. * For some light sensors with several working modes, this class can select the * desired working mode. */ export declare class YLightSensor extends YSensor { _className: string; _measureType: YLightSensor.MEASURETYPE; _valueCallbackLightSensor: YLightSensor.ValueCallback | null; _timedReportCallbackLightSensor: YLightSensor.TimedReportCallback | null; readonly MEASURETYPE_HUMAN_EYE: YLightSensor.MEASURETYPE; readonly MEASURETYPE_WIDE_SPECTRUM: YLightSensor.MEASURETYPE; readonly MEASURETYPE_INFRARED: YLightSensor.MEASURETYPE; readonly MEASURETYPE_HIGH_RATE: YLightSensor.MEASURETYPE; readonly MEASURETYPE_HIGH_ENERGY: YLightSensor.MEASURETYPE; readonly MEASURETYPE_HIGH_RESOLUTION: YLightSensor.MEASURETYPE; readonly MEASURETYPE_INVALID: YLightSensor.MEASURETYPE; static readonly MEASURETYPE_HUMAN_EYE: YLightSensor.MEASURETYPE; static readonly MEASURETYPE_WIDE_SPECTRUM: YLightSensor.MEASURETYPE; static readonly MEASURETYPE_INFRARED: YLightSensor.MEASURETYPE; static readonly MEASURETYPE_HIGH_RATE: YLightSensor.MEASURETYPE; static readonly MEASURETYPE_HIGH_ENERGY: YLightSensor.MEASURETYPE; static readonly MEASURETYPE_HIGH_RESOLUTION: YLightSensor.MEASURETYPE; static readonly MEASURETYPE_INVALID: YLightSensor.MEASURETYPE; constructor(yapi: YAPIContext, func: string); imm_parseAttr(name: string, val: any): number; set_currentValue(newval: number): Promise<number>; /** * Changes the sensor-specific calibration parameter so that the current value * matches a desired target (linear scaling). * * @param calibratedVal : the desired target value. * * Remember to call the saveToFlash() method of the module if the * modification must be kept. * * @return YAPI.SUCCESS if the call succeeds. * * On failure, throws an exception or returns a negative error code. */ calibrate(calibratedVal: number): Promise<number>; /** * Returns the type of light measure. * * @return a value among YLightSensor.MEASURETYPE_HUMAN_EYE, YLightSensor.MEASURETYPE_WIDE_SPECTRUM, * YLightSensor.MEASURETYPE_INFRARED, YLightSensor.MEASURETYPE_HIGH_RATE, * YLightSensor.MEASURETYPE_HIGH_ENERGY and YLightSensor.MEASURETYPE_HIGH_RESOLUTION corresponding to * the type of light measure * * On failure, throws an exception or returns YLightSensor.MEASURETYPE_INVALID. */ get_measureType(): Promise<YLightSensor.MEASURETYPE>; /** * Changes the light sensor type used in the device. The measure can either * approximate the response of the human eye, focus on a specific light * spectrum, depending on the capabilities of the light-sensitive cell. * Remember to call the saveToFlash() method of the module if the * modification must be kept. * * @param newval : a value among YLightSensor.MEASURETYPE_HUMAN_EYE, * YLightSensor.MEASURETYPE_WIDE_SPECTRUM, YLightSensor.MEASURETYPE_INFRARED, * YLightSensor.MEASURETYPE_HIGH_RATE, YLightSensor.MEASURETYPE_HIGH_ENERGY and * YLightSensor.MEASURETYPE_HIGH_RESOLUTION corresponding to the light sensor type used in the device * * @return YAPI.SUCCESS if the call succeeds. * * On failure, throws an exception or returns a negative error code. */ set_measureType(newval: YLightSensor.MEASURETYPE): Promise<number>; /** * Retrieves a light 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 light sensor is online at the time * it is invoked. The returned object is nevertheless valid. * Use the method YLightSensor.isOnline() to test if the light sensor is * indeed online at a given time. In case of ambiguity when looking for * a light 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 light sensor, for instance * LIGHTMK4.lightSensor. * * @return a YLightSensor object allowing you to drive the light sensor. */ static FindLightSensor(func: string): YLightSensor; /** * Retrieves a light 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 light sensor is online at the time * it is invoked. The returned object is nevertheless valid. * Use the method YLightSensor.isOnline() to test if the light sensor is * indeed online at a given time. In case of ambiguity when looking for * a light 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 light sensor, for instance * LIGHTMK4.lightSensor. * * @return a YLightSensor object allowing you to drive the light sensor. */ static FindLightSensorInContext(yctx: YAPIContext, func: string): YLightSensor; /** * 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: YLightSensor.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: YLightSensor.TimedReportCallback | null): Promise<number>; _invokeTimedReportCallback(value: YMeasure): Promise<number>; /** * Continues the enumeration of light sensors started using yFirstLightSensor(). * Caution: You can't make any assumption about the returned light sensors order. * If you want to find a specific a light sensor, use LightSensor.findLightSensor() * and a hardwareID or a logical name. * * @return a pointer to a YLightSensor object, corresponding to * a light sensor currently online, or a null pointer * if there are no more light sensors to enumerate. */ nextLightSensor(): YLightSensor | null; /** * Starts the enumeration of light sensors currently accessible. * Use the method YLightSensor.nextLightSensor() to iterate on * next light sensors. * * @return a pointer to a YLightSensor object, corresponding to * the first light sensor currently online, or a null pointer * if there are none. */ static FirstLightSensor(): YLightSensor | null; /** * Starts the enumeration of light sensors currently accessible. * Use the method YLightSensor.nextLightSensor() to iterate on * next light sensors. * * @param yctx : a YAPI context. * * @return a pointer to a YLightSensor object, corresponding to * the first light sensor currently online, or a null pointer * if there are none. */ static FirstLightSensorInContext(yctx: YAPIContext): YLightSensor | null; } export declare namespace YLightSensor { const enum MEASURETYPE { HUMAN_EYE = 0, WIDE_SPECTRUM = 1, INFRARED = 2, HIGH_RATE = 3, HIGH_ENERGY = 4, HIGH_RESOLUTION = 5, INVALID = -1 } interface ValueCallback { (func: YLightSensor, value: string): void; } interface TimedReportCallback { (func: YLightSensor, measure: YMeasure): void; } }