🔌 ModBridge - Real-Time Modbus API & WebSocket Bridge

⚡ Real-time Modbus TCP/RTU API with WebSocket Updates

📌 Overview

ModBridge is a scalable Modbus TCP/RTU bridging service built with Elixir & Phoenix, designed for real-time industrial automation.
It enables CRUD management of Modbus devices and supports:

✅ Modbus TCP & RTU Communication
✅ Bit-Level & Full Register Read/Write
✅ Real-Time WebSocket Updates
✅ Dynamic Device Configuration (No Static Settings)
✅ Efficient Polling with GenServer

📂 Folder Structure

modbridge/
│── lib/
│   ├── modbus_bridge/
│   │   ├── devices/                   # Device management
│   │   │   ├── device.ex              # Device schema (Ecto)
│   │   │   ├── devices.ex             # CRUD functions
│   │   │   ├── device_controller.ex   # REST API for managing devices
│   │   ├── modbus/                    # Modbus communication layer
│   │   │   ├── modbus_client.ex       # Handles Modbus TCP/RTU read/write
│   │   │   ├── modbus_polling.ex      # Polling mechanism for real-time updates
│   │   ├── websocket/                 # WebSocket for real-time streaming
│   │   │   ├── modbus_channel.ex      # Handles WebSocket communication
│   │   ├── modbus_bridge.ex           # Main application module
│── config/                            # Configuration files
│── priv/repo/migrations/              # Database migrations
│── test/                              # Unit & integration tests
│── mix.exs                            # Dependencies & project config
│── README.md                          # Project documentation

🚀 Installation

1️⃣ Install dependencies

mix local.hex --force
mix archive.install hex phx_new
mix deps.get

2️⃣ Setup the database

mix ecto.create
mix ecto.migrate

3️⃣ Start the server

mix phx.server

🛠 API Endpoints

📍 Create a Device

POST /api/devices
Content-Type: application/json
{
  "name": "PLC 1",
  "protocol": "TCP",
  "ip": "192.168.1.100",
  "port": 502,
  "type": "Holding Register",
  "address": 40001,
  "bit_address": null,
  "writable": true,
  "poll_interval": 1000
}

📍 Read a Register

GET /api/devices/1/read

Response:

{ "device_id": 1, "value": 12345 }

📍 Write to a Register

POST /api/devices/1/write
Content-Type: application/json
{
  "value": 54321
}

🔥 WebSocket Updates

let socket = new Phoenix.Socket("ws://localhost:4000/socket");
socket.connect();

let channel = socket.channel("modbus:updates", {});
channel.join();

channel.on("modbus_update", payload => {
  console.log("Modbus Update:", payload);
});

🛠 Features

• 📡 Supports Modbus TCP & RTU
• 🔄 Read & Write Registers (Bit-Level & Full Register)
• ⚡ WebSocket for Real-Time Updates
• 📊 Polling Optimized with GenServer
• 🛠 REST API for Dynamic Device Configuration

📜 License

This project is licensed under the MIT License.