MQTT Client

MQTT Client では、Visual Studio Code上で、テキストファイルからMQTTメッセージの配布・購読を行うことができます。

使用方法

拡張子が.mqttのファイルに以下ブロックを記述します。
各ブロックは#で始まる固有の文字列の行で開始します。ブロック開始行の行頭、行末に他の文字を追加することはできません。

ブローカー接続ブロック

ブローカーへの接続情報を# %%で始まるブロックに記述します。
# %%の上に表示されるConnectをクリックするとサーバーに接続されます。

例

# %%
url: mqtt://broker:1883
user: user
password: password

購読ブロック

購読するするtopicを# $$で始まるブロックに、topic１つにつき１行で記述します。
# $$の上あるいは各topicの上に表示されるSubscribe all、 Subscribeをクリックすると、購読用のタブを開き、購読が開始されます。

例

# %%
foo
bar/#

配布ブロック

配布したいメッセージごとに、# ##で始まるブロックに記述します。 配布先topic等の設定を記述後、１行空けてメッセージを記述します。
メッセージに# %%等のブロック開始行と同じ行を含めることはできません。別のブロックの開始と判断されます。
# ##の上に表示されるPublish Messageをクリックするとメッセージが配布されます。

例

# ##
topic: bar/#
qos: 0
retain: false

message1


# ##
topic: foo
qos: 1
retain: true

{
    "message": "hello"
}

変数

変数を定義し、各所で参照することができます。
変数は上記の全てのブロックより上に name=value の形で、１行に１つ記述します。
参照するには変数名を{{ }}で囲います。変数が定義されていない場合は、そのままの文字列として扱います。変数が定義されていて、{{ }}で囲った文字列をそのまま使用したい場合は、さらに{{ }}で囲います。
変数を参照できる箇所は以下です。

• 変数定義のvalue部分
  より上で定義した変数のみ参照できます。
• key:value 形式の設定値のvalue部分
• 購読ブロックのtopic指定部分
• 配布ブロックのメッセージ部分

例

host=broker
TopicLevel1=foo
TOPIC_FOO={{TopicLevel1}}/foo
message=Hello, world!

# %%
url: http://{{host}}:1883

# $$
{{TopicLevel1}}/#

# ##
# { "message": "Hello, world!" }をpublish
topic: {{TopicLevel1}}/bar

{
    "message": "{{message}}"
}

# ##
# {{messaeg}}をpublish
topic: {{TOPIC_FOO}}

{{{{message}}}}

ThirdParty Notices

MQTT.js

Copyright (c) 2015-2016 MQTT.js contributors
Released under the MIT license
https://github.com/mqttjs/MQTT.js/blob/main/LICENSE.md

wait-queue

Copyright (c) 2017 flarestart
Released under the MIT license
https://github.com/flarestart/wait-queue/blob/master/LICENSE

License

MIT License