https://github.com/atorber/mqtt2x

一个mqtt转发到其他服务的工具
https://github.com/atorber/mqtt2x

Last synced: about 1 month ago
JSON representation

一个mqtt转发到其他服务的工具

• Host: GitHub
• URL: https://github.com/atorber/mqtt2x
• Owner: atorber
• Created: 2023-07-28T05:38:02.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-05-22T10:49:55.000Z (8 months ago)
• Last Synced: 2024-10-19T22:29:33.436Z (3 months ago)
• Language: TypeScript
• Size: 68.4 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# MQTT2X

使用配置的方式从MQTT消息的原始topic A和payload A中查询数据，转换为新的topic B和payload B

适用于使用MQTT+JSON数据格式进行消息传输时的快速协议转换

## 特性

一个 mqtt 桥接其他服务的工具包，提供或即将提供以下特性：

- 支持 mqtt 桥接到 mqtt、kafka 等其他消息队列

- 支持 mqtt 桥接到 http、tcp 等服务

- 支持使用 jsonata 配置对 JSON 格式数据进行转换

## 快速开始

```

npm run test

```

## 配置规则

修改 src/test.ts 示例中的规则配置，重新运行可以验证结果

```

import { RawMessage, Query, dataConversion, Rule, Message } from "./mods/message";

const rule: Rule = {

    source: 'testtopic/#', //数据来源topic，支持通配符

    compute: {

        type: "json", //固定字符串，目前仅支持json

        filter: ``, //过滤条件，jsonata表达式

        query: {

            topicExpression: `$.topic`, //目标格式的topic表达式

            payloadExpression: `$.payload`, //目标格式的topic表达式

        },

    },

    destinations: [''], //数据目的地，暂未支持

};

const rawMessage: RawMessage = {

    topic: 'testtopic/123',

    payload: {"list":[{"value":4},{"value":7},{"value":13}],"key":100},

    rule

};

(async () => {

    const result = await dataConversion(rawMessage);

    if (result && result.topic) {

        console.log('result:', result);

    }

})();

```

### 在收到MQTT消息时调用

- 客户端发布消息

topic:testtopic/123

payload:

```

{

    "params": {

        "list": [

            {

                "value": 4

            },

            {

                "value": 7

            },

            {

                "value": 13

            }

        ],

        "key": 100

    },

    "rule": {

        "source": "testtopic/#",

        "compute": {

            "type": "json",

            "filter": "",

            "query": {

                "topicExpression": "$.topic",

                "payloadExpression": "$.payload"

            }

        },

        "destinations": [

            ""

        ]

    }

}

```

```

// 接收和处理消息

mqttCleint.on('message', async function (topic, message) {

    // console.log('从代理服务订阅到的消息：')

    // console.log(topic,'\n', message.toString())

    const messageJson = JSON.parse(message.toString())

    const rawMessage: RawMessage = {

        topic,

        payload:messageJson.params,

        rule:messageJson.rule

    };

    const result = await dataConversion(rawMessage);

    if (result && result.topic) {

        console.log('转换成功:', JSON.stringify(result));

    }

})

```

## 编写 jsonata 表达式

示例消息：

```

{

    "topic":"testtopic/123",

    "payload":{

        "list":[

            {

                "value":4

            },

            {

                "value":7

            },

            {

                "value":13

            }

        ],

        "key":100

    }

}

```

你需要基于示例消息的结构编写对应的 jsonata 表达式，即使用 `$.topic`和`$.payload` 可以分别拿到 MQTT 消息中的 topic 和 payload