EDU Arduino API
Data Fields
ketCube_Arduino_API_t::Time Struct Reference

KETCube Arduino Time API. More...

Data Fields

Time_delay_t delay
 Pauses the program for the amount of time (in milliseconds) More...
 
Time_delayMicroseconds_t delayMicroseconds
 Pauses the program for the amount of time (in microseconds) More...
 
Time_micros_t micros
 Get the number of microseconds since last KETCube PoR or overflow. More...
 
Time_millis_t millis
 Get the number of milliseconds since last KETCube PoR. More...
 
Time_wakeAfter_t wakeAfter
 Wake KETCube after defined amount of time. More...
 
Time_wakeIntervalElapsed_t wakeIntervalElapsed
 Check if the wake-up was caused by timer preset by wakeAfter() function. More...
 

Detailed Description

KETCube Arduino Time API.

Field Documentation

◆ delay

Time_delay_t ketCube_Arduino_API_t::Time::delay

Pauses the program for the amount of time (in milliseconds)

Parameters
msthe number of milliseconds to pause

◆ delayMicroseconds

Time_delayMicroseconds_t ketCube_Arduino_API_t::Time::delayMicroseconds

Pauses the program for the amount of time (in microseconds)

Parameters
usthe number of microseconds to pause

◆ micros

Time_micros_t ketCube_Arduino_API_t::Time::micros

Get the number of microseconds since last KETCube PoR or overflow.

Return values
msthe number of microseconds since last KETCube PoR or overflow

◆ millis

Time_millis_t ketCube_Arduino_API_t::Time::millis

Get the number of milliseconds since last KETCube PoR.

Return values
msthe number of milliseconds since last KETCube PoR

◆ wakeAfter

Time_wakeAfter_t ketCube_Arduino_API_t::Time::wakeAfter

Wake KETCube after defined amount of time.

Return values
msthe number of milliseconds from now to wake-up

◆ wakeIntervalElapsed

Time_wakeIntervalElapsed_t ketCube_Arduino_API_t::Time::wakeIntervalElapsed

Check if the wake-up was caused by timer preset by wakeAfter() function.

Return values
flagTRUE in case, that wake-up interval elapsed, else return FALSE