DBC Parse
CC Anti-Canape: CC DBC Parsing Application
Author: Chris Hinkson
Email: Christopher.Hinkson@clubcar.com
Desc: This application is designed to parse a Club Car DBC 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-DBC-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
dbcParse
The application presents a central dbcParse() class that can be used as a parsed-dbc directory. It includes the following features: - Initialization of empty dictionaries to declare space usage along with empty variable lookup - parseNewDBC(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 - getIDBySignalName(signalName), getMessageBySignalName(signalName), and getMessageByID(ID) methods to assist in message/ID lookup - Storage of all parsed data in dictionaries for the duration of the class instance - Optional saving and loading of dictionaries as json files for easier lookup
Examples:
currentDBC = dbcParse() currentDBC.parseNewDBC("ccPythonDBC.dbc") currentDBC.dumpDictionaries()
Attributes:
Name | Type | Description |
---|---|---|
version |
The version of the DBC - specified in the first line of the DBC. |
|
dbcPath |
The file path to the DBC loaded into the instance (if DBC is loaded). |
|
dbcName |
The name of the DBC loaded into the instance (if DBC is loaded). |
|
idToSignals |
Dictionary mapping ID's to signals. |
|
idToSignalDescriptions |
Dictionary mapping ID's to signal descriptions. |
|
idToSendType |
Dictionary mapping ID's to send types. |
|
idToCycleTime |
Dictionary mapping ID's to cycle times. |
|
signalsToId |
Dictionary mapping signals to ID's. |
|
signalsToMin |
Dictionary mapping signals to minimum values. |
|
signalsToMax |
Dictionary mapping signals to maximum values. |
Source code in drivers\dbcAutoParse.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 |
|
__init__()
Initializes the class upon instance creation.
Source code in drivers\dbcAutoParse.py
60 61 62 63 64 65 66 67 68 69 70 71 72 |
|
dumpDictionaries()
Saves (dumps) the current instance's dictionaries into the json save files located in the 'dictionaries' folder.
Returns:
Name | Type | Description |
---|---|---|
bool |
bool
|
True if execution completed with no errors, False otherwise. |
Source code in drivers\dbcAutoParse.py
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 |
|
getCycleTimeById(ID)
Get the cycle time for a given ID.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
ID |
str
|
The ID to index. |
required |
Returns:
Name | Type | Description |
---|---|---|
str |
str
|
The cycle time for the specified ID. |
Source code in drivers\dbcAutoParse.py
403 404 405 406 407 408 409 410 411 412 413 |
|
getDbcName()
Get the current DBC name.
Returns:
Name | Type | Description |
---|---|---|
str |
str
|
Name of the current instance's loaded DBC file. |
Source code in drivers\dbcAutoParse.py
438 439 440 441 442 443 444 |
|
getDbcPath()
Get the current DBC path.
Returns:
Name | Type | Description |
---|---|---|
str |
str
|
Path of the current instance's loaded DBC file. |
Source code in drivers\dbcAutoParse.py
429 430 431 432 433 434 435 |
|
getDescriptionBySignalName(signalName)
Get the description for a given signal.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
signalName |
str
|
The signal name to index. |
required |
Returns:
Name | Type | Description |
---|---|---|
str |
str
|
The description for the specified value, if it exists. |
Source code in drivers\dbcAutoParse.py
347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 |
|
getIdBySignalName(signalName)
Get the ID for a given signal.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
signalName |
str
|
The signal name to index. |
required |
Returns:
Name | Type | Description |
---|---|---|
str |
str
|
The ID for the specified signal. |
Source code in drivers\dbcAutoParse.py
321 322 323 324 325 326 327 328 329 330 331 |
|
getMaxBySignal(signalName)
Get the max for a given signal.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
signalName |
str
|
The signal name to index. |
required |
Returns:
Name | Type | Description |
---|---|---|
str |
str
|
The maximum value for the specified signal. |
Source code in drivers\dbcAutoParse.py
377 378 379 380 381 382 383 384 385 386 387 |
|
getMessageById(ID)
Get the message for a given ID.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
ID |
str
|
The ID to index. |
required |
Returns:
Name | Type | Description |
---|---|---|
dict |
dict
|
A dictionary of signal:value pairs for the specified ID's Message, where the value is the minimum value for each signal. |
Source code in drivers\dbcAutoParse.py
390 391 392 393 394 395 396 397 398 399 400 |
|
getMessageBySignalName(signalName)
Get the full message for a given signal.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
signalName |
str
|
The signal name to index. |
required |
Returns:
Name | Type | Description |
---|---|---|
str |
str
|
A dictionary of signal:value pairs for the specified signal's Message, where the value is the minimum value for each signal. |
Source code in drivers\dbcAutoParse.py
334 335 336 337 338 339 340 341 342 343 344 |
|
getMinBySignal(signalName)
Get the min for a given signal.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
signalName |
str
|
The signal name to index. |
required |
Returns:
Name | Type | Description |
---|---|---|
str |
str
|
The minimum value for the specified value. |
Source code in drivers\dbcAutoParse.py
364 365 366 367 368 369 370 371 372 373 374 |
|
getSendTypeById(ID)
Get the send type for a given ID.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
ID |
str
|
The ID to index. |
required |
Returns:
Name | Type | Description |
---|---|---|
str |
str
|
The send type for the specified ID. |
Source code in drivers\dbcAutoParse.py
416 417 418 419 420 421 422 423 424 425 426 |
|
loadDictionaries()
Loads the json save files located in the 'dictionaries' folder into the instance's dictionaries.
Returns:
Name | Type | Description |
---|---|---|
bool |
bool
|
True if execution completed with no errors, False otherwise. |
Source code in drivers\dbcAutoParse.py
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 |
|
parseNewDBC(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 |
Returns:
Name | Type | Description |
---|---|---|
bool |
bool
|
True if execution completed with no errors, False otherwise. |
Source code in drivers\dbcAutoParse.py
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 |
|