Skip to content

DOT Parse

CC Anti-Canape: CC DOT Parsing Application

Author: Chris Hinkson
Email: Christopher.Hinkson@clubcar.com

Desc: This application is designed to parse a Club Car DOT file and save the data as json files for easy interaction with python dictionaries. This will make it easier to use CAN communication in python, specifically writing.

Github: https://github.com/chrisInTheCode/CC-DOT-AutoParse
--> To get access to the github repository, please send me an email at the above address

References:
--> https://docs.python.org/3/library/json.html
--> https://docs.python.org/3/library/os.html
--> https://docs.python.org/3/library/collections.html#collections.defaultdict

dotParse

The application presents a central dotParse() class that can be used as a parsed-dot directory. It includes the following features: - Initialization of empty dictionaries to declare space usage along with empty variable lookup - parseNewDOT(filepath) method to load a given DBC into all of the dictionaries - dumpDictionaries() method to save the current dictionaries as json files in the 'dictionaries' folder - loadDictionaries() method to load the json files in the 'dictionaries' folder as current dictionaries - Several support methods for getting relevant data by lookup with hex ID, decimal ID, or parameter name

Examples:

currentDOT = dotParse() currentDOT.parseNewDOT("DiagnosticsObjectTableV14.xlsx") print(currentDOT.getParameterNameFromHexId("0x2808")) print(currentDOT.getDecIdFromHexId("0x2808")) print(currentDOT.getParameterNameFromDecId("10248")) print(currentDOT.getHexIdFromDecId("10248")) print(currentDOT.getDecIdFromParameterName("DST_rule_time_start")) print(currentDOT.getHexIdFromParameterName("DST_rule_time_start"))

Attributes:

Name Type Description
dotPath

The path to the current instance's DOT file.
dotName

The name of the current instance's DOT file.
hexIdToParameterDict

A dictionary mapping hex ID's to parameter names.
hexIdToDecIdDict

A dictionary mapping hex ID's to decimal ID's.
hexIdToRangeDict

A dictionary mapping hex ID's to parameter range values.
hexIdToOffsetDict

A dictionary mapping hex ID's to parameter offset values.
hexIdToScaleDict

A dictionary mapping hex ID's to parameter scale values.
hexIdToUnitDict

A dictionary mapping hex ID's to parameter units of measurement.
hexIdToNotesDict

A dictionary mapping hex ID's to a parameter's notes.
decIdToParameterDict

A dictionary mapping decimal ID's to parameter names.
decIdToHexIdDict

A dictionary mapping decimal ID's to hex ID's.
parameterToHexIdDict

A dictionary mapping parameter names to hex ID's.
parameterToDecIdDict

A dictionary mapping paremeter names to decimal ID's.
Source code in drivers\dotAutoParse.py 
 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
