#include <yocto_pwminput.h>

Inheritance diagram for YPwmInput:

Public Member Functions
virtual int	_invokeTimedReportCallback (YMeasure value)

virtual int	_invokeValueCallback (string value)

int	debouncePeriod (void)

double	dutyCycle (void)

double	frequency (void)

int	get_debouncePeriod (void)

double	get_dutyCycle (void)

double	get_frequency (void)

double	get_period (void)

s64	get_pulseCounter (void)

double	get_pulseDuration (void)

s64	get_pulseTimer (void)

Y_PWMREPORTMODE_enum	get_pwmReportMode (void)

YPwmInput *	next (void)

YPwmInput *	nextPwmInput (void)

double	period (void)

s64	pulseCounter (void)

double	pulseDuration (void)

s64	pulseTimer (void)

Y_PWMREPORTMODE_enum	pwmReportMode (void)

virtual int	registerTimedReportCallback (YPwmInputTimedReportCallback callback)

virtual int	registerValueCallback (YPwmInputValueCallback callback)

virtual int	resetCounter (void)

int	set_debouncePeriod (int newval)

int	set_pulseCounter (s64 newval)

int	set_pwmReportMode (Y_PWMREPORTMODE_enum newval)

int	setDebouncePeriod (int newval)

int	setPulseCounter (s64 newval)

int	setPwmReportMode (Y_PWMREPORTMODE_enum newval)

	~YPwmInput ()

Public Member Functions inherited from YSensor
virtual double	_applyCalibration (double rawValue)

virtual double	_decodeAvg (int dw)

virtual YMeasure	_decodeTimedReport (double timestamp, vector< int > report)

virtual double	_decodeVal (int w)

virtual string	_encodeCalibrationPoints (vector< double > rawValues, vector< double > refValues)

virtual int	_parserHelper (void)

Y_ADVMODE_enum	advMode (void)

virtual int	calibrateFromPoints (vector< double > rawValues, vector< double > refValues)

string	calibrationParam (void)

double	currentRawValue (void)

double	currentValue (void)

Y_ADVMODE_enum	get_advMode (void)

string	get_calibrationParam (void)

double	get_currentRawValue (void)

double	get_currentValue (void)

virtual YDataLogger *	get_dataLogger (void)

double	get_highestValue (void)

string	get_logFrequency (void)

double	get_lowestValue (void)

virtual YDataSet	get_recordedData (s64 startTime, s64 endTime)

string	get_reportFrequency (void)

double	get_resolution (void)

int	get_sensorState (void)

string	get_unit (void)

double	highestValue (void)

virtual bool	isSensorReady (void)

virtual int	loadCalibrationPoints (vector< double > &rawValues, vector< double > &refValues)

string	logFrequency (void)

double	lowestValue (void)

YSensor *	next (void)

YSensor *	nextSensor (void)

virtual int	registerTimedReportCallback (YSensorTimedReportCallback callback)

virtual int	registerValueCallback (YSensorValueCallback callback)

string	reportFrequency (void)

double	resolution (void)

int	sensorState (void)

int	set_advMode (Y_ADVMODE_enum newval)

int	set_calibrationParam (const string &newval)

int	set_highestValue (double newval)

int	set_logFrequency (const string &newval)

int	set_lowestValue (double newval)

int	set_reportFrequency (const string &newval)

int	set_resolution (double newval)

int	setAdvMode (Y_ADVMODE_enum newval)

int	setCalibrationParam (const string &newval)

int	setHighestValue (double newval)

int	setLogFrequency (const string &newval)

int	setLowestValue (double newval)

int	setReportFrequency (const string &newval)

int	setResolution (double newval)

virtual int	startDataLogger (void)

virtual int	stopDataLogger (void)

string	unit (void)

	~YSensor ()

Public Member Functions inherited from YFunction
void	_clearDataStreamCache ()

string	_decode_json_string (const string &json)

string	_download (const string &url)

YDataStream *	_findDataStream (YDataSet &dataset, const string &def)

string	_get_json_path (const string &json, const string &path)

vector< string >	_json_get_array (const string &json)

