mqtt

• DolphinDB Server: 2.00.10及更高版本

1. 在DolphinDB 客户端中使用 listRemotePlugins 命令查看插件仓库中的插件信息。

   login("admin", "123456")
   listRemotePlugins(, "http://plugins.dolphindb.cn/plugins/")

2. 使用 installPlugin 命令完成插件安装。

   installPlugin("mqtt")

   返回：<path_to_MQTT_plugin>/PluginMQTT.txt

3. 使用 loadPlugin 命令加载插件（即上一步返回的.txt文件）。

   loadPlugin("<path_to_MQTT_plugin>/PluginMQTT.txt")

   注意：若使用 Windows 插件，加载时必须指定绝对路径，且路径中使用"\\"或"/"代替"\"。

语法

mqtt::connect(host, port,[QoS=0],[formatter],[batchSize=0],[username],[password],[sendbufSize=40960])

建立一个与 MQTT server/broker 的连接。返回一个 connection。可以显式的调用 close 函数去关闭，也可以在 reference count 为0时自动释放。

参数

• host：是一个字符串，表示 MQTT server/broker 的 IP 地址。
• port：是一个整数，表示 MQTT server/broker 的端口号。
• QoS：表示是一个整数，表示消息发布服务质量。0：至多一次；1：至少一次；2：只有一次。它是可选参数，默认是0。
• formatter：是一个函数，用于对发布的数据按 CSV 或 JSON 格式进行打包。目前支持的函数由 createJsonFormatter 或 createCsvFormatter 创建。
• batchSize：是一个整数。当待发布内容是一个表时，可以分批发送，batchSize 表示每次发送的记录行数。
• username：是一个字符串，用于登录 MQTT server/broker 的用户名。
• password：是一个字符串，用于登录 MQTT server/broker 的密码。
• sendbufSize：是一个整数，省略时默认是 40960，用于指定发送缓冲区大小。

例子

f=mqtt::createJsonFormatter()
conn=connect("test.mosquitto.org",1883,0,f,50)

语法

mqtt::publish(conn,topic,obj)

向 MQTT server/broker 发布消息。

参数

• conn：是 connect 函数返回的值。
• topic：是一个字符串，表示主题。
• obj：是表或字符串或字符串数组，表示待发布的消息内容。

例子

mqtt::publish(conn,"dolphindb/topic1","welcome")
mqtt::publish(conn,"devStr/sensor001",["hello world","welcome"])
t=table(take(0..99,50) as hardwareId ,take(now(),
		50) as ts,rand(20..41,50) as temperature,
		rand(50,50) as humidity,rand(500..1000,
		50) as voltage)
mqtt::publish(conn,"dolphindb/device",t)		

语法

mqtt::createPublisher(conn,topic,colNames,colTypes)

创建一个对象，可以通过向该对象写入数据来发布消息。

参数

• conn：是 connect 函数返回的值。
• topic：是一个字符串，表示主题。
• colNames：发布的表结构的列名数组。
• colTypes：发布的表结构的列类型数组。

例子

MyFormat = take("", 3)
MyFormat[2] = "0.000"
f = createCsvFormatter(MyFormat, ',', ';')
pubConn = connect("127.0.0.1",1883,0,f,100)

colNames = [`ts, `hardwareId, `val]
colTypes = [TIMESTAMP, SYMBOL, INT]
publisher = createPublisher(pubConn, "sensor/s001", colNames, colTypes)

// 使用举例1：直接将要 push 的数据 append 到 publisher 中即可发布，这里的 tb 参数必须是一个表
append!(publisher, tb)

// 使用举例2：通过 insert SQL 语句
insert into publisher values([2023.08.25 10:57:47.961, 2023.08.25 10:57:47.961], symbol([`bb,`cc]), [22,33])

// 使用举例3：订阅流数据表时直接设置 handler=append!{publisher} 即可完成实时数据发布
share streamTable(1000:0, `time`sym`val, [TIMESTAMP, SYMBOL, INT]) as trades
subscribeTable(tableName="trades", actionName="engine1", offset=0, handler=append!{publisher}, msgAsTable=true);

