Mercurial > code > home > repos > homeauto

annotate lib/mqtt_client/mqtt_client.py @ 583:865dc66aa2c0

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
release 0.6.0 Ignore-this: f0e42f68bdf35bc5d6d4d395cd855f9d
author drewp@bigasterisk.com
date Fri, 10 May 2019 01:32:03 -0700
parents 6b6a7d06691e
children 8fcd51b1cb00
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
579
603272ee3000 big rewrite. now probably works for multiple subscriptions and over reconnects
drewp@bigasterisk.com
parents: 560
diff changeset
3 from rx.subjects import Subject
603272ee3000 big rewrite. now probably works for multiple subscriptions and over reconnects
drewp@bigasterisk.com
parents: 560
diff changeset
4 from twisted.application.internet import ClientService
554
2c4e8ef57f08 mqtt_client into a distributable
drewp@bigasterisk.com
parents: 378
diff changeset
5 from twisted.internet import reactor
582
6b6a7d06691e caller must set clientId
drewp@bigasterisk.com
parents: 579
diff changeset
6 from twisted.internet.defer import inlineCallbacks
378
b90d9321d2ce factor common mqtt code out of mqtt_graph_bridge
drewp@bigasterisk.com
parents:
diff changeset
7 from twisted.internet.endpoints import clientFromString
b90d9321d2ce factor common mqtt code out of mqtt_graph_bridge
drewp@bigasterisk.com
parents:
diff changeset
8
b90d9321d2ce factor common mqtt code out of mqtt_graph_bridge
drewp@bigasterisk.com
parents:
diff changeset
9 log = logging.getLogger('mqtt_client')
b90d9321d2ce factor common mqtt code out of mqtt_graph_bridge
drewp@bigasterisk.com
parents:
diff changeset
10
b90d9321d2ce factor common mqtt code out of mqtt_graph_bridge
drewp@bigasterisk.com
parents:
diff changeset
11 class MQTTService(ClientService):
b90d9321d2ce factor common mqtt code out of mqtt_graph_bridge
drewp@bigasterisk.com
parents:
diff changeset
12
582
6b6a7d06691e caller must set clientId
drewp@bigasterisk.com
parents: 579
diff changeset
13 def __init__(self, endpoint, factory, observersByTopic, clientId):
378
b90d9321d2ce factor common mqtt code out of mqtt_graph_bridge
drewp@bigasterisk.com
parents:
diff changeset
14 self.endpoint = endpoint
579
603272ee3000 big rewrite. now probably works for multiple subscriptions and over reconnects
drewp@bigasterisk.com
parents: 560
diff changeset
15 self.observersByTopic = observersByTopic
582
6b6a7d06691e caller must set clientId
drewp@bigasterisk.com
parents: 579
diff changeset
16 self.clientId = clientId
579
603272ee3000 big rewrite. now probably works for multiple subscriptions and over reconnects
drewp@bigasterisk.com
parents: 560
diff changeset
17 ClientService.__init__(self, endpoint, factory, retryPolicy=lambda _: 5)
378
b90d9321d2ce factor common mqtt code out of mqtt_graph_bridge
drewp@bigasterisk.com
parents:
diff changeset
18
b90d9321d2ce factor common mqtt code out of mqtt_graph_bridge
drewp@bigasterisk.com
parents:
diff changeset
19 def startService(self):
b90d9321d2ce factor common mqtt code out of mqtt_graph_bridge
drewp@bigasterisk.com
parents:
diff changeset
20 self.whenConnected().addCallback(self.connectToBroker)
b90d9321d2ce factor common mqtt code out of mqtt_graph_bridge
drewp@bigasterisk.com
parents:
diff changeset
21 ClientService.startService(self)
b90d9321d2ce factor common mqtt code out of mqtt_graph_bridge
drewp@bigasterisk.com
parents:
diff changeset
22
579
603272ee3000 big rewrite. now probably works for multiple subscriptions and over reconnects
drewp@bigasterisk.com
parents: 560
diff changeset
23 def ensureSubscribed(self, topic: bytes):
603272ee3000 big rewrite. now probably works for multiple subscriptions and over reconnects
drewp@bigasterisk.com
parents: 560
diff changeset
24 self.whenConnected().addCallback(self._subscribeToLatestTopic, topic)
603272ee3000 big rewrite. now probably works for multiple subscriptions and over reconnects
drewp@bigasterisk.com
parents: 560
diff changeset
25
603272ee3000 big rewrite. now probably works for multiple subscriptions and over reconnects
drewp@bigasterisk.com
parents: 560
diff changeset
26 def _subscribeToLatestTopic(self, protocol, topic: bytes):
603272ee3000 big rewrite. now probably works for multiple subscriptions and over reconnects
drewp@bigasterisk.com
parents: 560
diff changeset
27 if protocol.state == protocol.CONNECTED:
603272ee3000 big rewrite. now probably works for multiple subscriptions and over reconnects
drewp@bigasterisk.com
parents: 560
diff changeset
28 self.protocol.subscribe(topics=[(topic.decode('utf8'), 2)])
603272ee3000 big rewrite. now probably works for multiple subscriptions and over reconnects
drewp@bigasterisk.com
parents: 560
diff changeset
29 # else it'll get done in the next connectToBroker.
603272ee3000 big rewrite. now probably works for multiple subscriptions and over reconnects
drewp@bigasterisk.com
parents: 560
diff changeset
30
603272ee3000 big rewrite. now probably works for multiple subscriptions and over reconnects
drewp@bigasterisk.com
parents: 560
diff changeset
31 def _subscribeAll(self):
603272ee3000 big rewrite. now probably works for multiple subscriptions and over reconnects
drewp@bigasterisk.com
parents: 560
diff changeset
32 topics = list(self.observersByTopic)
603272ee3000 big rewrite. now probably works for multiple subscriptions and over reconnects
drewp@bigasterisk.com
parents: 560
diff changeset
33 log.info('subscribing %r', topics)
603272ee3000 big rewrite. now probably works for multiple subscriptions and over reconnects
drewp@bigasterisk.com
parents: 560
diff changeset
34 self.protocol.subscribe(topics=[(topic.decode('utf8'), 2) for topic in topics])
603272ee3000 big rewrite. now probably works for multiple subscriptions and over reconnects
drewp@bigasterisk.com
parents: 560
diff changeset
35
603272ee3000 big rewrite. now probably works for multiple subscriptions and over reconnects
drewp@bigasterisk.com
parents: 560
diff changeset
36
378
b90d9321d2ce factor common mqtt code out of mqtt_graph_bridge
drewp@bigasterisk.com
parents:
diff changeset
37 @inlineCallbacks
b90d9321d2ce factor common mqtt code out of mqtt_graph_bridge
drewp@bigasterisk.com
parents:
diff changeset
38 def connectToBroker(self, protocol):
b90d9321d2ce factor common mqtt code out of mqtt_graph_bridge
drewp@bigasterisk.com
parents:
diff changeset
39 self.protocol = protocol
579
603272ee3000 big rewrite. now probably works for multiple subscriptions and over reconnects
drewp@bigasterisk.com
parents: 560
diff changeset
40 self.protocol.onDisconnection = self._onProtocolDisconnection
603272ee3000 big rewrite. now probably works for multiple subscriptions and over reconnects
drewp@bigasterisk.com
parents: 560
diff changeset
41
378
b90d9321d2ce factor common mqtt code out of mqtt_graph_bridge
drewp@bigasterisk.com
parents:
diff changeset
42 # Publish requests beyond window size are enqueued
b90d9321d2ce factor common mqtt code out of mqtt_graph_bridge
drewp@bigasterisk.com
parents:
diff changeset
43 self.protocol.setWindowSize(1)
b90d9321d2ce factor common mqtt code out of mqtt_graph_bridge
drewp@bigasterisk.com
parents:
diff changeset
44
b90d9321d2ce factor common mqtt code out of mqtt_graph_bridge
drewp@bigasterisk.com
parents:
diff changeset
45 try:
582
6b6a7d06691e caller must set clientId
drewp@bigasterisk.com
parents: 579
diff changeset
46 yield self.protocol.connect(self.clientId, keepalive=60)
378
b90d9321d2ce factor common mqtt code out of mqtt_graph_bridge
drewp@bigasterisk.com
parents:
diff changeset
47 except Exception as e:
579
603272ee3000 big rewrite. now probably works for multiple subscriptions and over reconnects
drewp@bigasterisk.com
parents: 560
diff changeset
48 log.error(f"Connecting to {self.endpoint} raised {e!s}")
603272ee3000 big rewrite. now probably works for multiple subscriptions and over reconnects
drewp@bigasterisk.com
parents: 560
diff changeset
49 return
603272ee3000 big rewrite. now probably works for multiple subscriptions and over reconnects
drewp@bigasterisk.com
parents: 560
diff changeset
50
603272ee3000 big rewrite. now probably works for multiple subscriptions and over reconnects
drewp@bigasterisk.com
parents: 560
diff changeset
51 log.info(f"Connected to {self.endpoint}")
378
b90d9321d2ce factor common mqtt code out of mqtt_graph_bridge
drewp@bigasterisk.com
parents:
diff changeset
52
579
603272ee3000 big rewrite. now probably works for multiple subscriptions and over reconnects
drewp@bigasterisk.com
parents: 560
diff changeset
53 self.protocol.onPublish = self._onProtocolMessage
603272ee3000 big rewrite. now probably works for multiple subscriptions and over reconnects
drewp@bigasterisk.com
parents: 560
diff changeset
54 self._subscribeAll()
603272ee3000 big rewrite. now probably works for multiple subscriptions and over reconnects
drewp@bigasterisk.com
parents: 560
diff changeset
55
603272ee3000 big rewrite. now probably works for multiple subscriptions and over reconnects
drewp@bigasterisk.com
parents: 560
diff changeset
56 def _onProtocolMessage(self, topic, payload, qos, dup, retain, msgId):
603272ee3000 big rewrite. now probably works for multiple subscriptions and over reconnects
drewp@bigasterisk.com
parents: 560
diff changeset
57 topic = topic.encode('ascii')
603272ee3000 big rewrite. now probably works for multiple subscriptions and over reconnects
drewp@bigasterisk.com
parents: 560
diff changeset
58 observers = self.observersByTopic.get(topic, [])
603272ee3000 big rewrite. now probably works for multiple subscriptions and over reconnects
drewp@bigasterisk.com
parents: 560
diff changeset
59 log.debug(f'received {topic} payload {payload} ({len(observers)} obs)')
603272ee3000 big rewrite. now probably works for multiple subscriptions and over reconnects
drewp@bigasterisk.com
parents: 560
diff changeset
60 for obs in observers:
603272ee3000 big rewrite. now probably works for multiple subscriptions and over reconnects
drewp@bigasterisk.com
parents: 560
diff changeset
61 obs.on_next(payload)
603272ee3000 big rewrite. now probably works for multiple subscriptions and over reconnects
drewp@bigasterisk.com
parents: 560
diff changeset
62
603272ee3000 big rewrite. now probably works for multiple subscriptions and over reconnects
drewp@bigasterisk.com
parents: 560
diff changeset
63 def _onProtocolDisconnection(self, reason):
378
b90d9321d2ce factor common mqtt code out of mqtt_graph_bridge
drewp@bigasterisk.com
parents:
diff changeset
64 log.warn("Connection to broker lost: %r", reason)
b90d9321d2ce factor common mqtt code out of mqtt_graph_bridge
drewp@bigasterisk.com
parents:
diff changeset
65 self.whenConnected().addCallback(self.connectToBroker)
b90d9321d2ce factor common mqtt code out of mqtt_graph_bridge
drewp@bigasterisk.com
parents:
diff changeset
66
556
f263f76106aa some py3 compatibility
drewp@bigasterisk.com
parents: 554
diff changeset
67 def publish(self, topic: bytes, msg: bytes):
378
b90d9321d2ce factor common mqtt code out of mqtt_graph_bridge
drewp@bigasterisk.com
parents:
diff changeset
68 def _logFailure(failure):
b90d9321d2ce factor common mqtt code out of mqtt_graph_bridge
drewp@bigasterisk.com
parents:
diff changeset
69 log.warn("publish failed: %s", failure.getErrorMessage())
b90d9321d2ce factor common mqtt code out of mqtt_graph_bridge
drewp@bigasterisk.com
parents:
diff changeset
70 return failure
b90d9321d2ce factor common mqtt code out of mqtt_graph_bridge
drewp@bigasterisk.com
parents:
diff changeset
71
560
3501410e4cc7 also pass topic as str at publish
drewp@bigasterisk.com
parents: 558
diff changeset
72 return self.protocol.publish(topic=topic.decode('utf-8'), qos=0,
556
f263f76106aa some py3 compatibility
drewp@bigasterisk.com
parents: 554
diff changeset
73 message=bytearray(msg)).addErrback(_logFailure)
378
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
b90d9321d2ce factor common mqtt code out of mqtt_graph_bridge
drewp@bigasterisk.com
parents:
diff changeset
76 class MqttClient(object):
582
6b6a7d06691e caller must set clientId
drewp@bigasterisk.com
parents: 579
diff changeset
77 def __init__(self, clientId, brokerHost='bang', brokerPort=1883):
378
b90d9321d2ce factor common mqtt code out of mqtt_graph_bridge
drewp@bigasterisk.com
parents:
diff changeset
78
579
603272ee3000 big rewrite. now probably works for multiple subscriptions and over reconnects
drewp@bigasterisk.com
parents: 560
diff changeset
79 self.observersByTopic = {} # bytes: Set(observer)
378
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 factory = MQTTFactory(profile=MQTTFactory.PUBLISHER | MQTTFactory.SUBSCRIBER)
b90d9321d2ce factor common mqtt code out of mqtt_graph_bridge
drewp@bigasterisk.com
parents:
diff changeset
82 myEndpoint = clientFromString(reactor, 'tcp:%s:%s' % (brokerHost, brokerPort))
b90d9321d2ce factor common mqtt code out of mqtt_graph_bridge
drewp@bigasterisk.com
parents:
diff changeset
83 myEndpoint.__class__.__repr__ = lambda self: repr('%s:%s' % (self._host, self._port))
582
6b6a7d06691e caller must set clientId
drewp@bigasterisk.com
parents: 579
diff changeset
84 self.serv = MQTTService(myEndpoint, factory, self.observersByTopic,
6b6a7d06691e caller must set clientId
drewp@bigasterisk.com
parents: 579
diff changeset
85 clientId)
378
b90d9321d2ce factor common mqtt code out of mqtt_graph_bridge
drewp@bigasterisk.com
parents:
diff changeset
86 self.serv.startService()
579
603272ee3000 big rewrite. now probably works for multiple subscriptions and over reconnects
drewp@bigasterisk.com
parents: 560
diff changeset
87
603272ee3000 big rewrite. now probably works for multiple subscriptions and over reconnects
drewp@bigasterisk.com
parents: 560
diff changeset
88 def publish(self, topic: bytes, msg: bytes):
378
b90d9321d2ce factor common mqtt code out of mqtt_graph_bridge
drewp@bigasterisk.com
parents:
diff changeset
89 return self.serv.publish(topic, msg)
b90d9321d2ce factor common mqtt code out of mqtt_graph_bridge
drewp@bigasterisk.com
parents:
diff changeset
90
556
f263f76106aa some py3 compatibility
drewp@bigasterisk.com
parents: 554
diff changeset
91 def subscribe(self, topic: bytes):
378
b90d9321d2ce factor common mqtt code out of mqtt_graph_bridge
drewp@bigasterisk.com
parents:
diff changeset
92 """returns rx.Observable of payload strings"""
579
603272ee3000 big rewrite. now probably works for multiple subscriptions and over reconnects
drewp@bigasterisk.com
parents: 560
diff changeset
93 ret = Subject()
603272ee3000 big rewrite. now probably works for multiple subscriptions and over reconnects
drewp@bigasterisk.com
parents: 560
diff changeset
94 self.observersByTopic.setdefault(topic, set()).add(ret)
603272ee3000 big rewrite. now probably works for multiple subscriptions and over reconnects
drewp@bigasterisk.com
parents: 560
diff changeset
95 self.serv.ensureSubscribed(topic)
378
b90d9321d2ce factor common mqtt code out of mqtt_graph_bridge
drewp@bigasterisk.com
parents:
diff changeset
96 return ret