Some annotations for quantities

* Update bds50.py: round roll to 3 places instead of 1

Provide a bit more detail for smaller roll angles.

* remove rounding

* update poetry

* update poetry

* update test

* update bds06

* update workflow

---------

Co-authored-by: Junzi Sun <junzisun@gmail.com>

.github/dependabot.yml

@@ -0,0 +1,11 @@
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "monthly"
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "monthly"

.github/workflows/pypi-publish.yml

@@ -10,7 +10,6 @@ on:
 
 env:
   POETRY_VERSION: "1.3.1"
-  PYTHON_VERSION: "3.10"
 
 jobs:
   deploy:
@@ -18,7 +17,7 @@ jobs:
 
     strategy:
       matrix:
-        os: [ubuntu-latest, macos-latest, windows-latest]
+        os: [windows-latest, ubuntu-latest, macos-latest]
         python-version: ["3.8", "3.9", "3.10", "3.11"]
 
     steps:
@@ -27,7 +26,12 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v4
         with:
-          python-version: ${{ env.PYTHON_VERSION }}
+          python-version: ${{ matrix.python-version }}
+
+      - name: Add poetry to windows path
+        if: "startsWith(runner.os, 'windows')"
+        run: |
+          echo "C:\Users\runneradmin\.local\bin" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append
 
       - name: Install and configure Poetry
         uses: snok/install-poetry@v1.3.3