insert into trades values(2018.10.08T01:01:01.785,`dd,44)
insert into trades values(2018.10.08T01:01:02.125,`ee,55)
insert into trades values(2018.10.08T01:01:10.263,`ff,66)

语法

mqtt::close(conn)

断开与 MQTT server/broker 的连接。

参数

• conn：是 connect 函数返回的值。

例子

mqtt::close(conn)

语法

mqtt::subscribe(host, port, topic, [parser], handler, [username], [password], [recvbufSize=20480])

向 MQTT server/broker 订阅消息。返回一个连接。

参数

• host：是一个字符串，表示 MQTT server/broker 的 IP 地址。
• port：是一个整数，表示 MQTT server/broker 的端口号。
• topic：是一个字符串，表示订阅主题。
• parser：是一个函数，用于对订阅的消息按 CSV 或 JSON 格式进行解析，目前支持的函数由 createJsonParser 或 createCsvParser 创建。
• handler：是一个函数或表，用于处理从 MQTT server/broker 接收的消息。
• username：是一个字符串，用于登录 MQTT server/broker 的用户名。
• password：是一个字符串，用于登录 MQTT server/broker 的密码。
• recvbufSize：是一个整数，省略时默认是 20480，用于指定接收缓冲区大小。

例子

p = createCsvParser([INT, TIMESTAMP, DOUBLE, DOUBLE,DOUBLE], ',', ';' )
sensorInfoTable = table( 10000:0,`deviceID`send_time`temperature`humidity`voltage ,[INT, TIMESTAMP, DOUBLE, DOUBLE,DOUBLE])
conn = mqtt::subscribe("192.168.1.201",1883,"sensor/#",p,sensorInfoTable)

语法

mqtt::getSubscriberStat()    

查询所有订阅信息。返回的结果是一个包含7列的表，分别是："subscriptionId" 表示订阅标识符；"user" 表示建立订阅的会话用户; "host" 表示 MQTT server/broker 的 IP； "port" 表示 MQTT server/broker 的端口号；"topic" 表示订阅主题；"createTimestamp" 表示可以订阅建立时间；"receivedPackets" 表示订阅收到的消息报文数。

参数

无。

例子

mqtt::getSubscriberStat()    

语法

mqtt::unsubscribe(subscription)    

取消订阅MQTT server/broker。

参数

• subscription：是 subscribe 函数返回的值或 getSubscriberStat 返回的订阅标识符。

例子

mqtt::unsubscribe(sub1) 
mqtt::unsubscribe("350555232l")   

语法

mqtt::createCsvFormatter([format], [delimiter=','], [rowDelimiter=';'])

创建一个 CSV 格式的 Formatter 函数。

参数

• format：是一个字符串向量。
• delimiter：是列之间的分隔符，默认是','。
• rowDelimiter：是行之间的分隔符，默认是';'。

例子

def createT(n) {
    return table(take([false, true], n) as bool, take('a'..'z', n) as char, take(short(-5..5), n) as short, take(-5..5, n) as int, take(-5..5, n) as long, take(2001.01.01..2010.01.01, n) as date, take(2001.01M..2010.01M, n) as month, take(time(now()), n) as time, take(minute(now()), n) as minute, take(second(now()), n) as second, take(datetime(now()), n) as datetime, take(now(), n) as timestamp, take(nanotime(now()), n) as nanotime, take(nanotimestamp(now()), n) as nanotimestamp, take(3.1415, n) as float, take(3.1415, n) as double, take(`AAPL`IBM, n) as string, take(`AAPL`IBM, n) as symbol)
}
t = createT(100)
MyFormat = take("", 18)
MyFormat[2] = "0.000"
MyFormat[5] = "yyyy.MM.dd"
f = mqtt::createCsvFormatter(MyFormat)
f(t)

语法

mqtt::createCsvParser(schema, [delimiter=','], [rowDelimiter=';'])

该函数创建一个 CSV 格式的 Parser 函数。

参数

• schema：是一个列的数据类型的向量。
• delimiter：是列之间的分隔符，默认是','。
• rowDelimiter：是行之间的分隔符，默认是';'。

例子

def createT(n) {
    return table(take([false, true], n) as bool, take('a'..'z', n) as char, take(short(-5..5), n) as short, take(-5..5, n) as int, take(-5..5, n) as long, take(2001.01.01..2010.01.01, n) as date, take(2001.01M..2010.01M, n) as month, take(time(now()), n) as time, take(minute(now()), n) as minute, take(second(now()), n) as second, take(datetime(now()), n) as datetime, take(now(), n) as timestamp, take(nanotime(now()), n) as nanotime, take(nanotimestamp(now()), n) as nanotimestamp, take(3.1415, n) as float, take(3.1415, n) as double, take(`AAPL`IBM, n) as string, take(`AAPL`IBM, n) as symbol)
}
t = createT(100)
f = mqtt::createCsvFormatter([BOOL,CHAR,SHORT,INT,LONG,DATE,MONTH,TIME,MINUTE,SECOND,DATETIME,TIMESTAMP,NANOTIME,NANOTIMESTAMP,FLOAT,DOUBLE,STRING,SYMBOL])
s=f(t)
p = mqtt::createCsvParser([BOOL,CHAR,SHORT,INT,LONG,DATE,MONTH,TIME,MINUTE,SECOND,DATETIME,TIMESTAMP,NANOTIME,NANOTIMESTAMP,FLOAT,DOUBLE,STRING,SYMBOL])
p(s)

