Add type 52 updates and placeholders for types 53 and 54

Author: jacobrdavis

microSWIFTtelemetry/sbd/definitions.py

@@ -7,34 +7,43 @@
     "get_variable_definitions",
 ]
 
+import struct
 from typing import List, Tuple
 
 
-def get_sensor_type_definition(sensor_type: int) -> str:
+def get_sensor_type_definition(sensor_type: str, file_size: int) -> str:
     """
     Dictionary of microSWIFT sensor type definitions;
     see https://github.com/alexdeklerk/microSWIFT.
 
     Arguments:
-        - sensor_type (int), sensor type defintion to return
+        - sensor_type (str), sensor type definition to return
+        - file_size (int), size of the SBD file in bytes
 
     Raises:
         - ValueError, raise error if the sensor type is not one of the
                 types defined in microSWIFT.py and configured to be
                 parsed on the sever.
 
     Returns:
-        - (str), sensor type defintion in Python's struct module format
+        - (str), sensor type definition in Python's struct module format
             * See: https://docs.python.org/3/library/struct.html
     """
 
     # Define the sensor type using Python's struct module format
     PAYLOAD_DEFINITIONS = {
-        50: '<sbbhfff42f42f42f42f42f42f42ffffffffiiiiii',
-        51: '<sbbhfff42fffffffffffiiiiii',
-        52: '<sbBheee42eee42b42b42b42b42Bffeeef',  # original v1 has `b` in third pos
+        '50': '<sbbhfff42f42f42f42f42f42f42ffffffffiiiiii',
+        '51': '<sbbhfff42fffffffffffiiiiii',
+        '52': '<sbBheee42eee42b42b42b42b42Bffeeef',  # original v1 has `b` in third pos
+        '52-2': '<sbbheee42eee42b42b42b42b42BIIeeeII',  # Phil Mar 2025 edits
+        '53': '<sbbH' + 3 * 'iiiiIIHH',
+        '54': '<sbbH' + 6 * 'iiiiII13H',
     }
 
+    # Accommodate modified sensor type 52 definition past Nov 2024
+    if sensor_type == '52' and file_size == struct.calcsize(PAYLOAD_DEFINITIONS['52-2']):
+        sensor_type = '52-2'
+
     if sensor_type not in PAYLOAD_DEFINITIONS.keys():
         raise ValueError((f'sensor_type not defined - can only be value in:'
                           f'{list(PAYLOAD_DEFINITIONS.keys())}'))

microSWIFTtelemetry/sbd/read_sbd.py

@@ -8,7 +8,7 @@
 import struct
 import warnings
 from datetime import datetime, timezone
-from typing import Tuple
+from typing import Tuple, Union
 
 import numpy as np
 
@@ -52,8 +52,8 @@ def unpack_sbd(file_name: str, file_content: bytes) -> Tuple:
     sensor_type = get_sensor_type(file_content)
 
     if sensor_type:
-        payload_struct = get_sensor_type_definition(sensor_type)
         file_size = len(file_content)
+        payload_struct = get_sensor_type_definition(sensor_type, file_size)
         expected_file_size = struct.calcsize(payload_struct)
         if file_size == expected_file_size:
             data = struct.unpack(payload_struct, file_content)
@@ -70,10 +70,14 @@ def unpack_sbd(file_name: str, file_content: bytes) -> Tuple:
         error_message['error'] = _rstrip_null(file_content)  # decode('ascii')
 
     if data:
-        if sensor_type == 51:
+        if sensor_type == '51':
             swift = unpack_sensor_type_51(data)
-        elif sensor_type == 52:
+        elif sensor_type == '52':
             swift = unpack_sensor_type_52(data)
+        elif sensor_type == '53':
+            swift = {}  # TODO: ignore for now, but implement later
+        elif sensor_type == '54':
+            swift = {}  # TODO: ignore for now, but implement later
         else:
             raise NotImplementedError(f'The specified sensor type '
                                       f'({sensor_type}) is not supported.')
@@ -83,7 +87,7 @@ def unpack_sbd(file_name: str, file_content: bytes) -> Tuple:
     return swift, error_message
 
 
-def get_sensor_type(file_content: bytes) -> int:
+def get_sensor_type(file_content: bytes) -> Union[str, None]:
     """
     Determine sensor type from an SBD message.
 
@@ -96,13 +100,13 @@ def get_sensor_type(file_content: bytes) -> int:
         file_content (bytes): binary SBD message
 
     Returns:
-        (int): int corresponding to sensor type
+        (str): str corresponding to sensor type
     """
     payload_type = \
         file_content[PAYLOAD_START:PAYLOAD_START+1].decode(errors='replace')
 
     if payload_type == PAYLOAD_TYPE:
-        sensor_type = ord(file_content[PAYLOAD_START+1:PAYLOAD_START+2])
+        sensor_type = str(ord(file_content[PAYLOAD_START+1:PAYLOAD_START+2]))
     else:
         sensor_type = None
 

microSWIFTtelemetry/version.py

@@ -4,7 +4,7 @@
 # Format expected by setup.py and doc/source/conf.py: string of form "X.Y.Z"
 _version_major = 0
 _version_minor = 3
-_version_micro = 4  # use '' for first of series, number for 1 and above
+_version_micro = 5  # use '' for first of series, number for 1 and above
 # _version_extra = 'dev'
 _version_extra = ''  # TODO: Uncomment this for full releases