string	_json_get_key (const string &json, const string &data)

string	_json_get_string (const string &json)

int	_parseEx (yJsonStateMachine &j)

string	_parseString (yJsonStateMachine &j)

string	_request (const string &request)

string	_requestEx (int tcpchan, const string &request, yapiRequestProgressCallback callback, void *context)

void	_throw (YRETCODE errType, string errMsg)

YRETCODE	_upload (const string &path, const string &content)

YRETCODE	_uploadWithProgress (const string &path, const string &content, yapiRequestProgressCallback callback, void *context)

string	advertisedValue (void)

void	clearCache ()

string	describe (void)

string	errMessage (void)

string	errorMessage (void)

YRETCODE	errorType (void)

YRETCODE	errType (void)

YFUN_DESCR	functionDescriptor (void)

string	get_advertisedValue (void)

string	get_errorMessage (void)

YRETCODE	get_errorType (void)

virtual string	get_friendlyName (void)

YFUN_DESCR	get_functionDescriptor (void)

string	get_functionId (void)

string	get_hardwareId (void)

string	get_hubSerial ()

string	get_logicalName (void)

YModule *	get_module (void)

void *	get_userData (void)

bool	isOnline (void)

YRETCODE	load (int msValidity)

virtual string	loadAttribute (string attrName)

string	logicalName (void)

YModule *	module (void)

virtual int	muteValueCallbacks (void)

YFunction *	next (void)

YFunction *	nextFunction (void)

virtual int	registerValueCallback (YFunctionValueCallback callback)

int	set_advertisedValue (const string &newval)

int	set_logicalName (const string &newval)

void	set_userData (void *data)

int	setAdvertisedValue (const string &newval)

int	setLogicalName (const string &newval)

void	setUserData (void *data)

virtual int	unmuteValueCallbacks (void)

void *	userData (void)

virtual	~YFunction ()

Static Public Member Functions
static YPwmInput *	Find (string func)

static YPwmInput *	FindPwmInput (string func)

static YPwmInput *	First (void)

static YPwmInput *	FirstPwmInput (void)

Static Public Member Functions inherited from YSensor
static YSensor *	Find (string func)

static YSensor *	FindSensor (string func)

static YSensor *	First (void)

static YSensor *	FirstSensor (void)

Static Public Member Functions inherited from YFunction
static void	_ClearCache (void)

static YFunction *	Find (string func)

static YFunction *	FindFunction (string func)

static YFunction *	First (void)

static YFunction *	FirstFunction (void)

Static Public Attributes
static const int	DEBOUNCEPERIOD_INVALID = YAPI_INVALID_UINT

static const double	DUTYCYCLE_INVALID = YAPI_INVALID_DOUBLE

static const double	FREQUENCY_INVALID = YAPI_INVALID_DOUBLE

static const double	PERIOD_INVALID = YAPI_INVALID_DOUBLE

static const s64	PULSECOUNTER_INVALID = YAPI_INVALID_LONG

static const double	PULSEDURATION_INVALID = YAPI_INVALID_DOUBLE

static const s64	PULSETIMER_INVALID = YAPI_INVALID_LONG

static const Y_PWMREPORTMODE_enum	PWMREPORTMODE_INVALID = Y_PWMREPORTMODE_INVALID

static const Y_PWMREPORTMODE_enum	PWMREPORTMODE_PWM_CPM = Y_PWMREPORTMODE_PWM_CPM

static const Y_PWMREPORTMODE_enum	PWMREPORTMODE_PWM_CPS = Y_PWMREPORTMODE_PWM_CPS

static const Y_PWMREPORTMODE_enum	PWMREPORTMODE_PWM_DUTYCYCLE = Y_PWMREPORTMODE_PWM_DUTYCYCLE

static const Y_PWMREPORTMODE_enum	PWMREPORTMODE_PWM_EDGECOUNT = Y_PWMREPORTMODE_PWM_EDGECOUNT

static const Y_PWMREPORTMODE_enum	PWMREPORTMODE_PWM_FREQUENCY = Y_PWMREPORTMODE_PWM_FREQUENCY

