MQTT_Collector

Overview

The MQTT Collector is a headless background script (# @headless true) designed to aggregate multiple data points dynamically under a single base topic. Instead of spawning heavy individual MQTT subscriptions for every single sensor, this script listens to a wildcard path and seamlessly hands the values over to your display apps via global shared memory.

How it Works

1. It listens to a dynamic topic path like AwtrixNG/DataCollector/+.
2. When a message arrives, it automatically extracts the last part of the topic as the key name (e.g., PVpower or BatterySOC).
3. It checks the timestamp map. If the value arrived faster than your configured threshold, it drops the payload immediately to save CPU cycles and RAM.
4. If approved, it updates the timestamp and publishes the payload globally as mqtt_collector.<key_name>.

Setup Instructions

1. Install the Script:

   • Open your AWTRIX web interface.
   • Go to the Scripts tab, create a new script, and name it exactly mqtt_collector.
   • Paste the Berry code into the editor and press Save (Ctrl+S).

2. Configure via Web UI:

   • Go to the Apps tab.
   • Click the Gear icon on the MQTT Collector row.
   • MQTT Basis-Topic: Set this to your preferred path ending with a wildcard + (Default: AwtrixNG/DataCollector/+).
   • min. Interval (seconds): Choose how many seconds a specific data point must "cool down" before a new value is accepted (Default: 5 seconds). Set to 0 to disable throttling.
   • Log messages: Toggle true if you want to inspect incoming data streams in your AWTRIX console.

3. Read Data in your Display Apps:

   • Your custom display apps can easily fetch any collected value directly from any method using:

     var my_value = shared.get("mqtt_collector.YOUR_DATA_POINT_NAME")