node-red-contrib-modbus

node-red-contrib-modbus

The all-in-one Modbus TCP and Serial contribution package for Node-RED

International IIoT Website for Node-RED

For an international area, Iniationware has provided the PLUS for Node-RED International website.

IIoT Webseite Deutschland für Node-RED

Für einen deutschsprachigen Bereich hat Iniationware die Webseite PLUS for Node-RED Germany bereitgestellt.

Contribution Information

Node-RED contribution package for Modbus version overview:

Based on modbus-serial with TCP, C701, Telnet, Serial, RTU buffered, and ASCII

• stress tested with Node-RED v1.0.4 and Node.js LTS
• works with queueing per unit and round robin scheduling

Node-RED v3.x versions:

• Node.JS 18.x will be supported with v5.22+
• Node.JS 16.x will be supported with v5.22+

Node-RED v2.x versions:

• Node.JS 18.x will be supported with v5.22+
• Node.JS 16.x will be supported with v5.20+
• Node.JS 14.x is supported with v5.14+
• Node.JS 12.x is supported with v5.x

Node-RED v1.x versions:

• Node.JS 14.x is supported with v5.14.+
• Node.JS 12.x is supported with v5.x
• Node.JS 10.x is supported with v5.x

Node-RED v0.x versions:

• Node.JS 10.x is supported with v4.x
• Node.JS 8.x is supported with v3.x
• Node.JS 6.x is supported with v2.x
• Node.JS 4.x is supported with v1.x

If you like that contributor's package for Modbus, then please give us your star at GitHub !

Install

Run the following command in the root directory of your Node-RED install

npm install node-red-contrib-modbus

Run the following command for global install

npm install -g node-red-contrib-modbus

try these options on npm install to build, if you have problems to install

--unsafe-perm --build-from-source

modbus-serial, serialport and jsmodbus

The serialport optional dependency is just to list all ports on your system in the client configuration. It is not the serialport version to work with Modbus at runtime. For that check the modbus-serial or jsmodbus package.json, please! The modbus-serial supports and works for TCP connections in that package, too. The jsmodbus package is just to provide a simple Modbus Server node. All Modbus commands running on modbus-serial.

TCP or Serial testing

If you get in trouble with TCP connections, then check and test with just modbus-serial first, please!

If you get in trouble with Serial connections, then check with just serialport first, please!

Update/Upgrade/Downgrade

To update the dependencies or the whole package, you have just to install again.

npm show node-red-contrib-modbus@* version

To get a special version please set the version with @M.M.F:

npm install node-red-contrib-modbus@3.6.1

or global by

npm install -g node-red-contrib-modbus@3.6.1

How to use

• see Wiki pages
• use the Flow example to see how it works ...
• see YouTube Playlist

Errors

Since v5.22+ the package will catch network and other errors of the client and server node. That means, you have to handle the error status of the node and Node-RED should not crash in the handled cases.

Debug

Debug will be activated by starting Node-RED with debug mode:

DEBUG=contribModbus*,modbus-serial node-red -v

or

DEBUG=contribModbus:{option},contribModbus:{option},...

see Wiki pages to get more options in detail

Contributing

Let's work together! Contributors are welcome. Please, fork the repo and send your pull requests from your repo to our develop branch or open issues while you're testing!

For Developers

See the scripts of the package and the additional Shell scripts to clean, update, or upgrade this NPM package.

• dev-link (local testing with Node-RED)
• testing (unit, integration)
• coverage
• docs generation
• standard-version alpha, beta, release
• git-flow

For Testers

Report issues, share your experiences, record tutorials, write Wiki articles and Blogs to share more about this package, please!

Authors

since April 2016 by Klaus Landsdorf and Community Driven

History

• contribution since 2016 by Contributors
• license changed in 2016 by Jason D. Harper
• started in early 2015 by Mika Karaila

Contributors

Code Contributors

This project exists thanks to all the people who contribute. [Contribute].

Financial Contributors

Become a financial contributor and help us sustain our community. [Contribute]

Individuals

Organizations

Support this project with your organization. Your logo will show up here with a link to your website. [Contribute]

Changelog

5.27.2 (2023-08-29)

Bug Fixes