class dotParse():
    ''' The application presents a central dotParse() class that can be used as a parsed-dot directory. It includes the following features:
    - Initialization of empty dictionaries to declare space usage along with empty variable lookup
    - parseNewDOT(filepath) method to load a given DBC into all of the dictionaries
    - dumpDictionaries() method to save the current dictionaries as json files in the 'dictionaries' folder
    - loadDictionaries() method to load the json files in the 'dictionaries' folder as current dictionaries
    - Several support methods for getting relevant data by lookup with hex ID, decimal ID, or parameter name

    Examples:
        currentDOT = dotParse()
        currentDOT.parseNewDOT("DiagnosticsObjectTableV14.xlsx")
        print(currentDOT.getParameterNameFromHexId("0x2808"))
        print(currentDOT.getDecIdFromHexId("0x2808"))
        print(currentDOT.getParameterNameFromDecId("10248"))
        print(currentDOT.getHexIdFromDecId("10248"))
        print(currentDOT.getDecIdFromParameterName("DST_rule_time_start"))
        print(currentDOT.getHexIdFromParameterName("DST_rule_time_start"))


    Attributes:
        dotPath: The path to the current instance's DOT file.
        dotName: The name of the current instance's DOT file.
        hexIdToParameterDict: A dictionary mapping hex ID's to parameter names.
        hexIdToDecIdDict: A dictionary mapping hex ID's to decimal ID's.
        hexIdToRangeDict: A dictionary mapping hex ID's to parameter range values.
        hexIdToOffsetDict: A dictionary mapping hex ID's to parameter offset values.
        hexIdToScaleDict: A dictionary mapping hex ID's to parameter scale values.
        hexIdToUnitDict: A dictionary mapping hex ID's to parameter units of measurement.
        hexIdToNotesDict: A dictionary mapping hex ID's to a parameter's notes.
        decIdToParameterDict: A dictionary mapping decimal ID's to parameter names.
        decIdToHexIdDict: A dictionary mapping decimal ID's to hex ID's.
        parameterToHexIdDict: A dictionary mapping parameter names to hex ID's.
        parameterToDecIdDict: A dictionary mapping paremeter names to decimal ID's.
    '''    

    ########################
    # CLASS INITIALIZATION #
    ########################
    def __init__(self) -> None:
        ''' Initializes the dotParse class upon instance creation.
        '''
        self.dotPath = None
        self.dotName = None

        # Hex ID will serve as base for all lookup attributes | Initialize Hex Dictionaries
        self.hexIdToParameterDict = defaultdict(str)
        self.hexIdToDecIdDict = defaultdict(str)
        self.hexIdToRangeDict = defaultdict(str)
        self.hexIdToOffsetDict = defaultdict(str)
        self.hexIdToScaleDict = defaultdict(str)
        self.hexIdToUnitDict = defaultdict(str)
        self.hexIdToNotesDict = defaultdict(str)

        # For lookup by Decimal ID | Initialize Decimal Dictionaries
        self.decIdToParameterDict = defaultdict(str)
        self.decIdToHexIdDict = defaultdict(str)

        # For lookup by Parameter Name | Initialize Parameter Dictionaries
        self.parameterToHexIdDict = defaultdict(str)
        self.parameterToDecIdDict = defaultdict(str)


    ##############
    # DOT LOADER #
    ##############
    def parseNewDOT(self, filePath:str):
        '''Parses a DBC file and loads all information into instance-based dictionaries.

        Args:
            filePath (str): The Path to the DBC file to parse.
        '''        
        # Save the dbc path
        self.dotPath = filePath
        # Save the dbc name
        self.dotName = path.basename(self.dotPath)

        # Load the DOT into a pandas dataframe
        dotAsDataFrame = read_excel(io=self.dotPath, sheet_name="DOT", header=0, usecols=["Object Id", "Dec", "Parameter Name", "Range", "Offset", "Scale", "Unit", "Notes"])

        # For the entire excel file
        for indexCount in dotAsDataFrame.index:
            # Sort out the "reserved" rows from excel file
            if (dotAsDataFrame['Object Id'][indexCount] == 'Reserved'):
                continue

            # Else, add all of the appropriate entries to the respective dictionaries
            self.hexIdToParameterDict[dotAsDataFrame['Object Id'][indexCount]] = dotAsDataFrame['Parameter Name'][indexCount]
            self.hexIdToDecIdDict[dotAsDataFrame['Object Id'][indexCount]] = str(int(dotAsDataFrame['Dec'][indexCount]))
            self.hexIdToRangeDict[dotAsDataFrame['Object Id'][indexCount]] = dotAsDataFrame['Range'][indexCount]
            self.hexIdToOffsetDict[dotAsDataFrame['Object Id'][indexCount]] = dotAsDataFrame['Offset'][indexCount]
            self.hexIdToScaleDict[dotAsDataFrame['Object Id'][indexCount]] = dotAsDataFrame['Scale'][indexCount]
            self.hexIdToUnitDict[dotAsDataFrame['Object Id'][indexCount]] = dotAsDataFrame['Unit'][indexCount]
            self.hexIdToNotesDict[dotAsDataFrame['Object Id'][indexCount]] = dotAsDataFrame['Notes'][indexCount]
            self.decIdToParameterDict[str(int(dotAsDataFrame['Dec'][indexCount]))] = dotAsDataFrame['Parameter Name'][indexCount]
            self.decIdToHexIdDict[str(int(dotAsDataFrame['Dec'][indexCount]))] = dotAsDataFrame['Object Id'][indexCount]
            self.parameterToHexIdDict[dotAsDataFrame['Parameter Name'][indexCount]] = dotAsDataFrame['Object Id'][indexCount]
            self.parameterToDecIdDict[dotAsDataFrame['Parameter Name'][indexCount]] = str(int(dotAsDataFrame['Dec'][indexCount]))


    #############################
    # SAVE DICTIONARIES TO JSON #
    #############################
    def dumpDictionaries(self):
        '''Saves (dumps) the current instance's dictionaries into the json save files located in the 'dictionaries' folder.

        Returns:
            bool: True if execution completed with no errors, False otherwise.
        '''     
        # [https://www.geeksforgeeks.org/create-a-directory-in-python/]
        try:
            mkdir("dictionaries")
        except OSError as error:
            print("CC DOT-AutoParse: Dictionary Directory Already Exists!")

        # Save the hexIdToParameterDict Dictionary
        with open('dictionaries\\hexIdToParameterDict.json', 'w') as outputFile:
            # [https://docs.python.org/3/library/json.html#json.dump]
            dump(self.hexIdToParameterDict, outputFile, indent="")

        # Save the hexIdToDecIdDict Dictionary
        with open('dictionaries\\hexIdToDecIdDict.json', 'w') as outputFile:
            # [https://docs.python.org/3/library/json.html#json.dump]
            dump(self.hexIdToDecIdDict, outputFile, indent="")

        # Save the hexIdToRangeDict Dictionary
        with open('dictionaries\\hexIdToRangeDict.json', 'w') as outputFile:
            # [https://docs.python.org/3/library/json.html#json.dump]
            dump(self.hexIdToRangeDict, outputFile, indent="")

        # Save the hexIdToOffsetDict Dictionary
        with open('dictionaries\\hexIdToOffsetDict.json', 'w') as outputFile:
            # [https://docs.python.org/3/library/json.html#json.dump]
            dump(self.hexIdToOffsetDict, outputFile, indent="")

        # Save the hexIdToScaleDict Dictionary
        with open('dictionaries\\hexIdToScaleDict.json', 'w') as outputFile:
            # [https://docs.python.org/3/library/json.html#json.dump]
            dump(self.hexIdToScaleDict, outputFile, indent="")

        # Save the hexIdToUnitDict Dictionary
        with open('dictionaries\\hexIdToUnitDict.json', 'w') as outputFile:
            # [https://docs.python.org/3/library/json.html#json.dump]
            dump(self.hexIdToUnitDict, outputFile, indent="")

        # Save the hexIdToNotesDict Dictionary
        with open('dictionaries\\hexIdToNotesDict.json', 'w') as outputFile:
            # [https://docs.python.org/3/library/json.html#json.dump]
            dump(self.hexIdToNotesDict, outputFile, indent="")

        # Save the decIdToParameterDict Dictionary
        with open('dictionaries\\decIdToParameterDict.json', 'w') as outputFile:
            # [https://docs.python.org/3/library/json.html#json.dump]
            dump(self.decIdToParameterDict, outputFile, indent="")

        # Save the decIdToHexIdDict Dictionary
        with open('dictionaries\\decIdToHexIdDict.json', 'w') as outputFile:
            # [https://docs.python.org/3/library/json.html#json.dump]
            dump(self.decIdToHexIdDict, outputFile, indent="")

        # Save the parameterToHexIdDict Dictionary
        with open('dictionaries\\parameterToHexIdDict.json', 'w') as outputFile:
            # [https://docs.python.org/3/library/json.html#json.dump]
            dump(self.parameterToHexIdDict, outputFile, indent="")

        # Save the parameterToDecIdDict Dictionary
        with open('dictionaries\\parameterToDecIdDict.json', 'w') as outputFile:
            # [https://docs.python.org/3/library/json.html#json.dump]
            dump(self.parameterToDecIdDict, outputFile, indent="")


    ###############################
    # LOAD DICTIONARIES FROM JSON #
    ###############################
    def loadDictionaries(self):
        ''' Loads the json save files located in the 'dictionaries' folder into the instance's dictionaries.

        Returns:
            bool: True if execution completed with no errors, False otherwise.
        '''   
        # Load the hexIdToParameterDict Dictionary
        with open('dictionaries\\hexIdToParameterDict.json') as hexIdToParameterDict:
            # [https://docs.python.org/3/library/json.html#json.load]
            self.hexIdToParameterDict = load(hexIdToParameterDict)

        # Load the hexIdToDecIdDict Dictionary
        with open('dictionaries\\hexIdToDecIdDict.json') as hexIdToDecIdDict:
            # [https://docs.python.org/3/library/json.html#json.load]
            self.hexIdToDecIdDict = load(hexIdToDecIdDict)

        # Load the hexIdToRangeDict Dictionary
        with open('dictionaries\\hexIdToRangeDict.json') as hexIdToRangeDict:
            # [https://docs.python.org/3/library/json.html#json.load]
            self.hexIdToRangeDict = load(hexIdToRangeDict)

        # Load the hexIdToOffsetDict Dictionary
        with open('dictionaries\\hexIdToOffsetDict.json') as hexIdToOffsetDict:
            # [https://docs.python.org/3/library/json.html#json.load]
            self.hexIdToOffsetDict = load(hexIdToOffsetDict)

        # Load the hexIdToScaleDict Dictionary
        with open('dictionaries\\hexIdToScaleDict.json') as hexIdToScaleDict:
            # [https://docs.python.org/3/library/json.html#json.load]
            self.hexIdToScaleDict = load(hexIdToScaleDict)

        # Load the hexIdToUnitDict Dictionary
        with open('dictionaries\\hexIdToUnitDict.json') as hexIdToUnitDict:
            # [https://docs.python.org/3/library/json.html#json.load]
            self.hexIdToUnitDict = load(hexIdToUnitDict)

        # Load the hexIdToNotesDict Dictionary
        with open('dictionaries\\hexIdToNotesDict.json') as hexIdToNotesDict:
            # [https://docs.python.org/3/library/json.html#json.load]
            self.hexIdToNotesDict = load(hexIdToNotesDict)

        # Load the decIdToParameterDict Dictionary
        with open('dictionaries\\decIdToParameterDict.json') as decIdToParameterDict:
            # [https://docs.python.org/3/library/json.html#json.load]
            self.decIdToParameterDict = load(decIdToParameterDict)

        # Load the decIdToHexIdDict Dictionary
        with open('dictionaries\\decIdToHexIdDict.json') as decIdToHexIdDict:
            # [https://docs.python.org/3/library/json.html#json.load]
            self.decIdToHexIdDict = load(decIdToHexIdDict)

        # Load the parameterToHexIdDict Dictionary
        with open('dictionaries\\parameterToHexIdDict.json') as parameterToHexIdDict:
            # [https://docs.python.org/3/library/json.html#json.load]
            self.parameterToHexIdDict = load(parameterToHexIdDict)

        # Load the parameterToDecIdDict Dictionary
        with open('dictionaries\\parameterToDecIdDict.json') as parameterToDecIdDict:
            # [https://docs.python.org/3/library/json.html#json.load]
            self.parameterToDecIdDict = load(parameterToDecIdDict)


    #######################
    # DATA LOOKUP METHODS #
    #######################

    def getParameterNameFromHexId(self, hexId:str) -> str: 
        ''' Support method for looking up parameter name by hex ID.

        Args:
            hexId (str): The Hex ID to index by.

        Returns:
            str: Parameter name.
        '''        
        return self.hexIdToParameterDict[hexId]


    def getDecIdFromHexId(self, hexId:str) -> str:
        ''' Support method for looking up decimal ID by hex ID.

        Args:
            hexId (str): The Hex ID to index by.

        Returns:
            str: Decimal ID.
        '''        
        return self.hexIdToDecIdDict[hexId]


    def getRangeFromHexId(self, hexId:str) -> str:
        ''' Support method for looking up range by hex ID.

        Args:
            hexId (str): The Hex ID to index by.

        Returns:
            str: Parameter range.
        '''        
        return self.hexIdToRangeDict[hexId]


    def getOffsetFromHexId(self, hexId:str) -> str:
        ''' Support method for looking up offset by hex ID.

        Args:
            hexId (str): The Hex ID to index by.

        Returns:
            str: Parameter offset.
        '''        
        return self.hexIdToOffsetDict[hexId]


    def getScaleFromHexId(self, hexId:str) -> str:
        ''' Support method for looking up scale by hex ID.

        Args:
            hexId (str): The Hex ID to index by.

        Returns:
            str: Parameter Scale.
        '''        
        return self.hexIdToScaleDict[hexId]


    def getUnitFromHexId(self, hexId:str) -> str:
        ''' Support method for looking up unit by hex ID.

        Args:
            hexId (str): The Hex ID to index by.

        Returns:
            str: Parameter Unit.
        '''        
        return self.hexIdToUnitDict[hexId]


    def getNotesFromHexId(self, hexId:str) -> str:
        ''' Support method for looking up notes by hex ID.

        Args:
            hexId (str): The Hex ID to index by.

        Returns:
            str: Parameter Notes.
        '''        
        return self.hexIdToNotesDict[hexId]


    def getParameterNameFromDecId(self, decId:str) -> str:
        ''' Support method for looking up parameter name by decimal ID.

        Args:
            decId (str): The decimal ID to index by.

        Returns:
            str: Parameter name.
        '''        
        return self.decIdToParameterDict[decId]


    def getHexIdFromDecId(self, decId:str) -> str:
        ''' Support method for looking up hex ID by decimal ID.

        Args:
            decId (str): The decimal ID to index by.

        Returns:
            str: Hex ID.
        '''        
        return self.decIdToHexIdDict[decId]


    def getRangeFromDecId(self, decId:str) -> str:
        ''' Support method for looking up range by decimal ID.

        Args:
            decId (str): The decimal ID to index by.

        Returns:
            str: Parameter range.
        '''        
        return self.hexIdToRangeDict[self.decIdToHexIdDict[decId]]


    def getOffsetFromDecId(self, decId:str) -> str:
        ''' Support method for looking up offset by decimal ID.

        Args:
            decId (str): The decimal ID to index by.

        Returns:
            str: Parameter offset.
        '''        
        return self.hexIdToOffsetDict[self.decIdToHexIdDict[decId]]


    def getScaleFromDecId(self, decId:str) -> str:
        ''' Support method for looking up scale by decimal ID.

        Args:
            decId (str): The decimal ID to index by.

        Returns:
            str: Parameter Scale.
        '''        
        return self.hexIdToScaleDict[self.decIdToHexIdDict[decId]]


    def getUnitFromDecId(self, decId:str) -> str:
        ''' Support method for looking up unit by decimal ID.

        Args:
            decId (str): The decimal ID to index by.

        Returns:
            str: Parameter Unit.
        '''        
        return self.hexIdToUnitDict[self.decIdToHexIdDict[decId]]


    def getNotesFromDecId(self, decId:str) -> str:
        ''' Support method for looking up notes by decimal ID.

        Args:
            decId (str): The decimal ID to index by.

        Returns:
            str: Parameter Notes.
        '''        
        return self.hexIdToNotesDict[self.decIdToHexIdDict[decId]]


    def getHexIdFromParameterName(self, paramName:str) -> str:
        ''' Support method for looking up hex ID by parameter name.

        Args:
            paramName (str): The decimal ID to index by.

        Returns:
            str: Hex ID.
        '''        
        return self.parameterToHexIdDict[paramName]


    def getDecIdFromParameterName(self, paramName:str) -> str:
        ''' Support method for looking up decimal ID by parameter name.

        Args:
            paramName (str): The decimal ID to index by.

        Returns:
            str: Decimal ID.
        '''        
        return self.parameterToDecIdDict[paramName]


    def getRangeFromParameterName(self, paramName:str) -> str:
        ''' Support method for looking up range by parameter name.

        Args:
            paramName (str): The decimal ID to index by.

        Returns:
            str: Parameter range.
        '''        
        return self.hexIdToRangeDict[self.parameterToHexIdDict[paramName]]


    def getOffsetFromParameterName(self, paramName:str) -> str:
        ''' Support method for looking up offset by parameter name.

        Args:
            paramName (str): The decimal ID to index by.

        Returns:
            str: Parameter offset.
        '''        
        return self.hexIdToOffsetDict[self.parameterToHexIdDict[paramName]]


    def getScaleFromParameterName(self, paramName:str) -> str:
        ''' Support method for looking up scale by parameter name.

        Args:
            paramName (str): The decimal ID to index by.

        Returns:
            str: Parameter Scale.
        '''        
        return self.hexIdToScaleDict[self.parameterToHexIdDict[paramName]]


    def getUnitFromParameterName(self, paramName:str) -> str:
        ''' Support method for looking up unit by parameter name.

        Args:
            paramName (str): The decimal ID to index by.

        Returns:
            str: Parameter Unit.
        '''        
        return self.hexIdToUnitDict[self.parameterToHexIdDict[paramName]]


    def getNotesFromParameterName(self, paramName:str) -> str:
        ''' Support method for looking up notes by parameter name.

        Args:
            paramName (str): The decimal ID to index by.

        Returns:
            str: Parameter Notes.
        '''        
        return self.hexIdToNotesDict[self.parameterToHexIdDict[paramName]]