static const Y_PWMREPORTMODE_enum	PWMREPORTMODE_PWM_PULSECOUNT = Y_PWMREPORTMODE_PWM_PULSECOUNT

static const Y_PWMREPORTMODE_enum	PWMREPORTMODE_PWM_PULSEDURATION = Y_PWMREPORTMODE_PWM_PULSEDURATION

static const Y_PWMREPORTMODE_enum	PWMREPORTMODE_PWM_STATE = Y_PWMREPORTMODE_PWM_STATE

Static Public Attributes inherited from YSensor
static const Y_ADVMODE_enum	ADVMODE_IMMEDIATE = Y_ADVMODE_IMMEDIATE

static const Y_ADVMODE_enum	ADVMODE_INVALID = Y_ADVMODE_INVALID

static const Y_ADVMODE_enum	ADVMODE_PERIOD_AVG = Y_ADVMODE_PERIOD_AVG

static const Y_ADVMODE_enum	ADVMODE_PERIOD_MAX = Y_ADVMODE_PERIOD_MAX

static const Y_ADVMODE_enum	ADVMODE_PERIOD_MIN = Y_ADVMODE_PERIOD_MIN

static const string	CALIBRATIONPARAM_INVALID = YAPI_INVALID_STRING

static const double	CURRENTRAWVALUE_INVALID = YAPI_INVALID_DOUBLE

static const double	CURRENTVALUE_INVALID = YAPI_INVALID_DOUBLE

static const double	HIGHESTVALUE_INVALID = YAPI_INVALID_DOUBLE

static const string	LOGFREQUENCY_INVALID = YAPI_INVALID_STRING

static const double	LOWESTVALUE_INVALID = YAPI_INVALID_DOUBLE

static const string	REPORTFREQUENCY_INVALID = YAPI_INVALID_STRING

static const double	RESOLUTION_INVALID = YAPI_INVALID_DOUBLE

static const int	SENSORSTATE_INVALID = YAPI_INVALID_INT

static const string	UNIT_INVALID = YAPI_INVALID_STRING

Static Public Attributes inherited from YFunction
static const string	ADVERTISEDVALUE_INVALID = YAPI_INVALID_STRING

static const string	FRIENDLYNAME_INVALID = YAPI_INVALID_STRING

static const YFUN_DESCR	FUNCTIONDESCRIPTOR_INVALID = Y_FUNCTIONDESCRIPTOR_INVALID

static const string	FUNCTIONID_INVALID = YAPI_INVALID_STRING

static const string	HARDWAREID_INVALID = YAPI_INVALID_STRING

static const string	LOGICALNAME_INVALID = YAPI_INVALID_STRING

Protected Member Functions
virtual int	_parseAttr (YJSONObject *json_val)

	YPwmInput (const string &func)

Protected Member Functions inherited from YSensor
	YSensor (const string &func)

Protected Member Functions inherited from YFunction
YRETCODE	_buildSetRequest (const string &changeattr, const string *changeval, string &request, string &errmsg)

string	_escapeAttr (const string &changeval)

YRETCODE	_getDescriptor (YFUN_DESCR &fundescr, string &errMsg)

YRETCODE	_getDevice (YDevice *&dev, string &errMsg)

YRETCODE	_load_unsafe (int msValidity)

YRETCODE	_nextFunction (string &hwId)

int	_parse (YJSONObject *j)

YRETCODE	_setAttr (string attrname, string newvalue)

	YFunction (const string &func)

Protected Attributes
int	_debouncePeriod

double	_dutyCycle

double	_frequency

double	_period

s64	_pulseCounter

double	_pulseDuration

s64	_pulseTimer

Y_PWMREPORTMODE_enum	_pwmReportMode

YPwmInputTimedReportCallback	_timedReportCallbackPwmInput

YPwmInputValueCallback	_valueCallbackPwmInput

Protected Attributes inherited from YSensor
Y_ADVMODE_enum	_advMode

yCalibrationHandler	_calhdl

string	_calibrationParam

vector< int >	_calpar

vector< double >	_calraw

vector< double >	_calref

int	_caltyp

double	_currentRawValue

double	_currentValue

