Merge pull request #107 from sixfab/dev

release: 0.4.0

Author: ozgurkaraaslan

examples/mqtt/publish.py

@@ -0,0 +1,48 @@
+"""
+Example code for publishing data to an MQTT broker.
+
+Example Configuration
+---------------------
+Create a config.json file in the root directory of the PicoLTE device.
+config.json file must include the following parameters for this example:
+
+config.json
+{
+    "mqtts":{
+        "host":"[HOST_ADDRESS]",
+        "port": [PORT_NUMBER],
+        "pub_qos": [QoS],
+        "client_id": "[CLIENT_ID]",
+        "username":"[MQTT_USERNAME]",
+        "password":"[MQTT_PASSWORD]"
+    },
+}
+
+- [HOST_ADDRESS] should be an IP address or a domain name (without "mqtt://").
+- [QoS] is the quality of service level for the message and can be 0, 1 or 2. Default value is 1.
+- "client_id", "username" and "password" are optional. If your MQTT broker does not require authentication, you can skip these parameters.
+"""
+
+from pico_lte.utils.status import Status
+from pico_lte.core import PicoLTE
+from pico_lte.common import debug
+
+picoLTE = PicoLTE()
+
+picoLTE.network.register_network()
+picoLTE.network.get_pdp_ready()
+picoLTE.mqtt.open_connection()
+picoLTE.mqtt.connect_broker()
+
+debug.info("Publishing a message.")
+
+# PAYLOAD and TOPIC have to be in string format.
+PAYLOAD = "[PAYLOAD_MESSAGE]"
+TOPIC = "[TOPIC_NAME]"
+
+# Publish the message to the topic.
+result = picoLTE.mqtt.publish_message(PAYLOAD, TOPIC)
+debug.info("Result:", result)
+
+if result["status"] == Status.SUCCESS:
+    debug.info("Publish succeeded.")

examples/mqtt/subscribe.py

@@ -0,0 +1,52 @@
+"""
+Example code for subcribing to topic(s) of an MQTT broker.
+
+Example Configuration
+---------------------
+Create a config.json file in the root directory of the PicoLTE device.
+config.json file must include the following parameters for this example:
+
+config.json
+{
+    "mqtts":{
+        "host":"[HOST_ADDRESS]",
+        "port": [PORT_NUMBER],
+        "client_id": "[CLIENT_ID]",
+        "username":"[MQTT_USERNAME]",
+        "password":"[MQTT_PASSWORD]",
+        "sub_topics": [
+                ["[YOUR_MQTT_TOPIC_1]", [QoS]],
+                ["[YOUR_MQTT_TOPIC_2]", [QoS]],
+                ...
+            ]
+    },
+}
+
+- [HOST_ADDRESS] could be an IP address or a domain name (without "mqtt://").
+- "client_id", "username" and "password" are optional. If your MQTT broker does not require authentication, you can skip these parameters.
+- [QoS] is the quality of service level for the message and can be 0, 1 or 2.
+"""
+
+import time
+from pico_lte.utils.status import Status
+from pico_lte.core import PicoLTE
+from pico_lte.common import debug
+
+picoLTE = PicoLTE()
+
+picoLTE.network.register_network()
+picoLTE.network.get_pdp_ready()
+picoLTE.mqtt.open_connection()
+picoLTE.mqtt.connect_broker()
+
+debug.info("Subscribing to topics...")
+result = picoLTE.mqtt.subscribe_topics()
+debug.info("Result:", result)
+
+if result["status"] == Status.SUCCESS:
+    # Check is there any data in subscribed topics in each 5 seconds for 5 times
+    debug.info("Reading messages from subscribed topics...")
+    for _ in range(0, 5):
+        result = picoLTE.mqtt.read_messages()
+        debug.info(result["messages"])
+        time.sleep(5)

package.json

@@ -1,6 +1,6 @@
 {
     "urls": [],
     "deps": [],
-    "version": "0.3.0",
+    "version": "0.4.0",
     "license": "MIT"
 }

