Merge pull request #354 from jonascarvalh/mqtt-client

add: mqtt client project.

Author: itsyashvardhan

projects/MQTT Client/.env-example

@@ -0,0 +1,12 @@
+# Broker IP of MQTT (required)
+BROKER=
+
+# Default port for MQTT (required)
+PORT=1883 
+
+# Topic to interact (required)
+TOPIC=
+
+# User and Pass for login
+USER=
+PASS=

projects/MQTT Client/.gitignore

@@ -0,0 +1,5 @@
+/__pycache__
+/.pytest_cache
+/venv
+/build
+.env

projects/MQTT Client/MqttClient.py

@@ -0,0 +1,50 @@
+from paho.mqtt import client as mqtt_client
+from random import randint
+from decouple import config
+
+# Reading broker credentials
+BROKER = config("BROKER")
+PORT   = int(config("PORT"))
+TOPIC  = config("TOPIC")
+USER   = config("USER")
+PASS   = config("PASS")
+
+# Create a randdom id for login in MQTT
+CLIENT_ID = f'id-mqtt-{randint(0,100)}'
+
+# Create a client to interact with MQTT
+def connectMqtt() -> mqtt_client:
+    def on_connect(client, userdata, flags, rc):
+        if rc == 0:
+            print('[MQTT] Connected to server.')
+        else:
+            print('[MQTT] Failure to connect.')
+    
+    client = mqtt_client.Client(CLIENT_ID)
+    client.username_pw_set(USER, PASS)
+    client.on_connect = on_connect
+    client.connect(BROKER,PORT)
+
+    return client
+
+# Receiving messages sendings with MQTT
+def subscribe(client: mqtt_client):
+    def on_message(client, userdata, msg):
+        print(
+            f'[MQTT] Received message from {msg.topic} topic:',
+            f'\n{msg.payload.decode()}'
+        )
+
+    client.subscribe(TOPIC)
+    client.on_message = on_message
+
+# Publishing messages with MQTT
+def publish(client, msg='Hello MQTT'):
+    result = client.publish(TOPIC,msg)
+    
+if __name__ == '__main__':
+    client = connectMqtt()
+    subscribe(client)
+    publish(client)
+    publish(client, msg='Custom Messages Working!')
+    client.loop_forever()

projects/MQTT Client/README.md

@@ -0,0 +1,33 @@
+# MQTT Client
+> This code connects to an MQTT broker to publish and subscribe to topics to receive messages.
+
+## MQTT Operation
+![MQTT Operation](docs/imgs/mqtt_operation.png)
+
+## Requirements
+```sh
+pip install -r requirements.txt
+```
+
+This file includes:
+```
+paho-mqtt==1.6.1
+python-decouple==3.8
+```
+
+## How to execute?
+1. You need a Broker MQTT running. I recommend [Mosquitto](https://mosquitto.org/download/). 
+Ex (Do not need to do):
+    - `mosquitto -v`: Running Broker;
+    - `mosquitto  mosquitto_sub -h BROKER_IP -p PORT -t TOPIC`: Subscribe in topic.
+    - ` mosquitto_pub -h BROKER_IP -p PORT -t TOPIC -m MESSAGE`: Publish "MESSAGE" in topic.
+2. Duplicate the `.env-example` file and configure it;
+3. Edit name `.env-example` to `.env`;
+4. Execute `MqttClient.py`.
+
+```sh
+python3 MqttClient.py
+```
+
+## Code Running
+![Running Code](docs/imgs/running_code.png)

projects/MQTT Client/docs/imgs/mqtt_operation.png

@@ -0,0 +1,2 @@
+paho-mqtt==1.6.1
+python-decouple==3.8