Skip to main content
Help us improve Python packaging – donate today!

Python MQTT Client Library

Project Description

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

Release history Release notifications

This version
History Node

0.2.0

History Node

0.1.1

History Node

0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
nyamuk-v0.2.0.tar.gz (13.0 kB) Copy SHA256 hash SHA256 Source None Jul 2, 2016

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page