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

class 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:
        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.
    '''    
    ########################
    # CLASS INITIALIZATION #
    ########################
    def __init__(self) -> None:
        ''' Initializes the class upon instance creation.
        '''        
        self.version = None
        self.dbcPath = None
        self.dbcName = None
        self.idToSignals = defaultdict(dict)
        self.idToSignalDescriptions = defaultdict(dict)
        self.idToSendType = defaultdict(str)
        self.idToCycleTime = defaultdict(str)
        self.signalsToId = defaultdict(str)
        self.signalsToMin = defaultdict(str)
        self.signalsToMax = defaultdict(str)


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

        Args:
            filePath (str): The Path to the DBC file to parse.

        Returns:
            bool: True if execution completed with no errors, False otherwise.
        '''        
        # Save the dbc path
        self.dbcPath = filePath
        # Save the dbc name
        self.dbcName = path.basename(self.dbcPath)

        # [https://docs.python.org/3/library/functions.html#open]
        with open(file=filePath, mode='r') as dbcFile:
            latestAddedID = ""
            latestAddedDescriptionID = ""
            latestAddedDescriptionSignal = ""
            latestAddedDescriptionFlag = False

            for line in dbcFile:
                # Strip the line of beginning / ending whitespace
                # [https://www.geeksforgeeks.org/python-string-strip/]
                strippedLine = line.strip()
                # Split the line into an array
                # [https://www.geeksforgeeks.org/python-string-split/]
                lineComponents = line.split()

                # Handle empty lines
                if not lineComponents:
                    continue

                # Detect version line
                if lineComponents[0] == "VERSION":
                    # Save the version
                    self.version = lineComponents[1]
                    # Go to the next line in the file
                    continue
                # Detect a new ID
                elif lineComponents[0] == "BO_":
                    # Create a new key in the idToSignals dictionary
                    self.idToSignals[lineComponents[1]] = {}
                    # Save ID for adding signals
                    latestAddedID = lineComponents[1]
                    # Go to the next line in the file
                    continue


                # Detect a new signal
                elif lineComponents[0] == "SG_":
                    # Add the signal to the signalsToId dictionary
                    self.signalsToId[lineComponents[1]] = latestAddedID

                    # Get the min and max
                    signalValueRange = lineComponents[5].strip("[]").split("|")
                    self.signalsToMin[lineComponents[1]] = float(signalValueRange[0])
                    self.signalsToMax[lineComponents[1]] = float(signalValueRange[1])

                    # Add the signal to the dictionary of the latest ID parsed, with the value being the signal min
                    self.idToSignals[latestAddedID].update({lineComponents[1]: float(signalValueRange[0])})


                    # Go to the next line in the file
                    continue

                # Detect a new description
                elif lineComponents[0] == "CM_":
                    # Detect a description for a ID
                    if lineComponents[1] == "BO_":
                        currentDescription = ""
                        # Get the total description, which may have spaces and therefor was split up into the array
                        for descriptionPartCount in range(len(lineComponents) - 3):
                            currentDescription = currentDescription + " " + lineComponents[descriptionPartCount + 3]
                        # Save the ID and description to the dictionary
                        self.idToSignalDescriptions[lineComponents[2]][lineComponents[2]] = currentDescription
                        # Save the ID as last added (and as the latest signal for placeholder)
                        latestAddedDescriptionID = lineComponents[2]
                        latestAddedDescriptionSignal = lineComponents[2]
                        # Go to the next line in the file
                        continue

                    # Detect a description for a signal
                    elif lineComponents[1] == "SG_":
                        currentDescription = ""
                        # Get the total description, which may have spaces and therefor was split up into the array
                        for descriptionPartCount in range(len(lineComponents) - 4):
                            currentDescription = currentDescription + " " + lineComponents[descriptionPartCount + 4]
                        # Add the signal and description to the dictionary
                        self.idToSignalDescriptions[lineComponents[2]][lineComponents[3]] = currentDescription
                        # Save the ID as last added ID and signal as last added signal
                        latestAddedDescriptionID = lineComponents[2]
                        latestAddedDescriptionSignal = lineComponents[3]

                        # If the description is continued on next line, there will not be a semicolon
                        if currentDescription[-1] != ';':
                            # Set flag for next line
                            latestAddedDescriptionFlag = True

                        # Go to the next line in the file
                        continue

                # Detect a continued description
                elif latestAddedDescriptionFlag == True:
                    # Get the description so far for the signal
                    currentDescription = self.idToSignalDescriptions[latestAddedDescriptionID][latestAddedDescriptionSignal]
                    # For all the parts of the current line, add them to the description
                    for descriptionPartCount in range(len(lineComponents)):
                        currentDescription = currentDescription + " " + lineComponents[descriptionPartCount]
                    # Add the description back to the dictionary
                    self.idToSignalDescriptions[latestAddedDescriptionID][latestAddedDescriptionSignal] = currentDescription

                    # Check if this line was the last line of the description
                    if currentDescription[-1] == ';':
                        # Reset flag
                        latestAddedDescriptionFlag = False

                    # Go to the next line in the file
                    continue

                # Detect a new message send type or cycle time
                elif lineComponents[0] == "BA_":
                    # If it is cycle time (DBC places var name in "")
                    if lineComponents[1] == '"GenMsgCycleTime"':
                        # Add the ID and cycle time to dictionary
                        self.idToCycleTime[lineComponents[3]] = lineComponents[4]
                        # Go to the next line in the file
                        continue
                    # If it is send type (DBC places var name in "")
                    elif lineComponents[1] == '"GenMsgSendType"':
                        # Add the ID and send type to dictionary
                        self.idToSendType[lineComponents[3]] = lineComponents[4]
                        # Go to the next line in the file
                        continue


                #TODO: Figure out what VAL_ is, and add support for it
                #TODO: Figure out what VAL_TABLE_ is, and add support for it
        return True


    #############################
    # SAVE DICTIONARIES TO JSON #
    #############################
    def dumpDictionaries(self) -> bool:
        '''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 DBC-AutoParse: Dictionary Directory Already Exists!")

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

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

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

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

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

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

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

        return True


    ###############################
    # LOAD DICTIONARIES FROM JSON #
    ###############################
    def loadDictionaries(self) -> bool:
        ''' 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 idToSignals Dictionary
        with open('dictionaries\\idToSignals.json') as inputFileIdToSignals:
            # [https://docs.python.org/3/library/json.html#json.load]
            self.idToSignals = load(inputFileIdToSignals)

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

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

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

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

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

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


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

    def getIdBySignalName(self, signalName:str) -> str:
        ''' Get the ID for a given signal.

        Args:
            signalName (str): The signal name to index.

        Returns:
            str: The ID for the specified signal.
        '''        
        # Return the dict value for the signal
        return self.signalsToId[signalName]


    def getMessageBySignalName(self, signalName:str) -> str:
        ''' Get the full message for a given signal.

        Args:
            signalName (str): The signal name to index.

        Returns:
            str: A dictionary of signal:value pairs for the specified signal's Message, where the value is the minimum value for each signal. 
        '''        
        # Return the message for the ID linked to the signal
        return self.idToSignals[self.signalsToId[signalName]]


    def getDescriptionBySignalName(self, signalName:str) -> str:
        ''' Get the description for a given signal.

        Args:
            signalName (str): The signal name to index.

        Returns:
            str: The description for the specified value, if it exists.
        '''        
        # Return the dict value for the description
        descriptionDict = self.idToSignalDescriptions[self.signalsToId[signalName]]
        try:
            return descriptionDict[signalName]
        except KeyError:
            return "DBC Auto Parse: " + signalName + " does not have a description in the DBC " + self.dbcName + "!"


    def getMinBySignal(self, signalName:str) -> str:
        ''' Get the min for a given signal.

        Args:
            signalName (str): The signal name to index.

        Returns:
            str: The minimum value for the specified value.
        '''        
        # Return the dict value for the min
        return self.signalsToMin[signalName]


    def getMaxBySignal(self, signalName:str) -> str:
        ''' Get the max for a given signal.

        Args:
            signalName (str): The signal name to index.

        Returns:
            str: The maximum value for the specified signal.
        '''        
        # Return the dict value for the max
        return self.signalsToMax[signalName]


    def getMessageById(self, ID:str) -> dict:
        '''Get the message for a given ID.

        Args:
            ID (str): The ID to index.

        Returns:
            dict: A dictionary of signal:value pairs for the specified ID's Message, where the value is the minimum value for each signal.
        '''        
        # Return the message for the ID
        return self.idToSignals[ID]


    def getCycleTimeById(self, ID:str) -> str:
        ''' Get the cycle time for a given ID.

        Args:
            ID (str): The ID to index.

        Returns:
            str: The cycle time for the specified ID.
        '''        
        # Return the dict value for the cycle time
        return self.idToCycleTime[ID]


    def getSendTypeById(self, ID:str) -> str:
        ''' Get the send type for a given ID.

        Args:
            ID (str): The ID to index.

        Returns:
            str: The send type for the specified ID.
        '''        
        # Return the dict value for the send type
        return self.idToSendType[ID]


    def getDbcPath(self) -> str:
        ''' Get the current DBC path.

        Returns:
            str: Path of the current instance's loaded DBC file.
        '''        
        return self.dbcPath


    def getDbcName(self) -> str:
        ''' Get the current DBC name.

        Returns:
            str: Name of the current instance's loaded DBC file.
        '''        
        return self.dbcName