语法

mqtt::createJsonFormatter()

该函数创建一个 JSON 格式的 Formatter 函数。

参数

无。

例子

def createT(n) {
    return table(take([false, true], n) as bool, take('a'..'z', n) as char, take(short(-5..5), n) as short, take(-5..5, n) as int, take(-5..5, n) as long, take(2001.01.01..2010.01.01, n) as date, take(2001.01M..2010.01M, n) as month, take(time(now()), n) as time, take(minute(now()), n) as minute, take(second(now()), n) as second, take(datetime(now()), n) as datetime, take(now(), n) as timestamp, take(nanotime(now()), n) as nanotime, take(nanotimestamp(now()), n) as nanotimestamp, take(3.1415, n) as float, take(3.1415, n) as double, take(`AAPL`IBM, n) as string, take(`AAPL`IBM, n) as symbol)
}
t = createT(100)
f = mqtt::createJsonFormatter()
f(t)

语法

mqtt::createJsonParser(schema, colNames)

该函数创建一个 JSON 格式的 Parser 函数。

参数

• schema：是一个向量，表示列的数据类型。
• colNames：是一个向量，表示列名。

例子

def createT(n) {
    return table(take([false, true], n) as bool, take('a'..'z', n) as char, take(short(-5..5), n) as short, take(-5..5, n) as int, take(-5..5, n) as long, take(2001.01.01..2010.01.01, n) as date, take(2001.01M..2010.01M, n) as month, take(time(now()), n) as time, take(minute(now()), n) as minute, take(second(now()), n) as second, take(datetime(now()), n) as datetime, take(now(), n) as timestamp, take(nanotime(now()), n) as nanotime, take(nanotimestamp(now()), n) as nanotimestamp, take(3.1415, n) as float, take(3.1415, n) as double, take(`AAPL`IBM, n) as string, take(`AAPL`IBM, n) as symbol)
}
t = createT(100)
f = mqtt::createJsonFormatter()
p = createJsonParser([BOOL,CHAR,SHORT,INT,LONG,DATE,MONTH,TIME,MINUTE,SECOND,DATETIME,TIMESTAMP,NANOTIME,NANOTIMESTAMP,FLOAT,DOUBLE,STRING,SYMBOL],
`bool`char`short`int`long`date`month`time`minute`second`datetime`timestamp`nanotime`nanotimestamp`float`double`string`symbol)
s=f(t)
x=p(s)

• 以下步骤在64位 Linux GCC version 5.4.0 下编译测试通过。
• 在编译前需要先安装 git 和 CMake。

Ubuntu 用户只需要在命令行输入以下命令即可：

$ sudo apt-get install git cmake

• 在 mqtt 目录下创建 build 目录，进入后运行 cmake .. 和 make，即可编译生成 'libPluginMQTTClient.so'。

mkdir build
cd build
cmake ..
make

因为需要通过 CMake 和 MinGW 编译，所以需要先安装 CMake和 MinGW 环境，目前在64位win10上用 MinGW-W64-builds-4.3.3 版本编译通过。把 MinGW 和 CMake 的 bin 目录加入 Windows 系统 Path 路径。

    git clone https://github.com/dolphindb/DolphinDBPlugin.git
    cd DolphinDBPlugin/mqtt
    mkdir build
    cd build
    cmake ..
    copy /YOURPATH/libDolphinDB.dll . 
    make

注意： 如果需要指定特定的 MinGW 路径，请在 CmakeList.txt 中修改以下语句。

    set(MINGW32_LOCATION C://MinGW/MinGW/)  

编译之后目录下会产生 libPluginMQTTClient.dll 文件，然后按预编译安装方法导入并加载。

DolphinDB 提供两种方式加载插件，二者选一种即可：

• 通过函数 loadPlugin 加载；
• 通过配置参数 preloadModules 预加载。