Skip to content
php-baremetal REGISTRY
Publish a package

php-baremetal/ext-events

bm-ext MIT

Event bus: events, listeners, timer, pin and button sources. Core, every firmware requires it.

ext-events · Recipe

Run code periodically

Run code every N milliseconds without a loop: one timer source per period, state kept in ordinary variables between events.

Two timers at different rates: a fast one that counts, a slow one that reports. Any board works; this one is for a Waveshare ESP32-S3-Zero (N8R8).

The project

json composer.json
{
  "name": "acme/periodic-tick",
  "type": "project",
  "repositories": [
    { "type": "composer", "url": "https://repository.php-baremetal.com", "canonical": true }
  ],
  "require": {
    "php-baremetal/conductor": "^1.0",
    "php-baremetal/ext-events": "^1.0"
  },
  "config": {
    "allow-plugins": { "php-baremetal/conductor": true },
    "platform": { "php": "8.5.11" }
  },
  "extra": {
    "baremetal": {
      "sdk": "esp32@^2.0",
      "board": "waveshare-esp32-s3-zero-n8r8",
      "runtime": "event-driven",
      "storage": "embedded"
    }
  }
}

The script

php project-src/index.php
<?php
use Baremetal\Event;
use Baremetal\Events;

final class Fast extends Event {}
final class Report extends Event {}

$count = 0;
$started = microtime(true);

Events::listen(Fast::class, function () use (&$count): void {
    $count++;
});

Events::listen(Report::class, function () use (&$count, $started): void {
    printf("%.1f s: %d fast ticks, %d KB in use\n",
        microtime(true) - $started, $count, intdiv(memory_get_usage(), 1024));
});

every(100, Fast::class);     // 10 per second (a float works too: every(1000 / 60, ...) is 60 per second)
every(5000, Report::class);  // every 5 s

echo "periodic-tick: running\n";

After about five seconds the console shows a report with roughly 50 fast ticks, then one every five seconds.

How it works

  • Each every() starts its own hardware timer. The timer callback only posts a message; the listener runs later, on the PHP task, when the runtime takes the message from the queue.
  • The period is kept by the timer, not by your code: a slow listener does not shift the next tick. While a tick waits for delivery the next ones are merged into it (every() coalesces by default), so a slow listener sees fewer ticks instead of a backlog; Events::stats() counts them as coalesced.
  • $count lives as long as the program: the script's variables are never reset between events.
  • To stop the timer, keep the Baremetal\Timer that every() returns and call stop() (see Controlling a source).

Related