__init__()

Initializes the dotParse class upon instance creation.

Source code in drivers\dotAutoParse.py 
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
def __init__(self) -> None:
    ''' Initializes the dotParse class upon instance creation.
    '''
    self.dotPath = None
    self.dotName = None

    # Hex ID will serve as base for all lookup attributes | Initialize Hex Dictionaries
    self.hexIdToParameterDict = defaultdict(str)
    self.hexIdToDecIdDict = defaultdict(str)
    self.hexIdToRangeDict = defaultdict(str)
    self.hexIdToOffsetDict = defaultdict(str)
    self.hexIdToScaleDict = defaultdict(str)
    self.hexIdToUnitDict = defaultdict(str)
    self.hexIdToNotesDict = defaultdict(str)

    # For lookup by Decimal ID | Initialize Decimal Dictionaries
    self.decIdToParameterDict = defaultdict(str)
    self.decIdToHexIdDict = defaultdict(str)

    # For lookup by Parameter Name | Initialize Parameter Dictionaries
    self.parameterToHexIdDict = defaultdict(str)
    self.parameterToDecIdDict = defaultdict(str)

dumpDictionaries()

Saves (dumps) the current instance's dictionaries into the json save files located in the 'dictionaries' folder.

Returns:

Name Type Description
bool

True if execution completed with no errors, False otherwise.
Source code in drivers\dotAutoParse.py 
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
def dumpDictionaries(self):
    '''Saves (dumps) the current instance's dictionaries into the json save files located in the 'dictionaries' folder.

    Returns:
        bool: True if execution completed with no errors, False otherwise.
    '''     
    # [https://www.geeksforgeeks.org/create-a-directory-in-python/]
    try:
        mkdir("dictionaries")
    except OSError as error:
        print("CC DOT-AutoParse: Dictionary Directory Already Exists!")

    # Save the hexIdToParameterDict Dictionary
    with open('dictionaries\\hexIdToParameterDict.json', 'w') as outputFile:
        # [https://docs.python.org/3/library/json.html#json.dump]
        dump(self.hexIdToParameterDict, outputFile, indent="")

    # Save the hexIdToDecIdDict Dictionary
    with open('dictionaries\\hexIdToDecIdDict.json', 'w') as outputFile:
        # [https://docs.python.org/3/library/json.html#json.dump]
        dump(self.hexIdToDecIdDict, outputFile, indent="")

    # Save the hexIdToRangeDict Dictionary
    with open('dictionaries\\hexIdToRangeDict.json', 'w') as outputFile:
        # [https://docs.python.org/3/library/json.html#json.dump]
        dump(self.hexIdToRangeDict, outputFile, indent="")

    # Save the hexIdToOffsetDict Dictionary
    with open('dictionaries\\hexIdToOffsetDict.json', 'w') as outputFile:
        # [https://docs.python.org/3/library/json.html#json.dump]
        dump(self.hexIdToOffsetDict, outputFile, indent="")

    # Save the hexIdToScaleDict Dictionary
    with open('dictionaries\\hexIdToScaleDict.json', 'w') as outputFile:
        # [https://docs.python.org/3/library/json.html#json.dump]
        dump(self.hexIdToScaleDict, outputFile, indent="")

    # Save the hexIdToUnitDict Dictionary
    with open('dictionaries\\hexIdToUnitDict.json', 'w') as outputFile:
        # [https://docs.python.org/3/library/json.html#json.dump]
        dump(self.hexIdToUnitDict, outputFile, indent="")

    # Save the hexIdToNotesDict Dictionary
    with open('dictionaries\\hexIdToNotesDict.json', 'w') as outputFile:
        # [https://docs.python.org/3/library/json.html#json.dump]
        dump(self.hexIdToNotesDict, outputFile, indent="")

    # Save the decIdToParameterDict Dictionary
    with open('dictionaries\\decIdToParameterDict.json', 'w') as outputFile:
        # [https://docs.python.org/3/library/json.html#json.dump]
        dump(self.decIdToParameterDict, outputFile, indent="")

    # Save the decIdToHexIdDict Dictionary
    with open('dictionaries\\decIdToHexIdDict.json', 'w') as outputFile:
        # [https://docs.python.org/3/library/json.html#json.dump]
        dump(self.decIdToHexIdDict, outputFile, indent="")

    # Save the parameterToHexIdDict Dictionary
    with open('dictionaries\\parameterToHexIdDict.json', 'w') as outputFile:
        # [https://docs.python.org/3/library/json.html#json.dump]
        dump(self.parameterToHexIdDict, outputFile, indent="")

    # Save the parameterToDecIdDict Dictionary
    with open('dictionaries\\parameterToDecIdDict.json', 'w') as outputFile:
        # [https://docs.python.org/3/library/json.html#json.dump]
        dump(self.parameterToDecIdDict, outputFile, indent="")

