feat: adds property full_name to message type 21 (#163)

* feat: adds property full_name to message type 21

* chore: drops python 3.8 from CI replacing it with 3.13

Author: M0r13n

.github/workflows/main.yml

@@ -12,16 +12,15 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python: ['3.8', '3.9', '3.10', '3.11', '3.12']
+        python: ['3.9', '3.10', '3.11', '3.12', '3.13']
         os: ['ubuntu-latest']
     steps:
       - uses: actions/checkout@master
 
       - name: Setup python
-        uses: actions/setup-python@v1
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python }}
-          architecture: x64
 
       - name: Install requirements
         run: pip install -r requirements.txt

CHANGELOG.txt

@@ -1,6 +1,11 @@
 ====================
  pyais CHANGELOG
 ====================
+-------------------------------------------------------------------------------
+ Version 2.8.4 26 Jan 2025
+-------------------------------------------------------------------------------
+* closes #161: https://github.com/M0r13n/pyais/issues/161
+  * adds property `full_name` to message type 21
 -------------------------------------------------------------------------------
  Version 2.8.3 20 Dec 2024
 -------------------------------------------------------------------------------

pyais/__init__.py

@@ -5,7 +5,7 @@
 from pyais.tracker import AISTracker, AISTrack
 
 __license__ = 'MIT'
-__version__ = '2.8.3'
+__version__ = '2.8.4'
 __author__ = 'Leon Morten Richter'
 
 __all__ = (

pyais/messages.py

@@ -1329,6 +1329,18 @@ class MessageType21(Payload):
     spare_1 = bit_field(1, bytes, default=b'')
     name_ext = bit_field(88, str, default='')
 
+    @functools.cached_property
+    def full_name(self) -> str:
+        """The name field is up to 20 characters of 6-bit ASCII. If this field
+        is full (has no trailing @ characters) the decoder should interpret
+        the Name Extension field later in the message (no more than 14 6-bit
+        characters) and concatenate it to this one to obtain the full name."""
+        if self.name:
+            if self.name_ext:
+                return f"{self.name}{self.name_ext}"
+            return str(self.name)
+        return ""
+
 
 @attr.s(slots=True)
 class MessageType22Addressed(Payload):

tests/test_decode.py

@@ -961,6 +961,7 @@ def test_to_dict_non_enum(self):
                 "aid_type": 25,
                 "assigned": None,
                 "epfd": 7,
+                'full_name': 'STDB CUT 2',
                 "lat": -32.004333,
                 "lon": 115.691833,
                 "mmsi": 995036013,
@@ -986,7 +987,6 @@ def test_decode_and_merge(self):
         decoded = NMEAMessage(msg)
 
         d = decoded.decode_and_merge(enum_as_int=True)
-
         self.assertEqual(
             d,
             {
@@ -1001,6 +1001,7 @@ def test_decode_and_merge(self):
                 "fill_bits": 2,
                 "frag_cnt": 1,
                 "frag_num": 1,
+                'full_name': 'STDB CUT 2',
                 "lat": -32.004333,
                 "lon": 115.691833,
                 "mmsi": 995036013,
@@ -1041,6 +1042,7 @@ def test_decode_and_merge(self):
                 "fill_bits": 2,
                 "frag_cnt": 1,
                 "frag_num": 1,
+                'full_name': 'STDB CUT 2',
                 "lat": -32.004333,
                 "lon": 115.691833,
                 "mmsi": 995036013,
@@ -1768,3 +1770,9 @@ def test_decode_with_empty_payload(self):
             )
 
         self.assertEqual(str(err.exception), '!AIVDM,1,1,0,A,,0*16')
+
+    def test_decode_type_21_full_name(self):
+        raw = b"!AIVDM,1,1,,B,E>jHDL1W73nWaanah7S39T7a2h;wror=@5nL`A2AISd002CQ1PDS@0,4*39"
+        decoded = decode(raw)
+
+        assert decoded.full_name == "NNG-OSS-S OFFSHORE WINDFARM"