`init()`

Initializes the class upon instance creation.

Source code in drivers\dbcAutoParse.py

def __init__(self) -> None:
    ''' Initializes the class upon instance creation.
    '''        
    self.version = None
    self.dbcPath = None
    self.dbcName = None
    self.idToSignals = defaultdict(dict)
    self.idToSignalDescriptions = defaultdict(dict)
    self.idToSendType = defaultdict(str)
    self.idToCycleTime = defaultdict(str)
    self.signalsToId = defaultdict(str)
    self.signalsToMin = defaultdict(str)
    self.signalsToMax = 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`	`bool`	True if execution completed with no errors, False otherwise.

Source code in drivers\dbcAutoParse.py

def dumpDictionaries(self) -> bool:
    '''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 DBC-AutoParse: Dictionary Directory Already Exists!")

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

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

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

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

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

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

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

    return True

`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

def getCycleTimeById(self, ID:str) -> str:
    ''' Get the cycle time for a given ID.

    Args:
        ID (str): The ID to index.

    Returns:
        str: The cycle time for the specified ID.
    '''        
    # Return the dict value for the cycle time
    return self.idToCycleTime[ID]

`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

def getDbcName(self) -> str:
    ''' Get the current DBC name.

    Returns:
        str: Name of the current instance's loaded DBC file.
    '''        
    return self.dbcName

`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

