nmea2000 0.1.0__py3-none-any.whl

nmea2000/__init__.py

@@ -0,0 +1,5 @@
+from .decoder import NMEA2000Decoder
+from .encoder import NMEA2000Encoder
+from .message import NMEA2000Message
+
+__all__ = ["NMEA2000Decoder", "NMEA2000Encoder", "NMEA2000Message"]

nmea2000/cli.py

@@ -0,0 +1,81 @@
+import argparse
+import sys
+import logging
+import binascii
+
+from .decoder import NMEA2000Decoder
+from .pgns import *
+
+logger = logging.getLogger(__name__)
+
+
+def parse(filename: str, decoder: NMEA2000Decoder):
+    data_length = 8
+    try:
+        with open(filename, 'r') as file:
+            while True:
+                line = file.readline()
+                if not line:
+                    break
+                if line.startswith('#') or len(line) <= 1:
+                    continue
+                line = line.strip()
+                parts = line.split(',')
+                date = parts[0]
+                priority = int(parts[1])
+                pgn = int(parts[2])
+                src = int(parts[3])
+                dest = int(parts[4])
+                no_idea = parts[5]
+                can_data = parts[6:6 + data_length][::-1]
+                can_data_bytes = [int(byte, 16) for byte in can_data]
+                can_data_hex = binascii.hexlify(bytes(can_data_bytes)).decode('ascii')
+                logger.info(f'Processing: {can_data_hex}')
+                decoder.decode(date, priority, pgn, src, dest, can_data_hex)
+    except KeyboardInterrupt:
+        sys.stdout.flush()
+        pass
+
+def main():
+    logging.basicConfig(filename='parser.log', level=logging.NOTSET)
+    parser = argparse.ArgumentParser(description="NMEA 2000 CLI Tool")
+    subparsers = parser.add_subparsers(dest="command", required=True)
+
+    # Decode command
+    decode_parser = subparsers.add_parser("decode", help="Decode an NMEA 2000 frame")
+    
+    # Either provide a frame string or a file
+    decode_parser.add_argument(
+        "--frame", 
+        type=str, 
+        help="Hex-encoded NMEA 2000 frame (optional if file is provided)"
+    )
+    decode_parser.add_argument(
+        "--file", 
+        type=str, 
+        help="Path to a file containing a Hex-encoded NMEA 2000 frame"
+    )
+
+    # Parse arguments
+    args = parser.parse_args()
+
+    if args.command == "decode":
+        decoder = NMEA2000Decoder()
+
+        # Decode from a frame string if provided
+        if args.frame:
+            frame_str = args.frame
+            print(f"Decoding frame: {frame_str}")
+            decoded = decoder.decode_actisense_string(frame_str)
+            print(decoded)
+
+        # Decode from a file if provided
+        elif args.file:
+            parse(args.file, decoder)
+        else:
+            print("Error: You must provide either a frame or a file to decode.")
+            exit(1)
+
+
+if __name__ == "__main__":
+    main()

nmea2000/decoder.py

