0.3.5 HeartBeat

Author: RobTillaart

libraries/HeartBeat/.arduino-ci.yml

@@ -27,3 +27,4 @@ compile:
     - rpipico
   libraries:
     - "SRF05"
+    - "ACS712"

libraries/HeartBeat/CHANGELOG.md

@@ -6,6 +6,11 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
 
+## [0.3.5] - 2025-01-31
+- extended HeartBeatSL code length to 15.
+- add example **HeartBeat_ACS712_demo.ino**
+- minor edits readme.md
+
 ## [0.3.4] - 2024-09-09
 - Fix #12, add **bool codeCompleted()** to HeartBeatDiag and HeartBeatSL
 - update readme.md

libraries/HeartBeat/HeartBeat.cpp

@@ -1,7 +1,7 @@
 //
 //    FILE: HeartBeat.cpp
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.3.4
+// VERSION: 0.3.5
 // PURPOSE: Arduino library for HeartBeat with frequency and dutyCycle
 //    DATE: 2019-06-12
 //     URL: https://github.com/RobTillaart/HeartBeat
@@ -103,7 +103,7 @@ uint8_t HeartBeat::getState()
 //
 void HeartBeat::_setFreqDuty()
 {
-  float time = 10000.0/_frequency;
+  float time = 10000.0 / _frequency;
   _dutyCycleHigh = round(_dutyCycle * time);
   _dutyCycleLow  = round((100 - _dutyCycle) * time);
 }
@@ -216,7 +216,7 @@ void HeartBeatSL::beat()
     HeartBeat::beat();
     return;
   }
-  // _code mode
+  //  _code mode
   if (_codeStart == 0)
   {
     //  force a LOW first.
@@ -259,7 +259,7 @@ bool HeartBeatSL::code(const char * str)
   if (_codeMask > 0) return false;
   //  pattern too long
   uint8_t len = strlen(str);
-  if (len > 7) return false;
+  if (len > 15) return false;
 
   _code      = 0;
   _codeMask  = 1 << len;

libraries/HeartBeat/HeartBeat.h

@@ -2,15 +2,15 @@
 //
 //    FILE: HeartBeat.h
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.3.4
+// VERSION: 0.3.5
 // 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.4"))
+#define HEARTBEAT_LIB_VERSION       (F("0.3.5"))
 
 
 class HeartBeat
@@ -104,8 +104,8 @@ class HeartBeatSL : public HeartBeat
   bool   codeCompleted();         //  pattern has been executed.
 
 protected:
-  uint8_t _code        = 0;  //  up to 7 bits
-  uint8_t _codeMask    = 0;  //  to extract the bit value from code
+  uint16_t _code       = 0;  //  up to 15 bits
+  uint16_t _codeMask   = 0;  //  to extract the bit value from code
   uint8_t _codeStart   = 0;  //  force starting with LOW
   uint8_t _pulseLength = 0;  //  to track length of current pulse
 };

libraries/HeartBeat/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019-2024 Rob Tillaart
+Copyright (c) 2019-2025 Rob Tillaart
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

libraries/HeartBeat/README.md

@@ -39,9 +39,9 @@ No heart beat indicates the program is stuck or blocked.
 
 Since version 0.3.0 a derived class **HeartBeatSL** is added which can  
 send specific diagnostic or error patterns.
-A pattern exists of 1 to 7 HIGH pulses separated by a fixed length LOW pulse.
+A pattern exists of 1 to 15 HIGH pulses separated by a fixed length LOW pulse.
 The length of the HIGH pulses can be coded with characters S and L (short and long).
-An example of an SOS pattern is "SLS".
+An example of an SOS alike pattern is "SSSLLLSSS".
 The unit length of the base pulse is determined by the frequency.
 
 If a pattern is started it cannot be overwritten until it is either ready
@@ -65,7 +65,8 @@ If one wants to repeat a pattern the application has to repeat the call.
 
 To keep patterns recognizable one can exaggerate the difference in length.
 121 is harder to differentiate than 131, a rule of thumb is to use multiples 
-of 3 (1, 3, 6 and 9) as length as it allows 4 length levels.
+of 3 (1, 3, 6 and 9) as length as it allows 4 length levels. Or use three 
+levels (1 5 9) to keep it recognizeable.
 
 Many applications only need 2 lengths, short and long (BIOS alike), 
 but the interface allows more. 
