0.2.0 PIR

Author: RobTillaart

libraries/PIR/CHANGELOG.md

@@ -6,9 +6,20 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
 
-## [0.1.3] - 2023-11-15
+## [0.2.0] - 2025-06-26
+- add **reset()** to clean up internal admin
+- add **free()** to return available slots
+- add **add(array, length)** for easier configuration.
+- add **PIR_MAX_COUNT** to be compile time configurable
+- update unit tests
+- add examples PIR_demo_add_array.ino 
+- update keywords.txt
 - update readme.md
 
+----
+
+## [0.1.3] - 2023-11-15
+- update readme.md
 
 ## [0.1.2] - 2022-12-15
 - add changed(), read() + compare with the last value.

libraries/PIR/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022-2024 Rob Tillaart
+Copyright (c) 2022-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/PIR/PIR.cpp

@@ -1,7 +1,7 @@
 //
 //    FILE: PIR.cpp
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.1.3
+// VERSION: 0.2.0
 //    DATE: 2022-08-13
 // PURPOSE: PIR library for Arduino.
 //     URL: https://github.com/RobTillaart/PIR
@@ -12,30 +12,53 @@
 
 PIR::PIR()
 {
-  for (int i = 0; i < 8; i++)
-  {
-    _pins[i] = 0;
-  }
-  _count     = 0;
-  _lastValue = 0;
+  reset();
 }
 
 
 uint8_t PIR::add(uint8_t pin)
 {
-  if (_count >= 8) return PIR_ERR_ARRAY_FULL;
+  if (_count >= PIR_MAX_COUNT) return PIR_ERR_ARRAY_FULL;
   _pins[_count++] = pin;
   pinMode(pin, INPUT_PULLUP);
   return _count - 1;
 }
 
 
+uint8_t PIR::add(uint8_t * pins, uint8_t length)
+{
+  if ((_count + length) > PIR_MAX_COUNT) return PIR_ERR_ARRAY_FULL;
+  for (int i = 0; i < length; i++)
+  {
+    add(pins[i]);
+  }
+  return _count - 1;
+}
+
+
+void PIR::reset()
+{
+  for (int i = 0; i < PIR_MAX_COUNT; i++)
+  {
+    _pins[i] = 0;
+  }
+  _count     = 0;
+  _lastValue = 0;
+}
+
+
 uint8_t PIR::count()
 {
   return _count;
 }
 
 
+uint8_t PIR::free()
+{
+  return PIR_MAX_COUNT - _count;
+}
+
+
 uint8_t PIR::read()
 {
   if (_count == 0) return 0;

libraries/PIR/PIR.h

@@ -2,7 +2,7 @@
 //
 //    FILE: PIR.h
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.1.3
+// VERSION: 0.2.0
 //    DATE: 2022-08-13
 // PURPOSE: PIR library
 //     URL: https://github.com/RobTillaart/PIR
@@ -11,13 +11,19 @@
 #include "Arduino.h"
 
 
-#define PIR_LIB_VERSION        (F("0.1.3"))
+#define PIR_LIB_VERSION           (F("0.2.0"))
+
+
+#ifndef PIR_MAX_COUNT
+#define PIR_MAX_COUNT             8
+#endif
 
-//
-#define PIR_OK                0x00
-#define PIR_ERR_NO_SENSOR     0xFF
-#define PIR_ERR_ARRAY_FULL    0xFE
-#define PIR_ERR_INDEX         0xFD
+
+//  ERROR CODES
+#define PIR_OK                    0x00
+#define PIR_ERR_NO_SENSOR         0xFF
+#define PIR_ERR_ARRAY_FULL        0xFE
+#define PIR_ERR_INDEX             0xFD
 
 
 class PIR
@@ -28,9 +34,16 @@ class PIR
   //  adds a pin to the set
   //  returns the index or PIR_ARRAY_FULL
   uint8_t add(uint8_t pin);
+  //  adds multiple pins in one call.
+  uint8_t add(uint8_t * pins, uint8_t length);
+
+  //  resets the internal set to empty.
+  void reset();
 
   //  returns number of PIR sensors added.
   uint8_t count();
+  //  returns number of PIR slots available.
+  uint8_t free();
 
   //  MULTI PIN INTERFACE
   //  read all PIR sensors in the set
@@ -54,7 +67,7 @@ class PIR
 
 
 protected:
-  uint8_t  _pins[8]   = {0,0,0,0, 0,0,0,0};
+  uint8_t  _pins[PIR_MAX_COUNT];
   uint8_t  _count     = 0;
   uint8_t  _lastValue = 0;
 };

libraries/PIR/README.md

@@ -16,32 +16,46 @@ PIR library for Arduino. Supports up to 8 PIR sensors.
 ## Description
 
 The PIR library implements a class to monitor 1 or more PIR sensors.
-The library supports up to 8 PIR sensors per object, which typically are added in **setup()**.
-It is possible to add a sensor (pin) multiple times.
-The library accepts duplicates.
+The library supports default 8 PIR sensors per object, which typically are added in **setup()**.
+It is possible to add a sensor (pin) multiple times as the library accepts duplicates.
 
 The library has two **read()** functions, one to read a specific sensor, and one to read all of them.
 The latter will return a mask indicating HIGH and LOW.
 The first added PIR will have the LSB.
 
