TCAS Concentrator

[TwinFan]

Current Situation / Problem Only one X-Plane plugin can take control of TCAS targets at a time. This is a X-Plane design limitation. See Overriding TCAS and XPLMAcquirePlanes.

Suggested Solution A separate plugin, a TCAS concentrator, acts as kind of a proxy in that it is the plugin to actually have control of X-Plane's TCAS targets, receives plane positions from collaborating plugins which draw planes (like LiveTraffic, xPilot and the like), orders these planes by distance and forwards the first 63 to X-Plane's TCAS target system.

Design Approach

Collaborating Plugin

• [x] Can identify if there is a TCAS concentrator available and if it is in control of TCAS targets (via a provided dataRef)
  • [x] If there is an active concentrator: Forwards all plane positions to the concentrator (via a binary dataRef)
  • [x] Otherwise can follow the legacy approach (try to acquire TCAS control and set the TCAS targets itself)

TCAS Concentrator

• [ ] Publishes its status (has control or not) via dataRef
• [ ] Offers a binary-write dataRef, with which collaborating plugins send aircraft information
  • [ ] For performance reasons, the data should come in a binary C structure, one per aircraft
  • [ ] includes a priority as XPMP2 supports now already
  • [ ] includes a flag if the plane should appear in a TCAS map layer (see below)
  • [ ] includes a label (used in the map)
  • [ ] basic version handling needs to be included, e.g. by the classic approach of including a size field
• [x] Keeps a list of all aircraft positions from all collaborating plugins, including a plugin id
  • [x] Sorts by prioritized distance
  • [x] forwards the data of the first up to 63 aircraft to X-Plane's TCAS target dataRefs
  • [ ] remove aircraft not updated for more than 10 frames (as X-Plane does it, too)
• [x] provides a "TCAS" map layer
  • This is needed to handle the map flexibly: In X-Plane's TCAS targets handling, it is either possible to have X-Plane draw standard plane icons in the internal map automatically, or to switch that off, e.g. to have the map layer provided by the plugin. The concentrator should provide this flexibility, too. But if one collaborating plugin wants automatic plane icons, the other not, then X-Plane's standard functionality is of no use any longer.
  • [x] There is just one map layer provided by the concentrator. (A design which creates and administers several map layers is possible...but probably overkill given the main goal of the concentrator.)
  • [x] Icons can be chosen like XPMP2 does it already based on ICAO aircraft type (which is a TCAS target field anyway), which would be added functionality beyond X-Plane's standard approach
• [x] Much code could be taken over from, ideally shared with XPMP2:
  • [x] prioritized distance handling
  • [x] TCAS target dataRef handling
  • [x] even the TCAS fallback for pre-11.50 version could be supported
  • [x] map drawing
  • [x] The TCAS Concentrator plugin should be an additional target in the XPMP2 project.
• [ ] Will need a few menu items for configuration and actions:
  • [ ] Setting: try acquiring TCAS immediately at startup (this is against the TCAS plugin coordination rules, but the concentrator would do it for the benefit of many)
    • [ ] which also means: we need a config file
  • [x] "TCAS Control" (as LiveTraffic does it) to indicate, acquire, and release TCAS control
• [ ] A simple list of admnistered aircraft is probably helpful also for debug purposes

XPMP2

• [x] should support TCAS Concentrator automatically out of the box
  • [x] provide a config setting to switch it off...but what for?
• [ ] A call to XPMPMultiplayerEnable should
  • [ ] return success in case an active TCAS concentrator is found and feed that in the future
  • [x] otherwise perform as today
• [ ] Feeding the TCAS connector needs to be verified every frame: It could have given up TCAS control or have gotten deactivated
• [x] if feed to TCAS, send all planes over there, otherwise do as now

Benefits The planes of more than one multiplayer plugin can appear on TCAS systems and can be made available to 3rd party plugins reading this data (like map or camera tools).

Additional context The idea has also been formulated by Kuroneko.

[TwinFan]

The TCAS Concentrator functionality has been made available in the XPMP2 Remote Client (see issue #22). The architecture used is quite different from what has been considered here. All communication is via UDP Multicast, ie. the network, instead of local dataRefs. While this might be a little slower it has the advantage that less activity is going on during the flight loop and local network transfer (via the loopback interface) is actually quite fast, too.

So for the moment, the enhancement is considered implemented and available. Will see how it is received in the public after publishing the XPMP2 Remote Client.