https://github.com/iwanbk/nyamuk

Python MQTT Client Library Based on libmosquitto
https://github.com/iwanbk/nyamuk

m2m mqtt mqtt-client python

Last synced: 24 days ago
JSON representation

Python MQTT Client Library Based on libmosquitto

• Host: GitHub
• URL: https://github.com/iwanbk/nyamuk
• Owner: iwanbk
• License: bsd-2-clause
• Created: 2012-03-09T02:00:08.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2018-11-20T22:02:31.000Z (almost 6 years ago)
• Last Synced: 2024-09-29T08:41:01.965Z (about 1 month ago)
• Topics: m2m, mqtt, mqtt-client, python
• Language: Python
• Homepage:
• Size: 173 KB
• Stars: 78
• Watchers: 8
• Forks: 23
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        

Nyamuk

======

Nyamuk is a python MQTT library, originally based on libmosquitto.  

It implements both 3.1 and 3.1.1 versions of MQTT protocol.  

Currently only supporting python 2.7

Features

--------

* [x] MQTT v3.1

* [x] MQTT v3.1.1

* [x] SSL

* [x] Qos 0, 1 & 2 support

* [ ] docstring & documentation

* [ ] python3 support

* [ ] advanced logging

Install

-------

from sources:

```

$> python setup.py install

```

using pypi package:

```

$> pip install nyamuk

```

Example

-------

Publishing a message with Qos 1 (with MQTT v3.1.1)

```python

import sys

from nyamuk import *

def nloop(client):

    client.packet_write()     # flush write buffer (messages sent to MQTT server)

    client.loop()             # fill read buffer   (enqueue received messages)

    return client.pop_event() # return 1st received message (dequeued)

client = Nyamuk("test_nyamuk", server="test.mosquitto.org")

ret = client.connect(version=4)

ret = nloop(client) # ret should be EventConnack object

if not isinstance(ret, EventConnack) or ret.ret_code != 0:

    print 'connection failed'; sys.exit(1)

client.publish('foo/bar', 'this is a test', qos=1)

ret = nloop(client) # ret should be EventPuback

client.disconnect()

```

Subscribing a topic

```python

import sys

from nyamuk import *

def nloop(client):

    client.packet_write()     # flush write buffer (messages sent to MQTT server)

    client.loop()             # fill read buffer   (enqueue received messages)

    return client.pop_event() # return 1st received message (dequeued)

client = Nyamuk("test_nyamuk", server="test.mosquitto.org")

ret = client.connect(version=4)

ret = nloop(client) # ret should be EventConnack object

if not isinstance(ret, EventConnack) or ret.ret_code != 0:

    print 'connection failed'; sys.exit(1)

client.subscribe('foo/bar', qos=1)

ret = nloop(client)

if not isinstance(ret, EventSuback):

    print 'SUBACK not received'; sys.exit(2)

print 'granted qos is', ret.granted_qos[0]

try:

    while True:

        evt = nloop(client)

        if isinstance(evt, EventPublish):

            print 'we received a message: {0} (topic= {1})'.format(evt.msg.payload, evt.msg.topic)

            

            # received message is either qos 0 or 1

            # in case of qos 1, we must send back PUBACK message with same packet-id

            if evt.msg.qos == 1:

                client.puback(evt.msg.mid)

except KeyboardInterrupt:

    pass

client.disconnect()

```

Authors

-------

Original creator: Iwan B. Kusnanto  

Current maintainer: Guillaume Bour

License

-------

Nyamuk is distributed under BSD license