ustd::heartbeat Class Reference

muwerk HeartBeat Class More...

#include <heartbeat.h>

Public Member Functions
	heartbeat (unsigned long length=0)
heartbeat &	operator= (const unsigned long length)
	operator unsigned long () const
unsigned long	beat ()
unsigned long	elapsed ()

Detailed Description

muwerk HeartBeat Class

Implements a helper class for handling periodical operations at fixed intervals in scheduled tasks. The typical use case is in conjunction with a ustd::Scheduler task: let's assume you have an operation that has to be performed every 15 seconds.

#include <scheduler.h>
#include <heartbeat.h>
 
ustd::Scheduler sched;
ustd::heartbeat periodical = 15000; // 15 seconds in millliseconds
 
void appLoop();
 
void someTask() {
    // This is called every 50ms (50000us)
    // Do things here..
 
 
    if (periodical.beat()) {
        // this happens each 15 seconds
        // do special things here
    }
}
 
void setup() {
    // Create a task for the main application loop code:
    int tID = sched.add(appLoop, "main");
 
    // Create a second task that is called every 50ms
    sched.add(someTask, "someTask", 50000L);
}

Constructor & Destructor Documentation

heartbeat()

ustd::heartbeat::heartbeat ( unsigned long  length = 0 )

inline

Creates a heartbeat

Parameters

length

(optional, default 0) Cycle length in milliseconds

Member Function Documentation

beat()

unsigned long ustd::heartbeat::beat ( )

inline

Tests if a cycle has completed trying to be synchronous with the beat resulting from the configured cycle length.

Returns

0 if the current cycle is not completed or the number of full cycles passed since the last execution.

elapsed()

unsigned long ustd::heartbeat::elapsed ( )

inline

Tests if a cycle has completed without any compensation. In comparison to the function of beat this method behaves more like a classical watchdog. It is absolutely guaranteed that the previous elapsed() has occurred at least one cycle length before.

Returns

0 if the current cycle is not completed or the number of full cycles passed since the last execution.

operator unsigned long()

ustd::heartbeat::operator unsigned long ( ) const

inline

Returns the current cycle length

Returns

Cycle length in milliseconds

operator=()

heartbeat & ustd::heartbeat::operator= ( const unsigned long  length )

inline

Assigns a new cycle length

Parameters

length

Cycle length in milliseconds

---

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

• heartbeat.h