double	_decexp

double	_highestValue

double	_iresol

bool	_isScal

bool	_isScal32

string	_logFrequency

double	_lowestValue

double	_offset

double	_prevTimedReport

string	_reportFrequency

double	_resolution

double	_scale

int	_sensorState

YSensorTimedReportCallback	_timedReportCallbackSensor

string	_unit

YSensorValueCallback	_valueCallbackSensor

Protected Attributes inherited from YFunction
string	_advertisedValue

u64	_cacheExpiration

string	_className

std::map< string, YDataStream * >	_dataStreams

string	_func

YFUN_DESCR	_fundescr

string	_funId

string	_hwId

string	_lastErrorMsg

YRETCODE	_lastErrorType

string	_logicalName

string	_serial

yCRITICAL_SECTION	_this_cs

void *	_userData

YFunctionValueCallback	_valueCallbackFunction

Friends
YPwmInput *	yFindPwmInput (const string &func)

YPwmInput *	yFirstPwmInput (void)

Additional Inherited Members
Static Protected Member Functions inherited from YFunction
static void	_AddToCache (const string &classname, const string &func, YFunction *obj)

static YFunction *	_FindFromCache (const string &classname, const string &func)

static void	_UpdateTimedReportCallbackList (YFunction *func, bool add)

static void	_UpdateValueCallbackList (YFunction *func, bool add)

Static Protected Attributes inherited from YFunction
static std::map< string, YFunction * >	_cache

Detailed Description

YPwmInput Class: PwmInput function interface

The Yoctopuce class YPwmInput allows you to read and configure Yoctopuce PWM sensors. 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 signal parameter used to transmit information: the duty cycle, the frequency or the pulse width.

Definition at line 90 of file yocto_pwminput.h.

Constructor & Destructor Documentation

YPwmInput::YPwmInput ( const string & func )

protected

Definition at line 51 of file yocto_pwminput.cpp.

YPwmInput::~YPwmInput ( )

Definition at line 68 of file yocto_pwminput.cpp.

Member Function Documentation

int YPwmInput::_invokeTimedReportCallback ( YMeasure value )

virtual

Reimplemented from YSensor.

Definition at line 535 of file yocto_pwminput.cpp.

int YPwmInput::_invokeValueCallback ( string value )

virtual

Reimplemented from YSensor.

Definition at line 501 of file yocto_pwminput.cpp.

int YPwmInput::_parseAttr ( YJSONObject * json_val )

protectedvirtual

Reimplemented from YSensor.

Definition at line 80 of file yocto_pwminput.cpp.

int YPwmInput::debouncePeriod ( void )

inline

Definition at line 265 of file yocto_pwminput.h.

double YPwmInput::dutyCycle ( void )

inline

Definition at line 149 of file yocto_pwminput.h.

static YPwmInput* YPwmInput::Find ( string func )

inlinestatic

Definition at line 352 of file yocto_pwminput.h.

YPwmInput * YPwmInput::FindPwmInput ( string func )

static

Retrieves a PWM input 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 PWM input is online at the time it is invoked. The returned object is nevertheless valid. Use the method YPwmInput.isOnline() to test if the PWM input is indeed online at a given time. In case of ambiguity when looking for a PWM input 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.

Parameters

func	: a string that uniquely characterizes the PWM input

Returns: a YPwmInput object allowing you to drive the PWM input.

Definition at line 450 of file yocto_pwminput.cpp.

static YPwmInput* YPwmInput::First ( void )

inlinestatic

Definition at line 376 of file yocto_pwminput.h.

YPwmInput * YPwmInput::FirstPwmInput ( void )

static

Starts the enumeration of PWM inputs currently accessible. Use the method YPwmInput.nextPwmInput() to iterate on next PWM inputs.

Returns: a pointer to a YPwmInput object, corresponding to the first PWM input currently online, or a NULL pointer if there are none.

Definition at line 567 of file yocto_pwminput.cpp.

double YPwmInput::frequency ( void )

inline

Definition at line 174 of file yocto_pwminput.h.

int YPwmInput::get_debouncePeriod ( void )