@@ -55,7 +59,7 @@ jobs:
           poetry run twine upload dist/*.whl
 
       - name: Build and publish (source)
-        if: "startsWith(runner.os, 'ubuntu') and env.PYTHON_VERSION == '3.10'"
+        if: ${{ startsWith(runner.os, 'windows') && matrix.python-version == '3.11' }}
         env:
           TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
           TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}

.github/workflows/run-tests.yml

@@ -20,17 +20,17 @@ jobs:
       PYTHON_VERSION: ${{ matrix.python-version }}
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - name: Set up Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
 
       # virtualenv cache should depends on OS, Python version and `poetry.lock` (and optionally workflow files).
       - name: Cache Packages
         uses: actions/cache@v3
-        if: runner.os != 'windows-latest'
+        if: ${{ !startsWith(runner.os, 'windows') }}
         with:
           path: |
             ~/.local
@@ -65,7 +65,6 @@ jobs:
           poetry run pytest tests --cov --cov-report term-missing
 
       - name: Upload coverage to Codecov
-        if: ${{ github.event_name != 'pull_request_target' }}
+        uses: codecov/codecov-action@v3
-        uses: codecov/codecov-action@v2
         with:
           env_vars: PYTHON_VERSION

build.py

@@ -1,9 +1,10 @@
 import os
 import shutil
 import sys
-from distutils.core import Distribution, Extension
 from distutils.command import build_ext
+from distutils.core import Distribution, Extension
 
+# import pip
 from Cython.Build import cythonize
 
 
@@ -11,16 +12,7 @@ def build() -> None:
     compile_args = []
 
     if sys.platform == "linux":
-        compile_args += [
+        compile_args += ["-Wno-pointer-sign", "-Wno-unused-variable"]
-            "-march=native",
-            "-O3",
-            "-msse",
-            "-msse2",
-            "-mfma",
-            "-mfpmath=sse",
-            "-Wno-pointer-sign",
-            "-Wno-unused-variable",
-        ]
 
     extensions = [
         Extension(

pyModeS/decoder/bds/bds05.py

@@ -82,7 +82,7 @@ def airborne_position(
     if lon > 180:
         lon = lon - 360
 
-    return round(lat, 5), round(lon, 5)
+    return lat, lon
 
 
 def airborne_position_with_ref(
@@ -129,7 +129,7 @@ def airborne_position_with_ref(
 
     lon = d_lon * (m + cprlon)
 
-    return round(lat, 5), round(lon, 5)
+    return lat, lon
 
 
 def altitude(msg: str) -> None | int:

pyModeS/decoder/bds/bds06.py

@@ -19,7 +19,6 @@ def surface_position(
     lat_ref: float,
     lon_ref: float,
 ) -> None | tuple[float, float]:
-
     """Decode surface position from a pair of even and odd position message,
     the lat/lon of receiver must be provided to yield the correct solution.
 
@@ -92,7 +91,7 @@ def surface_position(
     imin = min(range(4), key=dls.__getitem__)
     lon = lons[imin]
 
-    return round(lat, 5), round(lon, 5)
+    return lat, lon
 
 
 def surface_position_with_ref(
@@ -139,12 +138,12 @@ def surface_position_with_ref(
 
     lon = d_lon * (m + cprlon)
 
-    return round(lat, 5), round(lon, 5)
+    return lat, lon
 
 
 def surface_velocity(
     msg: str, source: bool = False
-) -> tuple[None | float, float, int, str]:
+) -> tuple[None | float, None | float, int, str]:
     """Decode surface velocity from a surface position message
 
     Args:
@@ -173,7 +172,6 @@ def surface_velocity(
     trk_status = int(mb[12])
     if trk_status == 1:
         trk = common.bin2int(mb[13:20]) * 360 / 128
-        trk = round(trk, 1)
     else:
         trk = None
 

pyModeS/decoder/bds/bds09.py

@@ -48,7 +48,6 @@ def airborne_velocity(
     spd: None | float
 
     if subtype in (1, 2):
-
         v_ew = common.bin2int(mb[14:24])
         v_ns = common.bin2int(mb[25:35])
 
@@ -77,7 +76,7 @@ def airborne_velocity(
             trk = math.degrees(trk)  # convert to degrees
             trk = trk if trk >= 0 else trk + 360  # no negative val
 
-            trk_or_hdg = round(trk, 2)
+            trk_or_hdg = trk
 
         spd_type = "GS"
         dir_type = "TRUE_NORTH"
@@ -87,7 +86,6 @@ def airborne_velocity(
             hdg = None
         else:
             hdg = common.bin2int(mb[14:24]) / 1024 * 360.0
-            hdg = round(hdg, 2)
 
         trk_or_hdg = hdg
 

pyModeS/decoder/bds/bds44.py

@@ -72,7 +72,7 @@ def wind44(msg: str) -> Tuple[Optional[int], Optional[float]]:
     speed = common.bin2int(d[5:14])  # knots
     direction = common.bin2int(d[14:23]) * 180 / 256  # degree
 
-    return round(speed, 0), round(direction, 1)
+    return speed, direction
 
 
 def temp44(msg: str) -> Tuple[float, float]:
@@ -96,10 +96,8 @@ def temp44(msg: str) -> Tuple[float, float]:
         value = value - 1024
 
     temp = value * 0.25  # celsius
-    temp = round(temp, 2)
 
     temp_alternative = value * 0.125  # celsius
-    temp_alternative = round(temp_alternative, 3)
 
     return temp, temp_alternative
 
@@ -140,7 +138,7 @@ def hum44(msg: str) -> Optional[float]:
 
     hm = common.bin2int(d[50:56]) * 100 / 64  # %
 
-    return round(hm, 1)
+    return hm
 
 
 def turb44(msg: str) -> Optional[int]:

pyModeS/decoder/bds/bds45.py

@@ -171,7 +171,6 @@ def temp45(msg: str) -> Optional[float]:
         value = value - 512
 
     temp = value * 0.25  # celsius
-    temp = round(temp, 1)
 
     return temp
 

pyModeS/decoder/bds/bds50.py

@@ -81,7 +81,7 @@ def roll50(msg: str) -> Optional[float]:
         value = value - 512
 
     angle = value * 45 / 256  # degree
-    return round(angle, 1)
+    return angle
 
 
 def trk50(msg: str) -> Optional[float]:
@@ -110,7 +110,7 @@ def trk50(msg: str) -> Optional[float]:
     if trk < 0:
         trk = 360 + trk
 
-    return round(trk, 3)
+    return trk
 
 
 def gs50(msg: str) -> Optional[float]:
@@ -154,7 +154,7 @@ def rtrk50(msg: str) -> Optional[float]:
         value = value - 512
 
     angle = value * 8 / 256  # degree / sec
-    return round(angle, 3)
+    return angle
 
 
 def tas50(msg: str) -> Optional[float]:

pyModeS/decoder/bds/bds53.py

@@ -86,7 +86,7 @@ def hdg53(msg: str) -> Optional[float]:
     if hdg < 0:
         hdg = 360 + hdg
 
-    return round(hdg, 3)
+    return hdg
 
 
 def ias53(msg: str) -> Optional[float]:
@@ -122,7 +122,7 @@ def mach53(msg: str) -> Optional[float]:
         return None
 
     mach = common.bin2int(d[24:33]) * 0.008
-    return round(mach, 3)
+    return mach
 
 
 def tas53(msg: str) -> Optional[float]:
@@ -140,7 +140,7 @@ def tas53(msg: str) -> Optional[float]:
         return None
 
     tas = common.bin2int(d[34:46]) * 0.5  # kts
-    return round(tas, 1)
+    return tas
 
 
 def vr53(msg: str) -> Optional[int]:

pyModeS/decoder/bds/bds62.py

@@ -200,7 +200,6 @@ def selected_heading(msg: str) -> None | float:
     else:
         hdg_sign = int(mb[30])
         hdg = (hdg_sign + 1) * common.bin2int(mb[31:39]) * (180 / 256)
-        hdg = round(hdg, 2)
 
     return hdg
 

pyModeS/decoder/flarm/__init__.py

@@ -1,4 +1,5 @@
 from typing import TypedDict
+from typing_extensions import Annotated
 
 from .decode import flarm as flarm_decode
 
@@ -10,8 +11,8 @@ class DecodedMessage(TypedDict):
     icao24: str
     latitude: float
     longitude: float
-    altitude: int
+    altitude: Annotated[int, "m"]
-    vertical_speed: float
+    vertical_speed: Annotated[float, "m/s"]
     groundspeed: int
     track: int
     type: str

pyModeS/decoder/flarm/decode.pyx

@@ -130,12 +130,12 @@ def flarm(long timestamp, str msg, float refLat, float refLon, **kwargs):
     return dict(
         timestamp=timestamp,
         icao24=icao24,
-        latitude=round(lat * 1e-7, 6),
+        latitude=lat * 1e-7,
-        longitude=round(lon * 1e-7, 6),
+        longitude=lon * 1e-7,
         geoaltitude=altitude,
         vertical_speed=raw_vs * mult_factor / 10,
-        groundspeed=round(speed),
+        groundspeed=speed,
-        track=round(heading4 - 4 * turningRate(heading4, heading8) / 4),
+        track=heading4 - 4 * turningRate(heading4, heading8) / 4,
         type=AIRCRAFT_TYPES[aircraft_type],
         sensorLatitude=refLat,
         sensorLongitude=refLon,

pyModeS/extra/rtlreader.py

@@ -1,14 +1,22 @@
+from __future__ import annotations
+
 import time
 import traceback
 import numpy as np
 import pyModeS as pms
 
+from typing import Any
+
+
+import_msg = """
+---------------------------------------------------------------------
+Warning: pyrtlsdr not installed (required for using RTL-SDR devices)!
+---------------------------------------------------------------------"""
+
 try:
     import rtlsdr  # type: ignore
-except:
+except ImportError:
-    print("------------------------------------------------------------------------")
+    print(import_msg)
-    print("! Warning: pyrtlsdr not installed (required for using RTL-SDR devices) !")
-    print("------------------------------------------------------------------------")
 
 sampling_rate = 2e6
 smaples_per_microsec = 2
@@ -24,9 +32,9 @@ th_amp_diff = 0.8  # signal amplitude threshold difference between 0 and 1 bit
 
 
 class RtlReader(object):
-    def __init__(self, **kwargs):
+    def __init__(self, **kwargs) -> None:
         super(RtlReader, self).__init__()
-        self.signal_buffer = []  # amplitude of the sample only
+        self.signal_buffer: list[float] = []  # amplitude of the sample only
         self.sdr = rtlsdr.RtlSdr()
         self.sdr.sample_rate = sampling_rate
         self.sdr.center_freq = modes_frequency
@@ -39,7 +47,7 @@ class RtlReader(object):
 
         self.exception_queue = None
 
-    def _calc_noise(self):
+    def _calc_noise(self) -> float:
         """Calculate noise floor"""
         window = smaples_per_microsec * 100
         total_len = len(self.signal_buffer)
@@ -50,7 +58,7 @@ class RtlReader(object):
         )
         return min(means)
 
-    def _process_buffer(self):
+    def _process_buffer(self) -> list[list[Any]]:
         """process raw IQ data in the buffer"""
 
         # update noise floor
@@ -70,17 +78,18 @@ class RtlReader(object):
                 i += 1
                 continue
 
-            if self._check_preamble(self.signal_buffer[i : i + pbits * 2]):
+            frame_start = i + pbits * 2
-                frame_start = i + pbits * 2
+            if self._check_preamble(self.signal_buffer[i:frame_start]):
-                frame_end = i + pbits * 2 + (fbits + 1) * 2
                 frame_length = (fbits + 1) * 2
+                frame_end = frame_start + frame_length
                 frame_pulses = self.signal_buffer[frame_start:frame_end]
 
                 threshold = max(frame_pulses) * 0.2
 
-                msgbin = []
+                msgbin: list[int] = []
                 for j in range(0, frame_length, 2):
-                    p2 = frame_pulses[j : j + 2]
+                    j_2 = j + 2
+                    p2 = frame_pulses[j:j_2]
                     if len(p2) < 2:
                         break
 
@@ -117,7 +126,7 @@ class RtlReader(object):
 
         return messages
 
-    def _check_preamble(self, pulses):
+    def _check_preamble(self, pulses) -> bool:
         if len(pulses) != 16:
             return False
 
@@ -127,7 +136,7 @@ class RtlReader(object):
 
         return True
 
-    def _check_msg(self, msg):
+    def _check_msg(self, msg) -> bool:
         df = pms.df(msg)
         msglen = len(msg)
         if df == 17 and msglen == 28:
@@ -137,8 +146,9 @@ class RtlReader(object):
             return True
         elif df in [4, 5, 11] and msglen == 14:
             return True
+        return False
 
-    def _debug_msg(self, msg):
+    def _debug_msg(self, msg) -> None:
         df = pms.df(msg)
         msglen = len(msg)
         if df == 17 and msglen == 28:
@@ -151,7 +161,7 @@ class RtlReader(object):
             # print("[*]", msg)
             pass
 
-    def _read_callback(self, data, rtlsdr_obj):
+    def _read_callback(self, data, rtlsdr_obj) -> None:
         amp = np.absolute(data)
         self.signal_buffer.extend(amp.tolist())
 
@@ -159,16 +169,18 @@ class RtlReader(object):
             messages = self._process_buffer()
             self.handle_messages(messages)
 
-    def handle_messages(self, messages):
+    def handle_messages(self, messages) -> None:
         """re-implement this method to handle the messages"""
         for msg, t in messages:
             # print("%15.9f %s" % (t, msg))
             pass
 
-    def stop(self, *args, **kwargs):
+    def stop(self, *args, **kwargs) -> None:
         self.sdr.close()
 
-    def run(self, raw_pipe_in=None, stop_flag=None, exception_queue=None):
+    def run(
+        self, raw_pipe_in=None, stop_flag=None, exception_queue=None
+    ) -> None:
         self.raw_pipe_in = raw_pipe_in
         self.exception_queue = exception_queue
         self.stop_flag = stop_flag

pyModeS/py_common.py

@@ -231,7 +231,7 @@ def squawk(binstr: str) -> str:
         binstr (String): 13 bits binary string
 
     Returns:
-        int: altitude in ft
+        string: squawk code
 
     """
     if len(binstr) != 13 or not set(binstr).issubset(set("01")):

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pyModeS"
-version = "2.12"
+version = "2.16"
 description = "Python Mode-S and ADS-B Decoder"
 authors = ["Junzi Sun <j.sun-1@tudelft.nl>"]
 license = "GNU GPL v3"
@@ -22,7 +22,7 @@ include = [
     "*.pxd",
     "*.pyi",
     "py.typed",
-    { path = "src/pyModeS/**/*.so", format = "wheel" }
+    { path = "pyModeS/**/*.so", format = "wheel" }
 ]
 
 [tool.poetry.build]