• added missing verbose warn (4082952)
• adjusted failing tests to tcp ports (5db0e99)
• deps: can now successfully install deps (f8e0a64)
• deps: updated scope names for requires (9c643f6)
• fixed failing tests using same ports (06080d4)
• flex-getter: corrected isReadyForInput (806ee4c)
• flex-getter: fixed failing tests (1ab96b3)
• flex-getter: revise DelayOnStart (c9d246a)
• flex-server: changed var to const (d638d53)
• flex-write: deleted unused flow (2f0baee)
• flexFC: fixed routes for codes map (e2e2cc5)
• flexGetter-verboseWarn: node.serverInfo is left from client - removed (94c58db)
• isReadyForInput: now checks ONLY for readyforinput. Rest in onInput (99f60a8)
• Node-RED PLUS changed to PLUS for Node-RED (f726949)
• not-ready-for-input-warning: removed unnecessary variable/option (d435b9b)
• npmrc: added npmrc file to packed files (40ebf4d)
• require: now requires correct fork of lib (2f936f8)
• server: #333 Cannot read property 'disableMsgOutput' of undefined (5c28e02)
• server: #333 new check of msg object (4631795)
• test: same port on test (b6f531f)
• verboseWarn: verboseWarn accidentally used func left from client (c0d88cd)
• web: get routes for FlowForge (21102c6)

Features

• add custom function code client functionality (505329f)
• add flex-fc node (2766989)
• add modbus-flex-fc to package.json (2bbea1e)
• add path for customModbusMessage event (8a56fed)
• add reset template button for request map (859c563)
• add tests (94a3870)
• added "inactive"-test (03c744a)
• added isActive function (6005960)
• added isInactive check on input (92f49da)
• added more point to Todo (84f39ad)
• added more Todo notes (30c5e80)
• added planned updates for release (765a549)
• added test coverage to Todo (6148dd5)
• added test-helper-extension (c4b493d)
• added tests for Client check (55c235e)
• added Todo content (94d46e8)
• added Todo content, excecuted clean.sh (8f1977c)
• adjusted TODO and package.json (c481b6f)
• clex-connector-test: organized code (92c9e37)
• client-flows: extracted and updated flows (7c40530)
• client-test: added "ready to send"-tests (368e6cd)
• client-tests: organized code (830b0ce)
• client: more options and tabs for the client node (1048021)
• delay-flex-getter: added delay after start (f68d666)
• flex fc debug test (2785c7e)
• flex-connector-flows: extracted and updated flows (6f4330c)
• flex-connector: added "ready to send" tests (11d5b1e)
• flex-getter-flows: extracted and updated flows (db2471b)
• flex-getter-test: organized code (981a15e)
• flex-getter: added html information for node (c74dc2d)
• flex-getter: finished implementing delay + (9656e8f)
• flex-getter: finished implementing delay + warnings (9782a0d)
• flex-getter: further implementing "delayOnStart" (7666d95)
• flex-getter: implemented readyForInput (70bff72)
• flex-getter: started implementing "showWarnings" + "DelayOnStart" (d9db52a)
• flex-getter: startted implementing showReadyForInput (55b107c)
• flex-sequencer-test: changed var to const (ffbf9ff)
• flex-sequencer: added "Ready-To-Read" tests (43e34d6)
• flex-sequencer: extracted and updated flows (b8c12b9)
• flex-sequencer: input delay on start (758a3a5)
• flex-server: extracted and updated flows (64d69ea)
• flex-write: added "ready to send"-tests (9d35d13)
• flex-write: delay on input and check client is active (e1bce6c)
• flex-write: extracted and updated flows (38e4b18)
• getter-flows: updated flows to be organized (5c6239a)
• getter: input delay on start (b7acd97)
• getter: organized Code (19da2dc)
• io-config: extracted and updated flows (e037a59)
• optimized and extracted server flows (7456528)
• option show warning and tabs for optionals (12fa45e)
• queue-info: extracted and updated flows (1b668fa)
• ran clean script, updated Todo (f6f142f)
• read-flows: updated flows to be organized (ccfece8)
• ReadyToSend: added test to test-classes (ee1f924)
• response-filter: added Client check test (9db71b6)
• response-filter: extracted and updated flows (93e10f8)
• response-filter: prepared flow-extraction (39092de)
• response: extracted and updated flows (6930e37)
• simplified code with new function (15c06e2)
• ui issues fixed and rudimentary working (5fb77f8)
• working flex fc node (b75f826)
• write-flows: updated flows to be organized (b32cd54)
• write: input delay on start (7d3567e)
• wrote test for messageAllowedStates (e2c92ec)