Returns the shortest expected pulse duration, in ms. Any shorter pulse will be automatically ignored (debounce).

Returns: an integer corresponding to the shortest expected pulse duration, in ms

On failure, throws an exception or returns Y_DEBOUNCEPERIOD_INVALID.

Definition at line 376 of file yocto_pwminput.cpp.

double YPwmInput::get_dutyCycle ( void )

Returns the PWM duty cycle, in per cents.

Returns: a floating point number corresponding to the PWM duty cycle, in per cents

On failure, throws an exception or returns Y_DUTYCYCLE_INVALID.

Definition at line 117 of file yocto_pwminput.cpp.

double YPwmInput::get_frequency ( void )

Returns the PWM frequency in Hz.

Returns: a floating point number corresponding to the PWM frequency in Hz

On failure, throws an exception or returns Y_FREQUENCY_INVALID.

Definition at line 176 of file yocto_pwminput.cpp.

double YPwmInput::get_period ( void )

Returns the PWM period in milliseconds.

Returns: a floating point number corresponding to the PWM period in milliseconds

On failure, throws an exception or returns Y_PERIOD_INVALID.

Definition at line 205 of file yocto_pwminput.cpp.

s64 YPwmInput::get_pulseCounter ( void )

Returns the pulse counter value. Actually that counter is incremented twice per period. That counter is limited to 1 billion.

Returns: an integer corresponding to the pulse counter value

On failure, throws an exception or returns Y_PULSECOUNTER_INVALID.

Definition at line 236 of file yocto_pwminput.cpp.

double YPwmInput::get_pulseDuration ( void )

Returns the PWM pulse length in milliseconds, as a floating point number.

Returns: a floating point number corresponding to the PWM pulse length in milliseconds, as a floating point number

On failure, throws an exception or returns Y_PULSEDURATION_INVALID.

Definition at line 147 of file yocto_pwminput.cpp.

s64 YPwmInput::get_pulseTimer ( void )

Returns the timer of the pulses counter (ms).

Returns: an integer corresponding to the timer of the pulses counter (ms)

On failure, throws an exception or returns Y_PULSETIMER_INVALID.

Definition at line 281 of file yocto_pwminput.cpp.

Y_PWMREPORTMODE_enum YPwmInput::get_pwmReportMode ( void )

Returns the parameter (frequency/duty cycle, pulse width, edges count) returned by the get_currentValue function and callbacks. Attention

Returns: a value among Y_PWMREPORTMODE_PWM_DUTYCYCLE, Y_PWMREPORTMODE_PWM_FREQUENCY, Y_PWMREPORTMODE_PWM_PULSEDURATION, Y_PWMREPORTMODE_PWM_EDGECOUNT, Y_PWMREPORTMODE_PWM_PULSECOUNT, Y_PWMREPORTMODE_PWM_CPS, Y_PWMREPORTMODE_PWM_CPM and Y_PWMREPORTMODE_PWM_STATE corresponding to the parameter (frequency/duty cycle, pulse width, edges count) returned by the get_currentValue function and callbacks

On failure, throws an exception or returns Y_PWMREPORTMODE_INVALID.

Definition at line 315 of file yocto_pwminput.cpp.

YPwmInput* YPwmInput::next ( void )

inline

Definition at line 363 of file yocto_pwminput.h.

YPwmInput * YPwmInput::nextPwmInput ( void )

Continues the enumeration of PWM inputs started using yFirstPwmInput().

Returns: a pointer to a YPwmInput object, corresponding to a PWM input currently online, or a NULL pointer if there are no more PWM inputs to enumerate.

Definition at line 557 of file yocto_pwminput.cpp.

double YPwmInput::period ( void )

inline

Definition at line 186 of file yocto_pwminput.h.

s64 YPwmInput::pulseCounter ( void )

inline

Definition at line 200 of file yocto_pwminput.h.

double YPwmInput::pulseDuration ( void )

inline

Definition at line 162 of file yocto_pwminput.h.

s64 YPwmInput::pulseTimer ( void )

inline

Definition at line 216 of file yocto_pwminput.h.