getDecIdFromHexId(hexId)

Support method for looking up decimal ID by hex ID.

Parameters:

Name Type Description Default
hexId str

The Hex ID to index by.

 required

Returns:

Name Type Description
str str

Decimal ID.
Source code in drivers\dotAutoParse.py 
281
282
283
284
285
286
287
288
289
290
def getDecIdFromHexId(self, hexId:str) -> str:
    ''' Support method for looking up decimal ID by hex ID.

    Args:
        hexId (str): The Hex ID to index by.

    Returns:
        str: Decimal ID.
    '''        
    return self.hexIdToDecIdDict[hexId]

getDecIdFromParameterName(paramName)

Support method for looking up decimal ID by parameter name.

Parameters:

Name Type Description Default
paramName str

The decimal ID to index by.

 required

Returns:

Name Type Description
str str

Decimal ID.
Source code in drivers\dotAutoParse.py 
449
450
451
452
453
454
455
456
457
458
def getDecIdFromParameterName(self, paramName:str) -> str:
    ''' Support method for looking up decimal ID by parameter name.

    Args:
        paramName (str): The decimal ID to index by.

    Returns:
        str: Decimal ID.
    '''        
    return self.parameterToDecIdDict[paramName]

getHexIdFromDecId(decId)

Support method for looking up hex ID by decimal ID.

