-
-
Notifications
You must be signed in to change notification settings - Fork 238
/
Copy pathelm.py
1468 lines (1256 loc) · 54.4 KB
/
elm.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
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/python3
# -*- coding: utf-8 -*-
'''module contains class for working with ELM327
version: 160829
Borrowed code from PyRen (modified for this use)
'''
import os
import re
import string
import sys
import time
from datetime import datetime
import serial
from serial.tools import list_ports
import options
_ = options.translator('ddt4all')
# //TODO missing entries this need look side ecu addressing missing entries or ignore {}
dnat_entries = {"E7": "7E4", "E8": "644"}
snat_entries = {"E7": "7EC", "E8": "5C4"}
snat = dnat_entries
snat_ext = {}
dnat = snat_entries
dnat_ext = {}
# Code snippet from https://github.com/rbei-etas/busmaster
negrsp = {"10": "NR: General Reject",
"11": "NR: Service Not Supported",
"12": "NR: SubFunction Not Supported",
"13": "NR: Incorrect Message Length Or Invalid Format",
"21": "NR: Busy Repeat Request",
"22": "NR: Conditions Not Correct Or Request Sequence Error",
"23": "NR: Routine Not Complete",
"24": "NR: Request Sequence Error",
"31": "NR: Request Out Of Range",
"33": "NR: Security Access Denied- Security Access Requested ",
"35": "NR: Invalid Key",
"36": "NR: Exceed Number Of Attempts",
"37": "NR: Required Time Delay Not Expired",
"40": "NR: Download not accepted",
"41": "NR: Improper download type",
"42": "NR: Can not download to specified address",
"43": "NR: Can not download number of bytes requested",
"50": "NR: Upload not accepted",
"51": "NR: Improper upload type",
"52": "NR: Can not upload from specified address",
"53": "NR: Can not upload number of bytes requested",
"70": "NR: Upload Download NotAccepted",
"71": "NR: Transfer Data Suspended",
"72": "NR: General Programming Failure",
"73": "NR: Wrong Block Sequence Counter",
"74": "NR: Illegal Address In Block Transfer",
"75": "NR: Illegal Byte Count In Block Transfer",
"76": "NR: Illegal Block Transfer Type",
"77": "NR: Block Transfer Data Checksum Error",
"78": "NR: Request Correctly Received-Response Pending",
"79": "NR: Incorrect ByteCount During Block Transfer",
"7E": "NR: SubFunction Not Supported In Active Session",
"7F": "NR: Service Not Supported In Active Session",
"80": "NR: Service Not Supported In Active Diagnostic Mode",
"81": "NR: Rpm Too High",
"82": "NR: Rpm Too Low",
"83": "NR: Engine Is Running",
"84": "NR: Engine Is Not Running",
"85": "NR: Engine RunTime TooLow",
"86": "NR: Temperature Too High",
"87": "NR: Temperature Too Low",
"88": "NR: Vehicle Speed Too High",
"89": "NR: Vehicle Speed Too Low",
"8A": "NR: Throttle/Pedal Too High",
"8B": "NR: Throttle/Pedal Too Low",
"8C": "NR: Transmission Range In Neutral",
"8D": "NR: Transmission Range In Gear",
"8F": "NR: Brake Switch(es)NotClosed (brake pedal not pressed or not applied)",
"90": "NR: Shifter Lever Not In Park ",
"91": "NR: Torque Converter Clutch Locked",
"92": "NR: Voltage Too High",
"93": "NR: Voltage Too Low"
}
cmdb = '''
#v1.0 ;AC P; ATZ ; Z ; reset all
#v1.0 ;AC P; ATE1 ; E0, E1 ; Echo off, or on*
#v1.0 ;AC P; ATL0 ; L0, L1 ; Linefeeds off, or on
#v1.0 ;AC ; ATI ; I ; print the version ID
#v1.0 ;AC ; AT@1 ; @1 ; display the device description
#v1.0 ;AC P; ATAL ; AL ; Allow Long (>7 byte) messages
#v1.0 ;AC ; ATBD ; BD ; perform a Buffer Dump
#V1.0 ;ACH ; ATSP4 ; SP h ; Set Protocol to h and save it
#v1.0 ;AC ; ATBI ; BI ; Bypass the Initialization sequence
#v1.0 ;AC P; ATCAF0 ; CAF0, CAF1 ; Automatic Formatting off, or on*
#v1.0 ;AC ; ATCFC1 ; CFC0, CFC1 ; Flow Controls off, or on*
#v1.0 ;AC ; ATCP 01 ; CP hh ; set CAN Priority to hh (29 bit)
#v1.0 ;AC ; ATCS ; CS ; show the CAN Status counts
#v1.0 ;AC ; ATCV 1250 ; CV dddd ; Calibrate the Voltage to dd.dd volts
#v1.0 ;AC ; ATD ; D ; set all to Defaults
#v1.0 ;AC ; ATDP ; DP ; Describe the current Protocol
#v1.0 ;AC ; ATDPN ; DPN ; Describe the Protocol by Number
#v1.0 ;AC P; ATH0 ; H0, H1 ; Headers off*, or on
#v1.0 ;AC ; ATI ; I ; print the version ID
#v1.0 ;AC P; ATIB 10 ; IB 10 ; set the ISO Baud rate to 10400*
#v1.0 ;AC ; ATIB 96 ; IB 96 ; set the ISO Baud rate to 9600
#v1.0 ;AC ; ATL1 ; L0, L1 ; Linefeeds off, or on
#v1.0 ;AC ; ATM0 ; M0, M1 ; Memory off, or on
#v1.0 ; C ; ATMA ; MA ; Monitor All
#v1.0 ; C ; ATMR 01 ; MR hh ; Monitor for Receiver = hh
#v1.0 ; C ; ATMT 01 ; MT hh ; Monitor for Transmitter = hh
#v1.0 ;AC ; ATNL ; NL ; Normal Length messages*
#v1.0 ;AC ; ATPC ; PC ; Protocol Close
#v1.0 ;AC ; ATR1 ; R0, R1 ; Responses off, or on*
#v1.0 ;AC ; ATRV ; RV ; Read the input Voltage
#v1.0 ;ACH ; ATSP7 ; SP h ; Set Protocol to h and save it
#v1.0 ;ACH ; ATSH 00000000 ; SH wwxxyyzz ; Set Header to wwxxyyzz
#v1.0 ;AC ; ATSH 001122 ; SH xxyyzz ; Set Header to xxyyzz
#v1.0 ;AC P; ATSH 012 ; SH xyz ; Set Header to xyz
#v1.0 ;AC ; ATSP A6 ; SP Ah ; Set Protocol to Auto, h and save it
#v1.0 ;AC ; ATSP 6 ; SP h ; Set Protocol to h and save it
#v1.0 ;AC ; ATCM 123 ; CM hhh ; set the ID Mask to hhh
#v1.0 ;AC ; ATCM 12345678 ; CM hhhhhhhh ; set the ID Mask to hhhhhhhh
#v1.0 ;AC ; ATCF 123 ; CF hhh ; set the ID Filter to hhh
#v1.0 ;AC ; ATCF 12345678 ; CF hhhhhhhh ; set the ID Filter to hhhhhhhh
#v1.0 ;AC P; ATST FF ; ST hh ; Set Timeout to hh x 4 msec
#v1.0 ;AC P; ATSW 96 ; SW 00 ; Stop sending Wakeup messages
#v1.0 ;AC P; ATSW 34 ; SW hh ; Set Wakeup interval to hh x 20 msec
#v1.0 ;AC ; ATTP A6 ; TP Ah ; Try Protocol h with Auto search
#v1.0 ;AC ; ATTP 6 ; TP h ; Try Protocol h
#v1.0 ;AC P; ATWM 817AF13E ; WM [1 - 6 bytes] ; set the Wakeup Message
#v1.0 ;AC P; ATWS ; WS ; Warm Start (quick software reset)
#v1.1 ;AC P; ATFC SD 300000 ; FC SD [1 - 5 bytes]; FC, Set Data to [...]
#v1.1 ;AC P; ATFC SH 012 ; FC SH hhh ; FC, Set the Header to hhh
#v1.1 ;AC P; ATFC SH 00112233 ; FC SH hhhhhhhh ; Set the Header to hhhhhhhh
#v1.1 ;AC P; ATFC SM 1 ; FC SM h ; Flow Control, Set the Mode to h
#v1.1 ;AC ; ATPP FF OFF ; PP FF OFF ; all Prog Parameters disabled
#v1.1 ;AC ; ATPP FF ON ; PP FF ON ; all Prog Parameters enabled
#v1.1 ; ; ; PP xx OFF ; disable Prog Parameter xx
#v1.1 ; ; ; PP xx ON ; enable Prog Parameter xx
#v1.1 ; ; ; PP xx SV yy ; for PP xx, Set the Value to yy
#v1.1 ;AC ; ATPPS ; PPS ; print a PP Summary
#v1.2 ;AC ; ATAR ; AR ; Automatically Receive
#v1.2 ;AC 0; ATAT1 ; AT0, 1, 2 ; Adaptive Timing off, auto1*, auto2
#v1.2 ; ; ; BRD hh ; try Baud Rate Divisor hh
#v1.2 ; ; ; BRT hh ; set Baud Rate Timeout
#v1.2 ;ACH ; ATSPA ; SP h ; Set Protocol to h and save it
#v1.2 ; C ; ATDM1 ; DM1 ; monitor for DM1 messages
#v1.2 ; C ; ATIFR H ; IFR H, S ; IFR value from Header* or Source
#v1.2 ; C ; ATIFR0 ; IFR0, 1, 2 ; IFRs off, auto*, or on
#v1.2 ;AC ; ATIIA 01 ; IIA hh ; set ISO (slow) Init Address to hh
#v1.2 ;AC ; ATKW0 ; KW0, KW1 ; Key Word checking off, or on*
#v1.2 ; C ; ATMP 0123 ; MP hhhh ; Monitor for PGN 0hhhh
#v1.2 ; C ; ATMP 0123 4 ; MP hhhh n ; and get n messages
#v1.2 ; C ; ATMP 012345 ; MP hhhhhh ; Monitor for PGN hhhhhh
#v1.2 ; C ; ATMP 012345 6 ; MP hhhhhh n ; and get n messages
#v1.2 ;AC ; ATSR 01 ; SR hh ; Set the Receive address to hh
#v1.3 ; ; AT@2 ; @2 ; display the device identifier
#v1.3 ;AC P; ATCRA 012 ; CRA hhh ; set CAN Receive Address to hhh
#v1.3 ;AC ; ATCRA 01234567 ; CRA hhhhhhhh ; set the Rx Address to hhhhhhhh
#v1.3 ;AC ; ATD0 ; D0, D1 ; display of the DLC off*, or on
#v1.3 ;AC ; ATFE ; FE ; Forget Events
#v1.3 ;AC ; ATJE ; JE ; use J1939 Elm data format*
#v1.3 ;AC ; ATJS ; JS ; use J1939 SAE data format
#v1.3 ;AC ; ATKW ; KW ; display the Key Words
#v1.3 ;AC ; ATRA 01 ; RA hh ; set the Receive Address to hh
#v1.3 ;ACH ; ATSP6 ; SP h ; Set Protocol to h and save it
#v1.3 ;ACH ; ATRTR ; RTR ; send an RTR message
#v1.3 ;AC ; ATS1 ; S0, S1 ; printing of aces off, or on*
#v1.3 ;AC ; ATSP 00 ; SP 00 ; Erase stored protocol
#v1.3 ;AC ; ATV0 ; V0, V1 ; use of Variable DLC off*, or on
#v1.4 ;AC ; ATCEA ; CEA ; turn off CAN Extended Addressing
#v1.4 ;AC ; ATCEA 01 ; CEA hh ; use CAN Extended Address hh
#v1.4 ;AC ; ATCV 0000 ; CV 0000 ; restore CV value to factory setting
#v1.4 ;AC ; ATIB 48 ; IB 48 ; set the ISO Baud rate to 4800
#v1.4 ;AC ; ATIGN ; IGN ; read the IgnMon input level
#v1.4 ; ; ; LP ; go to Low Power mode
#v1.4 ;AC ; ATPB 01 23 ; PB xx yy ; Protocol B options and baud rate
#v1.4 ;AC ; ATRD ; RD ; Read the stored Data
#v1.4 ;AC ; ATSD 01 ; SD hh ; Save Data byte hh
#v1.4 ;ACH ; ATSP4 ; SP h ; Set Protocol to h and save it
#v1.4 ;AC P; ATSI ; SI ; perform a Slow (5 baud) Initiation
#v1.4 ;ACH ; ATZ ; Z ; reset all
#v1.4 ;ACH ; ATSP5 ; SP h ; Set Protocol to h and save it
#v1.4 ;AC P; ATFI ; FI ; perform a Fast Initiation
#v1.4 ;ACH ; ATZ ; Z ; reset all
#v1.4 ;AC ; ATSS ; SS ; use Standard Search order (J1978)
#v1.4 ;AC ; ATTA 12 ; TA hh ; set Tester Address to hh
#v1.4 ;ACH ; ATSPA ; SP h ; Set Protocol to h and save it
#v1.4 ;AC ; ATCSM1 ; CSM0, CSM1 ; Silent Monitoring off, or on*
#v1.4 ;AC ; ATJHF1 ; JHF0, JHF1 ; Header Formatting off, or on*
#v1.4 ;AC ; ATJTM1 ; JTM1 ; set Timer Multiplier to 1*
#v1.4 ;AC ; ATJTM5 ; JTM5 ; set Timer Multiplier to 5
#v1.4b;AC ; ATCRA ; CRA ; reset the Receive Address filters
#v2.0 ;AC ; ATAMC ; AMC ; display Activity Monitor Count
#v2.0 ;AC ; ATAMT 20 ; AMT hh ; set the Activity Mon Timeout to hh
#v2.1 ;AC ; ATCTM1 ; CTM1 ; set Timer Multiplier to 1*
#v2.1 ;AC ; ATCTM5 ; CTM5 ; set Timer Multiplier to 5
#v2.1 ;ACH ; ATZ ; Z ; reset all
'''
def addr_exist(addr):
result = True
if addr not in dnat:
if addr not in dnat_ext:
result = False
return result
def get_can_addr(txa):
for d in dnat.keys():
if dnat[d].upper() == txa.upper():
return d
return None
def get_can_addr_ext(txa):
for d in dnat_ext.keys():
if dnat_ext[d].upper() == txa.upper():
return d
return None
def get_can_addr_snat(txa):
for d in snat.keys():
if snat[d].upper() == txa.upper():
return d
return None
def get_can_addr_snat_ext(txa):
for d in snat_ext.keys():
if snat_ext[d].upper() == txa.upper():
return d
return None
def item_count(items):
return sum(1 for _ in items)
def get_available_ports():
ports = []
portlist = list_ports.comports()
if item_count(portlist) == 0:
return
iterator = sorted(list(portlist))
for port, desc, hwid in iterator:
ports.append((port, desc))
return ports
def reconnect_elm():
ports = get_available_ports()
current_adapter = "STD"
if options.elm:
current_adapter = options.elm.adapter_type
for port, desc in ports:
if desc == options.port_name:
options.elm = ELM(port, options.port_speed, current_adapter)
return True
return False
def errorval(val):
if val not in negrsp:
return "Unregistered error"
if val in negrsp.keys():
return negrsp[val]
class Port:
'''This is a serial port or a TCP-connection
if portName looks like a 192.168.0.10:35000
then it is wifi and we should open tcp connection
else try to open serial port
'''
connectionStatus = False
portType = 0 # 0-serial 1-tcp
ipaddr = '192.168.0.10'
tcpprt = 35000
portName = ""
portTimeout = 5 # don't change it here. Change in ELM class
droid = None
btcid = None
hdr = None
tcp_needs_reconnect = False
def __init__(self, portName, speed, portTimeout):
options.elm_failed = False
self.portTimeout = portTimeout
portName = portName.strip()
if re.match(r"^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}:\d{1,5}$", portName):
import socket
self.ipaddr, self.tcpprt = portName.split(':')
self.tcpprt = int(self.tcpprt)
self.portType = 1
self.init_wifi()
else:
self.portName = portName
self.portType = 0
try:
self.hdr = serial.Serial(self.portName, baudrate=speed, timeout=portTimeout,
parity=serial.PARITY_NONE, stopbits=serial.STOPBITS_ONE)
print(self.hdr)
self.connectionStatus = True
return
except Exception as e:
print(_("Error: ") + str(e))
print(_("ELM not connected or wrong COM port"), portName)
options.last_error = _("Error: ") + str(e)
options.elm_failed = True
def close(self):
try:
self.hdr.close()
print(_("Port closed"))
except:
pass
def init_wifi(self, reinit=False):
'''
Needed for wifi adapters with short connection timeout
'''
if self.portType != 1:
return
import socket
if reinit:
self.hdr.close()
self.hdr = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
self.hdr.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)
try:
self.hdr.connect((self.ipaddr, self.tcpprt))
self.hdr.setblocking(True)
self.connectionStatus = True
except:
options.elm_failed = True
def read_byte(self):
try:
byte = b""
if self.portType == 1:
import socket
try:
byte = self.hdr.recv(1)
print(str(byte))
except socket.timeout:
self.tcp_needs_reconnect = True
except Exception as e:
print(e)
elif self.portType == 2:
if self.droid.bluetoothReadReady():
byte = self.droid.bluetoothRead(1).result
else:
if self.hdr.inWaiting():
byte = self.hdr.read()
except:
print('*' * 40)
print('* ' + _('Connection to ELM was lost'))
self.connectionStatus = False
self.close()
return None
return byte
def read(self):
try:
byte = b""
if self.portType == 1:
import socket
try:
byte = self.hdr.recv(1)
print(str(byte))
except socket.timeout:
self.tcp_needs_reconnect = True
except Exception as e:
print(e)
elif self.portType == 2:
if self.droid.bluetoothReadReady():
byte = self.droid.bluetoothRead(1).result
else:
if self.hdr.inWaiting():
byte = self.hdr.read()
except:
print('*' * 40)
print('* ' + _('Connection to ELM was lost'))
self.connectionStatus = False
self.close()
return None
try:
return byte.decode("utf-8")
except:
print(_("Cannot decode bytes ") + str(byte))
return ""
def change_rate(self, rate):
self.hdr.baudrate = rate
def write(self, data):
try:
if self.portType == 1:
if self.tcp_needs_reconnect:
self.tcp_needs_reconnect = False
self.init_wifi(True)
return self.hdr.sendall(data)
elif self.portType == 2:
return self.droid.bluetoothWrite(data)
else:
return self.hdr.write(data)
except:
print('*' * 40)
print('* ' + _('Connection to ELM was lost'))
self.connectionStatus = False
self.close()
def expect_carriage_return(self, time_out=1):
tb = time.time() # start time
self.buff = b""
while True:
if not options.simulation_mode:
byte = self.read_byte()
else:
byte = '>'
if byte:
self.buff += byte
tc = time.time()
if b'\r' in self.buff:
return self.buff.decode('utf8')
if (tc - tb) > time_out:
return self.buff + b"TIMEOUT"
# self.close()
# self.connectionStatus = False
# return ''
def expect(self, pattern, time_out=1):
tb = time.time() # start time
self.buff = ""
while True:
if not options.simulation_mode:
byte = self.read()
else:
byte = '>'
if byte == '\r':
byte = '\n'
if byte:
self.buff += byte
tc = time.time()
if pattern in self.buff:
return self.buff
if (tc - tb) > time_out:
return self.buff + _("TIMEOUT")
# self.close()
# self.connectionStatus = False
# return ''
def check_elm(self):
self.hdr.timeout = 2
for s in [38400, 115200, 230400, 57600, 9600, 500000]:
print("\r\t\t\t\t\r" + _("Checking port speed:"), s, )
sys.stdout.flush()
self.hdr.baudrate = s
self.hdr.flushInput()
self.write("\r")
# search > string
tb = time.time() # start time
self.buff = ""
while (True):
if not options.simulation_mode:
byte = self.read()
else:
byte = '>'
self.buff += byte
tc = time.time()
if '>' in self.buff:
options.port_speed = s
print("\n" + _("Start COM speed :"), s)
self.hdr.timeout = self.portTimeout
return True
if (tc - tb) > 1:
break
print("\n" + _("ELM not responding"))
return False
class ELM:
'''ELM327 class'''
port = 0
lf = 0
vf = 0
keepAlive = 4 # send startSession to CAN after silence if startSession defined
busLoad = 0 # I am sure than it should be zero
srvsDelay = 0 # the delay next command requested by service
lastCMDtime = 0 # time when last command was sent to bus
portTimeout = 5 # timeout of port (com or tcp)
elmTimeout = 0 # timeout set by ATST
# error counters
error_frame = 0
error_bufferfull = 0
error_question = 0
error_nodata = 0
error_timeout = 0
error_rx = 0
error_can = 0
canline = 0
response_time = 0
buff = ""
currentprotocol = ""
currentsubprotocol = ""
currentaddress = ""
startSession = ""
lastinitrsp = ""
rsp_cache = {}
l1_cache = {}
ATR1 = True
ATCFC0 = False
portName = ""
lastMessage = ""
monitorstop = False
connectionStatus = False
def __init__(self, portName, rate, adapter_type="STD", maxspeed="No"):
for speed in [int(rate), 38400, 115200, 230400, 57600, 9600, 500000, 1000000, 2000000]:
print(_("Trying to open port ") + "%s @ %i" % (portName, speed))
self.sim_mode = options.simulation_mode
self.portName = portName
self.adapter_type = adapter_type
if not options.simulation_mode:
self.port = Port(portName, speed, self.portTimeout)
if options.elm_failed:
self.connectionStatus = False
# Try one other speed ...
continue
if not os.path.exists("./logs"):
os.mkdir("./logs")
if len(options.log) > 0:
self.lf = open("./logs/elm_" + options.log + ".txt", "at", encoding="utf-8")
self.vf = open("./logs/ecu_" + options.log + ".txt", "at", encoding="utf-8")
self.vf.write(
"Timestamp;ECU_CAN_Address_HEX;Raw_Command_HEX;Raw_Response_HEX_or_STR;Error_message_if_happens\n")
self.lastCMDtime = 0
self.ATCFC0 = options.opt_cfc0
# Purge unread data
self.port.expect(">")
res = self.send_raw("ATZ")
if 'ELM' in res or 'OBDII' in res:
options.last_error = ""
options.elm_failed = False
self.connectionStatus = True
rate = speed
break
else:
options.elm_failed = True
options.last_error = _("No ELM interface on port") + " %s" % portName
try:
maxspeed = int(maxspeed)
except:
maxspeed = 0
if adapter_type == "OBDLINK" and maxspeed > 0 and not options.elm_failed and rate != 2000000:
print(_("OBDLink Connection OK, attempting full speed UART switch"))
try:
self.raise_odb_speed(maxspeed)
except:
options.elm_failed = True
self.connectionStatus = False
print(_("Failed to switch to change OBDLink to ") + str(maxspeed))
elif adapter_type == "STD_USB" and rate != 115200 and maxspeed > 0:
print(_("ELM Connection OK, attempting high speed UART switch"))
try:
self.raise_elm_speed(maxspeed)
except:
options.elm_failed = True
self.connectionStatus = False
print(_("Failed to switch to change ELM to ") + str(maxspeed))
def raise_odb_speed(self, baudrate):
# Software speed switch
res = self.port.write(("ST SBR " + str(baudrate) + "\r").encode('utf-8'))
# Command echo
res = self.port.expect_carriage_return()
# Command result
res = self.port.expect_carriage_return()
if "OK" in res:
print(_("OBDLINK switched baurate OK, changing UART speed now..."))
self.port.change_rate(baudrate)
time.sleep(0.5)
res = self.send_raw("STI").replace("\n", "").replace(">", "").replace("STI", "")
if "STN" in res:
print(_("OBDLink full speed connection OK"))
print(_("OBDLink Version ") + res)
else:
raise
else:
raise
def raise_elm_speed(self, baudrate):
# Software speed switch to 115Kbps
if baudrate == 57600:
res = self.port.write("ATBRD 45\r".encode("utf-8"))
elif baudrate == 115200:
res = self.port.write("ATBRD 23\r".encode("utf-8"))
elif baudrate == 230400:
res = self.port.write("ATBRD 11\r".encode("utf-8"))
elif baudrate == 500000:
res = self.port.write("ATBRD 8\r".encode("utf-8"))
else:
return
# Command echo
res = self.port.expect_carriage_return()
# Command result
res = self.port.expect_carriage_return()
if "OK" in res:
print(_("ELM baudrate switched OK, changing UART speed now..."))
self.port.change_rate(baudrate)
version = self.port.expect_carriage_return()
if "ELM327" in version:
self.port.write('\r'.encode('utf-8'))
res = self.port.expect('>')
if "OK" in res:
print(_("ELM full speed connection OK "))
print(_("Version ") + version)
else:
raise
else:
raise
else:
print(_("Your ELM does not support baudrate ") + str(baudrate))
raise
def __del__(self):
try:
print(_("ELM reset..."))
self.port.write("ATZ\r".encode("utf-8"))
except:
pass
def connectionStat(self):
return self.port.connectionStatus
def clear_cache(self):
''' Clear L2 cache before screen update
'''
self.rsp_cache = {}
def request(self, req, positive='', cache=True, serviceDelay="0"):
''' Check if request is saved in L2 cache.
If not then
- make real request
- convert responce to one line
- save in L2 cache
returns response without consistency check
'''
if cache and req in self.rsp_cache.keys():
return self.rsp_cache[req]
# send cmd
rsp = self.cmd(req, serviceDelay)
if 'WRONG' in rsp:
return rsp
res = ""
if self.currentprotocol != "can":
# Trivially reject first line (echo)
rsp_split = rsp.split('\n')[1:]
for s in rsp_split:
if '>' not in s:
res += s.strip() + ' '
else:
# parse response
for s in rsp.split('\n'):
if ':' in s:
res += s[2:].strip() + ' '
else: # response consists only of one frame
if s.replace(' ', '').startswith(positive.replace(' ', '')):
res += s.strip() + ' '
rsp = res
# populate L2 cache
self.rsp_cache[req] = rsp
# save log
if self.vf != 0:
tmstr = datetime.now().strftime("%H:%M:%S.%f")[:-3]
if self.currentaddress in dnat_ext and len(self.currentaddress) == 8:
self.vf.write(tmstr + ";" + "0x" + dnat_ext[
self.currentaddress] + ";" + "0x" + req + ";" + "0x" + rsp.rstrip().replace(" ",
",0x") + ";" + "\n")
elif self.currentaddress in dnat:
self.vf.write(tmstr + ";" + "0x" + dnat[
self.currentaddress] + ";" + "0x" + req + ";" + "0x" + rsp.rstrip().replace(" ",
",0x") + ";" + "\n")
else:
print(_("Unknown address: "), self.currentaddress, "0x" + req, "0x" + rsp)
self.vf.flush()
return rsp
def errorval(self, val):
if val not in negrsp:
return "not registered error"
if val in negrsp.keys():
return negrsp[val]
def cmd(self, command, serviceDelay="0"):
tb = time.time() # start time
# Ensure time gap between commands
dl = self.busLoad + self.srvsDelay - tb + self.lastCMDtime
if ((tb - self.lastCMDtime) < (self.busLoad + self.srvsDelay)) \
and ("AT" not in command.upper() or "ST" not in command.upper()):
time.sleep(self.busLoad + self.srvsDelay - tb + self.lastCMDtime)
tb = time.time() # renew start time
# If we use wifi and there was more than keepAlive seconds of silence then reinit tcp
if (tb - self.lastCMDtime) > self.keepAlive:
self.port.init_wifi(True)
# If we are on CAN and there was more than keepAlive seconds of silence and
# start_session_can was executed then send startSession command again
# if ((tb-self.lastCMDtime)>self.keepAlive and self.currentprotocol=="can"
if ((tb - self.lastCMDtime) > self.keepAlive
and self.currentprotocol == "can"
and len(self.startSession) > 0):
# log KeepAlive event
if self.lf != 0:
tmstr = datetime.now().strftime("%H:%M:%S.%f")[:-3]
self.lf.write("#[" + tmstr + "]" + "KeepAlive\n")
self.lf.flush()
# send keepalive
self.send_cmd(self.startSession)
self.lastCMDtime = time.time() # for not to get into infinite loop
# send command
cmdrsp = self.send_cmd(command)
self.lastCMDtime = tc = time.time()
# add srvsDelay to time gap before send next command
self.srvsDelay = float(serviceDelay) / 1000.
# check for negative response
for l in cmdrsp.split('\n'):
l = l.strip().upper()
if l.startswith("7F") and len(l) == 8 and l[6:8] in negrsp.keys():
print(l, negrsp[l[6:8]])
if self.lf != 0:
self.lf.write("#[" + str(tc - tb) + "] rsp:" + l + ":" + negrsp[l[6:8]] + "\n")
self.lf.flush()
return cmdrsp
def set_can_timeout(self, value):
val = value // 4
if val > 255:
val = 255
val = hex(val)[2:].upper().zfill(2)
self.cmd("AT ST %s" % val)
def send_cmd(self, command):
if "AT" in command.upper() or "ST" in command.upper() or self.currentprotocol != "can":
return self.send_raw(command)
if self.ATCFC0:
return self.send_can_cfc0(command)
else:
rsp = self.send_can(command)
return rsp
def send_can(self, command):
command = command.strip().replace(' ', '')
if len(command) % 2 != 0 or len(command) == 0:
return "ODD ERROR"
if not all(c in string.hexdigits for c in command):
return "HEX ERROR"
# do framing
raw_command = []
cmd_len = int(len(command) / 2)
if cmd_len < 8: # single frame
# check L1 cache here
if command in self.l1_cache.keys():
raw_command.append(("%0.2X" % cmd_len) + command + self.l1_cache[command])
else:
raw_command.append(("%0.2X" % cmd_len) + command)
else:
# first frame
raw_command.append("1" + ("%0.3X" % cmd_len)[-3:] + command[:12])
command = command[12:]
# consecutive frames
frame_number = 1
while (len(command)):
raw_command.append("2" + ("%X" % frame_number)[-1:] + command[:14])
frame_number = frame_number + 1
command = command[14:]
responses = []
# send frames
for f in raw_command:
# send next frame
frsp = self.send_raw(f)
# analyse response (1 phase)
for s in frsp.split('\n'):
if s.strip() == f: # echo cancellation
continue
s = s.strip().replace(' ', '')
if len(s) == 0: # empty string
continue
if all(c in string.hexdigits for c in s): # some data
if s[:1] == '3': # flow control, just ignore it in this version
continue
responses.append(s)
# analyse response (2 phases)
result = ""
noerrors = True
cframe = 0 # frame counter
nbytes = 0 # number bytes in response
nframes = 0
if len(responses) == 0: # no data in response
return ""
if len(responses) > 1 and responses[0].startswith('037F') and responses[0][6:8] == '78':
responses = responses[1:]
if len(responses) == 1: # single frame response
if responses[0][:1] == '0':
nbytes = int(responses[0][1:2], 16)
nframes = 1
result = responses[0][2:2 + nbytes * 2]
else: # wrong response (not all frames received)
self.error_frame += 1
noerrors = False
else: # multi frame response
if responses[0][:1] == '1': # first frame
nbytes = int(responses[0][1:4], 16)
nframes = nbytes / 7 + 1
cframe = 1
result = responses[0][4:16]
else: # wrong response (first frame omitted)
self.error_frame += 1
noerrors = False
for fr in responses[1:]:
if fr[:1] == '2': # consecutive frames
tmp_fn = int(fr[1:2], 16)
if tmp_fn != (cframe % 16): # wrong response (frame lost)
self.error_frame += 1
noerrors = False
continue
cframe += 1
result += fr[2:16]
else: # wrong response
self.error_frame += 1
noerrors = False
errorstr = "Unknown"
# check for negative response (repeat the same as in cmd())
if result[:2] == '7F':
noerrors = False
if result[4:6] in negrsp.keys():
errorstr = negrsp[result[4:6]]
if self.vf != 0:
tmstr = datetime.now().strftime("%H:%M:%S.%f")[:-3]
if self.currentaddress in dnat_ext and len(self.currentaddress) == 8:
self.vf.write(tmstr + ";" + dnat_ext[
self.currentaddress] + ";" + "0x" + command + ";" + result + ";" + errorstr + "\n")
elif self.currentaddress in dnat:
self.vf.write(tmstr + ";" + dnat[
self.currentaddress] + ";" + "0x" + command + ";" + result + ";" + errorstr + "\n")
self.vf.flush()
# populate L1 cache
if noerrors and nframes < 16 and command[:1] == '2' and not options.opt_n1c:
self.l1_cache[command] = str(nframes)
if len(result) / 2 >= nbytes and noerrors:
# Remove unnecessary bytes
result = result[0:nbytes * 2]
# split by bytes and return
result = ' '.join(a + b for a, b in zip(result[::2], result[1::2]))
return result
else:
return "WRONG RESPONSE : " + errorstr + "(" + result + ")"
def send_can_cfc0(self, command):
command = command.strip().replace(' ', '')
if len(command) % 2 != 0 or len(command) == 0:
return "ODD ERROR"
if not all(c in string.hexdigits for c in command):
return "HEX ERROR"
# do framing
raw_command = []
cmd_len = int(len(command) / 2)
if cmd_len < 8: # single frame
raw_command.append(("%0.2X" % cmd_len) + command)
else:
# first frame
raw_command.append("1" + ("%0.3X" % cmd_len)[-3:] + command[:12])
command = command[12:]
# consecutive frames
frame_number = 1
while len(command):
raw_command.append("2" + ("%X" % frame_number)[-1:] + command[:14])
frame_number += 1
command = command[14:]
responses = []
# send frames
BS = 1 # Burst Size
ST = 0 # Frame Interval
Fc = 0 # Current frame
Fn = len(raw_command) # Number of frames
if Fn > 1 or len(raw_command[0]) > 15:
if options.cantimeout > 0:
self.set_can_timeout(options.cantimeout)
else:
# set elm timeout to 300ms for first response
self.send_raw('AT ST 4B')
while Fc < Fn:
# enable responses
if not self.ATR1:
frsp = self.send_raw('AT R1')
self.ATR1 = True
tb = time.time() # time of sending (ff)
if Fn > 1 and Fc == (Fn - 1): # set elm timeout to maximum for last response on long command
self.send_raw('AT ST FF')
self.send_raw('AT AT 1')
if (Fc == 0 or Fc == (Fn - 1)) and len(
raw_command[Fc]) < 16: # first or last frame in command and len<16 (bug in ELM)
frsp = self.send_raw(raw_command[Fc] + '1') # we'll get only 1 frame: nr, fc, ff or sf
else:
frsp = self.send_raw(raw_command[Fc])
Fc = Fc + 1
# analyse response
for s in frsp.split('\n'):
if s.strip()[:len(raw_command[Fc - 1])] == raw_command[Fc - 1]: # echo cancelation
continue
s = s.strip().replace(' ', '')
if len(s) == 0: # empty string
continue