Y_PWMREPORTMODE_enum YPwmInput::pwmReportMode ( void )

inline

Definition at line 233 of file yocto_pwminput.h.

int YPwmInput::registerTimedReportCallback ( YPwmInputTimedReportCallback callback )

virtual

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.

Parameters

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.

Definition at line 522 of file yocto_pwminput.cpp.

int YPwmInput::registerValueCallback ( YPwmInputValueCallback callback )

virtual

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.

Parameters

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.

Definition at line 482 of file yocto_pwminput.cpp.

int YPwmInput::resetCounter ( void )

virtual

Returns the pulse counter value as well as its timer.

Returns: YAPI_SUCCESS if the call succeeds.

On failure, throws an exception or returns a negative error code.

Definition at line 552 of file yocto_pwminput.cpp.

int YPwmInput::set_debouncePeriod ( int newval )

Changes the shortest expected pulse duration, in ms. Any shorter pulse will be automatically ignored (debounce).

Parameters

newval : an integer corresponding to the shortest expected pulse duration, in ms

Returns: YAPI_SUCCESS if the call succeeds.

On failure, throws an exception or returns a negative error code.

Definition at line 407 of file yocto_pwminput.cpp.

int YPwmInput::set_pulseCounter ( s64 newval )

Definition at line 258 of file yocto_pwminput.cpp.

int YPwmInput::set_pwmReportMode ( Y_PWMREPORTMODE_enum newval )

Changes the parameter type (frequency/duty cycle, pulse width, or edge count) returned by the get_currentValue function and callbacks. The edge count value is limited to the 6 lowest digits. For values greater than one million, use get_pulseCounter().

Parameters

newval : a value among Y_PWMREPORTMODE_PWM_DUTYCYCLE, Y_PWMREPORTMODE_PWM_FREQUENCY, Y_PWMREPORTMODE_PWM_PULSEDURATION, Y_PWMREPORTMODE_PWM_EDGECOUNT, Y_PWMREPORTMODE_PWM_PULSECOUNT, Y_PWMREPORTMODE_PWM_CPS, Y_PWMREPORTMODE_PWM_CPM and Y_PWMREPORTMODE_PWM_STATE corresponding to the parameter type (frequency/duty cycle, pulse width, or edge count) returned by the get_currentValue function and callbacks

Returns: YAPI_SUCCESS if the call succeeds.

On failure, throws an exception or returns a negative error code.

Definition at line 353 of file yocto_pwminput.cpp.

int YPwmInput::setDebouncePeriod ( int newval )

inline

Definition at line 278 of file yocto_pwminput.h.

int YPwmInput::setPulseCounter ( s64 newval )

inline

Definition at line 204 of file yocto_pwminput.h.

int YPwmInput::setPwmReportMode ( Y_PWMREPORTMODE_enum newval )

inline

Definition at line 253 of file yocto_pwminput.h.

Friends And Related Function Documentation

YPwmInput* yFindPwmInput ( const string & func )

friend

Retrieves a PWM input 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 PWM input is online at the time it is invoked. The returned object is nevertheless valid. Use the method YPwmInput.isOnline() to test if the PWM input is indeed online at a given time. In case of ambiguity when looking for a PWM input 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.

Parameters

func	: a string that uniquely characterizes the PWM input

Returns: a YPwmInput object allowing you to drive the PWM input.

Definition at line 413 of file yocto_pwminput.h.

YPwmInput* yFirstPwmInput ( void )

friend

Starts the enumeration of PWM inputs currently accessible. Use the method YPwmInput.nextPwmInput() to iterate on next PWM inputs.

Returns: a pointer to a YPwmInput object, corresponding to the first PWM input currently online, or a NULL pointer if there are none.

Definition at line 424 of file yocto_pwminput.h.

Member Data Documentation

int YPwmInput::_debouncePeriod

protected

Definition at line 105 of file yocto_pwminput.h.

double YPwmInput::_dutyCycle

protected

Definition at line 98 of file yocto_pwminput.h.

double YPwmInput::_frequency

protected

Definition at line 100 of file yocto_pwminput.h.

double YPwmInput::_period

protected