def getDbcPath(self) -> str:
    ''' Get the current DBC path.

    Returns:
        str: Path of the current instance's loaded DBC file.
    '''        
    return self.dbcPath

`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

def getDescriptionBySignalName(self, signalName:str) -> str:
    ''' Get the description for a given signal.

    Args:
        signalName (str): The signal name to index.

    Returns:
        str: The description for the specified value, if it exists.
    '''        
    # Return the dict value for the description
    descriptionDict = self.idToSignalDescriptions[self.signalsToId[signalName]]
    try:
        return descriptionDict[signalName]
    except KeyError:
        return "DBC Auto Parse: " + signalName + " does not have a description in the DBC " + self.dbcName + "!"

`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

def getIdBySignalName(self, signalName:str) -> str:
    ''' Get the ID for a given signal.

    Args:
        signalName (str): The signal name to index.

    Returns:
        str: The ID for the specified signal.
    '''        
    # Return the dict value for the signal
    return self.signalsToId[signalName]

`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

def getMaxBySignal(self, signalName:str) -> str:
    ''' Get the max for a given signal.

    Args:
        signalName (str): The signal name to index.

    Returns:
        str: The maximum value for the specified signal.
    '''        
    # Return the dict value for the max
    return self.signalsToMax[signalName]

`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