@@ -39,7 +39,6 @@ pyzmq = "^24.0"
 pyrtlsdr = {version = "^0.2.93", optional = true}
 
 [tool.poetry.group.dev.dependencies]
-Cython = "^0.29.32"
 mypy = "^0.991"
 flake8 = "^5.0.0"
 black = "^22.12.0"
@@ -47,7 +46,6 @@ isort = "^5.11.4"
 pytest = "^7.2.0"
 pytest-cov = "^4.0.0"
 codecov = "^2.1.12"
-ipykernel = "^6.20.0"
 
 [tool.poetry.extras]
 rtlsdr = ["pyrtlsdr"]

tests/test_adsb.py

@@ -1,4 +1,5 @@
 from pyModeS import adsb
+from pytest import approx
 
 # === TEST ADS-B package ===
 
@@ -22,7 +23,7 @@ def test_adsb_position():
         1446332400,
         1446332405,
     )
-    assert pos == (49.81755, 6.08442)
+    assert pos == (approx(49.81755, 0.001), approx(6.08442, 0.001))
 
 
 def test_adsb_position_swap_odd_even():
@@ -32,32 +33,32 @@ def test_adsb_position_swap_odd_even():
         1446332405,
         1446332400,
     )
-    assert pos == (49.81755, 6.08442)
+    assert pos == (approx(49.81755, 0.001), approx(6.08442, 0.001))
 
 
 def test_adsb_position_with_ref():
     pos = adsb.position_with_ref("8D40058B58C901375147EFD09357", 49.0, 6.0)