Definition at line 101 of file yocto_pwminput.h.

s64 YPwmInput::_pulseCounter

protected

Definition at line 102 of file yocto_pwminput.h.

double YPwmInput::_pulseDuration

protected

Definition at line 99 of file yocto_pwminput.h.

s64 YPwmInput::_pulseTimer

protected

Definition at line 103 of file yocto_pwminput.h.

Y_PWMREPORTMODE_enum YPwmInput::_pwmReportMode

protected

Definition at line 104 of file yocto_pwminput.h.

YPwmInputTimedReportCallback YPwmInput::_timedReportCallbackPwmInput

protected

Definition at line 107 of file yocto_pwminput.h.

YPwmInputValueCallback YPwmInput::_valueCallbackPwmInput

protected

Definition at line 106 of file yocto_pwminput.h.

const int YPwmInput::DEBOUNCEPERIOD_INVALID = YAPI_INVALID_UINT

static

Definition at line 138 of file yocto_pwminput.h.

const double YPwmInput::DUTYCYCLE_INVALID = YAPI_INVALID_DOUBLE

static

Definition at line 123 of file yocto_pwminput.h.

const double YPwmInput::FREQUENCY_INVALID = YAPI_INVALID_DOUBLE

static

Definition at line 125 of file yocto_pwminput.h.

const double YPwmInput::PERIOD_INVALID = YAPI_INVALID_DOUBLE

static

Definition at line 126 of file yocto_pwminput.h.

const s64 YPwmInput::PULSECOUNTER_INVALID = YAPI_INVALID_LONG

static

Definition at line 127 of file yocto_pwminput.h.

const double YPwmInput::PULSEDURATION_INVALID = YAPI_INVALID_DOUBLE

static

Definition at line 124 of file yocto_pwminput.h.

const s64 YPwmInput::PULSETIMER_INVALID = YAPI_INVALID_LONG

static

Definition at line 128 of file yocto_pwminput.h.

const Y_PWMREPORTMODE_enum YPwmInput::PWMREPORTMODE_INVALID = Y_PWMREPORTMODE_INVALID

static

Definition at line 137 of file yocto_pwminput.h.

const Y_PWMREPORTMODE_enum YPwmInput::PWMREPORTMODE_PWM_CPM = Y_PWMREPORTMODE_PWM_CPM

static

Definition at line 135 of file yocto_pwminput.h.

const Y_PWMREPORTMODE_enum YPwmInput::PWMREPORTMODE_PWM_CPS = Y_PWMREPORTMODE_PWM_CPS

static

Definition at line 134 of file yocto_pwminput.h.

const Y_PWMREPORTMODE_enum YPwmInput::PWMREPORTMODE_PWM_DUTYCYCLE = Y_PWMREPORTMODE_PWM_DUTYCYCLE

static

Definition at line 129 of file yocto_pwminput.h.

const Y_PWMREPORTMODE_enum YPwmInput::PWMREPORTMODE_PWM_EDGECOUNT = Y_PWMREPORTMODE_PWM_EDGECOUNT

static

Definition at line 132 of file yocto_pwminput.h.

const Y_PWMREPORTMODE_enum YPwmInput::PWMREPORTMODE_PWM_FREQUENCY = Y_PWMREPORTMODE_PWM_FREQUENCY

static

Definition at line 130 of file yocto_pwminput.h.

const Y_PWMREPORTMODE_enum YPwmInput::PWMREPORTMODE_PWM_PULSECOUNT = Y_PWMREPORTMODE_PWM_PULSECOUNT

static

Definition at line 133 of file yocto_pwminput.h.

const Y_PWMREPORTMODE_enum YPwmInput::PWMREPORTMODE_PWM_PULSEDURATION = Y_PWMREPORTMODE_PWM_PULSEDURATION

static

Definition at line 131 of file yocto_pwminput.h.

const Y_PWMREPORTMODE_enum YPwmInput::PWMREPORTMODE_PWM_STATE = Y_PWMREPORTMODE_PWM_STATE

static

Definition at line 136 of file yocto_pwminput.h.

The documentation for this class was generated from the following files:

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation