Mercurial > code > home > repos > homeauto

annotate lib/mqtt_client/mqtt_client.py @ 556:f263f76106aa

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