PAS CO2 Sensor  1.0.3
C++ library for Infineon Photoacoustic Spectroscopy (PAS) XENSIV™ CO2 miniaturized sensor
TimerIno Class Reference

#include <pas-co2-pal-timer-ino.hpp>

Inheritance diagram for TimerIno:
Collaboration diagram for TimerIno:

Public Member Functions

 TimerIno ()
 Timer Ino constructor. More...
 
 ~TimerIno ()
 Timer Ino destructor. More...
 
Error_t init ()
 Initialiazes the Arduino timer. More...
 
Error_t deinit ()
 Deinitialiazes the Arduino timer. More...
 
Error_t start ()
 Starts the Arduino timer. More...
 
Error_t elapsed (uint32_t &elapsed)
 Elapsed time since the timer was started. More...
 
Error_t elapsedMicro (uint32_t &elapsed)
 Elapsed time since the timer was started in microseconds. More...
 
Error_t stop ()
 Stops the Arduino timer. More...
 
Error_t delay (const uint32_t timeout)
 Introduces a delay during the specified time. More...
 

Constructor & Destructor Documentation

◆ TimerIno()

TimerIno::TimerIno ( )

Timer Ino constructor.

◆ ~TimerIno()

TimerIno::~TimerIno ( )

Timer Ino destructor.

Member Function Documentation

◆ init()

Error_t TimerIno::init ( void  )
inlinevirtual

Initialiazes the Arduino timer.

Returns
PAS CO2 error code
Return values
OKif success (always)

Implements pasco2::Timer.

◆ deinit()

Error_t TimerIno::deinit ( void  )
inlinevirtual

Deinitialiazes the Arduino timer.

Returns
PAS CO2 error code
Return values
OKif success (always)

Implements pasco2::Timer.

◆ start()

Error_t TimerIno::start ( )
inlinevirtual

Starts the Arduino timer.

Returns
PAS CO2 error code
Return values
OKif success (always)

Implements pasco2::Timer.

◆ elapsed()

Error_t TimerIno::elapsed ( uint32_t &  elapsed)
inlinevirtual

Elapsed time since the timer was started.

Parameters
[out]elapsedTime in milliseconds
Returns
PAS CO2 error code
Return values
OKif success (always)

Implements pasco2::Timer.

◆ elapsedMicro()

Error_t TimerIno::elapsedMicro ( uint32_t &  elapsed)
inlinevirtual

Elapsed time since the timer was started in microseconds.

Parameters
[out]elapsedTime in microseconds
Returns
PAS CO2 error code
Return values
OKif success (always)

Implements pasco2::Timer.

Here is the call graph for this function:

◆ stop()

Error_t TimerIno::stop ( )
inlinevirtual

Stops the Arduino timer.

Returns
PAS CO2 error code
Return values
OKif success (always)

Implements pasco2::Timer.

◆ delay()

Error_t TimerIno::delay ( const uint32_t  timeout)
inlinevirtual

Introduces a delay during the specified time.

Note
No delay() implementation since it cause troubles out of sketches https://www.arduino.cc/reference/en/language/functions/time/delay/
Parameters
[in]timeoutDelay time in milliseconds
Returns
PAS CO2 error code
Return values
OKif success (always)

Implements pasco2::Timer.

Here is the call graph for this function:

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