Class TimerWiced

• Defined in File timer-wiced.hpp

Inheritance Relationships

Base Type

• public Timer

Class Documentation

class TimerWiced : public virtual Timer

Public Functions

TimerWiced()

Constructor of the WICED Timer class.

~TimerWiced()

Destructor of the WICED Timer class.

Error_t init()

Initialization of the Timer.

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

Returns:

TimerWiced::Error_t

Error_t deinit()

Deinitialize the Timer.

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

Returns:

TimerWiced::Error_t

Error_t start()

Start the timer.

This function is starting the timer.

Returns:

TimerWiced::Error_t

Error_t elapsed(wiced_time_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:

TimerWiced::Error_t

Error_t stop()

Stop the timer.

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

Returns:

TimerWiced::Error_t

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:

TimerWiced::Error_t

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:

TimerWiced::Error_t