nodbus-plus 1.0.0 → 1.0.1

package/.readthedocs.yaml

@@ -1,35 +1,35 @@
-# .readthedocs.yaml
-# Read the Docs configuration file
-# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
-
-# Required
-version: 2
-
-# Set the OS, Python version and other tools you might need
-build:
-  os: ubuntu-22.04
-  tools:
-    python: "3.11"
-    # You can also specify other tool versions:
-    # nodejs: "19"
-    # rust: "1.64"
-    # golang: "1.19"
-
-# Build documentation in the "docs/" directory with Sphinx
-sphinx:
-   configuration: docs/conf.py
-
-# Optionally build your docs in additional formats such as PDF and ePub
-# formats:
-#    - pdf
-#    - epub
-
-# Optional but recommended, declare the Python requirements required
-# to build your documentation
-# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
-
-# Optionally declare the Python requirements required to build your docs
-python:
-   install:
-   - requirements: docs/requirements.txt
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+    # You can also specify other tool versions:
+    # nodejs: "19"
+    # rust: "1.64"
+    # golang: "1.19"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+   configuration: docs/conf.py
+
+# Optionally build your docs in additional formats such as PDF and ePub
+# formats:
+#    - pdf
+#    - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+
+# Optionally declare the Python requirements required to build your docs
+python:
+   install:
+   - requirements: docs/requirements.txt
      

package/LICENSE.md

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2017 Héctor Enrique Socarrás Cabrera
-
-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.
+MIT License
+
+Copyright (c) 2017 Héctor Enrique Socarrás Cabrera
+
+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

