node-red-contrib-tcp-client-server-avd 1.1.0 → 1.2.0

package/README.md

@@ -1,16 +1,22 @@
 # Node-RED TCP Client/Server Node (AVD)
 
+**Nederlands** | [English](#english)
+
 Een flexibele Node-RED node die functioneert als TCP client en/of TCP server, met uitgebreide configuratiemogelijkheden en foutafhandeling.
 
-## Installatie
+---
+
+## Nederlands
+
+### Installatie
 
-### Via npm (aanbevolen)
+#### Via npm (aanbevolen)
 
 ```bash
 npm install node-red-contrib-tcp-client-server-avd
 ```
 
-### Handmatige installatie
+#### Handmatige installatie
 
 1. Clone of download dit project
 2. Kopieer de map naar je Node-RED `nodes` directory (meestal `~/.node-red/nodes/`)
@@ -21,9 +27,9 @@ npm install
 ```
 4. Herstart Node-RED
 
-## Functionaliteiten
+### Functionaliteiten
 
-### TCP Client Mode
+#### TCP Client Mode
 - Automatisch verbinden bij flow start (optioneel)
 - Handmatig verbinden/verbreken via messages
 - Robuuste automatische herconnectie (detectie via error, close en write-fouten)
@@ -32,7 +38,7 @@ npm install
 - Message delimiter ondersteuning voor message framing
 - Keep-alive optie (aanbevolen voor detectie van half-open verbindingen)
 
-### TCP Server Mode
+#### TCP Server Mode
 - Automatisch starten bij flow start (optioneel)
 - Luisteren op geconfigureerde poort
 - Meerdere gelijktijdige client verbindingen
@@ -40,20 +46,20 @@ npm install
 - Broadcast naar alle clients of verzenden naar specifieke client
 - Zelfde dataformaat ondersteuning als client mode
 
-### Gecombineerde Mode
+#### Gecombineerde Mode
 - Gebruik zowel client als server functionaliteit in één node
 - Onafhankelijke configuratie voor beide modi
 
-## Gebruik
+### Gebruik
 
-### Basis Configuratie
+#### Basis Configuratie
 
 1. Sleep de node naar je flow
 2. Dubbelklik op de node om te configureren
 3. Selecteer de gewenste mode: TCP Client, TCP Server, of TCP Client & Server
 4. Configureer de instellingen volgens je behoeften
 
-### Client Mode - Verbinden
+#### Client Mode - Verbinden
 
 **Automatisch verbinden:**
 - Zet "Auto Verbinden" aan
@@ -66,7 +72,7 @@ npm install
 **Verbinden verbreken:**
 - Stuur een message met `topic: "disconnect"` naar de node
 
-### Server Mode - Server Beheer
+#### Server Mode - Server Beheer
 
 **Automatisch starten:**
 - Zet "Auto Start" aan
@@ -79,299 +85,247 @@ npm install
 **Server stoppen:**
 - Stuur een message met `topic: "stop"` naar de node
 
-## Message Formats
+### Message Formats
 
-### Input Messages (naar Node)
+#### Input Messages (naar Node)
 
-#### Client Mode
+**Client Mode:**
 
-**Verbinden:**
-```javascript
-{ topic: "connect" }
-```
+| Actie | Message |
+|-------|---------|
+| Verbinden | `{ topic: "connect" }` |
+| Verbreken | `{ topic: "disconnect" }` |
+| Data verzenden | `{ topic: "send", payload: "data" }` |
 
-**Verbreken:**
-```javascript
-{ topic: "disconnect" }
-```
+Als er geen topic is opgegeven, wordt de payload automatisch verzonden.
 
-**Data verzenden:**
-```javascript
-{
-  topic: "send",
-  payload: "data om te verzenden" // string, buffer, of object
-}
-```
+**Server Mode:**
 
-Als er geen topic is opgegeven, wordt de payload automatisch verzonden.
+| Actie | Message |
+|-------|---------|
+| Server starten | `{ topic: "start" }` |
+| Server stoppen | `{ topic: "stop" }` |
+| Naar client | `{ topic: "send", clientId: "id", payload: "data" }` |
+| Broadcast | `{ topic: "broadcast", payload: "data" }` |
 
-#### Server Mode
+#### Output Messages (van Node)
 
-**Server starten:**
-```javascript
-{ topic: "start" }
-```
+**Client:** `topic: "status"` (connected/disconnected/error), `topic: "data"` (ontvangen data)
 
-**Server stoppen:**
-```javascript
-{ topic: "stop" }
-```
+**Server:** `topic: "status"`, `topic: "client/connected"`, `topic: "client/disconnected"`, `topic: "data"` (met `clientId`)
 
-**Data verzenden naar specifieke client:**
-```javascript
-{
-  topic: "send",
-  clientId: "client-unique-id",
-  payload: "data om te verzenden"
-}
-```
+### ClientId bepalen (Server Mode)
 
-**Data verzenden naar alle clients (broadcast):**
-```javascript
-{
-  topic: "broadcast",
-  payload: "data om te verzenden"
-}
-```
+De `clientId` is beschikbaar in `client/connected` en `data` messages. Gebruik `clientId: msg.clientId` in je send message.
 
-### Output Messages (van Node)
+### Configuratie Opties
 
-#### Client Mode
+**Client:** Host, Port (8080), IP Versie, Auto Verbinden, Herconnectie, Reconnect Interval (2 sec), Connection Timeout (10 sec), Input/Output Format, Encoding, Message Delimiter, Keep-Alive
 
-**Verbindingsstatus:**
-```javascript
-{
-  topic: "status",
-  payload: "connected" | "disconnected" | "error",
-  status: "connected" | "disconnected" | "error",
-  error: "error message (indien van toepassing)"
-}
-```
+**Server:** Listen Port (8080), Bind Address (0.0.0.0), Auto Start, Max Connections, Connection Timeout (600 sec), Input/Output Format, Encoding, Message Delimiter, Keep-Alive
 
-**Ontvangen data:**
-```javascript
-{
-  topic: "data",
-  payload: "ontvangen data",
-  timestamp: "ISO timestamp"
-}
-```
+### Status Weergave
 
-#### Server Mode
+**Client:** Groen (verbonden), Rood (fout), Grijs (niet verbonden), Geel (verbinden)
 
-**Server status:**
-```javascript
-{
-  topic: "status",
-  payload: "listening" | "stopped" | "error",
-  port: 1234,
-  error: "error message (indien van toepassing)"
-}
-```
+**Server:** Groen (luisterend), Rood (gestopt/fout), Blauw (actief met X clients)
 
-**Client verbinding:**
-```javascript
-{
-  topic: "client/connected",
-  clientId: "unique-client-id",
-  remoteAddress: "client-ip",
-  remotePort: "client-port"
-}
-```
+### Voorbeeld Flows
+
+Importeer via **Menu (≡) → Import → Examples**:
+- **Basis TCP Client** – Client verbindt met localhost:8080
+- **Basis TCP Server** – Server luistert op 8080
+- **Client-Server Echo** – Server stuurt echo terug naar client
+
+### Troubleshooting
+
+- **Client kan niet verbinden:** Controleer server, firewall, host/port
+- **Server kan niet starten:** Controleer poort beschikbaarheid, firewall, rechten
+- **Data onjuist:** Controleer Output Format, Encoding, Delimiter
+
+### Bekende Beperkingen
+
+- TLS/SSL nog niet ondersteund
+- Alleen TCP (geen UDP)
+- Geen rate limiting
 
-**Client verbreking:**
-```javascript
-{
-  topic: "client/disconnected",
-  clientId: "unique-client-id"
-}
+---
+
+## English
+
+**Nederlands** | [English](#english)
+
+A flexible Node-RED node that acts as a TCP client and/or TCP server, with extensive configuration options and error handling.
+
+### Installation
+
+#### Via npm (recommended)
+
+```bash
+npm install node-red-contrib-tcp-client-server-avd
 ```
 
-**Ontvangen data:**
-```javascript
-{
-  topic: "data",
-  payload: "ontvangen data",
-  clientId: "unique-client-id",
-  remoteAddress: "client-ip",
-  remotePort: "client-port",
-  timestamp: "ISO timestamp"
-}
+#### Manual installation
+
+1. Clone or download this project
+2. Copy the folder to your Node-RED `nodes` directory (usually `~/.node-red/nodes/`)
+3. Install dependencies:
+```bash
+cd ~/.node-red/nodes/node-red-contrib-tcp-client-server-avd
+npm install
 ```
+4. Restart Node-RED
 
-### ClientId bepalen (Server Mode)
+### Features
 
-Om naar een specifieke client te sturen heb je de `clientId` nodig. Deze is beschikbaar in:
+#### TCP Client Mode
+- Auto connect on flow start (optional)
+- Manual connect/disconnect via messages
+- Robust automatic reconnection (detection via error, close and write failures)
+- Fast reconnection (default 2 sec, minimum 1 sec)
+- Support for various data formats (String, Buffer, JSON, Hex)
+- Message delimiter support for message framing
+- Keep-alive option (recommended for detecting half-open connections)
 
-1. **`client/connected`** – bij elke nieuwe clientverbinding
-2. **`data`** – bij elk ontvangen bericht (via `msg.clientId`)
+#### TCP Server Mode
+- Auto start on flow start (optional)
+- Listen on configured port
+- Multiple simultaneous client connections
+- Unique client identification
+- Broadcast to all clients or send to specific client
+- Same data format support as client mode
 
-Bewaar de `clientId` uit een van deze messages en gebruik deze in je `send` message met `clientId: msg.clientId`.
+#### Combined Mode
+- Use both client and server functionality in one node
+- Independent configuration for both modes
 
-## Configuratie Opties
+### Usage
 
-### Client Mode
+#### Basic Configuration
 
-- **Host**: Server hostname of IP adres (standaard: "localhost")
-- **Port**: Server poort nummer (standaard: 8080)
-- **IP Versie**: IPv4 of IPv6 (standaard: IPv4)
-- **Auto Verbinden**: Automatisch verbinden bij flow start (standaard: true)
-- **Herconnectie**: Automatische herconnectie bij verbroken verbinding (standaard: true)
-- **Reconnect Interval**: Tijd tussen reconnect pogingen in seconden (standaard: 2, minimum: 1)
-- **Max Reconnect Pogingen**: Maximum aantal reconnect pogingen (0 = oneindig, standaard: 0)
-- **Connection Timeout**: Timeout voor het opzetten van de verbinding in seconden (standaard: 10). Wordt na succesvol verbinden uitgeschakeld; geen idle-timeout.
-- **Input Format**: Data formaat voor verzenden (String, Buffer, JSON, Hex String)
-- **Output Format**: Data formaat voor ontvangen (String, Buffer, JSON, Hex String)
-- **Encoding**: Character encoding voor String format (UTF-8, ASCII, Latin1, Base64)
-- **Message Delimiter**: Optionele delimiter voor message framing (bijv. `\n` of `\r\n`)
-- **Keep-Alive**: TCP keep-alive optie (standaard: false). Aanbevolen voor vroegtijdige detectie van verbroken verbindingen.
+1. Drag the node to your flow
+2. Double-click the node to configure
+3. Select the desired mode: TCP Client, TCP Server, or TCP Client & Server
+4. Configure the settings according to your needs
 
-### Server Mode
+#### Client Mode - Connecting
 
-- **Listen Port**: Poort waarop de server luistert (standaard: 8080)
-- **Bind Address**: IP adres om aan te binden (standaard: "0.0.0.0" = alle interfaces)
-- **IP Versie**: IPv4 of IPv6 (standaard: IPv4)
-- **Auto Start**: Automatisch starten bij flow start (standaard: true)
-- **Max Connections**: Maximum aantal gelijktijdige verbindingen (0 = onbeperkt, standaard: 0)
-- **Connection Timeout**: Timeout voor client verbindingen in seconden (standaard: 600)
-- **Input Format**: Data formaat voor verzenden (String, Buffer, JSON, Hex String)
-- **Output Format**: Data formaat voor ontvangen (String, Buffer, JSON, Hex String)
-- **Encoding**: Character encoding voor String format (UTF-8, ASCII, Latin1, Base64)
-- **Message Delimiter**: Optionele delimiter voor message framing (bijv. `\n` of `\r\n`)
-- **Keep-Alive**: TCP keep-alive optie (standaard: false). Aanbevolen voor vroegtijdige detectie van verbroken verbindingen.
+**Auto connect:**
+- Enable "Auto Verbinden" (Auto Connect)
+- The client connects automatically on flow start
 
-## Status Weergave
+**Manual connect:**
+- Disable "Auto Verbinden"
+- Send a message with `topic: "connect"` to the node
 
-De node toont verschillende status indicatoren:
+**Disconnect:**
+- Send a message with `topic: "disconnect"` to the node
 
-### Client Mode
-- **Groen (verbonden)**: Succesvol verbonden met server
-- **Rood (fout)**: Verbindingsfout of verbreken
-- **Grijs (niet verbonden)**: Niet verbonden
-- **Geel (verbinden)**: Verbinding wordt tot stand gebracht
+#### Server Mode - Server Management
 
-### Server Mode
-- **Groen (luisterend)**: Server luistert actief op poort
-- **Rood (gestopt/fout)**: Server is gestopt of fout opgetreden
-- **Blauw (actief)**: Server actief met X verbindingen
+**Auto start:**
+- Enable "Auto Start"
+- The server starts automatically on flow start
 
-## Voorbeelden
+**Manual start:**
+- Disable "Auto Start"
+- Send a message with `topic: "start"` to the node
 
-### Voorbeeld 1: Basis TCP Client
+**Stop server:**
+- Send a message with `topic: "stop"` to the node
 
-Een eenvoudige TCP client die verbindt met een server en data verzendt/ontvangt.
+### Message Formats
 
-**Flow:**
-```
-[Inject] → [TCP Client Node] → [Debug]
-```
+#### Input Messages (to Node)
 
-**Configuratie:**
-- Mode: TCP Client
-- Host: localhost
-- Port: 8080
-- Auto Verbinden: aan
+**Client Mode:**
 
-### Voorbeeld 2: Basis TCP Server
+| Action | Message |
+|--------|---------|
+| Connect | `{ topic: "connect" }` |
+| Disconnect | `{ topic: "disconnect" }` |
+| Send data | `{ topic: "send", payload: "data" }` |
 
-Een TCP server die luistert op poort 8080 en data ontvangt van clients.
+If no topic is specified, the payload is sent automatically.
 
-**Flow:**
-```
-[TCP Server Node] → [Debug]
-```
+**Server Mode:**
 
-**Configuratie:**
-- Mode: TCP Server
-- Listen Port: 8080
-- Auto Start: aan
+| Action | Message |
+|--------|---------|
+| Start server | `{ topic: "start" }` |
+| Stop server | `{ topic: "stop" }` |
+| To client | `{ topic: "send", clientId: "id", payload: "data" }` |
+| Broadcast | `{ topic: "broadcast", payload: "data" }` |
 
-### Voorbeeld 3: Client met Reconnect
+#### Output Messages (from Node)
 
-Een TCP client met automatische herconnectie.
+**Client:** `topic: "status"` (connected/disconnected/error), `topic: "data"` (received data)
 
-**Configuratie:**
-- Mode: TCP Client
-- Host: 192.168.1.100
-- Port: 8080
-- Auto Verbinden: aan
-- Herconnectie: aan
-- Reconnect Interval: 2 seconden (of 1 voor snellere herverbinding)
-- Max Reconnect Pogingen: 0 (oneindig)
+**Server:** `topic: "status"`, `topic: "client/connected"`, `topic: "client/disconnected"`, `topic: "data"` (with `clientId`)
 
-### Voorbeeld 4: Server met Meerdere Clients
+### Determining ClientId (Server Mode)
 
-Een TCP server die data ontvangt van meerdere clients en responses terugstuurt.
+The `clientId` is available in `client/connected` and `data` messages. Use `clientId: msg.clientId` in your send message.
 
-**Flow:**
-```
-[TCP Server Node] → [Function Node] → [TCP Server Node]
-```
+### Configuration Options
 
-**Function Node code:**
-```javascript
-// Echo de data terug naar dezelfde client (clientId uit ontvangen bericht)
-if (msg.topic === "data") {
-    return {
-        topic: "send",
-        clientId: msg.clientId,
-        payload: "Echo: " + msg.payload
-    };
-}
-return null;
-```
+**Client:** Host, Port (8080), IP Version, Auto Connect, Reconnect, Reconnect Interval (2 sec), Connection Timeout (10 sec), Input/Output Format, Encoding, Message Delimiter, Keep-Alive
+
+**Server:** Listen Port (8080), Bind Address (0.0.0.0), Auto Start, Max Connections, Connection Timeout (600 sec), Input/Output Format, Encoding, Message Delimiter, Keep-Alive
 
-## Troubleshooting
+### Status Display
 
-### Client kan niet verbinden
+**Client:** Green (connected), Red (error), Grey (disconnected), Yellow (connecting)
 
-1. Controleer of de server draait en bereikbaar is
-2. Controleer firewall instellingen
-3. Controleer host en port configuratie
-4. Bekijk de status van de node voor foutmeldingen
+**Server:** Green (listening), Red (stopped/error), Blue (active with X clients)
 
-### Server kan niet starten
+### Example Flows
 
-1. Controleer of de poort niet al in gebruik is
-2. Controleer of je rechten hebt om op de poort te luisteren (voor poorten < 1024 op Linux/Mac)
-3. Controleer firewall instellingen
-4. Bekijk de status van de node voor foutmeldingen
+Import via **Menu (≡) → Import → Examples**:
+- **Basis TCP Client** – Client connects to localhost:8080
+- **Basis TCP Server** – Server listens on 8080
+- **Client-Server Echo** – Server sends echo back to client
 
-### Data wordt niet correct ontvangen
+### Troubleshooting
 
-1. Controleer de Output Format configuratie
-2. Controleer de Encoding instelling
-3. Voor message framing, gebruik de Message Delimiter optie
-4. Voor binary data, gebruik Buffer format
+- **Client cannot connect:** Check server, firewall, host/port
+- **Server cannot start:** Check port availability, firewall, permissions
+- **Incorrect data:** Check Output Format, Encoding, Delimiter
 
-## Bekende Beperkingen
+### Known Limitations
 
-- TLS/SSL ondersteuning is nog niet geïmplementeerd (toekomstige versie)
-- UDP protocol wordt niet ondersteund (alleen TCP)
-- Rate limiting is nog niet beschikbaar
+- TLS/SSL not yet supported
+- TCP only (no UDP)
+- No rate limiting
 
-## Licentie
+---
+
+## License
 
 MIT
 
-## Versie Geschiedenis
+## Version History
+
+### Version 1.2.0
+- Example flows: Basis TCP Client, Basis TCP Server, Client-Server Echo (via Import → Examples)
+- Bilingual README (Nederlands/English)
 
-### Versie 1.1.0
-- Robuuste verbindingscontrole: error handler triggert socket.destroy() voor betrouwbare herverbinding
-- Write-error detectie: bij mislukte verzending wordt herverbinding gestart
-- Snellere herverbinding: standaard 2 sec, minimum 1 sec
-- Geen idle-timeout na verbinden: verbinding blijft open zolang beide partijen verbonden zijn
-- Voorkomen dubbele reconnect en race conditions
+### Version 1.1.0
+- Robust connection control: error handler triggers socket.destroy() for reliable reconnection
+- Write error detection: reconnection starts on failed send
+- Faster reconnection: default 2 sec, minimum 1 sec
+- No idle timeout after connect: connection stays open as long as both parties are connected
+- Prevention of double reconnect and race conditions
 
-### Versie 1.0.0
-- Initiele release
-- TCP Client functionaliteit
-- TCP Server functionaliteit
-- Gecombineerde mode
-- String, Buffer, JSON, en Hex data formaten
-- Automatische herconnectie
-- Message delimiter ondersteuning
+### Version 1.0.0
+- Initial release
+- TCP Client functionality
+- TCP Server functionality
+- Combined mode
+- String, Buffer, JSON, and Hex data formats
+- Automatic reconnection
+- Message delimiter support
 
-## Ondersteuning
+## Support
 
-Voor vragen, problemen of suggesties, open een issue op de GitHub repository.
+For questions, issues or suggestions, open an issue on the GitHub repository.

package/examples/Basis TCP Client.json

@@ -0,0 +1,86 @@
+[
+    {
+        "id": "tab1",
+        "type": "tab",
+        "label": "Basis TCP Client",
+        "disabled": false
+    },
+    {
+        "id": "comment1",
+        "type": "comment",
+        "z": "tab1",
+        "name": "TCP Client die verbindt met localhost:8080. Start eerst de Server flow. De Inject node stuurt 'Hello' naar de server.",
+        "info": "",
+        "x": 350,
+        "y": 40,
+        "wires": []
+    },
+    {
+        "id": "inject1",
+        "type": "inject",
+        "z": "tab1",
+        "name": "Verstuur",
+        "props": [{"p": "payload"}],
+        "repeat": "",
+        "crontab": "",
+        "once": false,
+        "onceDelay": 0.1,
+        "topic": "send",
+        "payload": "Hello",
+        "payloadType": "str",
+        "x": 130,
+        "y": 120,
+        "wires": [["tcp1"]]
+    },
+    {
+        "id": "tcp1",
+        "type": "tcp-client-server-avd",
+        "z": "tab1",
+        "name": "TCP Client",
+        "mode": "client",
+        "clientHost": "localhost",
+        "clientPort": "8080",
+        "clientIpVersion": "4",
+        "clientAutoConnect": true,
+        "clientReconnect": true,
+        "clientReconnectInterval": "2",
+        "clientMaxReconnectAttempts": "0",
+        "clientConnectionTimeout": "10",
+        "clientInputFormat": "string",
+        "clientOutputFormat": "string",
+        "clientEncoding": "utf8",
+        "clientDelimiter": "",
+        "clientKeepAlive": false,
+        "serverPort": "8080",
+        "serverBindAddress": "0.0.0.0",
+        "serverIpVersion": "4",
+        "serverAutoStart": true,
+        "serverMaxConnections": "0",
+        "serverConnectionTimeout": "600",
+        "serverInputFormat": "string",
+        "serverOutputFormat": "string",
+        "serverEncoding": "utf8",
+        "serverDelimiter": "",
+        "serverKeepAlive": false,
+        "x": 340,
+        "y": 120,
+        "wires": [["debug1"]]
+    },
+    {
+        "id": "debug1",
+        "type": "debug",
+        "z": "tab1",
+        "name": "Output",
+        "active": true,
+        "tosidebar": true,
+        "console": false,
+        "tostatus": false,
+        "complete": "payload",
+        "targetType": "msg",
+        "statusVal": "",
+        "statusType": "auto",
+        "x": 540,
+        "y": 120,
+        "wires": []
+    }
+]