-    assert pos == (49.82410, 6.06785)
+    assert pos == (approx(49.82410, 0.001), approx(6.06785, 0.001))
     pos = adsb.position_with_ref("8FC8200A3AB8F5F893096B000000", -43.5, 172.5)
-    assert pos == (-43.48564, 172.53942)
+    assert pos == (approx(-43.48564, 0.001), approx(172.53942, 0.001))
 
 
 def test_adsb_airborne_position_with_ref():
     pos = adsb.airborne_position_with_ref(
         "8D40058B58C901375147EFD09357", 49.0, 6.0
     )
-    assert pos == (49.82410, 6.06785)
+    assert pos == (approx(49.82410, 0.001), approx(6.06785, 0.001))
     pos = adsb.airborne_position_with_ref(
         "8D40058B58C904A87F402D3B8C59", 49.0, 6.0
     )
-    assert pos == (49.81755, 6.08442)
+    assert pos == (approx(49.81755, 0.001), approx(6.08442, 0.001))
 
 
 def test_adsb_surface_position_with_ref():
     pos = adsb.surface_position_with_ref(
         "8FC8200A3AB8F5F893096B000000", -43.5, 172.5
     )
-    assert pos == (-43.48564, 172.53942)
+    assert pos == (approx(-43.48564, 0.001), approx(172.53942, 0.001))
 
 
 def test_adsb_surface_position():