Parameters:

Name Type Description Default
decId str

The decimal ID to index by.

 required

Returns:

Name Type Description
str str

Hex ID.
Source code in drivers\dotAutoParse.py 
365
366
367
368
369
370
371
372
373
374
def getHexIdFromDecId(self, decId:str) -> str:
    ''' Support method for looking up hex ID by decimal ID.

    Args:
        decId (str): The decimal ID to index by.

    Returns:
        str: Hex ID.
    '''        
    return self.decIdToHexIdDict[decId]

getHexIdFromParameterName(paramName)

Support method for looking up hex ID by parameter name.

Parameters:

Name Type Description Default
paramName str

The decimal ID to index by.

 required

Returns:

Name Type Description
str str

Hex ID.
Source code in drivers\dotAutoParse.py 
437
438
439
440
441
442
443
444
445
446
def getHexIdFromParameterName(self, paramName:str) -> str:
    ''' Support method for looking up hex ID by parameter name.

    Args:
        paramName (str): The decimal ID to index by.

    Returns:
        str: Hex ID.
    '''        
    return self.parameterToHexIdDict[paramName]

getNotesFromDecId(decId)

Support method for looking up notes by decimal ID.

Parameters:

Name Type Description Default
decId str

The decimal ID to index by.

 required

Returns:

