@iobroker/modbus 7.0.2

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015-2025 Bluefox <dogafox@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,40 @@
+# @iobroker/modbus
+This is a library that allows you to implement ioBroker Adapter that communicates via modbus with some device.
+
+It could accept TSV file as a configuration.
+
+## Test
+There are some programs in folder `test` to test the TCP communication:
+- Ananas32/64 is a slave simulator (only holding registers and inputs, no coils and digital inputs)
+- RMMS is master simulator
+- mod_RSsim.exe is a slave simulator. It can be that you need [Microsoft Visual C++ 2008 SP1 Redistributable Package](https://www.microsoft.com/en-us/download/details.aspx?id=5582) to start it (because of Side-By-Side error).
+
+<!--
+	### **WORK IN PROGRESS**
+-->
+## Changelog
+### 7.0.2 (2025-10-06)
+* (bluefox) initial commit
+
+## License
+The MIT License (MIT)
+
+Copyright (c) 2015-2025 Bluefox <dogafox@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/build/convert.d.ts

@@ -0,0 +1,2 @@
+import type { Register, RegisterType } from './types';
+export default function tsv2registers(type: RegisterType, fileNameOrText: string): Register[];

package/build/convert.js

@@ -0,0 +1,102 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = tsv2registers;
+const tsv_json_1 = require("tsv-json");
+const node_fs_1 = require("node:fs");
+const coils = [
+    { name: '_address' },
+    { name: 'name' },
+    { name: 'description' },
+    { name: 'formula' },
+    { name: 'role' },
+    { name: 'room' },
+    { name: 'poll', type: 'checkbox' },
+    { name: 'wp', type: 'checkbox' },
+    { name: 'cw', type: 'checkbox' },
+    { name: 'isScale', type: 'checkbox' },
+];
+const disInputs = [
+    { name: '_address' },
+    { name: 'name' },
+    { name: 'description' },
+    { name: 'formula' },
+    { name: 'role' },
+    { name: 'room' },
+    { name: 'cw', type: 'checkbox' },
+    { name: 'isScale', type: 'checkbox' },
+];
+const holdingRegs = [
+    { name: '_address' },
+    { name: 'name' },
+    { name: 'description' },
+    { name: 'unit' },
+    { name: 'type' },
+    { name: 'len' },
+    { name: 'factor' },
+    { name: 'offset' },
+    { name: 'formula' },
+    { name: 'role' },
+    { name: 'room' },
+    { name: 'poll', type: 'checkbox' },
+    { name: 'wp', type: 'checkbox' },
+    { name: 'cw', type: 'checkbox' },
+    { name: 'isScale', type: 'checkbox' },
+];
+const inputRegs = [
+    { name: '_address' },
+    { name: 'name' },
+    { name: 'description' },
+    { name: 'unit' },
+    { name: 'type' },
+    { name: 'len' },
+    { name: 'factor' },
+    { name: 'offset' },
+    { name: 'formula' },
+    { name: 'role' },
+    { name: 'room' },
+    { name: 'cw', type: 'checkbox' },
+    { name: 'isScale', type: 'checkbox' },
+];
+function tsv2registers(type, fileNameOrText) {
+    if (fileNameOrText.toLowerCase().endsWith('.tsv')) {
+        if ((0, node_fs_1.existsSync)(fileNameOrText)) {
+            fileNameOrText = (0, node_fs_1.readFileSync)(fileNameOrText).toString();
+        }
+    }
+    let propsFields;
+    if (type === 'coils') {
+        propsFields = coils;
+    }
+    else if (type === 'inputRegs') {
+        propsFields = inputRegs;
+    }
+    else if (type === 'holdingRegs') {
+        propsFields = holdingRegs;
+    }
+    else if (type === 'disInputs') {
+        propsFields = disInputs;
+    }
+    if (!propsFields) {
+        throw new Error('Unknown register type');
+    }
+    const data = (0, tsv_json_1.tsv2json)(fileNameOrText.endsWith('\n') ? fileNameOrText : `${fileNameOrText}\n`);
+    const fields = data.shift();
+    if (fields) {
+        for (const index in propsFields) {
+            if (propsFields[index].name !== fields[index]) {
+                throw new Error(`Unexpected field ${index} for ${fields[index]}`);
+            }
+        }
+    }
+    return data.map(itemValues => {
+        const item = {};
+        for (const index in propsFields) {
+            if (propsFields[index].type === 'checkbox') {
+                itemValues[index] = itemValues[index] === 'true';
+            }
+            item[propsFields[index].name] = itemValues[index];
+        }
+        return item;
+    });
+}
+//# sourceMappingURL=convert.js.map

package/build/convert.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"convert.js","sourceRoot":"","sources":["../src/convert.ts"],"names":[],"mappings":";;AAmEA,gCA4CC;AA9GD,uCAAoC;AACpC,qCAAmD;AAOnD,MAAM,KAAK,GAAoB;IAC3B,EAAE,IAAI,EAAE,UAAU,EAAE;IACpB,EAAE,IAAI,EAAE,MAAM,EAAE;IAChB,EAAE,IAAI,EAAE,aAAa,EAAE;IACvB,EAAE,IAAI,EAAE,SAAS,EAAE;IACnB,EAAE,IAAI,EAAE,MAAM,EAAE;IAChB,EAAE,IAAI,EAAE,MAAM,EAAE;IAChB,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE;IAClC,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE;IAChC,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE;IAChC,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,UAAU,EAAE;CACxC,CAAC;AAEF,MAAM,SAAS,GAAoB;IAC/B,EAAE,IAAI,EAAE,UAAU,EAAE;IACpB,EAAE,IAAI,EAAE,MAAM,EAAE;IAChB,EAAE,IAAI,EAAE,aAAa,EAAE;IACvB,EAAE,IAAI,EAAE,SAAS,EAAE;IACnB,EAAE,IAAI,EAAE,MAAM,EAAE;IAChB,EAAE,IAAI,EAAE,MAAM,EAAE;IAChB,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE;IAChC,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,UAAU,EAAE;CACxC,CAAC;AAEF,MAAM,WAAW,GAAoB;IACjC,EAAE,IAAI,EAAE,UAAU,EAAE;IACpB,EAAE,IAAI,EAAE,MAAM,EAAE;IAChB,EAAE,IAAI,EAAE,aAAa,EAAE;IACvB,EAAE,IAAI,EAAE,MAAM,EAAE;IAChB,EAAE,IAAI,EAAE,MAAM,EAAE;IAChB,EAAE,IAAI,EAAE,KAAK,EAAE;IACf,EAAE,IAAI,EAAE,QAAQ,EAAE;IAClB,EAAE,IAAI,EAAE,QAAQ,EAAE;IAClB,EAAE,IAAI,EAAE,SAAS,EAAE;IACnB,EAAE,IAAI,EAAE,MAAM,EAAE;IAChB,EAAE,IAAI,EAAE,MAAM,EAAE;IAChB,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE;IAClC,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE;IAChC,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE;IAChC,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,UAAU,EAAE;CACxC,CAAC;AAEF,MAAM,SAAS,GAAoB;IAC/B,EAAE,IAAI,EAAE,UAAU,EAAE;IACpB,EAAE,IAAI,EAAE,MAAM,EAAE;IAChB,EAAE,IAAI,EAAE,aAAa,EAAE;IACvB,EAAE,IAAI,EAAE,MAAM,EAAE;IAChB,EAAE,IAAI,EAAE,MAAM,EAAE;IAChB,EAAE,IAAI,EAAE,KAAK,EAAE;IACf,EAAE,IAAI,EAAE,QAAQ,EAAE;IAClB,EAAE,IAAI,EAAE,QAAQ,EAAE;IAClB,EAAE,IAAI,EAAE,SAAS,EAAE;IACnB,EAAE,IAAI,EAAE,MAAM,EAAE;IAChB,EAAE,IAAI,EAAE,MAAM,EAAE;IAChB,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE;IAChC,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,UAAU,EAAE;CACxC,CAAC;AAEF,SAAwB,aAAa,CAAC,IAAkB,EAAE,cAAsB;IAC5E,IAAI,cAAc,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;QAChD,IAAI,IAAA,oBAAU,EAAC,cAAc,CAAC,EAAE,CAAC;YAC7B,cAAc,GAAG,IAAA,sBAAY,EAAC,cAAc,CAAC,CAAC,QAAQ,EAAE,CAAC;QAC7D,CAAC;IACL,CAAC;IACD,IAAI,WAAwC,CAAC;IAE7C,IAAI,IAAI,KAAK,OAAO,EAAE,CAAC;QACnB,WAAW,GAAG,KAAK,CAAC;IACxB,CAAC;SAAM,IAAI,IAAI,KAAK,WAAW,EAAE,CAAC;QAC9B,WAAW,GAAG,SAAS,CAAC;IAC5B,CAAC;SAAM,IAAI,IAAI,KAAK,aAAa,EAAE,CAAC;QAChC,WAAW,GAAG,WAAW,CAAC;IAC9B,CAAC;SAAM,IAAI,IAAI,KAAK,WAAW,EAAE,CAAC;QAC9B,WAAW,GAAG,SAAS,CAAC;IAC5B,CAAC;IAED,IAAI,CAAC,WAAW,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;IAC7C,CAAC;IAED,MAAM,IAAI,GAA2B,IAAA,mBAAQ,EACzC,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,GAAG,cAAc,IAAI,CACzE,CAAC;IACF,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC;IAC5B,IAAI,MAAM,EAAE,CAAC;QACT,KAAK,MAAM,KAAK,IAAI,WAAW,EAAE,CAAC;YAC9B,IAAI,WAAW,CAAC,KAAK,CAAC,CAAC,IAAI,KAAK,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC5C,MAAM,IAAI,KAAK,CAAC,oBAAoB,KAAK,QAAQ,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YACtE,CAAC;QACL,CAAC;IACL,CAAC;IAED,OAAO,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE;QACzB,MAAM,IAAI,GAAa,EAAc,CAAC;QACtC,KAAK,MAAM,KAAK,IAAI,WAAW,EAAE,CAAC;YAC9B,IAAI,WAAW,CAAC,KAAK,CAAC,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;gBACzC,UAAU,CAAC,KAAK,CAAC,GAAG,UAAU,CAAC,KAAK,CAAC,KAAK,MAAM,CAAC;YACrD,CAAC;YACA,IAA6D,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;QAChH,CAAC;QACD,OAAO,IAAI,CAAC;IAChB,CAAC,CAAC,CAAC;AACP,CAAC"}