@@ -1,163 +1,167 @@
-# Nodbus-Plus
-
-A Modbus protocol library for Node.js, written entirely in JavaScript. It supports both Modbus Serial and Modbus TCP.
-
-## Introduction
-
-Nodbus Plus has been designed as a stack for the Modbus protocol. It can be used to create both your own Modbus client and server using its API, or you can use its build in client or server and have an application with Modbus communication in just minutes.
-
-## Installation
-
-```console
-$ npm install nodbus-plus
-``` 
-
-## Basic Usage:
-
-### Create a modbus server.
-
-```javascript
-const nodbus = require('nodbus-plus');
-
-//Basic config for tcp server. Default values.
-const cfg = {
-    inputs : 2048, //total inputs
-    coils : 2048,  //total coils
-    holdingRegisters : 2048, //total holding register
-    inputRegisters : 2048,  //total input register
-    port : 502,    //port to listen to
-}
-
-let server = nodbus.createTcpServer('tcp', cfg);
-```
-The first argument for createTcpServer function is the type of transport layer used. The nodbus-plus tcp server suport 'tcp', 'udp4' and 'udp6'. To create a 
-serial server the procedure is the same, but calling createSerialServer function instead.
-
-```javascript
-//Basic config for tcp server. Default values.
-let cfg = {
-    address : 1,
-    transmitionMode: 0, //0-rtu, 1 - ascii
-    inputs : 2048,
-    coils : 2048,
-    holdingRegisters : 2048,
-    inputRegisters : 2048,  
-    port : 502,    
-}
-
-let server = nodbus.createSerialServer('tcp', cfg);
-```
-The createSerialServer function can take the value 'serial' as fist argument as well, however the property port mus be a string
-with the path to a serial port and adicional port configuration property may be needed. See nodbus-plus api for more details.
-
-Add listeners for srever's events
-
-```javascript
-//listenning event
-server.on('listening', function(port){
-    console.log('Server listening on: ' + port);        
-});
-
-//event emited when a request are received
-server.on('request', function(sock, req){
-    console.log('Request received')
-    console.log(req)
-});
-
-//Event emited when server send a response to client
-server.on('response', function(sock, res){
-    console.log('Responding')
-    console.log(res)
-});
-
-server.on('error', function(err){
-    console.log(err)
-});
-```
-Finally the server must be started.
-
-```javascript
-server.start();
-```
-### Create a modbus client.
-
-To create a modbus client use the functions createTcpClient or createSerialClient.
-
-```javascript
-const nodbus = require('nodbus-plus');
-let client = nodbus.createSerialClient();
-
-//emitted when the client stablish connection with the server
-client.on('connection', (id)=>{
-    console.log('connection stablish')    
-})
-
-//emited when error occurs
-client.on('error', (e)=>{    
-    console.log(e)    
-})
-
-//emitted when a request is sended to server
-client.on('request', (id, req)=>{
-    console.log('request sended to device: ' + id);        
-})
-
-//emited when no response is received
-client.on('req-timeout', (id, adu)=>{
-    console.log('timeout')        
-})
-
-//emited when a response is received
-client.on('response', (id, res)=>{
-    console.log(res)        
-})
-```
-
-Then channels must be add to the client. The client will create a connection per channel. The following example add a modbus serial over tcp server, and conect to it.
-
-```javascript
-
-//channel
-channelCfg = {        
-    ip:'127.0.0.1',
-    port:502,
-    timeout:250,
-}
-
-client.addChannel('device', 'tcp1', channelCfg);
-client.connect('device')
-
-```
-
-Once the client is connected, and event listener configured, data can be exchange using availables modbus function.
-
-```javascript
-
-//reading from cannel 'device', modbus address 1, two coils from 0 coil's address
-    client.readCoils('device', 1, 0, 2);
-
-```
-
-### Official Documentation
-
-For comprehensive information on how to use NodbusPlus, refer to the [official documentation](https://nodbus-plus.readthedocs.io/en/latest/).
-
-### Getting Started
-
-If you're new to NodbusPlus, the [Getting Started Guide](https://nodbus-plus.readthedocs.io/en/latest/starting.html) is a great place to begin.
-It will walk you through the installation process and provide a basic usage example.
-
-
-### Examples
-
-Inside the root folder of Nodbus plus, there is a directory './samples' that contains three example programs that make use of the library.
-
-
-## Contributing
-
-If you have a suggestion or found a issue, let us known and [create an issue](https://github.com/hsocarras/nodbus-plus/issues)
-
-
-## License
-
-This project is licensed under the MIT License - see the LICENSE.md file for details
+# Nodbus-Plus
+
+A Modbus protocol library for Node.js, written entirely in JavaScript. It supports both Modbus Serial and Modbus TCP.
+
+## Introduction
+
+Nodbus-Plus is a Modbus protocol stack for Node.js. You can use its API to create your own Modbus client and server, or use its built-in client and server for quick Modbus communication in just minutes.
+
+## Installation
+
+```console
+npm install nodbus-plus
+```
+
+## Quick Start
+
+### Creating a Modbus Server
+
+```javascript
+const nodbus = require('nodbus-plus');
+
+// TCP server configuration (uses default values if not specified)
+const cfg = {
+    inputs: 2048,            // Number of discrete inputs
+    coils: 2048,             // Number of coils
+    holdingRegisters: 2048,  // Number of holding registers
+    inputRegisters: 2048,    // Number of input registers
+    port: 502                // Port on which to listen
+};
+
+let server = nodbus.createTcpServer('tcp', cfg);
+```
+
+The first argument specifies the transport layer type. Supported options are `'tcp'`, `'udp4'`, and `'udp6'`.  
+To create a serial server instead, use `createSerialServer`:
+
+
+```javascript
+// Serial server configuration
+const cfg = {
+    address: 1,                    // Modbus slave address (1–247)
+    transmissionMode: 0,           // 0 = RTU, 1 = ASCII
+    inputs: 2048,                  // Number of discrete inputs
+    coils: 2048,                   // Number of coils
+    holdingRegisters: 2048,        // Number of holding registers
+    inputRegisters: 2048,          // Number of input registers
+    port: 'COM1'                   // Serial port path (e.g., 'COM1' on Windows, '/dev/ttyUSB0' on Linux)
+};
+
+let server = nodbus.createSerialServer('serial', cfg);
+```
+#### Listen for Server Events
+
+```javascript
+// Emitted when server starts listening
+server.on('listening', (port) => {
+    console.log('Server listening on port:', port);
+});
+
+// Emitted when a request is received from a client
+server.on('request', (socket, req) => {
+    console.log('Request received:', req);
+});
+
+// Emitted before sending a response to client
+server.on('response', (socket, res) => {
+    console.log('Response:', res);
+});
+
+// Emitted when an error occurs
+server.on('error', (err) => {
+    console.error('Error:', err);
+});
+```
+
+Finally, start the server:
+
+```javascript
+server.start();
+```
+
+### Creating a Modbus Client
+
+To create a Modbus client, use `createTcpClient` or `createSerialClient`:
+
+```javascript
+const nodbus = require('nodbus-plus');
+
+let client = nodbus.createSerialClient();
+
+// Emitted when client establishes connection with the server
+client.on('connection', (id) => {
+    console.log('Connection established:', id);
+});
+
+// Emitted when an error occurs
+client.on('error', (err) => {
+    console.error('Error:', err);
+});
+
+// Emitted when a request is sent to server
+client.on('request', (id, req) => {
+    console.log('Request sent to device:', id);
+});
+
+// Emitted when a response timeout occurs
+client.on('req-timeout', (id, adu) => {
+    console.error('Request timeout for device:', id);
+});
+
+// Emitted when a response is received
+client.on('response', (id, res) => {
+    console.log('Response from device:', id, res);
+});
+```
+
+Add channels to the client. Each channel represents a connection to a Modbus device:
+
+```javascript
+// Channel configuration
+const channelCfg = {
+    ip: '127.0.0.1',      // Target device IP address
+    port: 502,            // Target device port
+    timeout: 250          // Request timeout in milliseconds
+};
+
+client.addChannel('device1', 'tcp1', channelCfg);
+client.connect('device1');
+```
+
+Once connected, use available Modbus functions to exchange data:
+
+```javascript
+// Read 2 coils starting at address 0 from device at Modbus address 1
+client.readCoils('device1', 1, 0, 2);
+```
+
+## Documentation
+
+For comprehensive API documentation, visit the [official documentation](https://nodbus-plus.readthedocs.io/en/latest/).
+
+## Getting Started
+
+New to Nodbus-Plus? The [Getting Started Guide](https://nodbus-plus.readthedocs.io/en/latest/starting.html) provides installation instructions and basic usage examples.
+
+## Examples
+
+See the `./samples` directory for example programs demonstrating library usage.
+
+
+
+## Features
+
+- **Full Modbus Protocol Support**: Read/write coils, discrete inputs, holding registers, and input registers.
+- **Modbus Serial (RTU/ASCII)**: Serial communication with RTU and ASCII transmission modes.
+- **Modbus TCP**: TCP/IP network communication with standard Modbus TCP protocol.
+- **Pure JavaScript**: No native dependencies; works on any Node.js environment.
+- **Client & Server**: Create both Modbus clients and servers with the same library.
+- **Event-Driven**: Asynchronous event-based API for responsive applications.
+
+## Contributing
+
+Contributions are welcome! If you find a bug or have a feature suggestion, please [open an issue](https://github.com/hsocarras/nodbus-plus/issues).
+
+## License
+
+MIT License. See `LICENSE.md` for details.

package/docs/Makefile

@@ -1,20 +1,20 @@
-# Minimal makefile for Sphinx documentation
-#
-
-# You can set these variables from the command line, and also
-# from the environment for the first two.
-SPHINXOPTS    ?=
-SPHINXBUILD   ?= sphinx-build
-SOURCEDIR     = source
-BUILDDIR      = build
-
-# Put it first so that "make" without argument is like "make help".
-help:
-	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
-
-.PHONY: help Makefile
-
-# Catch-all target: route all unknown targets to Sphinx using the new
-# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
-%: Makefile
-	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)