Merge pull request #280 from TwinFan/Next

v4.2.0

Author: TwinFan

.github/workflows/build.yml

@@ -16,7 +16,7 @@ jobs:
   #####################################
   # Linux with GCC
   build-lin:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     env:
       platform: lin
     steps:

CMakeLists.txt

@@ -23,7 +23,7 @@ endif()
 set(CMAKE_BUILD_TYPE RelWithDebInfo)
 
 project(LiveTraffic
-        VERSION 4.1.1
+        VERSION 4.2.0
         DESCRIPTION "LiveTraffic X-Plane plugin")
 set(VERSION_BETA 0)
 

Include/DataRefs.h

@@ -796,6 +796,7 @@ class DataRefs
     std::string OpenSkyRetryAt;         ///< OpenSky: If limit is reached, when to retry? (local time as string)
     long ADSBExRLimit = 0;              // ADSBEx: Limit on RapidAPI
     long ADSBExRRemain = 0;             // ADSBEx: Remaining Requests on RapidAPI
+    long ADSBExRReset = 0;              ///< [s] ADSBEx: When will the quota reset?
 
     // UI information
     int UIopacity = DEF_UI_OPACITY;     ///< [%] UI opacity

Include/InfoListWnd.h

@@ -26,8 +26,9 @@
 //
 class InfoListWnd : public LTImgWindow
 {
-protected:
+public:
     enum ILWTabTy { ILW_TAB_NONE=0, ILW_TAB_AC_LIST, ILW_TAB_MSG, ILW_TAB_STATUS, ILW_TAB_SETTINGS };
+protected:
     ILWTabTy    activeTab = ILW_TAB_NONE;
     std::string wndTitle;           ///< current window title, contains opened tab
 

Include/LTADSBEx.h

@@ -1,7 +1,12 @@
 /// @file       LTADSBEx.h
 /// @brief      ADS-B Exchange and adsb.fi: Requests and processes live tracking data
-/// @see        https://www.adsbexchange.com/
-/// @see        https://github.com/adsbfi/opendata
+/// @see        ADSBEx: https://www.adsbexchange.com/
+///             RAPID API: https://rapidapi.com/adsbx/api/adsbexchange-com1
+///             RAPID API Endpoint: https://rapidapi.com/adsbx/api/adsbexchange-com1/playground/endpoint_7dee5835-86b3-40ce-a402-f1ab43240884
+///             ADSBEx v2 API documentation:
+///             ...on Swagger: https://adsbexchange.com/api/aircraft/v2/docs
+///             ...fields: https://www.adsbexchange.com/version-2-api-wip/
+/// @see        adsb.fi: https://github.com/adsbfi/opendata
 /// @details    Defines a base class handling the ADSBEx data format,
 ///             which is shared by both ADS-B Exchange and adsb.fi.
 /// @details    Defines ADSBExchangeConnection:\n
@@ -39,21 +44,25 @@
 #define ADSBEX_CHECK_POPUP      "Check ADS-B Exchange's coverage"
 
 #define ADSBEX_NAME             "ADS-B Exchange"
-#define ADSBEX_URL              "https://adsbexchange.com/api/aircraft/v2/lat/%f/lon/%f/dist/%d/"
-#define ADSBEX_API_AUTH         "api-auth:"     // additional HTTP header
-
-#define ADSBEX_RAPIDAPI_25_URL  "https://adsbx-flight-sim-traffic.p.rapidapi.com/api/aircraft/json/lat/%f/lon/%f/dist/25/"
-#define ADSBEX_RAPIDAPI_HOST    "X-RapidAPI-Host:adsbx-flight-sim-traffic.p.rapidapi.com"
-#define ADSBEX_RAPIDAPI_KEY     "X-RapidAPI-Key:"
-#define ADSBEX_RAPIDAPI_RLIMIT  "x-ratelimit-requests-limit:"
-#define ADSBEX_RAPIDAPI_RREMAIN "x-ratelimit-requests-remaining:"
+#define ADSBEX_RAPIDAPI_URL     "https://adsbexchange-com1.p.rapidapi.com/v2/lat/%f/lon/%f/dist/%d/"
+#define ADSBEX_RAPIDAPI_HOST    "x-rapidapi-host: adsbexchange-com1.p.rapidapi.com"
+#define ADSBEX_RAPIDAPI_KEY     "x-rapidapi-key: "
+#define ADSBEX_RAPIDAPI_RLIMIT  "x-ratelimit-api-requests-limit: "
+#define ADSBEX_RAPIDAPI_RREMAIN "x-ratelimit-api-requests-remaining: "
+#define ADSBEX_RAPIDAPI_RESET   "x-ratelimit-api-requests-reset: "
 
 #define ADSBEX_TOTAL            "total"
 #define ADSBEX_NOW              "now"
+#define ADSBEX_TIME             "ctime"
 #define ADSBEX_AIRCRAFT_ARR     "ac"
+#define ADSBEX_MSG              "msg"           ///< Error message text field according to documentation
+#define ADSBEX_MESSAGE          "message"       ///< Error message text field we actually see in the responses
+
+#define ADSBEX_SUCCESS          "No error"      ///< Content of 'msg' in case of success
 
 // Version 2 keys
 #define ADSBEX_V2_TRANSP_ICAO   "hex"           // Key data
+#define ADSBEX_V2_TRANSP_TYPE   "type"          ///< type of transponder, or source of data, like "adsb_icao", "adsr_icao", or "tisb_other"
 #define ADSBEX_V2_RADAR_CODE    "squawk"        // Dynamic data
 #define ADSBEX_V2_FLIGHT        "flight"
 #define ADSBEX_V2_LAT           "lat"
@@ -72,47 +81,19 @@
 #define ADSBEX_V2_AC_CATEGORY   "category"
 #define ADSBEX_V2_FLAGS         "dbFlags"
 
-// Version 1 keys
-#define ADSBEX_TIME             "ctime"
-#define ADSBEX_V1_TRANSP_ICAO   "icao"          // Key data
-#define ADSBEX_V1_RADAR_CODE    "sqk"           // Dynamic data
-#define ADSBEX_V1_CALL          "call"
-#define ADSBEX_V1_LAT           "lat"
-#define ADSBEX_V1_LON           "lon"
-#define ADSBEX_V1_ELEVATION     "galt"          // geometric altitude
-#define ADSBEX_V1_ALT           "alt"           // barometric altitude
-#define ADSBEX_V1_TTRK          "ttrk"
-#define ADSBEX_V1_HEADING       "trak"
-#define ADSBEX_V1_GND           "gnd"
-#define ADSBEX_V1_POS_TIME      "postime"
-#define ADSBEX_V1_SPD           "spd"
-#define ADSBEX_V1_VSI           "vsi"
-#define ADSBEX_V1_REG           "reg"
-#define ADSBEX_V1_COUNTRY       "cou"
-#define ADSBEX_V1_AC_TYPE_ICAO  "type"
-#define ADSBEX_V1_MIL           "mil"
-#define ADSBEX_V1_OP_ICAO       "opicao"
-#define ADSBEX_V1_ORIGIN        "from"
-#define ADSBEX_V1_DESTINATION   "to"
-
-#define ADSBEX_V1_TYPE_GND      "-GND"
+#define ADSBEX_V2_TYPE_TISB     "tisb_other"    ///< type value for TIS-B data
 
+// Version 1 keys (only for enabling meaningful error message)
+#define ADSBEX_V1_TRANSP_ICAO   "icao"          // Key data
 
 // Testing an API key
-#define ADSBEX_VERIFY_KEY_URL   "https://adsbexchange.com/api/aircraft/icao/000000"
-#define ADSBEX_ERR              "msg"
-#define ADSBEX_SUCCESS          "No error"
-#define ADSBEX_NO_API_KEY       "You need an authorized API key."
-
-#define ADSBEX_VERIFY_RAPIDAPI  "https://adsbx-flight-sim-traffic.p.rapidapi.com/api/aircraft/json/lat/0.0/lon/0.0/dist/25/"
-#define ADSBEX_RAPID_ERR        "message"
-#define ADSBEX_NO_RAPIDAPI_KEY  "Key doesn't exists"
+#define ADSBEX_VERIFY_RAPIDAPI  "https://adsbexchange-com1.p.rapidapi.com/v2/lat/0.0/lon/0.0/dist/1/"
 
 #define ERR_ADSBEX_KEY_TECH     "ADSBEx: Technical problem while testing key: %d - %s"
 #define MSG_ADSBEX_KEY_SUCCESS  "ADS-B Exchange: API Key tested SUCCESSFULLY"
-#define ERR_ADSBEX_KEY_FAILED   "ADS-B Exchange: API Key INVALID"
-#define ERR_ADSBEX_KEY_UNKNOWN  "ADS-B Exchange: API Key test responded with unknown answer"
-#define ERR_ADSBEX_NO_KEY_DEF   "ADS-B Exchange: API Key missing. Get one at adsbexchange.com and enter it in Basic Settings."
+#define ERR_ADSBEX_KEY_FAILED   "ADS-B Exchange: API Key test FAILED: %s"
+#define ERR_ADSBEX_KEY_UNKNOWN  "ADS-B Exchange: API Key test responded with unknown answer: %s"
+#define ERR_ADSBEX_NO_KEY_DEF   "ADS-B Exchange: API Key missing. Get one at rapidapi.com/adsbx/api/adsbexchange-com1 and enter it in Basic Settings."
 #define ERR_ADSBEX_OTHER        "ADS-B Exchange: Received an ERRor response: %s"
 
 constexpr double ADSBEX_SMOOTH_AIRBORNE = 65.0; // smooth 65s of airborne data
@@ -131,29 +112,23 @@ class ADSBBase : public LTFlightDataChannel
         LTFlightDataChannel(ch, chName), sSlugBase(slugBase) {}
     /// Process ADSBEx foramtted data
     bool ProcessFetchedData () override;
-    /// Give derived class chance for channel-specific error-checking
-    virtual bool ProcessErrors (const JSON_Object* pObj) = 0;
     /// Process v2 data
-    void ProcessV2 (JSON_Object* pJAc, LTFlightData::FDKeyTy& fdKey,
+    void ProcessV2 (const JSON_Object* pJAc, LTFlightData::FDKeyTy& fdKey,
                     const double tBufPeriod, const double adsbxTime,
                     const positionTy& viewPos);
-    /// Process v1 data
-    void ProcessV1 (JSON_Object* pJAc, LTFlightData::FDKeyTy& fdKey,
-                    const double tsSimTime,
-                    const positionTy& viewPos);
+    /// Give derived class chance for channel-specific error-checking
+    virtual bool ProcessErrors (const JSON_Object* pObj) = 0;
+    /// Return the 'msg' content, if any
+    static std::string FetchMsg (const char* buf);
 };
 
 //
 // MARK: ADS-B Exchange
 //
 class ADSBExchangeConnection : public ADSBBase
 {
-public:
-    enum keyTypeE { ADSBEX_KEY_NONE=0, ADSBEX_KEY_EXCHANGE, ADSBEX_KEY_RAPIDAPI };
-    
 protected:
     std::string apiKey;
-    keyTypeE keyTy = ADSBEX_KEY_NONE;
     struct curl_slist* slistKey = NULL;
 public:
     ADSBExchangeConnection ();
@@ -174,12 +149,11 @@ class ADSBExchangeConnection : public ADSBBase
     bool ProcessErrors (const JSON_Object* pObj) override;
 
     // make list of HTTP header fields
-    static struct curl_slist* MakeCurlSList (keyTypeE keyTy, const std::string theKey);
+    static struct curl_slist* MakeCurlSList (const std::string theKey);
     // read header and parse for request limit/remaining
     static size_t ReceiveHeader(char *buffer, size_t size, size_t nitems, void *userdata);
 
 public:
-    static keyTypeE GetKeyType (const std::string theKey);
     // Just quickly sends one simple request to ADSBEx and checks if the response is not "NO KEY"
     // Does a SHOW_MSG about the result and saves the key to dataRefs on success.
     static void TestADSBExAPIKey (const std::string newKey);

Lib/LTAPI/LTAPI.h

@@ -10,7 +10,7 @@
 ///             textual info like type, registration, call sign, flight number.
 /// @see        https://twinfan.github.io/LTAPI/
 /// @author     Birger Hoppe
-/// @copyright  (c) 2019-2020 Birger Hoppe
+/// @copyright  (c) 2019-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
@@ -41,6 +41,10 @@
 #include "XPLMGraphics.h"
 
 class LTDataRef;
+class LTAPIAircraft;
+
+/// Smart pointer to an LTAPIAircraft object
+typedef std::shared_ptr<LTAPIAircraft> SPtrLTAPIAircraft;
 
 /// @brief Represents one aircraft as controlled by LiveTraffic.
 ///
@@ -62,6 +66,7 @@ class LTAPIAircraft
     /// @brief Flight phase, definition copied from LiveTraffic
     enum LTFlightPhase {
         FPH_UNKNOWN     = 0,            ///< used for initializations
+        FPH_PARKED      = 5,            ///< Parked at startup position
         FPH_TAXI        = 10,           ///< Taxiing
         FPH_TAKE_OFF    = 20,           ///< Group of status for take-off:
         FPH_TO_ROLL,                    ///< Take-off roll
@@ -117,7 +122,7 @@ class LTAPIAircraft
             bool        bcn        : 1;     ///< beacon light
             bool        strb       : 1;     ///< strobe light
             bool        nav        : 1;     ///< navigaton lights
-            unsigned    filler1    : 1;     ///< unused
+            unsigned    hidden     : 1;     ///< aircraft _not_ visible? (remains an 'unsigned' for backward compatibility)
             bool        camera     : 1;     ///< is LiveTraffic's camera on this aircraft?
             // Misc
             int         multiIdx    : 8;    ///< multiplayer index if plane reported via sim/multiplayer/position dataRefs, 0 if not
@@ -211,6 +216,15 @@ class LTAPIAircraft
     /// Helper in update loop, resets `bUpdated` flag
     void resetUpdated ()    { bUpdated = false; }
 
+    /// @brief Called when LiveTraffic toggles its aircraft camera, override in your class to handle event
+    /// @param bCameraActive `True` if camera is on this aircraft now, `false` if camera is switched off
+    /// @param spPrevAc May point to previous aircraft under camera if switching directly from one to this; can be `null`
+    virtual void toggleCamera ([[maybe_unused]] bool bCameraActive,
+                               [[maybe_unused]] SPtrLTAPIAircraft spPrevAc) {}
+    
+    /// @brief Declare the aircraft the one under the camera (e.g. if your plugin is a camera plugin and now views this aircraft)
+    void setCameraAc ();
+    
     // data access
 public:
     std::string     getKey()            const { return key; }                   ///< Unique key for this aircraft, usually ICAO transponder hex code
@@ -250,6 +264,7 @@ class LTAPIAircraft
     bool            isOnGnd()           const { return bulk.bits.onGnd; }       ///< Is plane on ground?
     LTFlightPhase   getPhase()          const { return bulk.bits.phase; }       ///< flight phase
     std::string     getPhaseStr()       const;                                  ///< flight phase as string
+    bool            isVisible()         const { return !bulk.bits.hidden; }     ///< aircraft visible?
     // configuration
     float           getFlaps()          const { return bulk.flaps; }            ///< flap position: 0.0 retracted, 1.0 fully extended
     float           getGear()           const { return bulk.gear; }             ///< gear position: 0.0 retracted, 1.0 fully extended
@@ -268,7 +283,7 @@ class LTAPIAircraft
     /// @param[out] y Local y coordinate
     /// @param[out] z Local z coordinate
     void            getLocalCoord (double& x, double& y, double& z) const
-    { XPLMWorldToLocal(bulk.lat,bulk.lon,bulk.alt_ft, &x,&y,&z); }
+    { XPLMWorldToLocal(bulk.lat,bulk.lon,bulk.alt_ft*0.3048, &x,&y,&z); }
 
 public:
     /// @brief Standard object creation callback.
@@ -280,9 +295,6 @@ class LTAPIAircraft
 // MapLTAPIAircraft
 //
 
-/// Smart pointer to an TLAPIAircraft object
-typedef std::shared_ptr<LTAPIAircraft> SPtrLTAPIAircraft;
-
 /// @brief Map of all aircrafts stored as smart pointers to LTAPIAircraft objects
 ///
 /// This is what LTAPIConnect::UpdateAcList() returns: a map of all aircrafts.
@@ -363,7 +375,7 @@ class LTAPIConnect
     ///          Depending on startup order, LiveTraffic might or might not have been started yet.
     ///          This note is basically true for all requests accessing LiveTraffic data.
     ///          It is noted here only because it is tempting to fetch the version number once only during startup.
-    /// @return Version (like 201 for v2.01), or constant 150 if unknown, or 0 if LiveTraffic is unavailable
+    /// @return Version (like 40101 for v4.1.1), or constant 150 if unknown, or 0 if LiveTraffic is unavailable
     static int getLTVerNr();
 
     /// @brief LiveTraffic's version date
@@ -418,6 +430,9 @@ class LTAPIConnect
     /// @return Pointer to aircraft in camera view, is empty if none is being viewed
     SPtrLTAPIAircraft getAcInCameraView () const;
 
+    /// @brief Clear camera information, ie. delcare that no aircraft is currently being viewed
+    void clearCameraInfo ();
+    
 protected:
     /// @brief fetch bulk data and create/update aircraft objects
     /// @param numAc Total number of aircraft to fetch
@@ -430,6 +445,8 @@ class LTAPIConnect
     bool DoBulkFetch (int numAc, LTDataRef& DR, int& outSizeLT,
                       std::unique_ptr<T[]> &vBulk);
 
+    /// @brief shared DataRef event notification
+    static void CameraSharedDataCB (LTAPIConnect* me);
 };
 
 

Lib/XPMP2

@@ -598,7 +598,7 @@
 				KnownAssetTags = (
 					New,
 				);
-				LastUpgradeCheck = 1610;
+				LastUpgradeCheck = 1620;
 			};
 			buildConfigurationList = D607B16209A5563100699BC3 /* Build configuration list for PBXProject "LiveTraffic" */;
 			compatibilityVersion = "Xcode 12.0";
@@ -807,8 +807,8 @@
 				LIBRARY_SEARCH_PATHS = Lib/fmod;
 				LIVETRAFFIC_VERSION_BETA = 0;
 				LIVETRAFFIC_VER_MAJOR = 4;
-				LIVETRAFFIC_VER_MINOR = 1;
-				LIVETRAFFIC_VER_PATCH = 1;
+				LIVETRAFFIC_VER_MINOR = 2;
+				LIVETRAFFIC_VER_PATCH = 0;
 				LLVM_LTO = NO;
 				MACH_O_TYPE = mh_dylib;
 				MACOSX_DEPLOYMENT_TARGET = 10.15;
@@ -916,8 +916,8 @@
 				LIBRARY_SEARCH_PATHS = Lib/fmod;
 				LIVETRAFFIC_VERSION_BETA = 0;
 				LIVETRAFFIC_VER_MAJOR = 4;
-				LIVETRAFFIC_VER_MINOR = 1;
-				LIVETRAFFIC_VER_PATCH = 1;
+				LIVETRAFFIC_VER_MINOR = 2;
+				LIVETRAFFIC_VER_PATCH = 0;
 				LLVM_LTO = YES;
 				MACH_O_TYPE = mh_dylib;
 				MACOSX_DEPLOYMENT_TARGET = 10.15;

LiveTraffic.xcodeproj/project.pbxproj

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1610"
+   LastUpgradeVersion = "1620"
    version = "1.8">
    <BuildAction
       parallelizeBuildables = "YES"

LiveTraffic.xcodeproj/xcuserdata/birger.xcuserdatad/xcschemes/LiveTraffic.xcscheme

@@ -472,11 +472,15 @@ bool ACTable::UpdateFDIs (const std::string& _filter)
         vecFDI.reserve(mapFd.size());
 
     // First pass: Add all matching and remember those we couldn't get
+    const bool bHideStatic = dataRefs.GetHideStaticTwr();
     std::vector<FDInfo> vecAgain;
     for (const mapLTFlightDataTy::value_type& p: mapFd) {
         // First filter: Visible a/c only?
         if (bFilterAcOnly && (!p.second.hasAc() || !p.second.GetAircraft()->IsVisible()))
             continue;
+        // 2nd filter: Don't show static objects
+        if (bHideStatic && p.second.GetUnsafeStat().isStaticObject())
+            continue;
         // others: test if filter matches
         FDInfo fdi(p.second);
         if (fdi.upToDate()) {