optolink-bridge 1.0.0 → 1.1.0

package/config.toml

@@ -193,9 +193,9 @@ prefix = "homeassistant"
 # you may set its entry in the overrides section to false, e.g.: some_data_point = false
 [mqtt.device_discovery.overrides.sensor]
 
-outside_temperature = { device_class = "temperature", unit_of_measurement = "°C", suggested_display_precision = 1, icon = "mdi:thermometer" }
-averaged_outside_temperature = { device_class = "temperature", unit_of_measurement = "°C", suggested_display_precision = 1, icon = "mdi:thermometer" }
-averaging_time_outside_temperature = { device_class = "duration", unit_of_measurement = "min" }
+outside_temperature = { device_class = "temperature", state_class = "measurement", unit_of_measurement = "°C", suggested_display_precision = 1, icon = "mdi:thermometer" }
+averaged_outside_temperature = { device_class = "temperature", state_class = "measurement", unit_of_measurement = "°C", suggested_display_precision = 1, icon = "mdi:thermometer" }
+averaging_time_outside_temperature = { device_class = "duration", state_class = "measurement", unit_of_measurement = "min" }
 
 operating_mode = { icon = "mdi:cog", value_template = """
 {% set mapping = ({
@@ -212,32 +212,32 @@ operating_mode = { icon = "mdi:cog", value_template = """
 
 hkl_level = { state_class = "measurement", icon = "mdi:chart-line" }
 hkl_slope = { state_class = "measurement", icon = "mdi:chart-line" }
-hysteresis = { device_class = "temperature", unit_of_measurement = "K", icon = "mdi:thermometer-lines" }
+hysteresis = { device_class = "temperature", unit_of_measurement = "K", state_class = "measurement", icon = "mdi:thermometer-lines" }
 
-buffer_temperature = { device_class = "temperature", unit_of_measurement = "°C", suggested_display_precision = 1 }
-primary_circuit_flow_temperature = { device_class = "temperature", unit_of_measurement = "°C", suggested_display_precision = 1 }
-secondary_circuit_flow_temperature = { device_class = "temperature", unit_of_measurement = "°C", suggested_display_precision = 1 }
-return_temperature = { device_class = "temperature", unit_of_measurement = "°C", suggested_display_precision = 1 }
+buffer_temperature = { device_class = "temperature", unit_of_measurement = "°C", state_class = "measurement", suggested_display_precision = 1 }
+primary_circuit_flow_temperature = { device_class = "temperature", unit_of_measurement = "°C", state_class = "measurement", suggested_display_precision = 1 }
+secondary_circuit_flow_temperature = { device_class = "temperature", unit_of_measurement = "°C", state_class = "measurement", suggested_display_precision = 1 }
+return_temperature = { device_class = "temperature", unit_of_measurement = "°C", state_class = "measurement", suggested_display_precision = 1 }
 
-"3way_valve_position" = { unit_of_measurement = "%", suggested_display_precision = 0, icon = "mdi:valve", value_template = "{{ value | float * 100 }}" }
+"3way_valve_position" = { unit_of_measurement = "%", state_class = "measurement", suggested_display_precision = 0, icon = "mdi:valve", value_template = "{{ value | float * 100 }}" }
 
-suction_gas_temperature = { device_class = "temperature", unit_of_measurement = "°C", suggested_display_precision = 1 }
-suction_gas_pressure = { device_class = "pressure", unit_of_measurement = "bar", suggested_display_precision = 1 }
-hot_gas_temperature = { device_class = "temperature", unit_of_measurement = "°C", suggested_display_precision = 1 }
-hot_gas_pressure = { device_class = "pressure", unit_of_measurement = "bar", suggested_display_precision = 1 }
-liquid_gas_temperature = { device_class = "temperature", unit_of_measurement = "°C", suggested_display_precision = 1 }
-condensation_temperature = { device_class = "temperature", unit_of_measurement = "°C", suggested_display_precision = 1 }
-evaporation_temperature = { device_class = "temperature", unit_of_measurement = "°C", suggested_display_precision = 1 }
-compressor_power = { unit_of_measurement = "%", suggested_display_precision = 0, icon = "mdi:heat-pump", value_template = "{{ value | int }}" }
-ecv_position = { unit_of_measurement = "%", suggested_display_precision = 0, icon = "mdi:valve", value_template = "{{ value | int }}" }
+suction_gas_temperature = { device_class = "temperature", unit_of_measurement = "°C", state_class = "measurement", suggested_display_precision = 1 }
+suction_gas_pressure = { device_class = "pressure", unit_of_measurement = "bar", state_class = "measurement", suggested_display_precision = 1 }
+hot_gas_temperature = { device_class = "temperature", unit_of_measurement = "°C", state_class = "measurement", suggested_display_precision = 1 }
+hot_gas_pressure = { device_class = "pressure", unit_of_measurement = "bar", state_class = "measurement", suggested_display_precision = 1 }
+liquid_gas_temperature = { device_class = "temperature", unit_of_measurement = "°C", state_class = "measurement", suggested_display_precision = 1 }
+condensation_temperature = { device_class = "temperature", unit_of_measurement = "°C", state_class = "measurement", suggested_display_precision = 1 }
+evaporation_temperature = { device_class = "temperature", unit_of_measurement = "°C", state_class = "measurement", suggested_display_precision = 1 }
+compressor_power = { unit_of_measurement = "%", state_class = "measurement", suggested_display_precision = 0, icon = "mdi:heat-pump", value_template = "{{ value | int }}" }
+ecv_position = { unit_of_measurement = "%", state_class = "measurement", suggested_display_precision = 0, icon = "mdi:valve", value_template = "{{ value | int }}" }
 
-dhw_temperature_storage = { device_class = "temperature", unit_of_measurement = "°C", suggested_display_precision = 1 }
-dhw_temperature_setpoint = { device_class = "temperature", unit_of_measurement = "°C", suggested_display_precision = 1 }
-dhw_temperature_setpoint2 = { device_class = "temperature", unit_of_measurement = "°C", suggested_display_precision = 1 }
+dhw_temperature_storage = { device_class = "temperature", unit_of_measurement = "°C", state_class = "measurement", suggested_display_precision = 1 }
+dhw_temperature_setpoint = { device_class = "temperature", unit_of_measurement = "°C", state_class = "measurement", suggested_display_precision = 1 }
+dhw_temperature_setpoint2 = { device_class = "temperature", unit_of_measurement = "°C", state_class = "measurement", suggested_display_precision = 1 }
 
-room_temperature_setpoint_normal = { device_class = "temperature", unit_of_measurement = "°C", suggested_display_precision = 1 }
-room_temperature_setpoint_reduced = { device_class = "temperature", unit_of_measurement = "°C", suggested_display_precision = 1 }
-room_temperature_setpoint_party = { device_class = "temperature", unit_of_measurement = "°C", suggested_display_precision = 1 }
+room_temperature_setpoint_normal = { device_class = "temperature", unit_of_measurement = "°C", state_class = "measurement", suggested_display_precision = 1 }
+room_temperature_setpoint_reduced = { device_class = "temperature", unit_of_measurement = "°C", state_class = "measurement", suggested_display_precision = 1 }
+room_temperature_setpoint_party = { device_class = "temperature", unit_of_measurement = "°C", state_class = "measurement", suggested_display_precision = 1 }
 
 compressor_phase = { icon = "mdi:information", value_template = """
 {% set mapping = ({
@@ -264,10 +264,10 @@ compressor_phase = { icon = "mdi:information", value_template = """
 }) %}
 {{ mapping[value[:2]] | default('Unknown') }}""" }
 
-compressor_starts = { unit_of_measurement = "cycles", state_class = "total_increasing", icon = "mdi:restart" }
+compressor_starts = { unit_of_measurement = "cycle(s)", state_class = "total_increasing", icon = "mdi:restart" }
 compressor_operating_hours = { device_class = "duration", unit_of_measurement = "h", state_class = "total_increasing", icon = "mdi:fan-clock" }
-compressor_heating_power = { device_class = "power", unit_of_measurement = "W" }
-compressor_power_consumption = { device_class = "power", unit_of_measurement = "W" }
+compressor_heating_power = { device_class = "power", unit_of_measurement = "W", state_class = "measurement" }
+compressor_power_consumption = { device_class = "power", unit_of_measurement = "W", state_class = "measurement" }
 
 annual_performance_factor = { state_class = "measurement", icon = "mdi:chart-line", value_template = "{{ value | float | round(2) }}" }
 annual_performance_factor_heating = { state_class = "measurement", icon = "mdi:chart-line", value_template = "{{ value | float | round(2) }}" }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "optolink-bridge",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Safely bridge the Optolink bus of your Viessmann heating system and publish attributes via MQTT + Home Assistant Device Discovery",
   "keywords": [
     "viessmann",
@@ -53,11 +53,11 @@
     "binary-parser-encoder-bump": "^2.2.1",
     "buffer-to-str": "^1.0.0",
     "change-case": "^5.4.4",
-    "chokidar": "^4.0.3",
+    "chokidar": "^5.0.0",
     "mqtt": "^5.14.1",
     "serialport": "^13.0.0",
-    "smol-toml": "^1.4.2",
-    "yocto-queue": "^1.2.1"
+    "smol-toml": "^1.5.2",
+    "yocto-queue": "^1.2.2"
   },
-  "packageManager": "yarn@4.10.3"
+  "packageManager": "yarn@4.12.0"
 }

package/parse_vs2.js

@@ -195,7 +195,7 @@ const valueParser = new Parser()
 
         let options;
         if (type === 'string') {
-          options = { greedy: true };
+          options = { greedy: true, formatter: str => str.replace(/\x00/g, '') };
         } else if (type === 'buffer') {
           options = { readUntil: 'eof' };
         }

package/tools/analyze_trace.js

@@ -107,19 +107,13 @@ function getRawValue(value, index) {
  * - Everything else to a string
  * @param {Buffer|any} value the (raw) value to output
  * @param {object} [dp] the datapoint to parse the value
- * @param {boolean} [scales] scale numbers to common factors (0.1, 0.01, 1/3600)
  * @returns {string} to value formatted as string
  */
-function getValue(value, dp, scales) {
-  if (typeof dp === 'boolean') {
-    scales = dp;
-    dp = undefined
-  }
-
+function getValue(value, dp) {
   if (Array.isArray(value)) {
-    return `${getValue(value[0], dp)} → ${getValue(value[1], dp, scales)}`;
+    return `${getValue(value[0], dp)} → ${getValue(value[1], dp)}`;
   } else if (typeof value === 'object' && value.data && value.write === true) {
-    return `${getValue(value.data, dp, scales)} (!)`;
+    return `${getValue(value.data, dp)} (!)`;
   } else if (Buffer.isBuffer(value) && dp) {
     try {
       value = dp.parse(value);
@@ -133,9 +127,10 @@ function getValue(value, dp, scales) {
     return `0x${value.toString('hex')}`;
   }
   
+  // in case the data point is unknown, output some scales for numbers
   if (typeof value === 'number') {
-    return scales ? [value, value / 10, value / 100, value / 3600].map(getNumber) : getNumber(value);
-  } else if (typeof value === 'bigint' && scales) {
+    return !dp ? [value, value / 10, value / 100, value / 3600].map(getNumber) : getNumber(value);
+  } else if (typeof value === 'bigint' && !dp) {
     return [value, value / BigInt(10), value / BigInt(100), value / BigInt(3600)].map(value => value.toString());
   }
 
@@ -285,7 +280,7 @@ for await (let line of lines) {
     let value;
     const dp = dps.get(packet.addr);
     if (dp) {
-      value = `data point: ${getValue(packet.data, dp)}`;
+      value = `data point "${dp.name}": ${getValue(packet.data, dp)}`;
     } else {
       value = `debug: ${JSON.stringify(Object.fromEntries(Object.entries(parseValue('debug', packet.data)).map(([key, value]) => [key, getValue(value)])))}`;
     }
@@ -365,7 +360,7 @@ if (malformed.length) {
 
 console.log();
 function output(stats, valueFn) {
-  const withDps = stats.filter(({ dp }) => dp);
+  const withDps = stats.filter(({ dp }) => dp).sort(({ addr: addrA }, { addr: addrB }) => addrA - addrB);
   if (withDps.length) {
     console.log();
     console.log('With configured data points:');
@@ -374,7 +369,7 @@ function output(stats, valueFn) {
     }
   }
   
-  const woDps = stats.filter(({ dp }) => !dp);
+  const woDps = stats.filter(({ dp }) => !dp).sort(({ addr: addrA }, { addr: addrB }) => addrA - addrB);;
   if (woDps.length) {
     console.log();
     console.log('Without configured data points (output as raw / hex):');
@@ -441,13 +436,13 @@ if (types.mostly_variable_values) {
 
 if (types.identical_values) {
   console.log('Addresses that never changed / always contained identical values (e.g. configurations):');
-  output(types.identical_values, (values, dp) => `${values.length}× ${getValue(values[0], dp, true)}`);
+  output(types.identical_values, (values, dp) => `${values.length}× ${getValue(values[0], dp)}`);
   console.log();
 }
 
 if (types.strings_or_arrays) {
   console.log('Addresses which contained mostly strings or arrays (e.g. labels & complex data types):');
-  output(types.strings_or_arrays, (values, dp) => `e.g. ${getValue(values[0], dp, true)}`);
+  output(types.strings_or_arrays, (values, dp) => `e.g. ${getValue(values[0], dp)}`);
   console.log();
 }
 

package/.editorconfig

@@ -1,10 +0,0 @@
-root = true
-
-[*]
-end_of_line = lf
-insert_final_newline = true
-
-[*.{js,json,yml}]
-charset = utf-8
-indent_style = space
-indent_size = 2

package/.gitattributes

@@ -1,4 +0,0 @@
-/.yarn/**            linguist-vendored
-/.yarn/releases/*    binary
-/.yarn/plugins/**/*  binary
-/.pnp.*              binary linguist-generated

package/.vscode/extensions.json

@@ -1,5 +0,0 @@
-{
-  "recommendations": [
-    "arcanis.vscode-zipfs"
-  ]
-}

package/.vscode/settings.json

@@ -1,11 +0,0 @@
-{
-  "search.exclude": {
-    "**/.yarn": true,
-    "**/.pnp.*": true
-  },
-  "cSpell.words": [
-    "Optolink",
-    "Viessmann",
-    "Vitoconnect"
-  ]
-}

package/.yarn/sdks/integrations.yml

@@ -1,5 +0,0 @@
-# This file is automatically generated by @yarnpkg/sdks.
-# Manual changes might be lost!
-
-integrations:
-  - vscode