pico_lte/modules/mqtt.py

@@ -257,7 +257,9 @@ def open_connection(self, host=None, port=None, cid=0):
             ]
 
             if result["status"] == Status.SUCCESS:
-                result = self.atcom.get_urc_response(desired_response, fault_responses, timeout=60)
+                result = self.atcom.get_urc_response(
+                    desired_response, fault_responses, timeout=60
+                )
             return result
         return {"status": Status.ERROR, "response": "Missing parameters : host"}
 
@@ -301,15 +303,17 @@ def close_connection(self, cid=0):
             result = self.atcom.get_urc_response(desired_response, timeout=60)
         return result
 
-    def connect_broker(self, client_id_string="PicoLTE", username=None, password=None, cid=0):
+    def connect_broker(
+        self, client_id_string=None, username=None, password=None, cid=0
+    ):
         """
         Function for connecting to MQTT broker. This function is used when a client requests a
         connection to the MQTT server. When a TCP/IP socket connection is established between
         a client and a server, a protocol level session must be created using a CONNECT flow.
 
         Parameters
         ----------
-        client_id_string : str, default: "PicoLTE"
+        client_id_string : str, default: None
             Client ID string. Maximum length: 23 bytes.
         username : str, default: None
             Username. Maximum length: 23 bytes.
@@ -327,6 +331,9 @@ def connect_broker(self, client_id_string="PicoLTE", username=None, password=Non
             username = get_parameter(["mqtts", "username"])
             password = get_parameter(["mqtts", "password"])
 
+        if client_id_string is None:
+            client_id_string = get_parameter(["mqtts", "client_id"], "PicoLTE")
+
         if username and password:
             command = f'AT+QMTCONN={cid},"{client_id_string}","{username}","{password}"'
         else:
@@ -337,7 +344,9 @@ def connect_broker(self, client_id_string="PicoLTE", username=None, password=Non
         if result["status"] == Status.SUCCESS:
             desired_response = f"+QMTCONN: {cid},0,0"
             fault_responses = [f"QMTSTAT: 0,{err_code}" for err_code in range(1, 8)]
-            result = self.atcom.get_urc_response(desired_response, fault_responses, timeout=60)
+            result = self.atcom.get_urc_response(
+                desired_response, fault_responses, timeout=60
+            )
         return result
 
     def is_connected_to_broker(self, cid=0):
@@ -436,7 +445,9 @@ def unsubscribe_topic(self, topic, cid=0, message_id=1):
         command = f'AT+QMTUNS={cid},{message_id},"{topic}"'
         return self.atcom.send_at_comm(command)
 
-    def publish_message(self, payload, topic=None, qos=1, retain=0, message_id=1, cid=0):
+    def publish_message(
+        self, payload, topic=None, qos=None, retain=0, message_id=1, cid=0
+    ):
         """
         Function for publishing MQTT message. This function is used when a client requests
         a message to be published. This method uses data mode of the modem to send the message.
@@ -473,13 +484,18 @@ def publish_message(self, payload, topic=None, qos=1, retain=0, message_id=1, ci
         if topic is None:
             topic = get_parameter(["mqtts", "pub_topic"])
 
+        if qos is None:
+            qos = get_parameter(["mqtts", "pub_qos"], 1)
+
         if payload and topic:
             command = f'AT+QMTPUB={cid},{message_id},{qos},{retain},"{topic}"'
             result = self.atcom.send_at_comm(command, ">", urc=True)
 
             if result["status"] == Status.SUCCESS:
                 self.atcom.send_at_comm_once(payload, line_end=False)  # Send message
-                result = self.atcom.send_at_comm(self.CTRL_Z)  # Send end char --> CTRL+Z
+                result = self.atcom.send_at_comm(
+                    self.CTRL_Z
+                )  # Send end char --> CTRL+Z
             return result
         return {"response": "Missing parameter", "status": Status.ERROR}