+The maximum number of PIR sensors supported can be adjusted with a define 
+in the .h file named **PIR_MAX_COUNT**. The default maximum is 8.
+
 Instead of PIR sensors one can add other DigitalOut sensors or even switches.
 
+As always feedback is welcome.
+
+### Related
+
+- https://github.com/RobTillaart/TCRT5000
+
 
 ## Interface
 
 ```cpp
 #include "PIR.h"
 ```
 
-#### Base
+### Base
 
-- **PIR()** constructor. Allocated room for 8 PIRs.
+- **PIR()** constructor. Default allocated room for 8 PIRs.
 - **uint8_t add(uint8_t pin)** adds a PIR pin to the set of pins.
 Returns the index or PIR_ARRAY_FULL (0xFE)
-- **uint8_t count** returns number of PIR sensors added.
+- **uint8_t add(uint8_t \* pins, uint8_t length)** adds an array of PIR pins
+to the set of pins if there is enough room for all pins of the array.
+If there is no room in the internal set to add length pins, no pin is added. 
+Returns the (last) index or PIR_ARRAY_FULL (0xFE) in case no pin is added.
+- **void reset()** removes all pins from the internal set, reset lastRead too.
+- **uint8_t count()** returns number of PIR sensors added.
+- **uint8_t free()** returns number of free slots to add.
 
 
-#### Read
+### Read
 
 - **uint8_t read()** read all PIR sensors in the set.
 Returns a bit mask of HIGH / LOW values.
@@ -64,16 +78,14 @@ This can improve processing in some cases.
 
 - add examples
   - interrupts?
+- investigate dynamic allocation in constructor (0.3.0)
+  - 0.2.0 has compile time define.
 
 #### Could
 
-- investigate PIR16 PIR32 class that can hold more
-  - think MEGA2560.
-  - or dynamic allocation?  0.2.0
-- one lastRead for all?
-- **uint8_t pin(uint8_t index)** to get back configuration
-- **bool add(uint8_t array, length)** faster configuration. Return true if there was enough room.
-- **clear()** to reset whole object?
+- one lastRead for all
+- **uint8_t getPinAtIndex(uint8_t index)** to get back configuration
+
 
 #### Wont
 

libraries/PIR/examples/PIR_demo/PIR_demo.ino

@@ -13,11 +13,13 @@ PIR  P;
 
 void setup()
 {
-  Serial.begin(115200);
   while (!Serial);
+  Serial.begin(115200);
+  Serial.println();
   Serial.println(__FILE__);
   Serial.print("PIR_LIB_VERSION: ");
   Serial.println(PIR_LIB_VERSION);
+  Serial.println();
 
   P.add(3);
   P.add(4);

libraries/PIR/examples/PIR_demo_add_array/PIR_demo_add_array.ino

@@ -0,0 +1,37 @@
+//
+//    FILE: PIR_demo_add_array.ino
+//  AUTHOR: Rob Tillaart
+// PURPOSE: demo pir sensor class
+//     URL: https://github.com/RobTillaart/PIR
+
+
+#include "PIR.h"
+
+
+PIR  P;
+
+uint8_t pins[4] = {3, 4, 5, 6};
+
+void setup()
+{
+  while (!Serial);
+  Serial.begin(115200);
+  Serial.println();
+  Serial.println(__FILE__);
+  Serial.print("PIR_LIB_VERSION: ");
+  Serial.println(PIR_LIB_VERSION);
+  Serial.println();
+
+  P.add(pins, 4);
+}
+
+
+void loop()
+{
+  uint8_t x = P.read();
+  Serial.println(x, HEX);
+  delay(1000);
+}
+
+
+//  -- END OF FILE --

libraries/PIR/examples/PIR_demo_lastValue/PIR_demo_lastValue.ino

@@ -11,11 +11,13 @@ PIR  P;
 
 void setup()
 {
-  Serial.begin(115200);
   while (!Serial);
+  Serial.begin(115200);
+  Serial.println();
   Serial.println(__FILE__);
   Serial.print("PIR_LIB_VERSION: ");
   Serial.println(PIR_LIB_VERSION);
+  Serial.println();
 
   //  add 3 PIR sensors
   P.add(3);

libraries/PIR/examples/PIR_performance/PIR_performance.ino

@@ -13,11 +13,13 @@ uint32_t start, stop;
 
 void setup()
 {
-  Serial.begin(115200);
   while (!Serial);
+  Serial.begin(115200);
+  Serial.println();
   Serial.println(__FILE__);
   Serial.print("PIR_LIB_VERSION: ");
   Serial.println(PIR_LIB_VERSION);
+  Serial.println();
 
   //  fully loaded
   P.add(3);
@@ -29,6 +31,11 @@ void setup()
   P.add(9);
   P.add(10);
 
+  Serial.print("pins: ");
+  Serial.println(P.count());
+  Serial.println();
+  delay(10);
+
   test_read();
   test_lastValue();
   test_changed();

libraries/PIR/examples/PIR_performance/performance_0.2.0.txt

@@ -0,0 +1,23 @@
+
+IDE:    1.8.19
+BOARD:  UNO R3
+
+PIR_performance.ino
+PIR_LIB_VERSION: 0.2.0
+
+pins: 8
+
+
+test_read
+TIME:	32
+VAL:	FF
+
+test_lastValue
+TIME:	4
+VAL:	FF
+
+test_changed
+TIME:	36
+VAL:	0
+
+