@@ -69,7 +70,7 @@ def test_adsb_surface_position():
         -43.496,
         172.558,
     )
-    assert pos == (-43.48564, 172.53942)
+    assert pos == (approx(-43.48564, 0.001), approx(172.53942, 0.001))
 
 
 def test_adsb_alt():
@@ -80,9 +81,9 @@ def test_adsb_velocity():
     vgs = adsb.velocity("8D485020994409940838175B284F")
     vas = adsb.velocity("8DA05F219B06B6AF189400CBC33F")
     vgs_surface = adsb.velocity("8FC8200A3AB8F5F893096B000000")
-    assert vgs == (159, 182.88, -832, "GS")
+    assert vgs == (159, approx(182.88, 0.1), -832, "GS")
-    assert vas == (375, 243.98, -2304, "TAS")
+    assert vas == (375, approx(243.98, 0.1), -2304, "TAS")
-    assert vgs_surface == (19, 42.2, 0, "GS")
+    assert vgs_surface == (19, approx(42.2, 0.1), 0, "GS")
     assert adsb.altitude_diff("8D485020994409940838175B284F") == 550
 
 
@@ -96,7 +97,9 @@ def test_adsb_target_state_status():
     sel_alt = adsb.selected_altitude("8DA05629EA21485CBF3F8CADAEEB")
     assert sel_alt == (16992, "MCP/FCU")
     assert adsb.baro_pressure_setting("8DA05629EA21485CBF3F8CADAEEB") == 1012.8