def getMessageById(self, ID:str) -> dict:
    '''Get the message for a given ID.

    Args:
        ID (str): The ID to index.

    Returns:
        dict: A dictionary of signal:value pairs for the specified ID's Message, where the value is the minimum value for each signal.
    '''        
    # Return the message for the ID
    return self.idToSignals[ID]

`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

def getMessageBySignalName(self, signalName:str) -> str:
    ''' Get the full message for a given signal.

    Args:
        signalName (str): The signal name to index.

    Returns:
        str: A dictionary of signal:value pairs for the specified signal's Message, where the value is the minimum value for each signal. 
    '''        
    # Return the message for the ID linked to the signal
    return self.idToSignals[self.signalsToId[signalName]]

`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

def getMinBySignal(self, signalName:str) -> str:
    ''' Get the min for a given signal.

    Args:
        signalName (str): The signal name to index.

    Returns:
        str: The minimum value for the specified value.
    '''        
    # Return the dict value for the min
    return self.signalsToMin[signalName]

`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

def getSendTypeById(self, ID:str) -> str:
    ''' Get the send type for a given ID.

    Args:
        ID (str): The ID to index.

    Returns:
        str: The send type for the specified ID.
    '''        
    # Return the dict value for the send type
    return self.idToSendType[ID]

`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