package/build/index.d.ts

@@ -0,0 +1,88 @@
+import { Adapter } from '@iobroker/adapter-core';
+import type { DeviceMasterOption, DeviceSlaveOption, ModbusAdapterConfig, ModbusParameters, Options, Register, RegisterInternal, RegisterType } from './types';
+import type { PortInfo } from '@serialport/bindings-interface';
+import tsv2registers from './convert';
+import { Master } from './lib/Master';
+import Slave from './lib/Slave';
+export { tsv2registers };
+export default class ModbusAdapter extends Adapter {
+    config: ModbusAdapterConfig;
+    private infoRegExp;
+    static readonly _rmap: {
+        [bit: number]: number;
+    };
+    static readonly _dmap: {
+        [bit: number]: number;
+    };
+    private objects;
+    private enumObjs;
+    static readonly typeItemsLen: {
+        [type: string]: number;
+    };
+    modbus: Master | Slave | null;
+    constructor(adapterName: string, params: ModbusParameters, registers: {
+        disInputs?: Register[];
+        coils?: Register[];
+        inputRegs?: Register[];
+        holdingRegs?: Register[];
+    });
+    processMessage(obj: ioBroker.Message): void;
+    stopAdapter(callback?: () => void): void;
+    static filterSerialPorts(path: string): boolean;
+    listSerial(ports: PortInfo[]): {
+        path: string;
+    }[] | undefined;
+    addToEnum(enumName: string, id: string): Promise<void>;
+    removeFromEnum(enumName: string, id: string): Promise<void>;
+    syncEnums(enumGroup: 'rooms', id: string, newEnumName: string): Promise<void>;
+    static address2alias(id: RegisterType, address: number | string, isDirect: boolean, offset: number): number;
+    createExtendObject(id: string, objData: ioBroker.StateObject | ioBroker.ChannelObject): Promise<void>;
+    processTasks(tasks: ({
+        name: 'add';
+        id: string;
+        obj: ioBroker.StateObject | ioBroker.ChannelObject;
+    } | {
+        name: 'del';
+        id: string;
+    } | {
+        name: 'syncEnums';
+        id: string;
+        newName: string;
+    })[]): Promise<void>;
+    prepareConfig(): Promise<Options>;
+    checkDeviceIds(options: Options, config: Register[], deviceIds: number[]): void;
+    checkObjects(regType: RegisterType, regName: string, regFullName: string, tasks: ({
+        name: 'add';
+        id: string;
+        obj: ioBroker.StateObject | ioBroker.ChannelObject;
+    } | {
+        name: 'del';
+        id: string;
+    } | {
+        name: 'syncEnums';
+        id: string;
+        newName: string;
+    })[], newObjects: string[], deviceId: number): void;
+    assignIds(deviceId: number, config: RegisterInternal[], result: DeviceSlaveOption | DeviceMasterOption, regName: string, regType: RegisterType, localOptions: {
+        multiDeviceId?: boolean;
+        showAliases: boolean;
+        doNotRoundAddressToWord: boolean;
+        directAddresses: boolean;
+        maxBlock?: number;
+        maxBoolBlock?: number;
+        doNotIncludeAdrInId: boolean;
+        preserveDotsInId: boolean;
+    }): void;
+    iterateAddresses(isBools: boolean, deviceId: number, result: DeviceSlaveOption | DeviceMasterOption, regName: string, regType: RegisterType, localOptions: {
+        multiDeviceId?: boolean;
+        showAliases: boolean;
+        doNotRoundAddressToWord: boolean;
+        directAddresses: boolean;
+        maxBlock?: number;
+        maxBoolBlock?: number;
+        doNotIncludeAdrInId: boolean;
+        preserveDotsInId: boolean;
+    }): void;
+    parseConfig(): Promise<Options>;
+    main(): Promise<void>;
+}