Class TimerIno

• Defined in File hss-pal-timer-ino.hpp

Inheritance Relationships

Base Type

• public hss::TimerPAL (Class TimerPAL)

Class Documentation

class TimerIno : public virtual hss::TimerPAL

Timer platform abstraction layer Arduino API.

Public Functions

TimerIno()

Constructor of the Timer class for arduino.

~TimerIno()

Destructor of the Timer class for arduino.

virtual Error_t init()

Initialization of the Timer.

This function is initializing the Timer and sets the elapsed time to zero.

Returns:

High-side switch error code

virtual Error_t deinit()

Deinitialize the Timer.

This function deinitialize the Timer and also resets the elapsed time variable.

Returns:

High-side switch error code

virtual Error_t start()

Start the timer.

This function is starting the timer.

Returns:

High-side switch error code

virtual Error_t elapsed(uint32_t &elapsed)

Calculate the elapsed time.

This function is calculating the elapsed time since the start of the timer. The value stored in the given variable is in milliseconds.

Parameters:

&elapsed – [in] Address of a value where the elapsed time should be stored

Returns:

High-side switch error code

virtual Error_t stop()

Stop the timer.

This function stops the timer and resets the start time variable.

Returns:

High-side switch error code

virtual Error_t delayMilli(uint32_t timeout)

Time delay.

This function is causing a desired delay of the application. The input value is given in milliseconds.

Parameters:

timeout – [in] Desired timeout in ms

Returns:

High-side switch error code

virtual Error_t delayMicro(uint32_t timeout)

Time delay.

This function is causing a desired delay of the application. The input value is given in microseconds.

Parameters:

timeout – [in] Desired timeout in us

Returns:

High-side switch error code