annotate lib/mqtt_client/mqtt_client.py @ 1358:fda1e7bdecb7

release 0.1.0 Ignore-this: 3360059fc57b39c0260ad5dafabd3144 darcs-hash:8b49fb1c767f63dbac8e7e3cf14bbe4609587d57
author drewp <drewp@bigasterisk.com>
date Tue, 30 Apr 2019 23:37:30 -0700
parents f99fe03803d4
children 8fb419235dc9
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1357
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
1 import logging
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
2 from mqtt.client.factory import MQTTFactory
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
3 from rx import Observable
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
4 from rx.concurrency import TwistedScheduler
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
5 from twisted.application.internet import ClientService, backoffPolicy
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
6 from twisted.internet import reactor
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
7 from twisted.internet.defer import inlineCallbacks, Deferred
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
8 from twisted.internet.endpoints import clientFromString
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
9
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
10 log = logging.getLogger('mqtt_client')
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
11
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
12 class MQTTService(ClientService):
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
13
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
14 def __init__(self, endpoint, factory):
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
15 self.endpoint = endpoint
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
16 ClientService.__init__(self, endpoint, factory, retryPolicy=backoffPolicy())
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
17
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
18 def startService(self):
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
19 self.whenConnected().addCallback(self.connectToBroker)
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
20 ClientService.startService(self)
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
21
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
22 @inlineCallbacks
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
23 def connectToBroker(self, protocol):
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
24 self.protocol = protocol
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
25 self.protocol.onDisconnection = self.onDisconnection
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
26 # We are issuing 3 publish in a row
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
27 # if order matters, then set window size to 1
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
28 # Publish requests beyond window size are enqueued
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
29 self.protocol.setWindowSize(1)
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
30
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
31 try:
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
32 yield self.protocol.connect("TwistedMQTT-pub", keepalive=60)
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
33 except Exception as e:
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
34 log.error("Connecting to {broker} raised {excp!s}",
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
35 broker=self.endpoint, excp=e)
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
36 else:
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
37 log.info("Connected to {broker}".format(broker=self.endpoint))
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
38 if getattr(self, 'onMqttConnectionMade', False):
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
39 self.onMqttConnectionMade()
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
40
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
41 def onDisconnection(self, reason):
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
42 log.warn("Connection to broker lost: %r", reason)
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
43 self.whenConnected().addCallback(self.connectToBroker)
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
44
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
45 def publish(self, topic, msg):
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
46 def _logFailure(failure):
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
47 log.warn("publish failed: %s", failure.getErrorMessage())
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
48 return failure
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
49
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
50 return self.protocol.publish(topic=topic, qos=0, message=msg).addErrback(_logFailure)
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
51
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
52
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
53 class MqttClient(object):
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
54 def __init__(self, brokerHost='bang', brokerPort=1883):
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
55
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
56 #scheduler = TwistedScheduler(reactor)
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
57
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
58 factory = MQTTFactory(profile=MQTTFactory.PUBLISHER | MQTTFactory.SUBSCRIBER)
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
59 myEndpoint = clientFromString(reactor, 'tcp:%s:%s' % (brokerHost, brokerPort))
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
60 myEndpoint.__class__.__repr__ = lambda self: repr('%s:%s' % (self._host, self._port))
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
61 self.serv = MQTTService(myEndpoint, factory)
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
62 self.serv.startService()
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
63
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
64 def publish(self, topic, msg):
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
65 return self.serv.publish(topic, msg)
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
66
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
67 def subscribe(self, topic):
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
68 """returns rx.Observable of payload strings"""
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
69 # This is surely broken for multiple topics and subscriptions. Might not even
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
70 # work over a reconnect.
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
71
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
72 ret = Observable.create(self._observe_msgs)
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
73
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
74 self.serv.onMqttConnectionMade = lambda: self._resubscribe(topic)
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
75 if (hasattr(self.serv, 'protocol') and
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
76 self.serv.protocol.state ==self.serv.protocol.CONNECTED):
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
77 self._resubscribe(topic)
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
78 return ret
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
79
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
80 def _resubscribe(self, topic):
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
81 log.info('subscribing %r', topic)
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
82 self.serv.protocol.onPublish = self._onPublish
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
83 return self.serv.protocol.subscribe(topic, 2)
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
84
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
85 def _observe_msgs(self, observer):
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
86 self.obs = observer
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
87
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
88 def _onPublish(self, topic, payload, qos, dup, retain, msgId):
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
89 log.debug('received payload %r', payload)
f99fe03803d4 mqtt_client into a distributable
drewp <drewp@bigasterisk.com>
parents:
diff changeset
90 self.obs.on_next(payload)