optolink-bridge 1.1.2 → 1.3.0

package/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 This file documents all *major & minor* releases. For revisions, please consult the [commit history](https://github.com/kristian/optolink-bridge/commits/main).
 
+## [1.3] - 2026-04-12
+
+Introduce a `max_buffer_chunks` option to prevent stalled streams from filling up the memory with too many buffered chunks, and expose the vito + opto serial ports and bridges on the event emitter for debugging purposes.
+
+## [1.2] - 2026-01-08
+
+Introduce a `publish_bus_state` MQTT option
+
+## [1.1] - 2025-12-17
+
+Major dependencies bump & allow Vitoconnect to reset the synchronization
+
 ## [1.0] - 2025-02-26
 
 Initial release

package/config.toml

@@ -132,6 +132,9 @@ max_decimals = 4
 # (this is because if poll_items is empty, optolink-bridge will start in pass-through mode and is not able to intercept messages)
 auto_reload_addr_items = true
 
+# the maximum number of chunks to buffer in one direction, before considering the stream to be stalled and dropping oldest chunks, defaults to 1000
+max_buffered_chunks = 100
+
 [mqtt]
 
 # broker protocol / host / port
@@ -150,6 +153,10 @@ suffix = "<dpname>"
 # note: if set to false, home assistant will not be able to determine if the devices / entities are available
 online = true
 
+# publish a "bus_state" topic, e.g. Vito/bus_state, indicating the current state of the optolink bus. defaults to true /
+# "bus_state", set to a string to use a different topic. possible bus states are: 0: syncing, 1: synced, 2: flowing
+publish_bus_state = true
+
 # publish unknown data points to MQTT as raw data
 publish_unknown_dps = false
 # the suffix to use to publish unknown data points, defaults to "raw/<addr>"

package/index.js

@@ -12,6 +12,17 @@ import { publishDevice } from './discovery.js';
 let logLevel, trace, logger = {};
 let dps, pollQueue = new Queue(), pollIntervals;
 let busState = 0; // 0: syncing, 1: synced, 2: flowing
+let afterBusStateUpdate = async (newState, oldState) => {};
+async function updateBusState(state) {
+  const oldState = busState; busState = state;
+  if (typeof afterBusStateUpdate === 'function') {
+    try {
+      await afterBusStateUpdate(state, oldState);
+    } catch {
+      // ignore errors
+    }
+  }
+}
 let deviceSerialNo = undefined, deviceDiscoveryOptions = { enabled: true }, deviceDiscovery;
 
 async function applyConfig(config) {
@@ -113,10 +124,23 @@ deviceDiscovery = async function(options = (deviceDiscoveryOptions ?? { enabled:
 }
 
 if (config.mqtt && config.mqtt.url) {
-  config.mqtt.online ??= true; // if not set, use a online topic
-  mqttTopic = config.mqtt.topic ?? 'Vito', mqttAvailabilityTopic =
-    `${mqttTopic}${mqttTopic.endsWith('/') || config.mqtt.online.startsWith?.('/') ? '' : '/'}${
-      typeof config.mqtt.online === 'string' ? config.mqtt.online : 'online'}`;
+  config.mqtt.online ??= true; // if not set, use topic "online"
+  config.mqtt.publish_bus_state ??= true; // if not set, use topic "bus_state"
+  
+  mqttTopic = config.mqtt.topic ?? 'Vito';
+  function prefixMqttTopic(topic, defaultTopic) {
+    return `${mqttTopic}${mqttTopic.endsWith('/') || topic?.startsWith?.('/') ? '' : '/'}${
+      typeof topic === 'string' ? topic : defaultTopic}`;
+  }
+  mqttAvailabilityTopic = prefixMqttTopic(config.mqtt.online, 'online');
+
+  if (config.mqtt.publish_bus_state) {
+    const mqttBusStateTopic = prefixMqttTopic(config.mqtt.publish_bus_state, 'bus_state');
+    afterBusStateUpdate = async state => {
+      await mqttClient.publishAsync(
+        mqttBusStateTopic, `${state}`);
+    };
+  }
 
   const mqttOptions = {
     username: config.mqtt.username,
@@ -156,11 +180,11 @@ const packetQueue = async.queue(async task => {
   }
 
   if (task.direction === fromVitoToOpto && packet.start === 0x04) {
-    busState = 0; // reset synchronization
+    await updateBusState(0); // reset synchronization
   } else if (busState === 0 && task.direction & toOpto && packet.start === 0x16 && 'zero' in packet) {
-    busState = 1;
+    await updateBusState(1);
   } else if (busState === 1 && task.direction & fromOpto && packet.res === 0x06 && !packet.peek?.length) {
-    busState = 2;
+    await updateBusState(2);
 
     logger.info('Synchronization completed. Streams are now flowing');
   }
@@ -205,7 +229,7 @@ const packetQueue = async.queue(async task => {
   const topic = mqttDpTopic(dp), value = dp ? dp.parse(packet.data) : packet.data;
   logger.debug(`Publishing ${dp ? dp.name : 'unknown'} data point (${formatAddr(packet.addr)}) to ${topic}:`, value);
   await mqttClient.publishAsync(topic, Buffer.isBuffer(value) ? bufferToFormat(value, config.buffer_format ?? 'hex') :
-    `${ typeof value === 'number' ? parseFloat(value.toFixed(config.max_decimals ?? 4 )) : value }`);
+    `${ typeof value === 'number' ? parseFloat(value.toFixed(config.max_decimals ?? 4)) : value }`);
 }, 1 /* no concurrency, packets should to be processed in order */);
 packetQueue.error((err, task) => {
   logger.error(`Error while processing packet: ${task?.data?.toString('hex')}`, err);
@@ -236,6 +260,10 @@ const chunkQueue = async.queue(async task => {
     packetQueue.push({ data, packet, direction });
   } else {
     chunks.push(task.chunk);
+    if (chunks.length > (config.max_buffered_chunks ?? 100)) {
+      logger.warn(`The chunk queue has buffered more than ${config.max_buffered_chunks ?? 100} chunks in the same direction (${directionName(direction)}), which could indicate that the stream is stalled. Consider increasing the max_buffered_chunks setting in your config.toml file if you are polling huge packets or check if there are any issues with the serial connection.`);
+      chunks.shift(); // drop the oldest chunk
+    }
   }
 }, 1 /* no concurrency, chunks need to be processed in order */);
 chunkQueue.error((err, task) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "optolink-bridge",
-  "version": "1.1.2",
+  "version": "1.3.0",
   "description": "Safely bridge the Optolink bus of your Viessmann heating system and publish attributes via MQTT + Home Assistant Device Discovery",
   "keywords": [
     "viessmann",
@@ -54,9 +54,9 @@
     "buffer-to-str": "^1.0.0",
     "change-case": "^5.4.4",
     "chokidar": "^5.0.0",
-    "mqtt": "^5.14.1",
+    "mqtt": "^5.15.1",
     "serialport": "^13.0.0",
-    "smol-toml": "^1.5.2",
+    "smol-toml": "^1.6.1",
     "yocto-queue": "^1.2.2"
   },
   "packageManager": "yarn@4.12.0"

package/serial.js

@@ -56,11 +56,12 @@ export async function connect(vitoPath = '/dev/ttyS0', optoPath = '/dev/ttyUSB0'
     lock: true // exclusive
   };
   
-  const vitoPort = new SerialPort({
+  // expose the vito + opto ports, mainly for debugging purpose
+  const vitoPort = eventEmitter.vitoPort = new SerialPort({
     path: vitoPath,
     ...portOptions
   });
-  const optoPort = new SerialPort({
+  const optoPort = eventEmitter.optoPort = new SerialPort({
     path: optoPath,
     ...portOptions
   });
@@ -80,8 +81,8 @@ export async function connect(vitoPath = '/dev/ttyS0', optoPath = '/dev/ttyUSB0'
   };
 
   eventEmitter.pipeline = Promise.all([
-    pipeline(vitoPort, createBridgeStream(fromVitoToOpto, vitoPort, optoPort), optoPort),
-    pipeline(optoPort, createBridgeStream(fromOptoToVito, vitoPort, optoPort), vitoPort)
+    pipeline(vitoPort, eventEmitter.vitoToOptoBridge = createBridgeStream(fromVitoToOpto, vitoPort, optoPort), optoPort),
+    pipeline(optoPort, eventEmitter.optoToVitoBridge = createBridgeStream(fromOptoToVito, vitoPort, optoPort), vitoPort)
   ]);
 
   return eventEmitter;