Merge pull request #292 from TwinFan/Next

v4.3.0

Author: TwinFan

CMakeLists.txt

@@ -23,7 +23,7 @@ endif()
 set(CMAKE_BUILD_TYPE RelWithDebInfo)
 
 project(LiveTraffic
-        VERSION 4.2.1
+        VERSION 4.3.0
         DESCRIPTION "LiveTraffic X-Plane plugin")
 set(VERSION_BETA 0)
 
@@ -167,6 +167,7 @@ set(Header_Files
     Include/LTADSBHub.h
     Include/LTAircraft.h
     Include/LTApt.h
+    Include/LTAutoATC.h
     Include/LTChannel.h
     Include/LTFlightData.h
     Include/LTForeFlight.h
@@ -214,6 +215,7 @@ set(Source_Files
     Src/LTADSBHub.cpp
     Src/LTAircraft.cpp
     Src/LTApt.cpp
+    Src/LTAutoATC.cpp
     Src/LTChannel.cpp
     Src/LTFlightData.cpp
     Src/LTForeFlight.cpp

Data/AutoATC/AutoATC.sjson/770408410.428292

@@ -270,6 +270,7 @@ constexpr const char* REMOTE_SIGNATURE      =  "TwinFan.plugin.XPMP2.Remote";
 #define HELP_SET_CH_REALTRAFFIC "setup/installation/realtraffic-connectivity"
 #define HELP_SET_CH_FSCHARTER   "setup/installation/fscharter"
 #define HELP_SET_CH_SI          "setup/installation/sayintentions"
+#define HELP_SET_CH_AUTOATC     "setup/installation/autoatc"
 #define HELP_SET_OUTPUT_CH      "setup/installation/foreflight"     // currently the same as ForeFlight, which is the only output channel
 #define HELP_SET_CH_FOREFLIGHT  "setup/installation/foreflight"
 #define HELP_SET_ACLABELS       "setup/configuration/settings-a-c-labels"

Data/AutoATC/AutoATC.sjson/data

@@ -434,6 +434,7 @@ enum dataRefsLT {
     DR_CHANNEL_FUTUREDATACHN_ONLINE,    // placeholder, first channel
     DR_CHANNEL_FORE_FLIGHT_SENDER,
     DR_CHANNEL_SYNTHETIC,
+    DR_CHANNEL_AUTOATC,
     DR_CHANNEL_SAYINTENTIONS,
     DR_CHANNEL_FSCHARTER,
     DR_CHANNEL_OPEN_GLIDER_NET,
@@ -475,6 +476,13 @@ enum SimTimeCtrlTy : int {
     STC_SIM_TIME_PLUS_BUFFER,           ///< Send current sim time plus buffering period, so that the traffic, when it appears, matches up with current sim time
 };
 
+/// Which amount of planes to send to ForeFlight?
+enum TrafficToSendTy : int {
+    TTS_NONE = 0,                       ///< Don't send any traffic
+    TTS_ALL,                            ///< Send all known planes
+    TTS_NONTCAS_ONLY,                   ///< Send only planes that don't have a TCAS slot in X-Plane
+};
+
 /// How to control weather?
 enum WeatherCtrlTy : int {
     WC_INIT = -1,                       ///< Initial value when not available in config file, then a default is determined in first flight loop depending if XP is using real weather
@@ -682,8 +690,7 @@ class DataRefs
     std::string LTPluginPath;           // path to plugin directory
     std::string DirSeparator;
     int bChannel[CNT_DR_CHANNELS];      // is channel enabled?
-    double chTsOffset           = 0.0f; // offset of network time compared to system clock
-    int chTsOffsetCnt           = 0;    // how many offset reports contributed to the calculated average offset?
+    double chTsOffset           = NAN;  ///< offset of network time compared to system clock
     int iTodaysDayOfYear        = 0;
     time_t tStartThisYear = 0, tStartPrevYear = 0;
     int lastCheckNewVer         = 0;    // when did we last check for updates? (hours since the epoch)
@@ -746,7 +753,7 @@ class DataRefs
     int ffListenPort    = 63093;        ///< UDP Port to listen to ForeFlight announcing itself, https://www.foreflight.com/connect/spec/
     int ffSendPort      = 49002;        ///< UDP Port to send simulator data to ForeFlight, https://www.foreflight.com/support/network-gps/
     int bffUserPlane    = 1;            // bool Send User plane data?
-    int bffTraffic      = 1;            // bool Send traffic data?
+    TrafficToSendTy ffTraffic=TTS_ALL;  ///< Send traffic data? And which amount of traffic?
     int ffSendTrfcIntvl = 3;            // [s] interval to broadcast traffic info
 
     vecCSLPaths vCSLPaths;              // list of paths to search for CSL packages
@@ -1033,11 +1040,9 @@ class DataRefs
     const std::string& GetSIDisplayName () const    { return sSIDisplayName; }
     void SetSIDisplayName (const std::string& dn)   { sSIDisplayName = dn; }
 
-    // timestamp offset network vs. system clock
-    inline void ChTsOffsetReset() { chTsOffset = 0.0f; chTsOffsetCnt = 0; }
-    inline double GetChTsOffset () const { return chTsOffset; }
-    bool ChTsAcceptMore () const { return cntAc == 0 && chTsOffsetCnt < CntChannelEnabled() * 2; }
-    void ChTsOffsetAdd (double aNetTS);
+    /// Get current time from a network resource to determine the offset of this computer to real time
+    void GetNetwTsOffset ();
+    inline double GetChTsOffset () const { return std::isnan(chTsOffset) ? 0.0 : chTsOffset; }
 
     // livetraffic/dbg/ac_filter: Debug a/c filter (the integer is converted to hex as an transpIcao key)
     std::string GetDebugAcFilter() const;

Data/AutoATC/AutoATC.sjson/metaData

@@ -0,0 +1,69 @@
+/// @file       LTAutoATC.h
+/// @brief      Channel to AutoATC traffic
+/// @see        https://autoatc.zem-solutions.com/
+/// @details    Defines AutoATCConnection:\n
+///             Takes AI traffic generated by AutoATC
+/// @author     Birger Hoppe
+/// @copyright  (c) 2025 Birger Hoppe
+/// @copyright  Permission is hereby granted, free of charge, to any person obtaining a
+///             copy of this software and associated documentation files (the "Software"),
+///             to deal in the Software without restriction, including without limitation
+///             the rights to use, copy, modify, merge, publish, distribute, sublicense,
+///             and/or sell copies of the Software, and to permit persons to whom the
+///             Software is furnished to do so, subject to the following conditions:\n
+///             The above copyright notice and this permission notice shall be included in
+///             all copies or substantial portions of the Software.\n
+///             THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+///             IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+///             FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+///             AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+///             LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+///             OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+///             THE SOFTWARE.
+
+#ifndef LTAutoATC_h
+#define LTAutoATC_h
+
+#include "LTChannel.h"
+
+//
+//MARK: AutoATC Constants
+//
+#define AATC_CHECK_NAME         "AutoATC Generated Traffic"
+#define AATC_CHECK_URL          "https://autoatc.zem-solutions.com/Status.html"
+#define AATC_CHECK_POPUP        "See AutoATC's status, but there is no list or map of flights"
+
+#define AATC_NAME               "AutoATC"
+#define AATC_URL                "https://load1.zem-solutions.com/AutoATCPeek?lat=%.4f&lon=%.4f"
+
+#define AATC_RESULT             "result"            ///< expected to be "success", all else treated as failure
+#define AATC_RESULT_SUCCESS     "success"
+#define AATC_DATA               "data"              ///< array of aircraft
+#define AATC_TIMESTAMP          "timestamp"         ///< when was the response compiled, used as timestamp for all positions
+
+#define AATC_KEY                "ADS-B"
+#define AATC_LAT                "lat"
+#define AATC_LON                "lon"
+#define AATC_ALT                "alt"
+#define AATC_HEADING            "h"
+#define AATC_GND                "ground"
+#define AATC_CALL_SPOKEN        "cs"                ///< callsign as spoken, e.g. "air serbia 4139"
+#define AATC_AC_TYPE            "af"
+#define AATC_OP_ICAO            "icao"              ///< ICAO operator code
+
+//
+// MARK: SayIntentions connection class
+//
+
+/// Connection to AutoATC
+class AutoATCConnection : public LTFlightDataChannel
+{
+public:
+    AutoATCConnection ();                                   ///< Constructor
+    std::string GetURL (const positionTy& pos) override;    ///< returns the URL to AutoATC traffic by position
+    bool ProcessFetchedData () override;                    ///< Process response, forwarding to the processing queues
+protected:
+    void Main () override;                                  ///< virtual thread main function
+};
+
+#endif /* LTAutoATC_h */

Data/RealTraffic/RealTraffic Developer Documentation v10 rev1.pdf

@@ -161,8 +161,22 @@ class LTFlightData
 
     // KEY (protected, can be set only once, no mutex-control)
 public:
-    // in ascending order of priority
-    enum FDKeyType { KEY_UNKNOWN=0, KEY_OGN, KEY_RT, KEY_FLARM, KEY_ICAO, KEY_FSC, KEY_ADSBEX, KEY_SAYINTENTIONS };
+    /// Types/origin of an aircraft's id, though some types are interchangeable
+    enum FDKeyType : unsigned {
+        KEY_UNKNOWN=0,
+        // the "interchangeable" key types, which essentially signify the same number range, they "compare equal" for the purpose of operator==()
+        KEY_ICAO,
+        KEY_FLARM,
+        KEY_ADSBEX,
+        KEY_RT,
+        KEY_OGN,
+        // here starts the range of non-interchangeable, truly organisation-specific keys
+        KEY_ORG_SPECIFIC = 0x0010,
+        KEY_FSC,
+        KEY_SAYINTENTIONS,
+        KEY_AUTOATC,
+        KEY_PRIVATE,                            // plane doesn't want to be identified, so we generate a private internally key ourselves
+    };
     struct FDKeyTy {
         FDKeyType               eKeyType = KEY_UNKNOWN;
         std::string             key;            // the primary key in use
@@ -183,10 +197,10 @@ class LTFlightData
         FDKeyTy& operator=(const FDKeyTy& o) = default;
         FDKeyTy& operator=(FDKeyTy&& o) = default;
 
-        // strict order based on numeric value
-        inline bool operator==(const FDKeyTy& o) const { return eKeyType == o.eKeyType && num == o.num; }
-        inline bool operator!=(const FDKeyTy& o) const { return eKeyType != o.eKeyType || num != o.num; }
-        inline bool operator<(const FDKeyTy& o) const { return eKeyType == o.eKeyType ? num < o.num : eKeyType < o.eKeyType; }
+        // strict order based on key type and numeric value
+        bool operator==(const FDKeyTy& o) const;
+        bool operator!=(const FDKeyTy& o) const { return !operator==(o); }
+        bool operator<(const FDKeyTy& o) const;
 
         // imitate some (std::)string functionality
         inline bool operator==(const std::string o) const { return key == o; }
@@ -195,16 +209,15 @@ class LTFlightData
 
         inline const char* c_str() const    { return key.c_str(); }
         inline bool empty() const           { return key.empty(); }
+        inline operator bool() const        { return !num && !key.empty(); }
         void clear()                        { *this = FDKeyTy(); }
 
-        // matches any string?
-        bool isMatch (const std::string t) const;
-        
         /// return the type of key (as string)
         const char* GetKeyTypeText () const;
     };
 protected:
-    FDKeyTy acKey;
+    FDKeyTy acKey;                  ///< the planes unique identifier, publicly visible
+    FDKeyTy acPrivateKey;           ///< (optional) the true but private, ie. non-public identifier of the plane, for purposes of matching against public planes
 
     // last used Receiver ID, identifies the receiver of the signal of this flight data
     int             rcvr;
@@ -286,8 +299,9 @@ class LTFlightData
     void SetKey    (FDKeyType eType, const std::string _key, int base=16)   { acKey.SetKey(eType, _key, base); }
     const FDKeyTy& key() const                              { return acKey; }
     std::string keyDbg() const                              { return key().key + ' ' + statData.acId("-"); }
-    /// Checks for a duplicate key on another key type and updates _key if so
-    static bool CheckDupKey(FDKeyTy& _key, FDKeyType _ty);
+    /// Set a private hidden key
+    void SetPrivateKey (const FDKeyTy& _privKey)            { acPrivateKey = _privKey; }
+    const FDKeyTy& keyPrivate() const { return acPrivateKey; }
 
     // Search support: icao, registration, call sign, flight number matches?
     bool IsMatch (const std::string t) const;
@@ -451,4 +465,13 @@ mapLTFlightDataTy::iterator mapFdAcByIdx (int idx);
 /// Find a/c by text, compares with key, call sigh, registration etc., passes pure numbers to mapFdAcByIdx()
 mapLTFlightDataTy::iterator mapFdSearchAc (const std::string& _s);
 
+/// Return aircraft with given key (optionally: if it has an active aircraft)
+LTFlightData* mapFdAc (const LTFlightData::FDKeyTy& key,
+                       bool bMustHaveAc = false);
+
+/// Do we know an aircraft with the given key (no matter if currently displayed or not)
+inline bool mapFdHasAc (const LTFlightData::FDKeyTy& key,
+                 bool bMustHaveAc = false)
+{ return mapFdAc(key,bMustHaveAc) != nullptr; }
+
 #endif /* LTFlightData_h */

Include/Constants.h

@@ -230,6 +230,7 @@ class OpenGliderConnection : public LTFlightDataChannel
     /// @return Shall the aircraft be displayed at all? (Otherwise it is marked non-trackable and we shall not show it.)
     bool AcListLookup (const std::string& sDevId,
                        LTFlightData::FDKeyTy& key,
+                       LTFlightData::FDKeyTy& privateKey,
                        LTFlightData::FDStaticData& stat);
 };