def loadDictionaries(self) -> bool:
    ''' 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 idToSignals Dictionary
    with open('dictionaries\\idToSignals.json') as inputFileIdToSignals:
        # [https://docs.python.org/3/library/json.html#json.load]
        self.idToSignals = load(inputFileIdToSignals)

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

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

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

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

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

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

`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

def parseNewDBC(self, filePath:str) -> bool:
    ''' Parses a DBC file and loads all information into instance-based dictionaries.

    Args:
        filePath (str): The Path to the DBC file to parse.

    Returns:
        bool: True if execution completed with no errors, False otherwise.
    '''        
    # Save the dbc path
    self.dbcPath = filePath
    # Save the dbc name
    self.dbcName = path.basename(self.dbcPath)

    # [https://docs.python.org/3/library/functions.html#open]
    with open(file=filePath, mode='r') as dbcFile:
        latestAddedID = ""
        latestAddedDescriptionID = ""
        latestAddedDescriptionSignal = ""
        latestAddedDescriptionFlag = False

        for line in dbcFile:
            # Strip the line of beginning / ending whitespace
            # [https://www.geeksforgeeks.org/python-string-strip/]
            strippedLine = line.strip()
            # Split the line into an array
            # [https://www.geeksforgeeks.org/python-string-split/]
            lineComponents = line.split()

            # Handle empty lines
            if not lineComponents:
                continue

            # Detect version line
            if lineComponents[0] == "VERSION":
                # Save the version
                self.version = lineComponents[1]
                # Go to the next line in the file
                continue
            # Detect a new ID
            elif lineComponents[0] == "BO_":
                # Create a new key in the idToSignals dictionary
                self.idToSignals[lineComponents[1]] = {}
                # Save ID for adding signals
                latestAddedID = lineComponents[1]
                # Go to the next line in the file
                continue


            # Detect a new signal
            elif lineComponents[0] == "SG_":
                # Add the signal to the signalsToId dictionary
                self.signalsToId[lineComponents[1]] = latestAddedID

                # Get the min and max
                signalValueRange = lineComponents[5].strip("[]").split("|")
                self.signalsToMin[lineComponents[1]] = float(signalValueRange[0])
                self.signalsToMax[lineComponents[1]] = float(signalValueRange[1])

                # Add the signal to the dictionary of the latest ID parsed, with the value being the signal min
                self.idToSignals[latestAddedID].update({lineComponents[1]: float(signalValueRange[0])})


                # Go to the next line in the file
                continue

            # Detect a new description
            elif lineComponents[0] == "CM_":
                # Detect a description for a ID
                if lineComponents[1] == "BO_":
                    currentDescription = ""
                    # Get the total description, which may have spaces and therefor was split up into the array
                    for descriptionPartCount in range(len(lineComponents) - 3):
                        currentDescription = currentDescription + " " + lineComponents[descriptionPartCount + 3]
                    # Save the ID and description to the dictionary
                    self.idToSignalDescriptions[lineComponents[2]][lineComponents[2]] = currentDescription
                    # Save the ID as last added (and as the latest signal for placeholder)
                    latestAddedDescriptionID = lineComponents[2]
                    latestAddedDescriptionSignal = lineComponents[2]
                    # Go to the next line in the file
                    continue

                # Detect a description for a signal
                elif lineComponents[1] == "SG_":
                    currentDescription = ""
                    # Get the total description, which may have spaces and therefor was split up into the array
                    for descriptionPartCount in range(len(lineComponents) - 4):
                        currentDescription = currentDescription + " " + lineComponents[descriptionPartCount + 4]
                    # Add the signal and description to the dictionary
                    self.idToSignalDescriptions[lineComponents[2]][lineComponents[3]] = currentDescription
                    # Save the ID as last added ID and signal as last added signal
                    latestAddedDescriptionID = lineComponents[2]
                    latestAddedDescriptionSignal = lineComponents[3]

                    # If the description is continued on next line, there will not be a semicolon
                    if currentDescription[-1] != ';':
                        # Set flag for next line
                        latestAddedDescriptionFlag = True

                    # Go to the next line in the file
                    continue

            # Detect a continued description
            elif latestAddedDescriptionFlag == True:
                # Get the description so far for the signal
                currentDescription = self.idToSignalDescriptions[latestAddedDescriptionID][latestAddedDescriptionSignal]
                # For all the parts of the current line, add them to the description
                for descriptionPartCount in range(len(lineComponents)):
                    currentDescription = currentDescription + " " + lineComponents[descriptionPartCount]
                # Add the description back to the dictionary
                self.idToSignalDescriptions[latestAddedDescriptionID][latestAddedDescriptionSignal] = currentDescription

                # Check if this line was the last line of the description
                if currentDescription[-1] == ';':
                    # Reset flag
                    latestAddedDescriptionFlag = False

                # Go to the next line in the file
                continue

            # Detect a new message send type or cycle time
            elif lineComponents[0] == "BA_":
                # If it is cycle time (DBC places var name in "")
                if lineComponents[1] == '"GenMsgCycleTime"':
                    # Add the ID and cycle time to dictionary
                    self.idToCycleTime[lineComponents[3]] = lineComponents[4]
                    # Go to the next line in the file
                    continue
                # If it is send type (DBC places var name in "")
                elif lineComponents[1] == '"GenMsgSendType"':
                    # Add the ID and send type to dictionary
                    self.idToSendType[lineComponents[3]] = lineComponents[4]
                    # Go to the next line in the file
                    continue


            #TODO: Figure out what VAL_ is, and add support for it
            #TODO: Figure out what VAL_TABLE_ is, and add support for it
    return True

DBC Parse

dbcParse

__init__()

dumpDictionaries()

getCycleTimeById(ID)

getDbcName()

getDbcPath()

getDescriptionBySignalName(signalName)

getIdBySignalName(signalName)

getMaxBySignal(signalName)

getMessageById(ID)

getMessageBySignalName(signalName)

getMinBySignal(signalName)

getSendTypeById(ID)

loadDictionaries()

parseNewDBC(filePath)

`dbcParse`

`init()`

`dumpDictionaries()`

`getCycleTimeById(ID)`

`getDbcName()`

`getDbcPath()`

`getDescriptionBySignalName(signalName)`

`getIdBySignalName(signalName)`

`getMaxBySignal(signalName)`

`getMessageById(ID)`

`getMessageBySignalName(signalName)`

`getMinBySignal(signalName)`

`getSendTypeById(ID)`

`loadDictionaries()`

`parseNewDBC(filePath)`