yoctolib-esm

/********************************************************************* * * $Id: svn_id $ * * Implements the high-level API for Power 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'; /** * YPower Class: electrical power sensor control interface, available for instance in the Yocto-Watt * * The YPower class allows you to read and configure Yoctopuce electrical power 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 access the energy counter and the power factor. */ export declare class YPower extends YSensor { _className: string; _powerFactor: number; _cosPhi: number; _meter: number; _deliveredEnergyMeter: number; _receivedEnergyMeter: number; _meterTimer: number; _valueCallbackPower: YPower.ValueCallback | null; _timedReportCallbackPower: YPower.TimedReportCallback | null; readonly POWERFACTOR_INVALID: number; readonly COSPHI_INVALID: number; readonly METER_INVALID: number; readonly DELIVEREDENERGYMETER_INVALID: number; readonly RECEIVEDENERGYMETER_INVALID: number; readonly METERTIMER_INVALID: number; static readonly POWERFACTOR_INVALID: number; static readonly COSPHI_INVALID: number; static readonly METER_INVALID: number; static readonly DELIVEREDENERGYMETER_INVALID: number; static readonly RECEIVEDENERGYMETER_INVALID: number; static readonly METERTIMER_INVALID: number; constructor(yapi: YAPIContext, func: string); imm_parseAttr(name: string, val: any): number; /** * Returns the power factor (PF), i.e. ratio between the active power consumed (in W) * and the apparent power provided (VA). * * @return a floating point number corresponding to the power factor (PF), i.e * * On failure, throws an exception or returns YPower.POWERFACTOR_INVALID. */ get_powerFactor(): Promise<number>; /** * Returns the Displacement Power factor (DPF), i.e. cosine of the phase shift between * the voltage and current fundamentals. * On the Yocto-Watt (V1), the value returned by this method correponds to the * power factor as this device is cannot estimate the true DPF. * * @return a floating point number corresponding to the Displacement Power factor (DPF), i.e * * On failure, throws an exception or returns YPower.COSPHI_INVALID. */ get_cosPhi(): Promise<number>; set_meter(newval: number): Promise<number>; /** * Returns the energy counter, maintained by the wattmeter by integrating the * power consumption over time. This is the sum of forward and backwad energy transfers, * if you are insterested in only one direction, use get_receivedEnergyMeter() or * get_deliveredEnergyMeter(). Note that this counter is reset at each start of the device. * * @return a floating point number corresponding to the energy counter, maintained by the wattmeter by * integrating the * power consumption over time * * On failure, throws an exception or returns YPower.METER_INVALID. */ get_meter(): Promise<number>; /** * Returns the energy counter, maintained by the wattmeter by integrating the power consumption over time, * but only when positive. Note that this counter is reset at each start of the device. * * @return a floating point number corresponding to the energy counter, maintained by the wattmeter by * integrating the power consumption over time, * but only when positive * * On failure, throws an exception or returns YPower.DELIVEREDENERGYMETER_INVALID. */ get_deliveredEnergyMeter(): Promise<number>; /** * Returns the energy counter, maintained by the wattmeter by integrating the power consumption over time, * but only when negative. Note that this counter is reset at each start of the device. * * @return a floating point number corresponding to the energy counter, maintained by the wattmeter by * integrating the power consumption over time, * but only when negative * * On failure, throws an exception or returns YPower.RECEIVEDENERGYMETER_INVALID. */ get_receivedEnergyMeter(): Promise<number>; /** * Returns the elapsed time since last energy counter reset, in seconds. * * @return an integer corresponding to the elapsed time since last energy counter reset, in seconds * * On failure, throws an exception or returns YPower.METERTIMER_INVALID. */ get_meterTimer(): Promise<number>; /** * Retrieves a electrical power 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 electrical power sensor is online at the time * it is invoked. The returned object is nevertheless valid. * Use the method YPower.isOnline() to test if the electrical power sensor is * indeed online at a given time. In case of ambiguity when looking for * a electrical power 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 electrical power sensor, for instance * YWATTMK1.power. * * @return a YPower object allowing you to drive the electrical power sensor. */ static FindPower(func: string): YPower; /** * Retrieves a electrical power 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 electrical power sensor is online at the time * it is invoked. The returned object is nevertheless valid. * Use the method YPower.isOnline() to test if the electrical power sensor is * indeed online at a given time. In case of ambiguity when looking for * a electrical power 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 electrical power sensor, for instance * YWATTMK1.power. * * @return a YPower object allowing you to drive the electrical power sensor. */ static FindPowerInContext(yctx: YAPIContext, func: string): YPower; /** * 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: YPower.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: YPower.TimedReportCallback | null): Promise<number>; _invokeTimedReportCallback(value: YMeasure): Promise<number>; /** * Resets the energy counters. * * @return YAPI.SUCCESS if the call succeeds. * * On failure, throws an exception or returns a negative error code. */ reset(): Promise<number>; /** * Continues the enumeration of electrical power sensors started using yFirstPower(). * Caution: You can't make any assumption about the returned electrical power sensors order. * If you want to find a specific a electrical power sensor, use Power.findPower() * and a hardwareID or a logical name. * * @return a pointer to a YPower object, corresponding to * a electrical power sensor currently online, or a null pointer * if there are no more electrical power sensors to enumerate. */ nextPower(): YPower | null; /** * Starts the enumeration of electrical power sensors currently accessible. * Use the method YPower.nextPower() to iterate on * next electrical power sensors. * * @return a pointer to a YPower object, corresponding to * the first electrical power sensor currently online, or a null pointer * if there are none. */ static FirstPower(): YPower | null; /** * Starts the enumeration of electrical power sensors currently accessible. * Use the method YPower.nextPower() to iterate on * next electrical power sensors. * * @param yctx : a YAPI context. * * @return a pointer to a YPower object, corresponding to * the first electrical power sensor currently online, or a null pointer * if there are none. */ static FirstPowerInContext(yctx: YAPIContext): YPower | null; } export declare namespace YPower { interface ValueCallback { (func: YPower, value: string): void; } interface TimedReportCallback { (func: YPower, measure: YMeasure): void; } }