/********************************************************************* * * $Id: yocto_genericsensor.h 59978 2024-03-18 15:04:46Z mvuilleu $ * * Declares yFindGenericSensor(), the high-level API for GenericSensor 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. * *********************************************************************/ #ifndef YOCTO_GENERICSENSOR_H #define YOCTO_GENERICSENSOR_H #include #include #include "yocto_api.h" #ifdef YOCTOLIB_NAMESPACE namespace YOCTOLIB_NAMESPACE { #endif //--- (YGenericSensor return codes) //--- (end of YGenericSensor return codes) //--- (YGenericSensor yapiwrapper) //--- (end of YGenericSensor yapiwrapper) //--- (YGenericSensor definitions) class YGenericSensor; // forward declaration typedef void (*YGenericSensorValueCallback)(YGenericSensor *func, const string& functionValue); class YMeasure; // forward declaration typedef void (*YGenericSensorTimedReportCallback)(YGenericSensor *func, YMeasure measure); #ifndef _Y_SIGNALSAMPLING_ENUM #define _Y_SIGNALSAMPLING_ENUM typedef enum { Y_SIGNALSAMPLING_HIGH_RATE = 0, Y_SIGNALSAMPLING_HIGH_RATE_FILTERED = 1, Y_SIGNALSAMPLING_LOW_NOISE = 2, Y_SIGNALSAMPLING_LOW_NOISE_FILTERED = 3, Y_SIGNALSAMPLING_HIGHEST_RATE = 4, Y_SIGNALSAMPLING_AC = 5, Y_SIGNALSAMPLING_INVALID = -1, } Y_SIGNALSAMPLING_enum; #endif #ifndef _Y_ENABLED_ENUM #define _Y_ENABLED_ENUM typedef enum { Y_ENABLED_FALSE = 0, Y_ENABLED_TRUE = 1, Y_ENABLED_INVALID = -1, } Y_ENABLED_enum; #endif #define Y_SIGNALVALUE_INVALID (YAPI_INVALID_DOUBLE) #define Y_SIGNALUNIT_INVALID (YAPI_INVALID_STRING) #define Y_SIGNALRANGE_INVALID (YAPI_INVALID_STRING) #define Y_VALUERANGE_INVALID (YAPI_INVALID_STRING) #define Y_SIGNALBIAS_INVALID (YAPI_INVALID_DOUBLE) //--- (end of YGenericSensor definitions) //--- (YGenericSensor declaration) /** * YGenericSensor Class: GenericSensor control interface, available for instance in the * Yocto-0-10V-Rx, the Yocto-4-20mA-Rx, the Yocto-Bridge or the Yocto-milliVolt-Rx * * The YGenericSensor class allows you to read and configure Yoctopuce signal * transducers. It inherits from YSensor class the core functions to read measurements, * to register callback functions, to access the autonomous datalogger. * This class adds the ability to configure the automatic conversion between the * measured signal and the corresponding engineering unit. */ class YOCTO_CLASS_EXPORT YGenericSensor: public YSensor { #ifdef __BORLANDC__ #pragma option push -w-8022 #endif //--- (end of YGenericSensor declaration) protected: //--- (YGenericSensor attributes) // Attributes (function value cache) double _signalValue; string _signalUnit; string _signalRange; string _valueRange; double _signalBias; Y_SIGNALSAMPLING_enum _signalSampling; Y_ENABLED_enum _enabled; YGenericSensorValueCallback _valueCallbackGenericSensor; YGenericSensorTimedReportCallback _timedReportCallbackGenericSensor; friend YGenericSensor *yFindGenericSensor(const string& func); friend YGenericSensor *yFirstGenericSensor(void); // Function-specific method for parsing of JSON output and caching result virtual int _parseAttr(YJSONObject *json_val); // Constructor is protected, use yFindGenericSensor factory function to instantiate YGenericSensor(const string& func); //--- (end of YGenericSensor attributes) public: virtual ~YGenericSensor(); //--- (YGenericSensor accessors declaration) static const double SIGNALVALUE_INVALID; static const string SIGNALUNIT_INVALID; static const string SIGNALRANGE_INVALID; static const string VALUERANGE_INVALID; static const double SIGNALBIAS_INVALID; static const Y_SIGNALSAMPLING_enum SIGNALSAMPLING_HIGH_RATE = Y_SIGNALSAMPLING_HIGH_RATE; static const Y_SIGNALSAMPLING_enum SIGNALSAMPLING_HIGH_RATE_FILTERED = Y_SIGNALSAMPLING_HIGH_RATE_FILTERED; static const Y_SIGNALSAMPLING_enum SIGNALSAMPLING_LOW_NOISE = Y_SIGNALSAMPLING_LOW_NOISE; static const Y_SIGNALSAMPLING_enum SIGNALSAMPLING_LOW_NOISE_FILTERED = Y_SIGNALSAMPLING_LOW_NOISE_FILTERED; static const Y_SIGNALSAMPLING_enum SIGNALSAMPLING_HIGHEST_RATE = Y_SIGNALSAMPLING_HIGHEST_RATE; static const Y_SIGNALSAMPLING_enum SIGNALSAMPLING_AC = Y_SIGNALSAMPLING_AC; static const Y_SIGNALSAMPLING_enum SIGNALSAMPLING_INVALID = Y_SIGNALSAMPLING_INVALID; static const Y_ENABLED_enum ENABLED_FALSE = Y_ENABLED_FALSE; static const Y_ENABLED_enum ENABLED_TRUE = Y_ENABLED_TRUE; static const Y_ENABLED_enum ENABLED_INVALID = Y_ENABLED_INVALID; /** * Changes the measuring unit for the measured value. * Remember to call the saveToFlash() method of the module if the * modification must be kept. * * @param newval : a string corresponding to the measuring unit for the measured value * * @return YAPI::SUCCESS if the call succeeds. * * On failure, throws an exception or returns a negative error code. */ int set_unit(const string& newval); inline int setUnit(const string& newval) { return this->set_unit(newval); } /** * Returns the current value of the electrical signal measured by the sensor. * * @return a floating point number corresponding to the current value of the electrical signal * measured by the sensor * * On failure, throws an exception or returns YGenericSensor::SIGNALVALUE_INVALID. */ double get_signalValue(void); inline double signalValue(void) { return this->get_signalValue(); } /** * Returns the measuring unit of the electrical signal used by the sensor. * * @return a string corresponding to the measuring unit of the electrical signal used by the sensor * * On failure, throws an exception or returns YGenericSensor::SIGNALUNIT_INVALID. */ string get_signalUnit(void); inline string signalUnit(void) { return this->get_signalUnit(); } /** * Returns the input signal range used by the sensor. * * @return a string corresponding to the input signal range used by the sensor * * On failure, throws an exception or returns YGenericSensor::SIGNALRANGE_INVALID. */ string get_signalRange(void); inline string signalRange(void) { return this->get_signalRange(); } /** * Changes the input signal range used by the sensor. * When the input signal gets out of the planned range, the output value * will be set to an arbitrary large value, whose sign indicates the direction * of the range overrun. * * For a 4-20mA sensor, the default input signal range is "4...20". * For a 0-10V sensor, the default input signal range is "0.1...10". * For numeric communication interfaces, the default input signal range is * "-999999.999...999999.999". * * Remember to call the saveToFlash() * method of the module if the modification must be kept. * * @param newval : a string corresponding to the input signal range used by the sensor * * @return YAPI::SUCCESS if the call succeeds. * * On failure, throws an exception or returns a negative error code. */ int set_signalRange(const string& newval); inline int setSignalRange(const string& newval) { return this->set_signalRange(newval); } /** * Returns the physical value range measured by the sensor. * * @return a string corresponding to the physical value range measured by the sensor * * On failure, throws an exception or returns YGenericSensor::VALUERANGE_INVALID. */ string get_valueRange(void); inline string valueRange(void) { return this->get_valueRange(); } /** * Changes the output value range, corresponding to the physical value measured * by the sensor. The default output value range is the same as the input signal * range (1:1 mapping), but you can change it so that the function automatically * computes the physical value encoded by the input signal. Be aware that, as a * side effect, the range modification may automatically modify the display resolution. * * Remember to call the saveToFlash() * method of the module if the modification must be kept. * * @param newval : a string corresponding to the output value range, corresponding to the physical value measured * by the sensor * * @return YAPI::SUCCESS if the call succeeds. * * On failure, throws an exception or returns a negative error code. */ int set_valueRange(const string& newval); inline int setValueRange(const string& newval) { return this->set_valueRange(newval); } /** * Changes the electric signal bias for zero shift adjustment. * If your electric signal reads positive when it should be zero, setup * a positive signalBias of the same value to fix the zero shift. * Remember to call the saveToFlash() * method of the module if the modification must be kept. * * @param newval : a floating point number corresponding to the electric signal bias for zero shift adjustment * * @return YAPI::SUCCESS if the call succeeds. * * On failure, throws an exception or returns a negative error code. */ int set_signalBias(double newval); inline int setSignalBias(double newval) { return this->set_signalBias(newval); } /** * Returns the electric signal bias for zero shift adjustment. * A positive bias means that the signal is over-reporting the measure, * while a negative bias means that the signal is under-reporting the measure. * * @return a floating point number corresponding to the electric signal bias for zero shift adjustment * * On failure, throws an exception or returns YGenericSensor::SIGNALBIAS_INVALID. */ double get_signalBias(void); inline double signalBias(void) { return this->get_signalBias(); } /** * Returns the electric signal sampling method to use. * The HIGH_RATE method uses the highest sampling frequency, without any filtering. * The HIGH_RATE_FILTERED method adds a windowed 7-sample median filter. * The LOW_NOISE method uses a reduced acquisition frequency to reduce noise. * The LOW_NOISE_FILTERED method combines a reduced frequency with the median filter * to get measures as stable as possible when working on a noisy signal. * * @return a value among YGenericSensor::SIGNALSAMPLING_HIGH_RATE, * YGenericSensor::SIGNALSAMPLING_HIGH_RATE_FILTERED, YGenericSensor::SIGNALSAMPLING_LOW_NOISE, * YGenericSensor::SIGNALSAMPLING_LOW_NOISE_FILTERED, YGenericSensor::SIGNALSAMPLING_HIGHEST_RATE and * YGenericSensor::SIGNALSAMPLING_AC corresponding to the electric signal sampling method to use * * On failure, throws an exception or returns YGenericSensor::SIGNALSAMPLING_INVALID. */ Y_SIGNALSAMPLING_enum get_signalSampling(void); inline Y_SIGNALSAMPLING_enum signalSampling(void) { return this->get_signalSampling(); } /** * Changes the electric signal sampling method to use. * The HIGH_RATE method uses the highest sampling frequency, without any filtering. * The HIGH_RATE_FILTERED method adds a windowed 7-sample median filter. * The LOW_NOISE method uses a reduced acquisition frequency to reduce noise. * The LOW_NOISE_FILTERED method combines a reduced frequency with the median filter * to get measures as stable as possible when working on a noisy signal. * Remember to call the saveToFlash() * method of the module if the modification must be kept. * * @param newval : a value among YGenericSensor::SIGNALSAMPLING_HIGH_RATE, * YGenericSensor::SIGNALSAMPLING_HIGH_RATE_FILTERED, YGenericSensor::SIGNALSAMPLING_LOW_NOISE, * YGenericSensor::SIGNALSAMPLING_LOW_NOISE_FILTERED, YGenericSensor::SIGNALSAMPLING_HIGHEST_RATE and * YGenericSensor::SIGNALSAMPLING_AC corresponding to the electric signal sampling method to use * * @return YAPI::SUCCESS if the call succeeds. * * On failure, throws an exception or returns a negative error code. */ int set_signalSampling(Y_SIGNALSAMPLING_enum newval); inline int setSignalSampling(Y_SIGNALSAMPLING_enum newval) { return this->set_signalSampling(newval); } /** * Returns the activation state of this input. * * @return either YGenericSensor::ENABLED_FALSE or YGenericSensor::ENABLED_TRUE, according to the * activation state of this input * * On failure, throws an exception or returns YGenericSensor::ENABLED_INVALID. */ Y_ENABLED_enum get_enabled(void); inline Y_ENABLED_enum enabled(void) { return this->get_enabled(); } /** * Changes the activation state of this input. When an input is disabled, * its value is no more updated. On some devices, disabling an input can * improve the refresh rate of the other active inputs. * Remember to call the saveToFlash() * method of the module if the modification must be kept. * * @param newval : either YGenericSensor::ENABLED_FALSE or YGenericSensor::ENABLED_TRUE, according to * the activation state of this input * * @return YAPI::SUCCESS if the call succeeds. * * On failure, throws an exception or returns a negative error code. */ int set_enabled(Y_ENABLED_enum newval); inline int setEnabled(Y_ENABLED_enum newval) { return this->set_enabled(newval); } /** * Retrieves a generic 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 generic sensor is online at the time * it is invoked. The returned object is nevertheless valid. * Use the method isOnline() to test if the generic sensor is * indeed online at a given time. In case of ambiguity when looking for * a generic 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 generic sensor, for instance * RX010V01.genericSensor1. * * @return a YGenericSensor object allowing you to drive the generic sensor. */ static YGenericSensor* FindGenericSensor(string func); /** * 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 */ virtual int registerValueCallback(YGenericSensorValueCallback callback); using YSensor::registerValueCallback; virtual int _invokeValueCallback(string value); /** * 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 */ virtual int registerTimedReportCallback(YGenericSensorTimedReportCallback callback); using YSensor::registerTimedReportCallback; virtual int _invokeTimedReportCallback(YMeasure value); /** * Adjusts the signal bias so that the current signal value is need * precisely as zero. 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. */ virtual int zeroAdjust(void); inline static YGenericSensor *Find(string func) { return YGenericSensor::FindGenericSensor(func); } /** * Continues the enumeration of generic sensors started using yFirstGenericSensor(). * Caution: You can't make any assumption about the returned generic sensors order. * If you want to find a specific a generic sensor, use GenericSensor.findGenericSensor() * and a hardwareID or a logical name. * * @return a pointer to a YGenericSensor object, corresponding to * a generic sensor currently online, or a NULL pointer * if there are no more generic sensors to enumerate. */ YGenericSensor *nextGenericSensor(void); inline YGenericSensor *next(void) { return this->nextGenericSensor();} /** * Starts the enumeration of generic sensors currently accessible. * Use the method YGenericSensor::nextGenericSensor() to iterate on * next generic sensors. * * @return a pointer to a YGenericSensor object, corresponding to * the first generic sensor currently online, or a NULL pointer * if there are none. */ static YGenericSensor *FirstGenericSensor(void); inline static YGenericSensor *First(void) { return YGenericSensor::FirstGenericSensor();} #ifdef __BORLANDC__ #pragma option pop #endif //--- (end of YGenericSensor accessors declaration) }; //--- (YGenericSensor functions declaration) /** * Retrieves a generic 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 generic sensor is online at the time * it is invoked. The returned object is nevertheless valid. * Use the method isOnline() to test if the generic sensor is * indeed online at a given time. In case of ambiguity when looking for * a generic 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 generic sensor, for instance * RX010V01.genericSensor1. * * @return a YGenericSensor object allowing you to drive the generic sensor. */ inline YGenericSensor *yFindGenericSensor(const string& func) { return YGenericSensor::FindGenericSensor(func);} /** * Starts the enumeration of generic sensors currently accessible. * Use the method YGenericSensor::nextGenericSensor() to iterate on * next generic sensors. * * @return a pointer to a YGenericSensor object, corresponding to * the first generic sensor currently online, or a NULL pointer * if there are none. */ inline YGenericSensor *yFirstGenericSensor(void) { return YGenericSensor::FirstGenericSensor();} //--- (end of YGenericSensor functions declaration) #ifdef YOCTOLIB_NAMESPACE // end of namespace definition } #endif #endif