README.md

WebsocketMQTTBridge

About

WebsocketMQTTBridge is state of art, straightforward tool to create connection and relay MQTT broker communication through Websocket.

Why Websocket - MQTT Bridge?

One day at work a regular everyday normal project, created a regular everday normal problem which needed a regular everyday normal solution. And the solution was the blazing fast WebsocketMQTTBridge.

What's in the box

MQTT broker and WS server support.

What's missing & TODOs

• Supporting MQTTS brokers and WSS server.
• Configurating the websocket server through json and console application.

Default server parameters

Default websocket server is created on: ws://127.0.0.1:80
IP: 127.0.0.1 PORT: 80 Server parameters can be changed in source code, under WebsocketServer.cs

Commands

Commands are in Json format. In given examples, the parameters are for demonstrating the data type only.

Connection request to MQTT broker

{ 
  "command": "connect",
  "ip": "127.0.0.1",
  "port": 10,
  "clientId": "1"
}

Subscription/Unsubscribtion Request

The command subscribe works in same structure with unsubscribe.

{
  "command": "subscribe", 
  "topics:" ["topic1", "topic2"]
}

{
  "command": "unsubscribe", 
  "topics:" ["topic1", "topic2"]
}

Publishing message to given topic

{
  "command": "publish",
  "topic": "topic1",
  "message": { "customParameter": "message is a json object" }
}

Dependencies used for the project

• Used for serializing/deserializing json requests/responses to objects. Newtonsoft.Json
• Creating websocket server. websocket-sharp
• Creating communication to MQTT broker. paho.mqtt.m2mqtt