-
Notifications
You must be signed in to change notification settings - Fork 4
/
GSV6_Protocol.py
229 lines (211 loc) · 11.4 KB
/
GSV6_Protocol.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
# -*- coding: utf-8 -*-
__author__ = 'Dennis Rump'
###############################################################################
#
# The MIT License (MIT)
#
# Copyright (c) 2015 Dennis Rump
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
#
# Hiermit wird unentgeltlich, jeder Person, die eine Kopie der Software
# und der zugehörigen Dokumentationen (die "Software") erhält, die
# Erlaubnis erteilt, uneingeschränkt zu benutzen, inklusive und ohne
# Ausnahme, dem Recht, sie zu verwenden, kopieren, ändern, fusionieren,
# verlegen, verbreiten, unter-lizenzieren und/oder zu verkaufen, und
# Personen, die diese Software erhalten, diese Rechte zu geben, unter
# den folgenden Bedingungen:
#
# Der obige Urheberrechtsvermerk und dieser Erlaubnisvermerk sind in
# alle Kopien oder Teilkopien der Software beizulegen.
#
# DIE SOFTWARE WIRD OHNE JEDE AUSDRÜCKLICHE ODER IMPLIZIERTE GARANTIE
# BEREITGESTELLT, EINSCHLIESSLICH DER GARANTIE ZUR BENUTZUNG FÜR DEN
# VORGESEHENEN ODER EINEM BESTIMMTEN ZWECK SOWIE JEGLICHER
# RECHTSVERLETZUNG, JEDOCH NICHT DARAUF BESCHRÄNKT. IN KEINEM FALL SIND
# DIE AUTOREN ODER COPYRIGHTINHABER FÜR JEGLICHEN SCHADEN ODER SONSTIGE
# ANSPRUCH HAFTBAR ZU MACHEN, OB INFOLGE DER ERFÜLLUNG VON EINEM
# VERTRAG, EINEM DELIKT ODER ANDERS IM ZUSAMMENHANG MIT DER BENUTZUNG
# ODER SONSTIGE VERWENDUNG DER SOFTWARE ENTSTANDEN.
#
###############################################################################
import logging
from twisted.internet import protocol
from Queue import Full
import GSV6_BasicFrameType
import GSV6_ErrorCodes
class GSV_6Protocol(protocol.Protocol):
inDataBuffer = {}
def connectionLost(self, reason):
self.session.lostSerialConnection(reason.getErrorMessage())
def __init__(self, session, frameQueue, anfrageQueue):
self.session = session
self.inDataBuffer = bytearray()
self.frameQueue = frameQueue
self.anfrageQueue = anfrageQueue
def dataReceived(self, data):
self.inDataBuffer.extend(data)
logging.getLogger('serial2ws.WAMP_Component.GSV_6Protocol').trace(
'data received: ' + ' '.join(format(x, '02x') for x in bytearray(data)))
self.checkForCompleteFrame()
def checkForCompleteFrame(self, recursion=-1):
state = 0
counter = 0
frametype = 0
payloadLength = 0
foundcompleteframe = False
tempArray = bytearray()
# drop all bytes to find sync byte
while (len(self.inDataBuffer) > 0) and (self.inDataBuffer[0] != 0xAA):
self.inDataBuffer.pop(0)
logging.getLogger('serial2ws.WAMP_Component.GSV_6Protocol').trace('Drop Byte.')
# min length messwert = 5 Byte
# min length antwort = 4 Byte
# abort if not enougth data received
if len(self.inDataBuffer) < 4:
logging.getLogger('serial2ws.WAMP_Component.GSV_6Protocol').trace(
'return, because minimal FrameLength not reached.')
return
for b in self.inDataBuffer:
tempArray.append(b)
counter += 1
logging.getLogger('serial2ws.WAMP_Component.GSV_6Protocol').trace('State: ' + str(state))
if state == 0:
# okay we strip sync bytes 0xAA and 0x85 in this function
# strip 0xAA in state 0
del tempArray[-1]
# next state
state = 1
elif state == 1:
# check FrameType, Interface and length/channels -> state=2
# if AntwortFrame or MessFrame?
if not (((b & 0xC0) == 0x40) or ((b & 0xC0) == 0x00)):
# in this scope we can't pop (del) first byte -> idea: blank the 0xAA
self.inDataBuffer[0] = 0x00
logging.getLogger('serial2ws.WAMP_Component.GSV_6Protocol').trace(
'[break] Frame seems to be not a Antwort or MsessFrame.')
break
else:
frametype = int(b >> 6)
# if Interface== Serial?
if not (b & 0x30 == 0x10):
# in this scope we can't pop (del) first byte -> idea: blank the 0xAA
self.inDataBuffer[0] = 0x00
logging.getLogger('serial2ws.WAMP_Component.GSV_6Protocol').trace('[break] Interface != Serial')
break
# payloadLength for AntwortFrame or count of Channels for Messframe
payloadLength = int(b & 0x0F)
logging.getLogger('serial2ws.WAMP_Component.GSV_6Protocol').trace('payloadLength=' + str(payloadLength))
state = 2
# if not -> drop: state=0;counter=0;drop incommingDataBuffer.pop(0), tempArray=[]
elif state == 2:
# check status byte Mess=indicator; AntwortFrame = in listErrorList?; payloadLength=calculate legnth of expected payload -> state=3
if frametype == 0:
logging.getLogger('serial2ws.WAMP_Component.GSV_6Protocol').trace('detected MessFrame')
# it's a MessFrame
# first check Indikator==1
if (b & 0x80) != 0x80:
# in this scope we can't pop (del) first byte -> idea: blank the 0xAA
self.inDataBuffer[0] = 0x00
logging.getLogger('serial2ws.WAMP_Component.GSV_6Protocol').trace('[break] Indikator!=1')
break
# now get datatype as multiplier for payloadLength
multiplier = int((b & 0x70) >> 4) + 1
logging.getLogger('serial2ws.WAMP_Component.GSV_6Protocol').trace('multiplier: ' + str(multiplier))
# start count at 0-> +1
payloadLength += 1
payloadLength *= multiplier
logging.getLogger('serial2ws.WAMP_Component.GSV_6Protocol').trace(
'payloadLength: ' + str(payloadLength))
state = 3
elif frametype == 1:
logging.getLogger('serial2ws.WAMP_Component.GSV_6Protocol').trace('detected Antwort Frame')
# it's a AntwortFrame
# check if errorcode is in the list
if not GSV6_ErrorCodes.error_code_to_error_shortcut.has_key(b):
# in this scope we can't pop (del) first byte -> idea: blank the 0xAA
self.inDataBuffer[0] = 0x00
logging.getLogger('serial2ws.WAMP_Component.GSV_6Protocol').trace(
"[break] can't find errorcode ins list.")
break
else:
# if no payload there, stepover state3
if payloadLength > 0:
state = 3
else:
state = 4
else:
# any other frametype is not allow: drop
# in this scope we can't pop (del) first byte -> idea: blank the 0xAA
self.inDataBuffer[0] = 0x00
logging.getLogger('serial2ws.WAMP_Component.GSV_6Protocol').trace(
'[break] other FrameType detected.')
break
# if not -> drop: state=0;counter=0;drop incommingDataBuffer.pop(0), tempArray=[]
# if payload>6*4Byte, drop also
elif state == 3:
logging.getLogger('serial2ws.WAMP_Component.GSV_6Protocol').trace(
'counter-state: ' + str((counter - state)))
if payloadLength == (counter - state):
state = 4
# so we got the whole payload goto state=4
elif state == 4:
# at the first time in state 4, we have to break
# if b== 0x85 -> we have a complete Frame; pushback the complete Frame and remove copyed bytes from incommingBuffer and break For-Loop
if not (b == 0x85):
# in this scope we can't pop (del) first byte -> idea: blank the 0xAA
self.inDataBuffer[0] = 0x00
logging.getLogger('serial2ws.WAMP_Component.GSV_6Protocol').trace("[break] can't find 0x85")
else:
logging.getLogger('serial2ws.WAMP_Component.GSV_6Protocol').trace('[break] found an complete Frame')
foundcompleteframe = True
# okay we strip sync bytes 0xAA and 0x85 in this function
# strip 0x85 in state 4
del tempArray[-1]
#logging.getLogger('serial2ws.WAMP_Component.SerialProtocol').debug('[serialRcv] Data: ' + ' '.join(format(z, '02x') for z in tempArray))
# pushback data here!
# publish WAMP event to all subscribers on topic
##
frame = GSV6_BasicFrameType.BasicFrame(tempArray)
# self.frameQueue.append(frame)
try:
self.frameQueue.put_nowait(frame)
except Full:
logging.getLogger('serial2ws.WAMP_Component.GSV_6Protocol').warning(
'a complete Frame was droped, because Queue was full')
logging.getLogger('serial2ws.WAMP_Component.GSV_6Protocol').trace(
'[serial] Received compelte Frame: ' + ' '.join(format(x, '02x') for x in bytearray(tempArray)))
# break anyway
break
# else drop last <counter> bytes and retry sync
if foundcompleteframe:
# remove copyed items
self.inDataBuffer[0:counter - 1] = []
logging.getLogger('serial2ws.WAMP_Component.GSV_6Protocol').trace(
'new inDataBuffer[0]: ' + ' '.join(format(self.inDataBuffer[0], '02x')))
# at this point we have to test, if we have enougth data for a second frame
# execute this function again if (recursion == -1 and len(incommingBuffer>4) or ()
lenthOfData = len(self.inDataBuffer)
if (lenthOfData > 3) and (recursion != lenthOfData):
logging.getLogger('serial2ws.WAMP_Component.GSV_6Protocol').trace('[rec] start rec')
self.checkForCompleteFrame(lenthOfData)
else:
logging.getLogger('serial2ws.WAMP_Component.GSV_6Protocol').trace('[rec] no more rec')
def write(self, data):
self.transport.write(data)