Index: dialin/hd/buttons.py =================================================================== diff -u -r9d116c25f6482d61d324558b8a1f745468030740 -r0d1e40ce50fa9b702ec281b6fc9c85e52a3e1490 --- dialin/hd/buttons.py (.../buttons.py) (revision 9d116c25f6482d61d324558b8a1f745468030740) +++ dialin/hd/buttons.py (.../buttons.py) (revision 0d1e40ce50fa9b702ec281b6fc9c85e52a3e1490) @@ -33,7 +33,7 @@ """ HD_Buttons constructor - @param can_interface: the denali can interface object + @param can_interface: the Denali CAN interface object """ super().__init__() Index: dialin/hd/ui_proxy.py =================================================================== diff -u -r5b7f516eed037f0f2650c5e41757610f11a629cc -r0d1e40ce50fa9b702ec281b6fc9c85e52a3e1490 --- dialin/hd/ui_proxy.py (.../ui_proxy.py) (revision 5b7f516eed037f0f2650c5e41757610f11a629cc) +++ dialin/hd/ui_proxy.py (.../ui_proxy.py) (revision 0d1e40ce50fa9b702ec281b6fc9c85e52a3e1490) @@ -145,7 +145,7 @@ def __init__(self, can_interface, logger: Logger): """ - @param can_interface: the denali can interface object + @param can_interface: the Denali CAN interface object """ super().__init__() Index: dialin/hd/watchdog.py =================================================================== diff -u -r2e392c92d55178f457a67423ba8c503a86dcf3c8 -r0d1e40ce50fa9b702ec281b6fc9c85e52a3e1490 --- dialin/hd/watchdog.py (.../watchdog.py) (revision 2e392c92d55178f457a67423ba8c503a86dcf3c8) +++ dialin/hd/watchdog.py (.../watchdog.py) (revision 0d1e40ce50fa9b702ec281b6fc9c85e52a3e1490) @@ -31,7 +31,7 @@ def __init__(self, can_interface, logger: Logger): """ - @param can_interface: the denali can interface object + @param can_interface: the Denali CAN interface object """ super().__init__() Index: dialin/protocols/CAN.py =================================================================== diff -u -r6356891100bf5058c4c77ac388eb23415d6435c6 -r0d1e40ce50fa9b702ec281b6fc9c85e52a3e1490 --- dialin/protocols/CAN.py (.../CAN.py) (revision 6356891100bf5058c4c77ac388eb23415d6435c6) +++ dialin/protocols/CAN.py (.../CAN.py) (revision 0d1e40ce50fa9b702ec281b6fc9c85e52a3e1490) @@ -359,7 +359,7 @@ class DenaliChannels: """ - Convenience class listing all the possible CAN channels used in the denali system. + Convenience class listing all the possible CAN channels used in the Denali system. Updates made to the "Message List.xlsx" document found in the Diality Software Team SharePoint, specifically in the CAN Channels sheet, should also be applied here. """ @@ -388,7 +388,7 @@ def __init__(self, frame: can.Message): """ - LongDialityMessageBuilder is a utility object that helps construct a denali message + LongDialityMessageBuilder is a utility object that helps construct a Denali message that is longer than 8 bytes. It is only called when we don't yet have a long message builder for the current channel. Basic principle is to construct an object with the first 8 byte message which contains the length of the message, and the later push the @@ -409,16 +409,16 @@ def frames(self) -> List[can.Message]: """ - Gets the list of frames for the long denali message + Gets the list of frames for the long Denali message - @return: A list of can messages + @return: A list of CAN messages """ return self.frames def push(self, message: can.Message, first_packet=False): """ - push appends the can message to the current list of messages + push appends the CAN message to the current list of messages @param message: 8-byte message @@ -507,7 +507,7 @@ def set_callback_complete_messages(self, callback: Callable) -> bool: """ - Sets the callback for complete denali messages + Sets the callback for complete Denali messages :param callback: a callable function that accepts a DenaliMessage as a parameter :return: True if set is successful, False otherwise @@ -520,7 +520,7 @@ def set_callback_invalid_messages(self, callback: Callable) -> bool: """ - Sets the callback function for invalid denali messages + Sets the callback function for invalid Denali messages :param callback: a callable function that accepts a DenaliMessage as a parameter :return: True if set is successful, False otherwise @@ -595,11 +595,11 @@ message: can.Message = self.message_queue.popleft() if message.dlc == DenaliMessage.PACKET_LENGTH: - # We have received a legit can message of 8 bytes + # We have received a legit CAN message of 8 bytes can_data = [b for b in message.data] channel_id = message.arbitration_id if not DenaliMessage.PAYLOAD_LENGTH_INDEX < len(can_data): - self.logger.error("Invalid denali message received: {0}".format(message)) + self.logger.error("Invalid Denali message received: {0}".format(message)) self.messages = None # Can't process this message, get the next one continue else: @@ -622,7 +622,7 @@ # We are starting to build a long message, include it in the lonMsgChannelIDSet self.long_msg_channel_id_set.add(channel_id) - # if we don't have a long denali message builder yet, create it + # if we don't have a long Denali message builder yet, create it if channel_id not in self.long_message_builders.keys(): self.long_message_builders[channel_id] = LongDenaliMessageBuilder(message) self.messages = None @@ -713,13 +713,13 @@ resend: bool = False, is_ack: bool = False): """ - Sends a denali message + Sends a Denali message @param built_message: (dict) message built using DialinMessage class @param time_out: (float) time it will wait for a response in seconds @param resend: (bool) Allow resending the message when no response is received. Disabled by default @param is_ack: (bool) If we're sending an ACK, False by default - @return: (dict) The denali packet. If a timeout occurs returns None + @return: (dict) The Denali packet. If a timeout occurs returns None """ msg_sent = False Index: dialin/utils/data_logger.py =================================================================== diff -u -r93629045e925eea85b2808a0e7a7b0ea77426f7a -r0d1e40ce50fa9b702ec281b6fc9c85e52a3e1490 --- dialin/utils/data_logger.py (.../data_logger.py) (revision 93629045e925eea85b2808a0e7a7b0ea77426f7a) +++ dialin/utils/data_logger.py (.../data_logger.py) (revision 0d1e40ce50fa9b702ec281b6fc9c85e52a3e1490) @@ -69,7 +69,7 @@ # ("module", "timestamp", "header", "value") if not os.path.exists(self.path_disable_logging): self.queue.append(data) - # Keep for debugging + # TODO: Remove later - keep for debugging # else: # self.logger.debug("Ignoring {0}".format(data)) Index: dialin/utils/singleton.py =================================================================== diff -u -r12fc8d4dee213f861ee7645ce83c8b3a79896e10 -r0d1e40ce50fa9b702ec281b6fc9c85e52a3e1490 --- dialin/utils/singleton.py (.../singleton.py) (revision 12fc8d4dee213f861ee7645ce83c8b3a79896e10) +++ dialin/utils/singleton.py (.../singleton.py) (revision 0d1e40ce50fa9b702ec281b6fc9c85e52a3e1490) @@ -35,7 +35,7 @@ the returned instance. """ cls._creation_attempts += 1 - # Keep for debugging + # TODO: Remove later - keep for debugging # print("CAN interface constructor call counter: {0}".format(cls._creation_attempts)) # First thread acquires the lock with cls._lock: