Python で MQTT (Paho)

pythonにおけるmqttのクライアントであるpaho-mqttの使い方、そしてクライアントとMQTTブローカー間の接続、publish/subscribeなどの機能をPythonで実装する方法を紹介します。

## 準備

今回はPython 3.6を使います。以下のコマンドでPythonのバージョンを確認できます。

```bash
➜  ~ python3 --version             
Python 3.6.7
```

### paho (mqttクライアント) について

[Paho Python Client](https://www.eclipse.org/paho/index.php?page=clients/python/index.php)には、Python 2.7または3.x上でMQTT v3.1とv3.1.1をサポートするクライアントのクラスが用意されています。また、MQTTサーバーに単発でpublishするようなヘルパー関数も用意されています。

### pahoのインストール

```bash
pip3 install paho-mqtt
```
pipは、Pythonパッケージの管理ツールです。pipを使って、Pythonパッケージの検索、ダウンロード、インストール、アンインストールを行えます。

## PythonでMQTTを使う

### MQTTブローカーに接続

EMQ Xが提供している[テスト用のMQTTブローカー](https://www.emqx.io/mqtt/public-mqtt5-broker)を使用します（このブローカーは、[EMQ X Cloud](https://cloud.emqx.io)をベースに運用されています）。ブローカーのアクセス情報は以下の通りです。接続先は以下の通りです。

- Host: __broker.emqx.io__
- TCP Port: __1883__
- Websocket Port: __8083__

### pahoをimport

```python
from paho.mqtt import client as mqtt_client
```

### 接続のパラメータ設定

ブローカーに接続するためのアドレス、ポート、トピックを設定します。今回は、Pythonの関数`random.randint`を使って、Client IDをランダムに生成します。

```python
broker = 'broker.emqx.io'
port = 1883
topic = "/python/mqtt"
client_id = f'python-mqtt-{random.randint(0, 1000)}'
# username = 'emqx'
# password = 'public'
```

### 接続する関数を書く

`on_connect`はコールバック関数です。この関数は、クライアントが接続した後に呼び出されます。この関数にある`rc` (return code) によって、クライアントが正常に接続したかどうかを判断することができます。このコールバック関数を使ってMQTTクライアントを作成し、`broker.emqx.io`に接続するクライアントを作ります。

```python
def connect_mqtt():
    def on_connect(client, userdata, flags, rc):
        if rc == 0:
            print("Connected to MQTT Broker!")
        else:
            print("Failed to connect, return code %d\n", rc)
    # Set Connecting Client ID
    client = mqtt_client.Client(client_id)
    client.username_pw_set(username, password)
    client.on_connect = on_connect
    client.connect(broker, port)
    return client
```

### publish (送信)

上記のクライアントを引数に取るpublish関数を作ります。今回は、`while`ループを使って1秒ごとにトピック`/python/mqtt`にメッセージを送信するようにします。

```python
def publish(client):
    msg_count = 0
    while True:
        time.sleep(1)
        msg = f"messages: {msg_count}"
        result = client.publish(topic, msg)
        # result: [0, 1]
        status = result[0]
        if status == 0:
            print(f"Send `{msg}` to topic `{topic}`")
        else:
            print(f"Failed to send message to topic {topic}")
        msg_count += 1
```

### subscribe (受信)

コールバック関数`on_message`を書きます。この関数は、クライアントがブローカーからメッセージを受信したときに呼び出されます。今回は、subscribeしたトピックの名前と受信したメッセージを出力します。

```python
def subscribe(client: mqtt_client):
    def on_message(client, userdata, msg):
        print(f"Received `{msg.payload.decode()}` from `{msg.topic}` topic")

    client.subscribe(topic)
    client.on_message = on_message
```

## スクリプトを完成させる

### メッセージをpublishするスクリプト

```python
# python 3.6

import random
import time

from paho.mqtt import client as mqtt_client


broker = 'broker.emqx.io'
port = 1883
topic = "python/mqtt"
# generate client ID with pub prefix randomly
client_id = f'python-mqtt-{random.randint(0, 1000)}'
# username = 'emqx'
# password = 'public'

def connect_mqtt():
    def on_connect(client, userdata, flags, rc):
        if rc == 0:
            print("Connected to MQTT Broker!")
        else:
            print("Failed to connect, return code %d\n", rc)

    client = mqtt_client.Client(client_id)
    client.username_pw_set(username, password)
    client.on_connect = on_connect
    client.connect(broker, port)
    return client


def publish(client):
    msg_count = 0
    while True:
        time.sleep(1)
        msg = f"messages: {msg_count}"
        result = client.publish(topic, msg)
        # result: [0, 1]
        status = result[0]
        if status == 0:
            print(f"Send `{msg}` to topic `{topic}`")
        else:
            print(f"Failed to send message to topic {topic}")
        msg_count += 1


def run():
    client = connect_mqtt()
    client.loop_start()
    publish(client)


if __name__ == '__main__':
    run()
```

### メッセージをsubscribeするスクリプト

```python
# python3.6

import random

from paho.mqtt import client as mqtt_client


broker = 'broker.emqx.io'
port = 1883
topic = "python/mqtt"
# generate client ID with pub prefix randomly
client_id = f'python-mqtt-{random.randint(0, 100)}'
# username = 'emqx'
# password = 'public'


def connect_mqtt() -> mqtt_client:
    def on_connect(client, userdata, flags, rc):
        if rc == 0:
            print("Connected to MQTT Broker!")
        else:
            print("Failed to connect, return code %d\n", rc)

    client = mqtt_client.Client(client_id)
    client.username_pw_set(username, password)
    client.on_connect = on_connect
    client.connect(broker, port)
    return client


def subscribe(client: mqtt_client):
    def on_message(client, userdata, msg):
        print(f"Received `{msg.payload.decode()}` from `{msg.topic}` topic")

    client.subscribe(topic)
    client.on_message = on_message


def run():
    client = connect_mqtt()
    subscribe(client)
    client.loop_forever()


if __name__ == '__main__':
    run()
```

## 実行

### publish

```
python3 pub.py
```

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/763141/8bd61a7d-0020-fe78-cb8b-7fbe1e99f3fb.png)


### subscibe

```
python3 sub.py
```

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/763141/0c5f0cc8-f9bb-5420-52e5-da296211278d.png)


## おわりに

この記事は [How to use MQTT in Python (Paho)](https://www.emqx.io/blog/how-to-use-mqtt-in-python)の翻訳です。