Support Home Assistant configuration for external converters. https://github.com/Koenkk/zigbee-herdsman-converters/issues/1343

lib/extension/externalConverters.js

@@ -1,30 +1,17 @@
 const zigbeeHerdsmanConverters = require('zigbee-herdsman-converters');
 const settings = require('../util/settings');
 const Extension = require('./extension');
-const data = require('../util/data');
+const utils = require('../util/utils');
 
 class ExternalConverters extends Extension {
     constructor(zigbee, mqtt, state, publishEntityState, eventBus) {
         super(zigbee, mqtt, state, publishEntityState, eventBus);
 
-        const externalConverters = settings.get().external_converters;
-
-        externalConverters.forEach((moduleName) => {
-            let converterModule = moduleName;
-
-            if (moduleName.endsWith('.js')) {
-                converterModule = data.joinPath(moduleName.split('.')[0]);
-            }
-
-            const converter = require(converterModule);
-            if (Array.isArray(converter)) {
-                converter.forEach((mod) => {
-                    zigbeeHerdsmanConverters.addDeviceDefinition(mod);
-                });
-            } else {
-                zigbeeHerdsmanConverters.addDeviceDefinition(converter);
-            }
-        });
+        for (const definition of utils.getExternalConvertersDefinitions(settings)) {
+            const toAdd = {...definition};
+            delete toAdd['homeassistant'];
+            zigbeeHerdsmanConverters.addDeviceDefinition(toAdd);
+        }
     }
 }
 

lib/extension/homeassistant.js

@@ -1,6 +1,7 @@
 const zigbeeHerdsmanConverters = require('zigbee-herdsman-converters');
 const settings = require('../util/settings');
 const logger = require('../util/logger');
+const utils = require('../util/utils');
 const zigbee2mqttVersion = require('../../package.json').version;
 const Extension = require('./extension');
 const objectAssignDeep = require(`object-assign-deep`);
@@ -1776,6 +1777,12 @@ class HomeAssistant extends Extension {
         this.eventBus.on('deviceRemoved', (data) => this.onDeviceRemoved(data.device));
         this.eventBus.on('publishEntityState', (data) => this.onPublishEntityState(data));
         this.eventBus.on('deviceRenamed', (data) => this.onDeviceRenamed(data.device));
+
+        for (const definition of utils.getExternalConvertersDefinitions(settings)) {
+            if (definition.hasOwnProperty('homeassistant')) {
+                mapping[definition.model] = definition.homeassistant;
+            }
+        }
     }
 
     onDeviceRemoved(device) {

lib/util/utils.js

@@ -1,6 +1,7 @@
 const zigbeeHerdsmanConverters = require('zigbee-herdsman-converters');
 const equals = require('fast-deep-equal');
 const humanizeDuration = require('humanize-duration');
+const data = require('./data');
 
 // Xiaomi uses 4151 and 4447 (lumi.plug) as manufacturer ID.
 const xiaomiManufacturerID = [4151, 4447];
@@ -150,6 +151,27 @@ function parseJSON(value, failedReturnValue) {
     }
 }
 
+function* getExternalConvertersDefinitions(settings) {
+    const externalConverters = settings.get().external_converters;
+
+    for (const moduleName of externalConverters) {
+        let converterModule = moduleName;
+
+        if (moduleName.endsWith('.js')) {
+            converterModule = data.joinPath(moduleName.split('.')[0]);
+        }
+
+        const converter = require(converterModule);
+        if (Array.isArray(converter)) {
+            for (const item of converter) {
+                yield item;
+            }
+        } else {
+            yield converter;
+        }
+    }
+}
+
 module.exports = {
     millisecondsToSeconds: (milliseconds) => milliseconds / 1000,
     secondsToMilliseconds: (seconds) => seconds * 1000,
@@ -169,4 +191,5 @@ module.exports = {
     getResponse,
     capitalize,
     parseJSON,
+    getExternalConvertersDefinitions,
 };