|
12
|
1 #
|
|
|
2 # Mux the ZB module to TCP ports
|
|
|
3 #
|
|
|
4 # Copyright (c) 2009
|
|
|
5 # Daniel O'Connor <darius@dons.net.au>. All rights reserved.
|
|
|
6 #
|
|
|
7 # Redistribution and use in source and binary forms, with or without
|
|
|
8 # modification, are permitted provided that the following conditions
|
|
|
9 # are met:
|
|
|
10 # 1. Redistributions of source code must retain the above copyright
|
|
|
11 # notice, this list of conditions and the following disclaimer.
|
|
|
12 # 2. Redistributions in binary form must reproduce the above copyright
|
|
|
13 # notice, this list of conditions and the following disclaimer in the
|
|
|
14 # documentation and/or other materials provided with the distribution.
|
|
|
15 #
|
|
|
16 # THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
|
|
17 # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
|
18 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
|
19 # ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
|
|
|
20 # FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
|
21 # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
|
22 # OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
|
23 # HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
|
24 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
|
25 # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
|
26 # SUCH DAMAGE.
|
|
|
27 #
|
|
|
28
|
|
|
29 from twisted.internet.serialport import SerialPort
|
|
|
30 from twisted.internet.protocol import Protocol
|
|
14
|
31 from twisted.conch.telnet import TelnetTransport, TelnetBootstrapProtocol
|
|
|
32 from twisted.conch.insults import insults
|
|
12
|
33 from twisted.protocols import basic
|
|
|
34 from twisted.internet import protocol, reactor
|
|
|
35 from twisted.python import log
|
|
14
|
36 import sys, zb, logging, logging.handlers, string
|
|
12
|
37
|
|
|
38 portname = '/dev/cuaU0'
|
|
|
39 baudrate = 38400
|
|
|
40 lognamebase = '/tmp/zbmux-%d.log'
|
|
|
41 baseport = 1080
|
|
|
42 zbids = [1, 2]
|
|
|
43
|
|
14
|
44 class ZBClient(insults.TerminalProtocol):
|
|
12
|
45 """Client for the TCP connection"""
|
|
14
|
46 #: Time to wait before sending pending data (seconds)
|
|
|
47 QUEUE_TIME = 0.1
|
|
|
48
|
|
12
|
49 def connectionMade(self):
|
|
|
50 log.msg("Got new client")
|
|
14
|
51 log.msg("Me - %s, terminal - %s" % (str(type(self)), str(type(self.terminal))))
|
|
|
52 self.terminal.eraseDisplay()
|
|
|
53 self.terminal.resetPrivateModes([])
|
|
|
54
|
|
|
55 # Send the last whole line we've seen out
|
|
12
|
56 if self.factory.lastline != None:
|
|
|
57 self.message(self.factory.lastline)
|
|
14
|
58
|
|
|
59 self.pending = ""
|
|
|
60 self.pendtimer = None
|
|
|
61 self.factory.clients.append(self)
|
|
12
|
62
|
|
|
63 def connectionLost(self, reason):
|
|
|
64 log.msg("Lost a client")
|
|
|
65 self.factory.clients.remove(self)
|
|
14
|
66
|
|
|
67 def keystrokeReceived(self, keyID, modifier):
|
|
|
68 """Got some data, add it to the pending output queue"""
|
|
|
69 if modifier != None:
|
|
|
70 print "Received unhandled modifier: %s" % (str(modifier))
|
|
|
71 return
|
|
|
72 #if keyID not in string.printable:
|
|
|
73 # print "Received unhandled keyID: %r" % (keyID,)
|
|
|
74 # return
|
|
|
75 #log.msg("Got key ->%s<-" % (keyID))
|
|
|
76 self.pending = self.pending + keyID
|
|
|
77 if self.pendtimer == None:
|
|
|
78 self.pendtimer = reactor.callLater(self.QUEUE_TIME, self.sendData)
|
|
|
79
|
|
|
80 def sendData(self):
|
|
|
81 """Send pending data to module"""
|
|
|
82 #log.msg("sending " + self.pending)
|
|
|
83 self.factory.zbproto.sendData(self.factory.zbid, self.pending)
|
|
|
84 self.pending = ""
|
|
|
85 self.pendtimer = None
|
|
|
86
|
|
12
|
87 def message(self, message):
|
|
|
88 """Called to write a mesage to our client"""
|
|
14
|
89 self.terminal.write(message)
|
|
12
|
90
|
|
|
91 class ZBFactory(protocol.ServerFactory):
|
|
|
92 """Factory for a ZB module
|
|
|
93
|
|
|
94 Represents a remote ZB module and has zero or more clients and a log file.
|
|
|
95 """
|
|
|
96 protocol = ZBClient
|
|
|
97
|
|
14
|
98 def __init__(self, zbid, lognamebase):
|
|
12
|
99 self.zbid = zbid
|
|
|
100 self.clients = []
|
|
|
101 self.tmpline = ""
|
|
|
102 self.lastline = None
|
|
|
103
|
|
|
104 # Open logger
|
|
|
105 self.logger = logging.getLogger('Zigbee-%d' % (zbid))
|
|
|
106 self.logger.setLevel(logging.DEBUG)
|
|
|
107
|
|
|
108 # Add the log message handler to the logger
|
|
|
109 handler = logging.handlers.RotatingFileHandler(
|
|
|
110 lognamebase % (zbid), maxBytes = 20 * 1024, backupCount = 5)
|
|
|
111
|
|
|
112 self.logger.addHandler(handler)
|
|
|
113
|
|
|
114 def message(self, zbid, message):
|
|
|
115 """Called when we get a message, check it's for us - if it is log it and write to our clients"""
|
|
|
116 if zbid != self.zbid:
|
|
|
117 return
|
|
|
118
|
|
|
119 for c in self.clients:
|
|
|
120 c.message(message)
|
|
|
121
|
|
|
122 # Logger is line oriented, convert from packet oriented here
|
|
|
123 self.tmpline = self.tmpline + message
|
|
|
124 tmp = self.tmpline.split('\n')
|
|
|
125 for l in tmp[0:-1]:
|
|
|
126 self.lastline = l # Stores last seen line for new clients
|
|
|
127 self.logger.debug(l.replace('\n', ''))
|
|
|
128 self.tmpline = tmp[-1]
|
|
|
129
|
|
|
130 class ZBProto(Protocol):
|
|
|
131 """Protocol to handle packets from the ZB module on the serial port"""
|
|
|
132 def __init__(self):
|
|
|
133 self.pkts = zb.Packets()
|
|
|
134 self.factories = []
|
|
|
135
|
|
|
136 def dataReceived(self, data):
|
|
|
137 """Parses data from ZB module into packets, calls each factory if a RX packet is received"""
|
|
|
138 #log.msg("Read data " + data)
|
|
|
139 if self.pkts.processstr(data) > 0:
|
|
|
140 while len(self.pkts.pktq) > 0:
|
|
|
141 a = self.pkts.pktq.pop(0)
|
|
|
142 #log.msg("type is " + str(type(a)))
|
|
|
143 if type(a) == type(zb.RX_16_Bit()):
|
|
|
144 #log.msg("Rx'd from %d => %s" % (a.sender, a.payloadstr))
|
|
|
145 for f in self.factories:
|
|
|
146 f.message(a.sender, a.payloadstr)
|
|
14
|
147 if type(a) == type(zb.TX_Status()):
|
|
|
148 #log.msg("Tx status for frame %d is %s" % (a.frameid, a.statusMsg))
|
|
|
149 pass
|
|
|
150
|
|
12
|
151 def sendData(self, zbid, data):
|
|
|
152 """Sends a chunk of data to our ZB module"""
|
|
|
153 #log.msg("%d <= %s" % (zbid, data))
|
|
14
|
154
|
|
12
|
155 # Chop up data into pieces the module can handle
|
|
14
|
156 maxsz = zb.TX_16_Bit.PKT_MAX_PAYLOAD
|
|
12
|
157 for i, j in zip(range(0, len(data), maxsz), range(maxsz, len(data) + maxsz, maxsz)):
|
|
|
158 p = zb.TX_16_Bit(zbid, data[i:j])
|
|
|
159 self.transport.write(p.Pack())
|
|
|
160 #log.msg("sent " + str(p))
|
|
14
|
161
|
|
12
|
162 if __name__ == '__main__':
|
|
|
163 logFile = sys.stdout
|
|
|
164 log.startLogging(logFile)
|
|
|
165
|
|
|
166 # ZigBee serial protocol handler
|
|
|
167 zbproto = ZBProto()
|
|
|
168 SerialPort(zbproto, portname, reactor, baudrate = 38400)
|
|
|
169
|
|
|
170 # Per-module TCP listener
|
|
|
171 for id in zbids:
|
|
14
|
172 f = ZBFactory(id, lognamebase)
|
|
|
173 f.zbproto = zbproto
|
|
|
174 f.protocol = lambda: TelnetTransport(TelnetBootstrapProtocol,
|
|
|
175 insults.ServerProtocol,
|
|
|
176 ZBClient)
|
|
|
177 zbproto.factories.append(f)
|
|
|
178 reactor.listenTCP(baseport + id, f)
|
|
12
|
179
|
|
|
180 reactor.run()
|