@@ -0,0 +1,206 @@
+import sys
+import logging
+import binascii
+from .message import *
+from .pgns import *
+
+logger = logging.getLogger(__name__)
+
+class fast_pgn_metadata():
+    def __init__(self) -> None:
+        self.frames = {}
+        self.payload_length = 0
+        self.bytes_stored = 0
+        self.sequence_counter = 0
+
+class NMEA2000Decoder():
+    def __init__(self) -> None:
+        self.data = {}
+
+    def _decode_fast_message(self, pgn, priority, src, dest, can_data_hex) -> NMEA2000Message:
+        """Parse a fast packet message and store the data until all frames are received."""
+        fast_packet_key = f"{pgn}_{src}_{dest}"
+        
+        # Check if this PGN already has a storage structure; if not, create one
+        if self.data.get(fast_packet_key) is None:
+            self.data[fast_packet_key] = fast_pgn_metadata()
+            
+        fast_pgn = self.data[fast_packet_key]
+
+        # Convert the last two characters to an integer to get the sequence and frame counters
+        last_byte = int(can_data_hex[-2:], 16)  # Convert the last two hex digits to an integer
+        
+        # Extract the sequence counter (high 3 bits) and frame counter (low 5 bits) from the last byte
+        sequence_counter = (last_byte >> 5) & 0b111  # Extract high 3 bits
+        frame_counter = last_byte & 0b11111  # Extract low 5 bits
+        
+        total_bytes = None
+        
+        if frame_counter != 0 and fast_pgn.payload_length == 0:
+            logger.debug(f"Ignoring frame {frame_counter} for PGN {pgn} as first frame has not been received.")
+            return None
+        
+        # Calculate data payload
+        if frame_counter == 0:
+            
+            # Extract the total number of frames from the second-to-last byte
+            total_bytes_hex = can_data_hex[-4:-2]  # Get the second-to-last byte in hex
+            total_bytes = int(total_bytes_hex, 16)  # Convert hex to int
+            
+            # Start a new pgn hass structure 
+        
+            fast_pgn.payload_length = total_bytes
+            fast_pgn.sequence_counter = sequence_counter
+            fast_pgn.bytes_stored = 0  # Reset bytes stored for a new message
+            fast_pgn.frames.clear()  # Clear previous frames
+                    
+            # For the first frame, exclude the last 4 hex characters (2 bytes) from the payload
+            data_payload_hex = can_data_hex[:-4]
+            
+        else:       
+            if sequence_counter != fast_pgn.sequence_counter:
+                logger.debug(f"Ignoring frame {sequence_counter} for PGN {pgn} as it does not match current sequence.")
+                return None
+            elif frame_counter in fast_pgn.frames:
+                logger.debug(f"Frame {frame_counter} for PGN {pgn} is already stored.")
+                return None
+            else:
+                # For subsequent frames, exclude the last 2 hex characters (1 byte) from the payload
+                data_payload_hex = can_data_hex[:-2]
+        
+        byte_length = len(data_payload_hex) // 2
+
+        # Store the frame data
+        fast_pgn.frames[frame_counter] = data_payload_hex
+        fast_pgn.bytes_stored += byte_length  # Update the count of bytes stored
+        
+        # Log the extracted values
+        logger.debug(f"Sequence Counter: {sequence_counter}, Frame Counter: {frame_counter}")
+        
+        if total_bytes is not None:
+            logger.debug(f"Total Payload Bytes: {total_bytes}")
+
+        logger.debug(f"Orig Payload (hex): {can_data_hex}, Data Payload (hex): {data_payload_hex}")
+        
+        logger.debug("HASS PGN Data: %s", fast_pgn)
+        
+        # Check if all expected bytes have been stored
+        if fast_pgn.bytes_stored >= fast_pgn.payload_length:
+            
+            logger.debug("All Fast packet frames collected for PGN: %d", pgn)
+
+            # All data for this PGN has been received, proceed to publish
+            combined_payload_hex = self._combine_pgn_frames(fast_pgn)
+            combined_payload_int = int(combined_payload_hex, 16)
+            
+            nmea = None
+            if combined_payload_int is not None:
+                logger.debug(f"Combined Payload (hex): {combined_payload_hex})")
+                logger.debug(f"Combined Payload (hex): (hex: {combined_payload_int:x})")
+
+                nmea = self._call_decode_function(pgn, priority, src, dest, combined_payload_int)
+
+            # Reset the structure for this PGN
+            del self.data[fast_packet_key]
+            return nmea
+        else:
+            logger.debug(f"Waiting for {fast_pgn.payload_length - fast_pgn.bytes_stored} more bytes.")
+            return None
+
+    def _combine_pgn_frames(self, fast_pgn):
+        """Combine stored frame data for a PGN into a single hex string, preserving the original byte lengths."""
+        
+        combined_payload_hex = ""  # Start with an empty string
+
+        for frame_counter in sorted(fast_pgn.frames):
+            frame_data_hex = fast_pgn.frames[frame_counter]
+            combined_payload_hex = frame_data_hex + combined_payload_hex
+
+        return combined_payload_hex
+
+    def decode_actisense_string(self, actisense_string: str) -> NMEA2000Message:
+        """Process an Actisense packet string and extract the PGN, source ID, and CAN data."""
+        # Split the Actisense string by spaces
+        parts = actisense_string.split()
+        
+        if len(parts) < 2:
+            raise ValueError("Invalid Actisense string format")
+        
+        # Extract the priority, destination, and source from the first part
+        n = int(parts[0], 16)
+        priority = n & 0xF
+        dest = (n >> 4) & 0xFF
+        src = (n >> 12) & 0xFF
+        
+        # Extract the PGN from the second part
+        pgn = int(parts[1], 16)
+        
+        # Extract the CAN data from the remaining parts
+        # Convert to bytes
+        bytes_data = bytes.fromhex(parts[2])
+
+        # Reverse the byte order
+        reversed_bytes = bytes_data[::-1]
+
+        # Log the extracted information
+        logger.debug(f"Priority: {priority}, Destination: {dest}, Source: {src}, PGN: {pgn}, CAN Data: {reversed_bytes}")
+        
+        return self._call_decode_function(pgn, priority, src, dest, reversed_bytes)
+        
+    def decode(self, packet: bytes) -> NMEA2000Message:
+        """Process a single packet and extract the PGN, source ID, and CAN data."""
+        
+        # Extract the priority (first 3 bits) and data length (last 4 bits) from the type byte
+        type_byte = packet[0]
+        priority = (type_byte >> 5) & 0x07  # first 3 bits represent the priority
+        data_length = type_byte & 0x0F  # last 4 bits represent the data length
+        
+        # Extract and reverse the frame ID
+        frame_id = packet[1:5][::-1]
+        
+        # Convert frame_id bytes to an integer
+        frame_id_int = int.from_bytes(frame_id, byteorder='big')
+        
+        # Extracting Source ID from the frame ID
+        source_id = frame_id_int & 0xFF
+        
+        # Extracting PGN ID from the frame ID
+        pgn_id = (frame_id_int >> 8) & 0x3FFFF  # Shift right by 8 bits and mask to 18 bits
+        
+        # Extract and reverse the CAN data
+        can_data = packet[5:5 + data_length][::-1]
+               
+        # Log the extracted information including the combined string
+        logger.debug("PGN ID: %s, Frame ID: %s, CAN Data: %s, Source ID: %s",
+            pgn_id,
+            binascii.hexlify(frame_id).decode('ascii'),
+            can_data,
+            source_id)
+
+        is_fast_func_name = f'is_fast_pgn_{pgn_id}'
+        is_fast_func = globals().get(is_fast_func_name)
+
+        if is_fast_func:
+            is_fast = is_fast_func()
+            logger.info(f"Is fast PGN: {is_fast}")
+        else:
+            logger.error(f"No function found for PGN: {pgn_id}\n")
+            return None
+
+        if (is_fast):
+            return self._decode_fast_message(pgn_id, priority, source_id, 0, can_data) # TODO: destination is hardcoded to 0
+        else:
+            return self._call_decode_function(pgn_id, priority, source_id, 0, can_data) # TODO: destination is hardcoded to 0
+
+    def _call_decode_function(self, pgn:int, priority: int, src: int, dest: int, data:bytes) -> NMEA2000Message:
+        decode_func_name = f'decode_pgn_{pgn}'
+        decode_func = globals().get(decode_func_name)
+
+        if not decode_func:
+            raise ValueError(f"No function found for PGN: {pgn}")
+
+        nmea2000Message = decode_func(int.from_bytes(data, "big"))
+        nmea2000Message.add_data(src, dest, priority)
+        sys.stdout.write(nmea2000Message.to_string_test_style()+"\n")
+        return nmea2000Message
+        