@@ -89,7 +90,6 @@ For more complex patterns, please check my pulsePattern library.
 #include "HeartBeat.h"
 ```
 
-
 ### HeartBeat
 
 The interface of the base **HeartBeat** consists of the following functions:
@@ -98,25 +98,33 @@ The interface of the base **HeartBeat** consists of the following functions:
 - **void begin(uint8_t pin, float frequency = 1.0)** to configure the HeartBeat.
 The output pin should be unique.
 The default frequency is 1.0.
+- **void beat()** the worker; this function checks if the HeartBeat is enabled 
+and the OUTPUT (LED) must be toggled.  
+It must be called as often as possible to keep a steady pace,
+preferably at least 4 times the given frequency.  
+Not calling **beat()** effectively stops the heartbeat.
+
+
+### Frequency and duty cycle
+
 - **void setFrequency(float frequency = 1.0)** change the frequency of the pulsing.
 The default frequency is 1.0.
 Setting the frequency will not enable or disable the HeartBeat.  
 The frequency must be > 0.001 otherwise it will be constrained to 0.001.
 On the upper side values beyond 10 Hz are hard for humans but are allowed.
+- **float getFrequency()** returns set frequency (or constrained value).
 - **void setDutyCycle(float dutyCycle = 50)** duty cycle in percentage time HIGH.
 The default duty cycle = 50 %.
 The duty cycle must be between 0.0 and 100.0 %.  
 A value of 0 will put the heartbeat effectively off.
-- **float getFrequency()** returns set frequency (or constrained value).
 - **float getDutyCycle()** returns set duty cycle (or constrained value).
+
+
+### Status
+
 - **void enable()** enables the heart beat.
 - **void disable()** disable the heart beat. Will switch the pin to LOW.
 - **bool isEnabled()** returns true if the heart beat is enabled (running).
-- **void beat()** the worker; this function checks if the HeartBeat is enabled 
-and the OUTPUT (LED) must be toggled.  
-It must be called as often as possible to keep a steady pace,
-preferably at least 4 times the given frequency.  
-Not calling **beat()** effectively stops the heartbeat.
 - **uint8_t getState()** returns the state of the heartbeat.
 Useful for debugging.
 
@@ -128,7 +136,7 @@ The interface of **HeartBeatSL** adds of the following functions to **HeartBeat*
 - **HeartBeatSL()** constructor.
 - **bool code(const char \* str)** executes the pattern ONE time. 
 Repeating the pattern means repeating the call. 
-The max supported string length is **7** as pattern is stored in a byte.
+The max supported string length is **15** as pattern is stored in a byte.
 - **void codeOff()** explicitly stops the pattern. Forced stop.
 - **bool codeCompleted()** returns true if pattern is executed completely.
 
@@ -150,7 +158,10 @@ void setup()
 void loop()
 {
   HB.beat();
-  if (some_error) HB.code("LSSLSL");  // ==> L HHHHHH L H L H L HHH 
+  if (some_error) 
+  {
+    HB.code("LSSLSL");  // ==> L HHHHHH L H L H L HHHHHH L H L HHH
+  }
 
   // other code here
 }
@@ -167,7 +178,6 @@ void someOtherfunction()
 Note: a code will be executed, even if the HB is disabled.
 
 
-
 ### HeartBeatDiag
 
 The interface of **HeartBeatDiag** adds of the following functions:
@@ -242,18 +252,18 @@ See examples
 #### Should
 
 - add examples
-  - ACS712 current sensor
   - buffer % filled (e.g. stream)
 
 #### Could
 
+- HBSL: add R at the end for repeat?
 - investigate a pattern recognizer (fun)
   - e.g. with an LDR or lux sensor.
-- HeartBeatSL
-  - extend code length to 16 (bit)?
+- send Morse characters?
 
 #### Wont
 
+- add **setColor(r, g, b)** for 8 colour RGBheartbeat (no PWM)
 
 ## Support
 

libraries/HeartBeat/examples/HeartBeat_ACS712_demo/HeartBeat_ACS712_demo.ino

@@ -0,0 +1,65 @@
+//
+//    FILE: HeartBeat_ACS712_demo.ino
+//  AUTHOR: Rob Tillaart
+// PURPOSE: demo distance sensor
+//     URL: https://github.com/RobTillaart/HeartBeat
+//          https://github.com/RobTillaart/ACS712
+
+
+//  HEARTBEAT
+#include "HeartBeat.h"
+const int buzzer = 13;  //  also build in LED UNO
+HeartBeat HB;
+
+
+//  CURRENT SENSOR
+//  Arduino UNO has 5.0 volt with a max ADC value of 1023 steps
+//  ACS712 5A  uses 185 mV per A
+//  ACS712 20A uses 100 mV per A
+//  ACS712 30A uses  66 mV per A
+#include "ACS712.h"
+ACS712  ACS(A0, 5.0, 1023, 100);  //  analog pin, maxV, maxADC, mV/A
+
+
+uint32_t lastTime = 0;
+
+
+void setup()
+{
+  while (!Serial);
+  Serial.begin(115200);
+  Serial.println(__FILE__);
+  Serial.print("HEARTBEAT_LIB_VERSION: ");
+  Serial.println(HEARTBEAT_LIB_VERSION);
+  Serial.print("   ACS712_LIB_VERSION: ");
+  Serial.println(ACS712_LIB_VERSION);
+  Serial.println();
+
+  HB.begin(buzzer, 0.1);  // very low frequency
+  HB.setDutyCycle(10);    // short pulses
+
+  ACS.autoMidPoint();
+}
+
+
+void loop()
+{
+  HB.beat();
+
+  int mA = ACS.mA_DC();  //  Direct Current
+  //  int mA = ACS.mA_AC();  //  Alternating Current
+  Serial.println(mA);    //  print e.g. for plotter.
+
+  if (millis() - lastTime > 250)      //  update 4 times per second
+  {
+    lastTime = millis();
+    //  map 0..20000 mA ==> 0..20 Hz
+    float freq = mA * 0.001;
+    HB.setFrequency(freq);
+  }
+
+  delay(10);
+}
+
+
+// -- END OF FILE --

libraries/HeartBeat/library.json

@@ -15,7 +15,7 @@
     "type": "git",
     "url": "https://github.com/RobTillaart/HeartBeat.git"
   },
-  "version": "0.3.4",
+  "version": "0.3.5",
   "license": "MIT",
   "frameworks": "*",
   "platforms": "*",

libraries/HeartBeat/library.properties

@@ -1,5 +1,5 @@
 name=HeartBeat
-version=0.3.4
+version=0.3.5
 author=Rob Tillaart <[email protected]>
 maintainer=Rob Tillaart <[email protected]>
 sentence=Arduino library for HeartBeat with frequency and duty cycle.