WindRose/html/_circadian_8h_source.html

#ifndef Circadian_h

#define Circadian_h


#include "arduino.h"


class Circadian {

private:

  unsigned long previousMillis;


  unsigned long interval;


public:

  Circadian(unsigned long _interval);


  bool isElapsed();


  static unsigned long secondsToMillis(unsigned int seconds);


  static unsigned long minutesToMillis(unsigned int minutes);


  static unsigned long hoursToMillis(unsigned int hours);


  static unsigned long hertzToMillis(float hertz);

};


#endif // Circadian_h

Circadian
A class to handle periodic time intervals.
Definition: Circadian.h:19

Circadian::hoursToMillis
static unsigned long hoursToMillis(unsigned int hours)
Converts hours to milliseconds.
Definition: Circadian.cpp:61

Circadian::minutesToMillis
static unsigned long minutesToMillis(unsigned int minutes)
Converts minutes to milliseconds.
Definition: Circadian.cpp:52

Circadian::isElapsed
bool isElapsed()
Checks if the interval has elapsed.
Definition: Circadian.cpp:24

Circadian::hertzToMillis
static unsigned long hertzToMillis(float hertz)
Converts frequency in hertz to milliseconds (period of the frequency).
Definition: Circadian.cpp:70

Circadian::secondsToMillis
static unsigned long secondsToMillis(unsigned int seconds)
Converts seconds to milliseconds.
Definition: Circadian.cpp:43

Circadian::Circadian
Circadian(unsigned long _interval)
Constructor to initialize the interval and record the current time.
Definition: Circadian.cpp:15