nmea2000/encoder.py

@@ -0,0 +1,45 @@
+import sys
+import logging
+import binascii
+from .message import *
+from .pgns import *
+
+logger = logging.getLogger(__name__)
+
+class NMEA2000Encoder:
+    def _call_encode_function(self, nmea2000Message: NMEA2000Message) -> bytearray:
+        encode_func_name = f'encode_pgn_{nmea2000Message.PGN}'
+        encode_func = globals().get(encode_func_name)
+
+        if encode_func:
+            bytes = encode_func(nmea2000Message)
+            return bytes
+        else:
+            logger.error(f"No function found for PGN: {nmea2000Message.PGN}\n")
+            return None
+            
+    def encode_actisense(self, nmea2000Message: NMEA2000Message) -> str:
+        """Convert an Nmea2000Message object into an Actisense packet string."""
+        # Extract necessary fields
+        priority = nmea2000Message.priority & 0xF
+        dest = nmea2000Message.destination & 0xFF
+        src = nmea2000Message.source & 0xFF
+        pgn = nmea2000Message.PGN & 0xFFFFFF
+
+        # Construct the first part (priority, dest, src)
+        n = (src << 12) | (dest << 4) | priority
+        first_part = f"{n:05X}"
+
+        # Convert PGN to hex
+        pgn_part = f"{pgn:05X}"
+
+        nmea_int = self._call_encode_function(nmea2000Message)
+        byte_length = (nmea_int.bit_length() + 7) // 8
+        can_data_part = nmea_int.to_bytes(byte_length, byteorder="big")[::-1].hex().upper()
+
+        # Construct the final Actisense string
+        actisense_string = f"{first_part} {pgn_part} {can_data_part}"
+        
+        logger.debug(f"Encoded Actisense string: {actisense_string}")
+        
+        return actisense_string

