From 457a948879eed7831ca709cccf4f9c8145b06a5f Mon Sep 17 00:00:00 2001
From: JoseAndresMR <josmilrom@gmail.com>
Date: Fri, 22 Jun 2018 12:31:19 +0200
Subject: [PATCH] Uncertainty and Accuracy parameters

---
 pyModeS/decoder/adsb.py    | 266 +++++++++++++++++++++++++++++++++++++
 pyModeS/streamer/stream.py |  50 ++++++-
 2 files changed, 314 insertions(+), 2 deletions(-)

diff --git a/pyModeS/decoder/adsb.py b/pyModeS/decoder/adsb.py
index e509fce..0421d65 100644
--- a/pyModeS/decoder/adsb.py
+++ b/pyModeS/decoder/adsb.py
@@ -222,3 +222,269 @@ def oe_flag(msg):
     """
     msgbin = common.hex2bin(msg)
     return int(msgbin[53])
+
+# Uncertainty & accuracy
+
+def nic_v1(msg,nic_sup_b):
+    """Calculate NIC, navigation integrity category
+
+    Args:
+        msg (string): 28 bytes hexadecimal message string, nic_sup_b (int): NIC supplement
+
+    Returns:
+        int: NIC number (from 0 to 11), -1 if not applicable
+    """
+    if typecode(msg) < 5 or typecode(msg) > 22:
+        raise RuntimeError("%s: Not a surface position message (5<TC<8, )airborne position message (8<TC<19), airborne position with GNSS height (20<TC<22)" % msg)
+
+    tc = typecode(msg)
+
+    if tc in [0, 8, 18, 22]:
+        nic = 0
+    elif tc == 17:
+        nic = 1
+    elif tc == 16:
+        if nic_sup_b:
+            nic = 3
+        else:
+            nic = 2
+    elif tc == 15:
+        nic = 4
+    elif tc == 14:
+        nic = 5
+    elif tc == 13:
+        if nic_sup_b:
+            nic = 6
+        else:
+            nic = 6
+    elif tc == 12:
+        nic = 7
+    elif tc == 11:
+        if nic_sup_b:
+            nic = 9
+        else:
+            nic = 8
+    elif tc in [6, 10, 21]:
+        nic = 10
+    elif tc in [5, 9, 20]:
+        nic = 11
+    elif tc == 7:
+        if nic_sup_b:
+            nic = 9
+        else:
+            nic = 8
+    else:
+        nic = -1
+    return nic
+
+def nic_v2(msg,nic_a,nic_b,nic_c):
+    """Calculate NIC, navigation integrity category
+
+    Args:
+        msg (string): 28 bytes hexadecimal message string, nic_a (int): NIC supplement, nic_b (int): NIC supplement, nic_c (int): NIC supplement
+    Returns:
+        int: NIC number (from 0 to 11), -1 if not applicable
+    """
+    if typecode(msg) < 5 or typecode(msg) > 22:
+        raise RuntimeError("%s: Not a surface position message (5<TC<8, )airborne position message (8<TC<19), airborne position with GNSS height (20<TC<22)" % msg)
+
+    tc = typecode(msg)
+
+    if tc in [0, 18, 22]:
+        nic = 0
+    elif tc == 17:
+        nic = 1
+    elif tc == 16:
+        if nic_a:
+            nic = 3
+        else:
+            nic = 2
+    elif tc == 15:
+        nic = 4
+    elif tc == 14:
+        nic = 5
+    elif tc == 13:
+        if nic_a:
+            nic = 6
+        else:
+            if nic_b:
+                nic = 6
+            else:
+                nic = 6
+    elif tc == 12:
+        nic = 7
+    elif tc == 11:
+        if nic_a:
+            nic = 9
+        else:
+            nic = 8
+    elif tc in [6, 10, 21]:
+        nic = 10
+    elif tc in [5, 9, 20]:
+        nic = 11
+    elif tc == 8:
+        if nic_a:
+            if nic_c:
+                nic = 7
+            else:
+                nic = 6
+        else:
+            if nic_c:
+                nic = 6
+            else:
+                nic = 0
+    elif tc == 7:
+        if nic_a:
+            nic = 9
+        else:
+            nic = 8
+    else:
+        nic = -1
+    return nic
+
+
+
+def nic_s(msg):
+    """Calculate NICs, navigation integrity category supplement
+
+    Args:
+        msg (string): 28 bytes hexadecimal message string
+
+    Returns:
+        int: NIC number (from 0 to 11), -1 if not applicable
+    """
+    if typecode(msg) != 31:
+        raise RuntimeError("%s: Not a status operation message, expecting TC = 31" % msg)
+
+    msgbin = common.hex2bin(msg)
+    nic_s = common.bin2int(msgbin[75])
+
+    return nic_s
+
+def nic_a_and_c(msg):
+    """Calculate NICa and NICc, navigation integrity category supplements
+
+    Args:
+        msg (string): 28 bytes hexadecimal message string
+
+    Returns:
+        int: NIC number (from 0 to 11), -1 if not applicable
+    """
+    if typecode(msg) != 31:
+        raise RuntimeError("%s: Not a status operation message, expecting TC = 31" % msg)
+
+    msgbin = common.hex2bin(msg)
+    nic_a = common.bin2int(msgbin[75])
+    nic_c = common.bin2int(msgbin[51])
+
+    return nic_a, nic_c
+
+def nic_b(msg):
+    """Calculate NICb, navigation integrity category supplement
+
+    Args:
+        msg (string): 28 bytes hexadecimal message string
+
+    Returns:
+        int: NIC number (from 0 to 11), -1 if not applicable
+    """
+    if typecode(msg) < 9 or typecode(msg) > 18:
+        raise RuntimeError("%s: Not a airborne position message, expecting 8<TC<19" % msg) 
+
+    msgbin = common.hex2bin(msg)
+    nic_b = common.bin2int(msgbin[39])
+
+    return nic_b
+
+def nac_p(msg):
+    """Calculate NACp, Navigation Accuracy Category - Position
+
+    Args:
+        msg (string): 28 bytes hexadecimal message string, TC = 29 or 31
+
+    Returns:
+        int: NACp number (from 0 to 11), -1 if not applicable
+    """
+    if typecode(msg) not in [29,31]:
+        raise RuntimeError("%s: Not a target state and status message neither operation status message, expecting TC = 29 or 31" % msg)
+
+    msgbin = common.hex2bin(msg)
+    tc = typecode(msg)
+    if tc == 29:
+        nac_p = common.bin2int(msgbin[71:75])
+    elif tc == 31:
+        nac_p = common.bin2int(msgbin[76:80])
+    else:
+        nac_p = -1
+    return nac_p
+
+
+def nac_v(msg):
+    """Calculate NACv, Navigation Accuracy Category - Velocity
+
+    Args:
+        msg (string): 28 bytes hexadecimal message string, TC = 19
+
+    Returns:
+        int: NACv number (from 0 to 4), -1 if not applicable
+    """
+    if typecode(msg) != 19:
+        raise RuntimeError("%s: Not an airborne velocity message, expecting TC = 19" % msg)
+
+    msgbin = common.hex2bin(msg)
+    tc = typecode(msg)
+    if tc == 19:
+        nac_v = common.bin2int(msgbin[42:45])
+    else:
+        nac_v = -1
+    return nac_v
+
+def sil(msg,version):
+    """Calculate SIL, Surveillance Integrity Level 
+
+    Args:
+        msg (string): 28 bytes hexadecimal message string with TC = 29, 31
+
+    Returns:
+        int: sil number, -1 if not applicable
+    """
+    if typecode(msg) not in [29,31]:
+        raise RuntimeError("%s: Not a target state and status message neither operation status message, expecting TC = 29 or 31" % msg)
+
+    msgbin = common.hex2bin(msg)
+    tc = typecode(msg)
+    if tc == 29:
+        sil = common.bin2int(msgbin[76:78])
+    elif tc == 31:
+        sil = common.bin2int(msg[82:84])
+    else:
+        sil = -1
+
+    if version == 2:
+        if typecode(msg) == 29:
+            sils = common.bin2int(msgbin[39])
+        elif typecode(msg) == 31:
+            sils = common.bin2int(msgbin[86])
+    else:
+        sils = -1
+
+    return sil, sils
+
+def version(msg):
+    """ADS-B Version
+
+    Args:
+        msg (string): 28 bytes hexadecimal message string, TC = 31
+
+    Returns:
+        int: version number
+    """
+    msgbin = common.hex2bin(msg)
+    if typecode(msg) not in [29,31]:
+        raise RuntimeError("%s: Not a target state and status message neither operation status message, expecting TC = 29 or 31" % msg)
+
+    if typecode(msg) in [29,31]:
+        version = common.bin2int(msgbin[72:75])
+    else:
+        version = -1
+    return version
diff --git a/pyModeS/streamer/stream.py b/pyModeS/streamer/stream.py
index f139bfd..174afab 100644
--- a/pyModeS/streamer/stream.py
+++ b/pyModeS/streamer/stream.py
@@ -46,6 +46,11 @@ class Stream():
                     'ias': None,
                     'mach': None,
                     'hdg': None,
+                    'adsb_version' : None,    
+                    'nic_s' : None,
+                    'nic_a' : None,
+                    'nic_b' : None,
+                    'nic_c' : None
                 }
 
             self.acs[icao]['t'] = t
@@ -101,7 +106,48 @@ class Stream():
                     self.acs[icao]['lat'] = latlon[0]
                     self.acs[icao]['lon'] = latlon[1]
                     self.acs[icao]['alt'] = adsb.altitude(msg)
-                    local_updated_acs_buffer.append(icao)
+                    local_updated_acs_buffer.append(icao)acs[icao]['adsb_version'] 
+
+            # Uncertainty & accuracy
+            if (5 <= tc <= 8):
+                if self.acs[icao]['adsb_version']  == 1:
+                    if self.acs[icao]['nic_s'] != None:
+                        self.nic = adsb.nic_v1(msg,self.acs[icao]['nic_s'])
+                elif self.acs[icao]['adsb_version']  == 2:
+                    if self.acs[icao]['nic_a'] != None and self.acs[icao]['nic_b'] != None:
+                        self.nic = adsb.nic_v2(msg,self.nic_a,self.acs[icao]['nic_b'],self.acs[icao]['nic_c'])
+            if (9 <= tc <= 18):
+                if self.acs[icao]['adsb_version']  == 1:
+                    if self.acs[icao]['nic_s'] != None:
+                        self.nic = adsb.nic_v1(msg,self.acs[icao]['nic_s'])
+                elif self.acs[icao]['adsb_version']  == 2:
+                    self.acs[icao]['nic_b'] = adsb.nic_b(msg)
+                    if self.acs[icao]['nic_a'] != None and self.acs[icao]['nic_b'] != None:
+                        self.nic = adsb.nic_v2(msg,self.acs[icao]['nic_a'],self.nic_b,self.acs[icao]['nic_c'])
+            if tc == 19:
+                self.acs[icao]['nac_v'] = adsb.nac_v(msg)
+            if (20 <= tc <= 22):
+                if self.acs[icao]['adsb_version']  == 1:
+                    if self.acs[icao]['nic_s'] != None:
+                        self.nic = adsb.nic_v1(msg,self.acs[icao]['nic_s'])
+                elif self.acs[icao]['adsb_version']  == 2:
+                    if self.acs[icao]['nic_a'] != None and self.acs[icao]['nic_b'] != None:
+                        self.nic = adsb.nic_v2(msg,self.acs[icao]['nic_a'],self.acs[icao]['nic_b'],self.acs[icao]['nic_c'])
+            if tc == 29:
+                if self.acs[icao]['adsb_version'] != None:
+                    self.acs[icao]['sil'] = adsb.sil(msg,self.acs[icao]['adsb_version'])
+                self.acs[icao]['nac_p'] = adsb.nac_p(msg)
+            if tc == 31:
+                self.acs[icao]['adsb_version']  = adsb.version(msg)
+                self.acs[icao]['sil'] = adsb.version(msg)
+                self.acs[icao]['nac_p'] = adsb.nac_p(msg)
+                if self.acs[icao]['adsb_version']  == 1:
+                    self.acs[icao]['nic_s'] = adsb.nic_s(msg)
+                elif self.acs[icao]['adsb_version']  == 2:
+                    self.acs[icao]['nic_a'] , self.acs[icao]['nic_c'] = adsb.nic_a_and_c(msg)
+
+
+                
 
         # process ehs message
         for t, msg in zip(ehs_ts, ehs_msgs):
@@ -167,4 +213,4 @@ class Stream():
 
     def reset_new_aircraft(self):
         """reset the updated icao buffer once been read"""
-        self.__new_acs = set()
+        self.__new_acs = set()
\ No newline at end of file