0.3.1 HeartBeat

Author: RobTillaart

libraries/HeartBeat/.arduino-ci.yml

@@ -9,3 +9,5 @@ compile:
     - esp32
     # - esp8266
     # - mega2560
+  libraries:
+    - "SRF05"

libraries/HeartBeat/HeartBeat.cpp

@@ -1,7 +1,7 @@
 //
 //    FILE: HeartBeat.cpp
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.2.1
+// VERSION: 0.3.1
 // PURPOSE: Arduino library for HeartBeat with frequency and dutyCycle
 //    DATE: 2019-06-12
 //     URL: https://github.com/RobTillaart/HeartBeat
@@ -12,13 +12,20 @@
 //  0.1.2   2021-01-15  renamed all to HeartBeat
 //                      added dutyCycle
 //  0.1.3   2021-05-27  fix Arduino-lint
+//
 //  0.2.0   2021-11-02  update Build-CI, add badges
 //                      add getFrequency(), getDutyCycle();
 //                      add getState().
 //                      removed set()
 //  0.2.1   2021-12-18  update library.json, license, minor edits
+//
 //  0.3.0   2022-02-04  added HeartBeatDiag class.
 //                      added HeartBeatSL class (slightly simpler).
+//  0.3.1   2022-07-26  move all code to .cpp
+//                      add isEnabled()
+//                      rename examples
+//                      add example SRF05 distance sensor
+
 
 
 #include "HeartBeat.h"
@@ -50,11 +57,43 @@ void HeartBeat::setFrequency(float frequency)
 
 void HeartBeat::setDutyCycle(float dutyCycle)
 {
-  _dutyCycle = constrain(dutyCycle, 0, 100);  // percentage
+  _dutyCycle = dutyCycle;
+  if (_dutyCycle < 0)   _dutyCycle = 0;
+  if (_dutyCycle > 100) _dutyCycle = 100;
   _setFreqDuty();
 }
 
 
+float HeartBeat::getFrequency()
+{
+  return _frequency;
+};
+
+
+float HeartBeat::getDutyCycle()
+{
+  return _dutyCycle;
+};
+
+
+void HeartBeat::enable()    
+{ 
+  _running = true;  
+};
+
+
+void HeartBeat::disable()   
+{ 
+  _running = false; 
+};
+
+
+bool HeartBeat::isEnabled() 
+{
+  return _running;
+};
+
+
 void HeartBeat::beat()
 {
   if (_running == false)
@@ -73,7 +112,10 @@ void HeartBeat::beat()
 }
 
 
-
+uint8_t HeartBeat::getState()
+{
+  return _state; 
+};
 
 
 /////////////////////////////////
@@ -157,6 +199,12 @@ bool HeartBeatDiag::code(uint32_t pattern)
 }
 
 
+void HeartBeatDiag::codeOff()
+{
+  _codeMask = 0;
+}
+
+
 /////////////////////////////////////////////////////////////////////////////
 //
 // HEARTBEATSL
@@ -238,5 +286,11 @@ bool HeartBeatSL::code(const char * str)
 }
 
 
+void HeartBeatSL::codeOff()
+{
+  _codeMask = 0;
+}
+
+
 // -- END OF FILE --
 

libraries/HeartBeat/HeartBeat.h

@@ -2,34 +2,40 @@
 //
 //    FILE: HeartBeat.h
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.3.0
+// VERSION: 0.3.1
 // PURPOSE: Arduino library for HeartBeat with frequency and dutyCycle
 //    DATE: 2019-06-12
 //     URL: https://github.com/RobTillaart/HeartBeat
 
 
 #include "Arduino.h"
 
-#define HEARTBEAT_LIB_VERSION       (F("0.3.0"))
+#define HEARTBEAT_LIB_VERSION       (F("0.3.1"))
 
 
 class HeartBeat
 {
 public:
+  //  CONSTRUCTOR
   HeartBeat();
 
   void   begin(const uint8_t pin, float frequency = 1.0);
 
+  //  CONFIGURATION
   void   setFrequency(float frequency = 1.0);
   void   setDutyCycle(float dutyCycle = 50);
-  float  getFrequency() { return _frequency; };
-  float  getDutyCycle() { return _dutyCycle; };
+  float  getFrequency();
+  float  getDutyCycle();
 
-  inline void enable()  { _running = true;  };
-  inline void disable() { _running = false; };
+  //  START STOP interface
+  void   enable();
+  void   disable();
+  bool   isEnabled();
 
+  //  WORKER
   void    beat();
-  uint8_t getState()    { return _state; };
+  uint8_t getState();
+
 
 protected:
   void     _setFreqDuty();
@@ -55,14 +61,18 @@ class HeartBeat
 class HeartBeatDiag : public HeartBeat
 {
 public:
+  //  CONSTRUCTOR
   HeartBeatDiag();
 
+  //  WORKER
   void   beat();
 
+  //  CONFIGURATION PATTERN
   //  pattern = up to 9 digits, indicating the relative length of the pulses
   //            of the error or diagnostic code
-  bool   code(uint32_t pattern);        //  executes ONE time
-  void   codeOff() { _codeMask = 0; };  //  explicit stop.
+  bool   code(uint32_t pattern);   //  executes ONE time
+  void   codeOff();                //  explicit stop.
+
 
 protected:
   uint32_t _code        = 0;  //  up to 9 digits
@@ -80,14 +90,18 @@ class HeartBeatDiag : public HeartBeat
 class HeartBeatSL : public HeartBeat
 {
 public:
+  //  CONSTRUCTOR
   HeartBeatSL();
 
+  //  WORKER
   void   beat();
 
+  //  CONFIGURATION PATTERN
   //  str = string of L (long) and S or non-L (short) characters.
   //        L is a pulse of 3 units, S is a pulse of 1 unit.
-  bool   code(const char * str);        //  executes ONE time
-  void   codeOff() { _codeMask = 0; };  //  explicit stop.
+  bool   code(const char * str);  //  executes ONE time
+  void   codeOff();               //  explicit stop.
+
 
 protected:
   uint8_t _code        = 0;  //  up to 7 bits