Name Type Description
str str

Parameter Notes.
Source code in drivers\dotAutoParse.py 
425
426
427
428
429
430
431
432
433
434
def getNotesFromDecId(self, decId:str) -> str:
    ''' Support method for looking up notes by decimal ID.

    Args:
        decId (str): The decimal ID to index by.

    Returns:
        str: Parameter Notes.
    '''        
    return self.hexIdToNotesDict[self.decIdToHexIdDict[decId]]

getNotesFromHexId(hexId)

Support method for looking up notes by hex ID.

Parameters:

Name Type Description Default
hexId str

The Hex ID to index by.

 required

Returns:

Name Type Description
str str

Parameter Notes.
Source code in drivers\dotAutoParse.py 
341
342
343
344
345
346
347
348
349
350
def getNotesFromHexId(self, hexId:str) -> str:
    ''' Support method for looking up notes by hex ID.

    Args:
        hexId (str): The Hex ID to index by.

    Returns:
        str: Parameter Notes.
    '''        
    return self.hexIdToNotesDict[hexId]

getNotesFromParameterName(paramName)

Support method for looking up notes by parameter name.

Parameters:

Name Type Description Default
paramName str

The decimal ID to index by.

 required

Returns:

Name Type Description
str str

Parameter Notes.
Source code in drivers\dotAutoParse.py 
509
510
511
512
513
514
515
516
517
518
def getNotesFromParameterName(self, paramName:str) -> str:
    ''' Support method for looking up notes by parameter name.

    Args:
        paramName (str): The decimal ID to index by.

    Returns:
        str: Parameter Notes.
    '''        
    return self.hexIdToNotesDict[self.parameterToHexIdDict[paramName]]

getOffsetFromDecId(decId)

Support method for looking up offset by decimal ID.

Parameters:

Name Type Description Default
decId str

The decimal ID to index by.

 required

Returns:

Name Type Description
str str

Parameter offset.
Source code in drivers\dotAutoParse.py 
389
390
391
392
393
394
395
396
397
398
def getOffsetFromDecId(self, decId:str) -> str:
    ''' Support method for looking up offset by decimal ID.

    Args:
        decId (str): The decimal ID to index by.

    Returns:
        str: Parameter offset.
    '''        
    return self.hexIdToOffsetDict[self.decIdToHexIdDict[decId]]

getOffsetFromHexId(hexId)

Support method for looking up offset by hex ID.

Parameters:

Name Type Description Default
hexId str

The Hex ID to index by.

 required

Returns:

Name Type Description
str str

Parameter offset.
Source code in drivers\dotAutoParse.py 
305
306
307
308
309
310
311
312
313
314
def getOffsetFromHexId(self, hexId:str) -> str:
    ''' Support method for looking up offset by hex ID.

    Args:
        hexId (str): The Hex ID to index by.

    Returns:
        str: Parameter offset.
    '''        
    return self.hexIdToOffsetDict[hexId]

getOffsetFromParameterName(paramName)

Support method for looking up offset by parameter name.

Parameters:

Name Type Description Default
paramName str

The decimal ID to index by.

 required

Returns:

Name Type Description
str str

Parameter offset.
Source code in drivers\dotAutoParse.py 
473
474
475
476
477
478
479
480
481
482
def getOffsetFromParameterName(self, paramName:str) -> str:
    ''' Support method for looking up offset by parameter name.

    Args:
        paramName (str): The decimal ID to index by.

    Returns:
        str: Parameter offset.
    '''        
    return self.hexIdToOffsetDict[self.parameterToHexIdDict[paramName]]

getParameterNameFromDecId(decId)

Support method for looking up parameter name by decimal ID.

Parameters:

Name Type Description Default
decId str

The decimal ID to index by.

 required

Returns:

Name Type Description
str str

Parameter name.
Source code in drivers\dotAutoParse.py 
353
354
355
356
357
358
359
360
361
362
def getParameterNameFromDecId(self, decId:str) -> str:
    ''' Support method for looking up parameter name by decimal ID.

    Args:
        decId (str): The decimal ID to index by.

    Returns:
        str: Parameter name.
    '''        
    return self.decIdToParameterDict[decId]

getParameterNameFromHexId(hexId)

Support method for looking up parameter name by hex ID.

Parameters:

Name Type Description Default
hexId str

The Hex ID to index by.

 required

Returns:

Name Type Description
str str

Parameter name.
Source code in drivers\dotAutoParse.py 
269
270
271
272
273
274
275
276
277
278
def getParameterNameFromHexId(self, hexId:str) -> str: 
    ''' Support method for looking up parameter name by hex ID.

    Args:
        hexId (str): The Hex ID to index by.

    Returns:
        str: Parameter name.
    '''        
    return self.hexIdToParameterDict[hexId]

getRangeFromDecId(decId)

Support method for looking up range by decimal ID.

Parameters:

Name Type Description Default
decId str

The decimal ID to index by.

 required

Returns:

Name Type Description
str str