nmea2000/message.py

@@ -0,0 +1,72 @@
+import binascii
+
+# NMEA2000Message class represent a single NMEA 2000 PGN
+class NMEA2000Message():
+    def __init__(
+        self,
+        PGN,
+        id, 
+        description, 
+    ):
+        """Initialize the NMEA2000Message."""
+        self.PGN = PGN
+        self.id = id
+        self.description = description
+        self.fields = []
+
+    def add_data(self, src, dest, priority):
+        self.source = src
+        self.destination = dest
+        self.priority = priority
+        
+    def __repr__(self):
+        return f"NMEA2000Message(PGN={self.PGN}, id={self.id}, description={self.description}, fields={self.fields})"        
+
+    def to_string_test_style(self):
+        fields_str = ', '.join([field.to_string_test_style() for field in self.fields])
+        return f"{self.PGN} {self.description}:  {fields_str}"
+    
+# NMEA2000Field class represent a single NMEA 2000 field
+class NMEA2000Field():
+    def __init__(
+        self, 
+        id, 
+        name, 
+        description, 
+        unit_of_measurement, 
+        value,
+        raw_value 
+    ):
+        """Initialize the field."""
+        self.id = id
+        self.name = name
+        self.description = description
+        self.unit_of_measurement = unit_of_measurement
+        self.value = value
+        self.raw_value = raw_value
+
+    def __repr__(self):
+        return f"NMEA2000Field(id={self.id}, name={self.name}, description={self.description}, unit_of_measurement={self.unit_of_measurement}, value={self.value}, raw_value={self.raw_value})"
+
+    def to_string_test_style(self):
+ #       raw_value_hex = hex(int(self.raw_value)) if isinstance(self.raw_value, int) else self.raw_value
+        if isinstance(self.raw_value, int):
+            # Determine the number of bytes needed
+            byte_length = (self.raw_value.bit_length() + 8) // 8 or 1
+
+            # Convert integer to bytes (big-endian)
+            value_bytes = int_to_bytes(self.raw_value, byte_length)
+
+            # Use binascii.hexlify to convert bytes to hex
+            hex_value = binascii.hexlify(value_bytes, " ").upper()
+
+            # Convert hex bytes to a string (if needed)
+            raw_value_hex = hex_value.decode('utf-8')
+        else:
+            raw_value_hex = self.raw_value
+        return f'{self.name} = {self.value} (bytes = "{raw_value_hex}")'
+    
+def int_to_bytes(value, length):
+    result = value.to_bytes(length, byteorder='little', signed=True)
+    return result
+