-    assert adsb.selected_heading("8DA05629EA21485CBF3F8CADAEEB") == 66.8
+    assert adsb.selected_heading("8DA05629EA21485CBF3F8CADAEEB") == approx(
+        66.8, 0.1
+    )
     assert adsb.autopilot("8DA05629EA21485CBF3F8CADAEEB") is True
     assert adsb.vnav_mode("8DA05629EA21485CBF3F8CADAEEB") is True
     assert adsb.altitude_hold_mode("8DA05629EA21485CBF3F8CADAEEB") is False

tests/test_commb.py

@@ -1,5 +1,5 @@
 from pyModeS import bds, commb
-import pytest
+from pytest import approx
 
 # from pyModeS import ehs, els    # deprecated
 
@@ -23,32 +23,24 @@ def test_bds40_functions():
 
 
 def test_bds50_functions():
-    assert bds.bds50.roll50("A000139381951536E024D4CCF6B5") == 2.1
+    msg1 = "A000139381951536E024D4CCF6B5"
-    assert bds.bds50.roll50("A0001691FFD263377FFCE02B2BF9") == -0.4
+    msg2 = "A0001691FFD263377FFCE02B2BF9"
-    assert bds.bds50.trk50("A000139381951536E024D4CCF6B5") == 114.258
-    assert bds.bds50.gs50("A000139381951536E024D4CCF6B5") == 438
-    assert bds.bds50.rtrk50("A000139381951536E024D4CCF6B5") == 0.125
-    assert bds.bds50.tas50("A000139381951536E024D4CCF6B5") == 424
 
-    assert commb.roll50("A000139381951536E024D4CCF6B5") == 2.1
+    for module in [bds.bds50, commb]:
-    assert commb.roll50("A0001691FFD263377FFCE02B2BF9") == -0.4  # signed value
+        assert module.roll50(msg1) == approx(2.1, 0.01)
-    assert commb.trk50("A000139381951536E024D4CCF6B5") == 114.258
+        assert module.roll50(msg2) == approx(-0.35, 0.01)  # signed value
-    assert commb.gs50("A000139381951536E024D4CCF6B5") == 438
+        assert module.trk50(msg1) == approx(114.258, 0.1)
-    assert commb.rtrk50("A000139381951536E024D4CCF6B5") == 0.125
+        assert module.gs50(msg1) == 438
-    assert commb.tas50("A000139381951536E024D4CCF6B5") == 424
+        assert module.rtrk50(msg1) == 0.125
+        assert module.tas50(msg1) == 424
 
 
 def test_bds60_functions():
     msg = "A00004128F39F91A7E27C46ADC21"
 
-    assert bds.bds60.hdg60(msg) == pytest.approx(42.71484)
+    for module in [bds.bds60, commb]:
-    assert bds.bds60.ias60(msg) == 252
+        assert bds.bds60.hdg60(msg) == approx(42.71484)
-    assert bds.bds60.mach60(msg) == 0.42
+        assert bds.bds60.ias60(msg) == 252
-    assert bds.bds60.vr60baro(msg) == -1920
+        assert bds.bds60.mach60(msg) == 0.42
-    assert bds.bds60.vr60ins(msg) == -1920
+        assert bds.bds60.vr60baro(msg) == -1920
-
+        assert bds.bds60.vr60ins(msg) == -1920
-    assert commb.hdg60(msg) == pytest.approx(42.71484)
-    assert commb.ias60(msg) == 252
-    assert commb.mach60(msg) == 0.42
-    assert commb.vr60baro(msg) == -1920
-    assert commb.vr60ins(msg) == -1920