Parameter range.
Source code in drivers\dotAutoParse.py 
377
378
379
380
381
382
383
384
385
386
def getRangeFromDecId(self, decId:str) -> str:
    ''' Support method for looking up range by decimal ID.

    Args:
        decId (str): The decimal ID to index by.

    Returns:
        str: Parameter range.
    '''        
    return self.hexIdToRangeDict[self.decIdToHexIdDict[decId]]

getRangeFromHexId(hexId)

Support method for looking up range by hex ID.

Parameters:

Name Type Description Default
hexId str

The Hex ID to index by.

 required

Returns:

Name Type Description
str str

Parameter range.
Source code in drivers\dotAutoParse.py 
293
294
295
296
297
298
299
300
301
302
def getRangeFromHexId(self, hexId:str) -> str:
    ''' Support method for looking up range by hex ID.

    Args:
        hexId (str): The Hex ID to index by.

    Returns:
        str: Parameter range.
    '''        
    return self.hexIdToRangeDict[hexId]

getRangeFromParameterName(paramName)

Support method for looking up range by parameter name.

Parameters:

Name Type Description Default
paramName str

The decimal ID to index by.

 required

Returns:

Name Type Description
str str

Parameter range.
Source code in drivers\dotAutoParse.py 
461
462
463
464
465
466
467
468
469
470
def getRangeFromParameterName(self, paramName:str) -> str:
    ''' Support method for looking up range by parameter name.

    Args:
        paramName (str): The decimal ID to index by.

    Returns:
        str: Parameter range.
    '''        
    return self.hexIdToRangeDict[self.parameterToHexIdDict[paramName]]

getScaleFromDecId(decId)

Support method for looking up scale by decimal ID.

Parameters:

Name Type Description Default
decId str

The decimal ID to index by.

 required

Returns:

Name Type Description
str str

Parameter Scale.
Source code in drivers\dotAutoParse.py 
401
402
403
404
405
406
407
408
409
410
def getScaleFromDecId(self, decId:str) -> str:
    ''' Support method for looking up scale by decimal ID.

    Args:
        decId (str): The decimal ID to index by.

    Returns:
        str: Parameter Scale.
    '''        
    return self.hexIdToScaleDict[self.decIdToHexIdDict[decId]]

getScaleFromHexId(hexId)

Support method for looking up scale by hex ID.

Parameters:

Name Type Description Default
hexId str

The Hex ID to index by.

 required

Returns:

Name Type Description
str str

Parameter Scale.
Source code in drivers\dotAutoParse.py 
317
318
319
320
321
322
323
324
325
326
def getScaleFromHexId(self, hexId:str) -> str:
    ''' Support method for looking up scale by hex ID.

    Args:
        hexId (str): The Hex ID to index by.

    Returns:
        str: Parameter Scale.
    '''        
    return self.hexIdToScaleDict[hexId]

getScaleFromParameterName(paramName)

Support method for looking up scale by parameter name.

Parameters:

Name Type Description Default
paramName str

The decimal ID to index by.

 required

Returns:

Name Type Description
str str

Parameter Scale.
Source code in drivers\dotAutoParse.py 
485
486
487
488
489
490
491
492
493
494
def getScaleFromParameterName(self, paramName:str) -> str:
    ''' Support method for looking up scale by parameter name.

    Args:
        paramName (str): The decimal ID to index by.

    Returns:
        str: Parameter Scale.
    '''        
    return self.hexIdToScaleDict[self.parameterToHexIdDict[paramName]]

getUnitFromDecId(decId)

Support method for looking up unit by decimal ID.

Parameters:

Name Type Description Default
decId str

The decimal ID to index by.

 required

Returns:

Name Type Description
str str

Parameter Unit.
Source code in drivers\dotAutoParse.py 
413
414
415
416
417
418
419
420
421
422
def getUnitFromDecId(self, decId:str) -> str:
    ''' Support method for looking up unit by decimal ID.

    Args:
        decId (str): The decimal ID to index by.

    Returns:
        str: Parameter Unit.
    '''        
    return self.hexIdToUnitDict[self.decIdToHexIdDict[decId]]

getUnitFromHexId(hexId)

Support method for looking up unit by hex ID.

Parameters:

Name Type Description Default
hexId str

The Hex ID to index by.

 required

Returns:

Name Type Description
str str

Parameter Unit.
Source code in drivers\dotAutoParse.py 
329
330
331
332
333
334
335
336
337
338
def getUnitFromHexId(self, hexId:str) -> str:
    ''' Support method for looking up unit by hex ID.

    Args:
        hexId (str): The Hex ID to index by.

    Returns:
        str: Parameter Unit.
    '''        
    return self.hexIdToUnitDict[hexId]

getUnitFromParameterName(paramName)

Support method for looking up unit by parameter name.

Parameters:

Name Type Description Default
paramName str

The decimal ID to index by.

 required

Returns:

Name Type Description
str str

Parameter Unit.
Source code in drivers\dotAutoParse.py 
497
498
499
500
501
502
503
504
505
506
def getUnitFromParameterName(self, paramName:str) -> str:
    ''' Support method for looking up unit by parameter name.

    Args:
        paramName (str): The decimal ID to index by.

    Returns:
        str: Parameter Unit.
    '''        
    return self.hexIdToUnitDict[self.parameterToHexIdDict[paramName]]

loadDictionaries()

Loads the json save files located in the 'dictionaries' folder into the instance's dictionaries.

Returns:

Name Type Description
bool

