optolink-bridge 1.1.1 → 1.2.0

package/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 This file documents all *major & minor* releases. For revisions, please consult the [commit history](https://github.com/kristian/optolink-bridge/commits/main).
 
+## [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

@@ -150,6 +150,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,
@@ -150,17 +174,17 @@ const packetQueue = async.queue(async task => {
   trace && console.log(dateTimeString(), directionName(task.direction), (task.data ?? encodePacket(task.packet, task.direction & fromOpto)).toString('hex'));
 
   const packet = task.packet ?? parsePacket(task.data, task.direction & fromOpto);
-  if (packet.rest) {
+  if (packet.rest?.length) {
     // if there is any rest, two packets have been sent in the same direction, so unshift the rest as the next packet to the queue
     packetQueue.unshift({ data: packet.rest, direction: task.direction });
   }
 
   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');
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "optolink-bridge",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "description": "Safely bridge the Optolink bus of your Viessmann heating system and publish attributes via MQTT + Home Assistant Device Discovery",
   "keywords": [
     "viessmann",