🚀 node-red-contrib-throughput-tcp

Welcome! This Node-RED node lets you easily test TCP network throughput using the powerful nping tool. Whether you're a network engineer, a developer, or just curious about your network's performance, this node makes it simple and visual.

🌟 Features

• Easy configuration: Set your destination, port, duration, packet size, and more—all from the Node-RED editor.
• Flexible testing: Choose probe modes, set DSCP for QoS, and optionally specify a source IP.
• Clear results: Get summary and (optionally) detailed test results right in your flow.

🛠️ Installation

1. Copy the folder: Place the throughput-tcp folder inside your Node-RED user directory, under ~/.node-red/node_modules/.
   • Or, if published, install via npm: npm install node-red-contrib-throughput-tcp
2. Restart Node-RED to load the new node.

Note: Make sure nping is installed and available in your system's PATH. You can get it from the Nmap website.

🧑‍💻 How to Use

1. Add the node: Drag the throughput-tcp node into your Node-RED flow.
2. Double-click to configure:
   • Name: (Optional) Give your test a friendly label.
   • Destination IP: The IP address you want to test against. (Required)
   • Port: The TCP port to use. (Required)
   • Duration (s): How long to run the test (default: 30 seconds).
   • Packet Size (bytes): Size of each packet (default: 1400).
   • Rate (pps): Packets per second to send (default: 10000).
   • Probe Mode: Choose from SYN, ACK, SACK, or CONNECT.
   • DSCP (0-63): (Optional) Set a DSCP value for QoS.
   • Source IP: (Optional) Use a specific source IP.
   • Show Details: Check this to get detailed output in your results.
3. Wire it up: Connect the node to your flow as needed.
4. Deploy and trigger the node. Your results will appear in msg.payload.

📦 Example Output

msg.payload = {
  success: true,
  summary: "Throughput: 100 Mbps, Loss: 0.1%",
  details: { /* ...detailed nping output if enabled... */ }
}

❓ FAQ

Q: Do I need to install anything extra? A: Yes, you need nping installed on your system. Node-RED and this node do not install it for you.

Q: Where do I see the results? A: The results are in msg.payload—connect a debug node to see them in the sidebar.

Q: Can I use this on Windows, Linux, or Mac? A: Yes! As long as Node-RED and nping are installed and available in your PATH.

⚡ Requirements

• Node-RED
• nping (part of the Nmap suite)

� Repository & Support

• Repository: https://github.com/WasimCoder/node-red-contrib-throughput-tcp-fetch
• Report Issues: GitHub Issues
• Pull Requests: Contribute via PRs

Have a suggestion or found a bug? Please open an issue or submit a pull request!

�📄 License

MIT — Free to use, modify, and share!