True if execution completed with no errors, False otherwise.
Source code in drivers\dotAutoParse.py 
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
def loadDictionaries(self):
    ''' Loads the json save files located in the 'dictionaries' folder into the instance's dictionaries.

    Returns:
        bool: True if execution completed with no errors, False otherwise.
    '''   
    # Load the hexIdToParameterDict Dictionary
    with open('dictionaries\\hexIdToParameterDict.json') as hexIdToParameterDict:
        # [https://docs.python.org/3/library/json.html#json.load]
        self.hexIdToParameterDict = load(hexIdToParameterDict)

    # Load the hexIdToDecIdDict Dictionary
    with open('dictionaries\\hexIdToDecIdDict.json') as hexIdToDecIdDict:
        # [https://docs.python.org/3/library/json.html#json.load]
        self.hexIdToDecIdDict = load(hexIdToDecIdDict)

    # Load the hexIdToRangeDict Dictionary
    with open('dictionaries\\hexIdToRangeDict.json') as hexIdToRangeDict:
        # [https://docs.python.org/3/library/json.html#json.load]
        self.hexIdToRangeDict = load(hexIdToRangeDict)

    # Load the hexIdToOffsetDict Dictionary
    with open('dictionaries\\hexIdToOffsetDict.json') as hexIdToOffsetDict:
        # [https://docs.python.org/3/library/json.html#json.load]
        self.hexIdToOffsetDict = load(hexIdToOffsetDict)

    # Load the hexIdToScaleDict Dictionary
    with open('dictionaries\\hexIdToScaleDict.json') as hexIdToScaleDict:
        # [https://docs.python.org/3/library/json.html#json.load]
        self.hexIdToScaleDict = load(hexIdToScaleDict)

    # Load the hexIdToUnitDict Dictionary
    with open('dictionaries\\hexIdToUnitDict.json') as hexIdToUnitDict:
        # [https://docs.python.org/3/library/json.html#json.load]
        self.hexIdToUnitDict = load(hexIdToUnitDict)

    # Load the hexIdToNotesDict Dictionary
    with open('dictionaries\\hexIdToNotesDict.json') as hexIdToNotesDict:
        # [https://docs.python.org/3/library/json.html#json.load]
        self.hexIdToNotesDict = load(hexIdToNotesDict)

    # Load the decIdToParameterDict Dictionary
    with open('dictionaries\\decIdToParameterDict.json') as decIdToParameterDict:
        # [https://docs.python.org/3/library/json.html#json.load]
        self.decIdToParameterDict = load(decIdToParameterDict)

    # Load the decIdToHexIdDict Dictionary
    with open('dictionaries\\decIdToHexIdDict.json') as decIdToHexIdDict:
        # [https://docs.python.org/3/library/json.html#json.load]
        self.decIdToHexIdDict = load(decIdToHexIdDict)

    # Load the parameterToHexIdDict Dictionary
    with open('dictionaries\\parameterToHexIdDict.json') as parameterToHexIdDict:
        # [https://docs.python.org/3/library/json.html#json.load]
        self.parameterToHexIdDict = load(parameterToHexIdDict)

    # Load the parameterToDecIdDict Dictionary
    with open('dictionaries\\parameterToDecIdDict.json') as parameterToDecIdDict:
        # [https://docs.python.org/3/library/json.html#json.load]
        self.parameterToDecIdDict = load(parameterToDecIdDict)

parseNewDOT(filePath)

Parses a DBC file and loads all information into instance-based dictionaries.

Parameters:

Name Type Description Default
filePath str

The Path to the DBC file to parse.

 required
Source code in drivers\dotAutoParse.py 
 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
def parseNewDOT(self, filePath:str):
    '''Parses a DBC file and loads all information into instance-based dictionaries.

    Args:
        filePath (str): The Path to the DBC file to parse.
    '''        
    # Save the dbc path
    self.dotPath = filePath
    # Save the dbc name
    self.dotName = path.basename(self.dotPath)

    # Load the DOT into a pandas dataframe
    dotAsDataFrame = read_excel(io=self.dotPath, sheet_name="DOT", header=0, usecols=["Object Id", "Dec", "Parameter Name", "Range", "Offset", "Scale", "Unit", "Notes"])

    # For the entire excel file
    for indexCount in dotAsDataFrame.index:
        # Sort out the "reserved" rows from excel file
        if (dotAsDataFrame['Object Id'][indexCount] == 'Reserved'):
            continue

        # Else, add all of the appropriate entries to the respective dictionaries
        self.hexIdToParameterDict[dotAsDataFrame['Object Id'][indexCount]] = dotAsDataFrame['Parameter Name'][indexCount]
        self.hexIdToDecIdDict[dotAsDataFrame['Object Id'][indexCount]] = str(int(dotAsDataFrame['Dec'][indexCount]))
        self.hexIdToRangeDict[dotAsDataFrame['Object Id'][indexCount]] = dotAsDataFrame['Range'][indexCount]
        self.hexIdToOffsetDict[dotAsDataFrame['Object Id'][indexCount]] = dotAsDataFrame['Offset'][indexCount]
        self.hexIdToScaleDict[dotAsDataFrame['Object Id'][indexCount]] = dotAsDataFrame['Scale'][indexCount]
        self.hexIdToUnitDict[dotAsDataFrame['Object Id'][indexCount]] = dotAsDataFrame['Unit'][indexCount]
        self.hexIdToNotesDict[dotAsDataFrame['Object Id'][indexCount]] = dotAsDataFrame['Notes'][indexCount]
        self.decIdToParameterDict[str(int(dotAsDataFrame['Dec'][indexCount]))] = dotAsDataFrame['Parameter Name'][indexCount]
        self.decIdToHexIdDict[str(int(dotAsDataFrame['Dec'][indexCount]))] = dotAsDataFrame['Object Id'][indexCount]
        self.parameterToHexIdDict[dotAsDataFrame['Parameter Name'][indexCount]] = dotAsDataFrame['Object Id'][indexCount]
        self.parameterToDecIdDict[dotAsDataFrame['Parameter Name'][indexCount]] = str(int(dotAsDataFrame['Dec'][indexCount]))