Updates

Author: 27pchrisl

README.md

@@ -317,7 +317,7 @@ use Flat3\RevPi\Interfaces\Monitor;
 class MyMonitor implements Monitor {
     public function evaluate(int|bool|null $next): bool {
         // Implement custom transition/action logic here
-        // e.g. if crossing a threshold, fire webhook
+        // e.g. if crossing a threshold
         // Return true if the monitor has detected sufficient change
     }
 }

src/Interfaces/Monitor.php

@@ -6,5 +6,5 @@
 
 interface Monitor
 {
-    public function evaluate(int|bool|null $next): bool;
+    public function evaluate(int|bool $next): bool;
 }

src/Monitors/DeadbandMonitor.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Flat3\RevPi\Monitors;
+
+use Flat3\RevPi\Exceptions\NotSupportedException;
+use Flat3\RevPi\Interfaces\Monitor;
+
+class DeadbandMonitor implements Monitor
+{
+    protected bool $wasOutside = false;
+
+    public function __construct(protected float $center, protected float $deadband) {}
+
+    public function evaluate(int|bool $next): bool
+    {
+        if (is_bool($next)) {
+            throw new NotSupportedException;
+        }
+
+        $outside = abs($next - $this->center) > $this->deadband;
+        $trigger = ($outside !== $this->wasOutside) && $outside;
+        $this->wasOutside = $outside;
+
+        return $trigger;
+    }
+}

src/Monitors/DigitalMonitor.php

@@ -10,7 +10,7 @@ class DigitalMonitor implements Monitor
 {
     protected int|bool|null $previous = null;
 
-    public function evaluate(int|bool|null $next): bool
+    public function evaluate(int|bool $next): bool
     {
         $previous = $this->previous;
         $this->previous = $next;

src/Monitors/MovingAverageMonitor.php

@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Flat3\RevPi\Monitors;
+
+use Flat3\RevPi\Interfaces\Monitor;
+
+class MovingAverageMonitor implements Monitor
+{
+    /**
+     * @var array<int|bool>
+     */
+    protected array $window = [];
+
+    public function __construct(protected int $windowSize, protected float $threshold) {}
+
+    public function evaluate(int|bool $next): bool
+    {
+        $this->window[] = $next;
+
+        if (count($this->window) > $this->windowSize) {
+            array_shift($this->window);
+        }
+
+        if (count($this->window) === 0) {
+            return false;
+        }
+
+        $average = array_sum($this->window) / count($this->window);
+
+        return $average > $this->threshold;
+    }
+}

src/Monitors/RangeMonitor.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Flat3\RevPi\Monitors;
+
+use Flat3\RevPi\Interfaces\Monitor;
+
+class RangeMonitor implements Monitor
+{
+    public function __construct(protected int|float $min, protected int|float $max) {}
+
+    public function evaluate(int|bool $next): bool
+    {
+        if ($next < $this->min || $next > $this->max) {
+            return true;
+        }
+
+        return false;
+    }
+}

src/Monitors/RateOfChangeMonitor.php

@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Flat3\RevPi\Monitors;
+
+use Flat3\RevPi\Exceptions\NotSupportedException;
+use Flat3\RevPi\Interfaces\Monitor;
+
+class RateOfChangeMonitor implements Monitor
+{
+    protected ?int $previous = null;
+
+    public function __construct(protected float $maxRate)
+    {
+        if ($maxRate <= 0) {
+            throw new NotSupportedException('maxRate must be positive');
+        }
+    }
+
+    public function evaluate(int|bool $next): bool
+    {
+        if (is_bool($next)) {
+            throw new NotSupportedException;
+        }
+
+        $result = false;
+
+        if ($this->previous !== null) {
+            $rate = abs($next - $this->previous);
+            $result = $rate >= $this->maxRate;
+        }
+
+        $this->previous = $next;
+
+        return $result;
+    }
+}

src/Monitors/StuckMonitor.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Flat3\RevPi\Monitors;
+
+use Flat3\RevPi\Interfaces\Monitor;
+
+class StuckMonitor implements Monitor
+{
+    protected int|bool|null $previous = null;
+
+    protected int $sameCount = 0;
+
+    public function __construct(protected int $repeatCount) {}
+
+    public function evaluate(int|bool $next): bool
+    {
+        if ($next === $this->previous) {
+            $this->sameCount++;
+        } else {
+            $this->sameCount = 1;
+        }
+
+        $this->previous = $next;
+
+        return $this->sameCount >= $this->repeatCount;
+    }
+}

src/Monitors/TrendMonitor.php

@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Flat3\RevPi\Monitors;
+
+use Flat3\RevPi\Interfaces\Monitor;
+
+class TrendMonitor implements Monitor
+{
+    /**
+     * @var array<int|bool>
+     */
+    protected array $window = [];
+
+    public function __construct(protected int $size) {}
+
+    public function evaluate(int|bool $next): bool
+    {
+        $this->window[] = $next;
+
+        if (count($this->window) > $this->size) {
+            array_shift($this->window);
+        }
+
+        if (count($this->window) < $this->size) {
+            return false;
+        }
+
+        for ($i = 1; $i < $this->size; $i++) {
+            if ($this->window[$i] <= $this->window[$i - 1]) {
+                return false;
+            }
+        }
+
+        return true;
+    }
+}

src/Rpc/RpcDevice.php

@@ -142,7 +142,7 @@ protected function invoke(string $method, array $params): mixed
                     while (true) {
                         $data = @fread($stream, Constants::BlockSize);
 
-                        if (!is_string($data) || $data === '') {
+                        if (! is_string($data) || $data === '') {
                             break;
                         }
 
@@ -162,7 +162,7 @@ protected function invoke(string $method, array $params): mixed
                         }
                     }
 
-                    if (!is_resource($stream) || @feof($stream)) {
+                    if (! is_resource($stream) || @feof($stream)) {
                         EventLoop::cancel($callbackId);
                     }
                 });