The SR20 Companion and troubleshooting
The SR20 Companion is the small Windows program that comes with the mod. This section says what it does, how to read its tray icon, what it does on your PC and network, and how to fix the problems users are most likely to meet.
What the Companion is
What it does. Some SR20 features need work that the sim's avionics cannot do on their own: reading real terrain data, exporting airport maps from the sim, talking to an iPad on your Wi-Fi, or driving a force-feedback yoke over USB. The Companion does that work on your PC, beside the sim. It has no window of its own. You see it only as an icon by the clock.
It runs five helpers, each as its own background process, so a problem in one cannot stop the others. If a helper exits, the Companion starts it again 3 seconds later. If a helper exits five times in a row within 10 seconds of starting, the Companion gives up on it and the tray icon turns red.
Where to find it. After an installer install: Start menu > SR20 Realism Mod > SR20 Companion, and the icon by the clock (it may be hidden under the ^ arrow). After a hand install: SR20Companion.exe in the folder you copied.
Features that need the Companion
| Feature | Status list name | What the Companion does for it |
|---|---|---|
| TAWS-B forward-looking terrain and obstacle alerts | Terrain alerts (TAWS) | Computes the forward-looking terrain and obstacle alerts twice a second on real terrain data, and the potential impact areas for the maps and synthetic vision. |
| Glide range ring | Glide ring | Computes the wind-corrected glide range over real terrain twice a second. |
| SafeTaxi / SurfaceWatch maps for airports outside the included 50 | Airport maps (SafeTaxi, SurfaceWatch) | Exports the airport's taxiways from the sim on demand, corrects the taxiway names from OpenStreetMap, and stores the map in the aircraft package. |
| iPad / ForeFlight link | iPad and ForeFlight | Receives flight plans from ForeFlight and sends the sim's position to ForeFlight's moving map. Serves the iPad setup page. |
| RealSimGear Cirrus yoke force feel | RealSimGear yoke feel | Drives the yoke's centring and stiffness from the sim (trim, autopilot, ESP). |
| Instructor Station terrain check for setups that start at a fix of the approach | (part of Terrain alerts (TAWS)) | Answers "what is the highest terrain around this point". |
What still works without it
Everything else. The aircraft, its engine, systems, displays, CAS, circuit breakers, autopilot behaviour, ESP and speed protection do not use the Companion. These also work without it:
- SafeTaxi and SurfaceWatch at the 50 airports whose maps are included in the package, and at any airport whose map the Companion made earlier (those maps stay in the package).
- The FAA obstacles on the MFD and PFD maps and the PFD synthetic vision (the data ships in the package).
- The TAWS-B descent-rate, negative-climb, premature-descent and "Five hundred" alerts, which are computed in the aircraft.
- The Instructor Station, except the terrain check for fix-relative setups.
Without the Companion, the PFD shows TAWS FAIL about a minute after the avionics come on (it waits 60 seconds for the Companion; by then the 20 seconds without data have passed), and you hear "TAWS System Failure". The forward-looking terrain and obstacle alerts are then not available. The glide ring is not drawn. A missing airport map stays missing.
The tray icon (needs the Companion)
What it does. The icon is the Companion's only control. It shows whether every feature is working, and its menu has the few commands you need.
Where to find it. In the notification area by the clock. If you do not see it, click the ^ arrow. You can drag it onto the taskbar to keep it visible.
What you see. A cyan disc with a white aircraft, and a coloured dot in the lower right corner:
| Dot | Menu headline | Tooltip | Meaning |
|---|---|---|---|
| Green | Everything is working | "SR20 Companion: everything is working", plus " (sim not running)" while the sim is closed | Every helper is running. A yoke helper that waits for a yoke ("no yoke connected") or that you turned off in setup still counts as working. |
| Amber | Starting up… | "SR20 Companion: starting" | At least one helper is starting or restarting. Normal for a few seconds after the Companion starts or after Restart all. |
| Red | Something needs attention | "SR20 Companion: " followed by the first problem, for example "Glide ring: keeps failing (see the log)" | At least one helper has stopped and the Companion has given up on it. See Troubleshooting. |
When a helper gives up, Windows also shows a notification once: "... stopped working. Right-click the SR20 icon > Restart all."
The menu
Right-click the icon. Clicking the icon with the left button does the same as the first item, iPad setup….
| Item | What it does |
|---|---|
| iPad setup… | Opens the iPad setup page in your browser (http://127.0.0.1:47822/setup). If the iPad helper is not answering, it opens a page "Start the SR20 Companion first" instead. |
| Headline (greyed) | "Everything is working", "Starting up…" or "Something needs attention", the same as the dot. |
| Five status rows (greyed) | One row per feature. See below. |
| Sim row (greyed) | "✓ Sim running" or "– Sim not running". The Companion checks for the sim every 15 seconds. |
| Start with Windows | A tick. Ticked, the Companion starts quietly when you log on to Windows. Click it to switch. See Start with Windows. |
| Restart all | Stops every helper and starts them again. Use it after a helper gave up (red), or after you fixed what was wrong. |
| Open log folder | Opens %LOCALAPPDATA%\SR20Companion\logs in Explorer. |
| Quit SR20 Companion | Stops all helpers cleanly (the yoke is left loose and its port closed) and removes the icon. |
The status rows read as states, not switches. You cannot turn a feature off here.
| Row | Meaning |
|---|---|
| ✓ feature | Running. |
| … feature (starting) | Starting or restarting. |
| - RealSimGear yoke feel (no yoke connected) | No RealSimGear Cirrus yoke is plugged in. Normal if you do not have one. The Companion looks for the yoke every 5 seconds and starts the helper when it appears. |
| - RealSimGear yoke feel (off) | You unticked the yoke feel in Setup (or set "yoke_feel": false in settings.json). A choice, not a fault. |
| ✗ feature: reason | Stopped. The reason is "keeps failing (see the log)", or for airport maps "the SR20 aircraft isn't in the Community2024 folder". |
The five feature names in the list are: Terrain alerts (TAWS), Glide ring, Airport maps (SafeTaxi, SurfaceWatch), iPad and ForeFlight, RealSimGear yoke feel.
Starting it again by hand
Only one Companion runs at a time. If you start SR20 Companion from the Start menu while it is already running, no second copy starts: the running one opens the iPad setup page instead. The Start-menu item SR20 iPad setup opens that page directly.
Start with Windows (needs the Companion)
What it does. Puts a shortcut named "SR20 Companion" in your Windows Startup folder (shell:startup). At log-on, Windows starts the Companion in the background. It never opens a page when started this way.
Turning it on and off. Setup's option Start the SR20 Companion with Windows (on by default), or the Start with Windows tick in the tray menu at any time. Both manage the same shortcut. No administrator rights are needed.
Why it matters. The RealSimGear yoke feel only works if the Companion opens the yoke's port before the sim starts RealSimGear's own software. Starting with Windows makes sure of that. For the other features it is enough that the Companion runs before you fly.
What the Companion does on your PC and network (needs the Companion)
| What | Details |
|---|---|
| Local services for the aircraft | 127.0.0.1 (this PC only): port 47820 airport maps, port 47821 TAWS terrain alerts and the Instructor Station terrain check, port 47822 iPad link and the iPad setup page. Nothing outside your PC can reach these. |
| iPad link listener | TCP port 47823 on your home network. It accepts connections only from private (home network) addresses, and only from an iPad you paired with the QR code. |
| ForeFlight moving map | Listens on UDP port 63093 for ForeFlight's announcements, and sends about 30 bytes of position data to each iPad it hears (UDP port 49002), five times a second, on your home network only. Nothing is sent while the sim's GPS is failed or the sim is not running. |
| Downloads folder | Watches your Windows Downloads folder for ForeFlight*.fpl flight plan files (every 2 seconds) and offers them to the MFD. It never changes or deletes them. |
| Terrain downloads | Free Copernicus DEM terrain tiles (90 m) from Amazon Web Services (copernicus-dem-90m.s3.amazonaws.com), one tile per 1° by 1° square, only for areas you fly near: around the aircraft, around an approach the Instructor Station sets up, and within 40 NM of an airport you pick on the Instructor Station. Each tile is downloaded once and kept. Ocean squares have no tile. |
| Taxiway names | When the Companion makes an airport map on demand, it asks OpenStreetMap (api.openstreetmap.org, or an Overpass mirror if that fails) once for the airport's taxiway names. The answer is cached. |
| Writes into the aircraft package | Airport maps made on demand go into paulw-aircraft-sr20\html_ui\SR20SurfaceWatch\airports in your Community2024 folder, so they are there at the next sim start too. |
If you do not use the iPad link, you can turn it off: in %LOCALAPPDATA%\SR20Companion\data\efb\efb.json set "lan_upload": false (no listener on port 47823) and "map": false (no moving map), then Restart all.
Where the data and logs are kept, and how big they get
| Folder | Contents | Size |
|---|---|---|
%LOCALAPPDATA%\SR20Glide\tiles |
Terrain tiles, about 5.5 MB per 1° square (a region the size of Southern California is about 30 tiles, 166 MB). | Capped at 2 GB: beyond that, the tiles used least recently are deleted. Safe to delete at any time; tiles come back on demand. |
%LOCALAPPDATA%\SR20Companion\settings.json |
Your Setup choices: yoke feel on or off, the Community2024 folder. | Tiny. |
%LOCALAPPDATA%\SR20Companion\data |
iPad pairing and pending flight plan (efb\), taxiway-name cache (osm_cache\), the yoke feel settings (yoke_feel.json). |
Small. |
%LOCALAPPDATA%\SR20Companion\logs |
companion.log and one folder per helper: glide, taws, surfacewatch, efb, yoke. |
Each helper log is capped at 1 to 2 MB, with one older copy kept. The glide ring's terrain check file is capped at 5 MB plus one older copy. With a RealSimGear yoke, the yoke helper also writes a detailed log of about 25 MB per hour flown, deleted after 14 days. Without the yoke the logs stay small (about 1.5 MB after weeks of flying). |
Privacy
- No accounts, no sign-in, no registration, no telemetry.
- Nothing about you is sent anywhere. The only internet traffic is the terrain tile downloads and the OpenStreetMap taxiway-name requests described above. Like any download, those servers see your internet address and which area's data was asked for.
- The iPad link works only inside your home network. Pairing uses a QR code shown on your own PC; no cloud service is involved.
Source code and licence
The Companion is open source under the GNU Affero General Public License v3.0 (AGPL-3.0), because it uses the AGPL Python-SimConnect library. The source code is at https://github.com/wazooda/SR20-Companion. The aircraft package itself is licensed CC BY-NC 4.0 (free, non-commercial). See LICENSE.txt and THIRD-PARTY-NOTICES.txt (Start menu > SR20 Realism Mod > Read me opens the read-me; the licences are in the same docs folder).
Troubleshooting
Check the tray icon first. If it is red, the tooltip and the status rows name the feature and the reason. Open log folder shows the logs; each helper's log is in its own folder.
Installing and finding the aircraft
| Symptom | Cause | Fix |
|---|---|---|
| The SR20 is not in the sim's aircraft list. | The aircraft was copied into the Community folder. The sim treats that folder as MSFS 2020 add-ons and ignores the SR20 there. | Move paulw-aircraft-sr20 into Community2024 (next to Community), or run Setup and choose Community2024. |
| The SR20 is not in the list, and it is in Community2024. | The sim was running while you installed. It reads the Community2024 folder only when it starts. | Restart the sim. |
| The SR20 is not in the list, and it is in Community2024, and you restarted. | The folder is nested one level too deep (for example Community2024\paulw-aircraft-sr20\paulw-aircraft-sr20), or the stock SR22T is not installed. |
The folder paulw-aircraft-sr20 must sit directly in Community2024 and contain manifest.json. Make sure the stock Cirrus SR22T is installed. |
Windows says "Windows protected your PC" when you start Setup or SR20Companion.exe. |
SmartScreen: the files are not code-signed. | Click More info, then Run anyway. |
| Windows blocks Setup with no Run anyway button. | Smart App Control or a company policy. | Use the manual-install zip and install by hand, or install on a PC without that block. |
| Setup says "That is the Community folder, which the sim uses for MSFS 2020 add-ons. Choose Community2024 (next to it)." | You chose the wrong folder. | Choose the Community2024 folder beside it. |
| A change, an update or a new airport map does not show in the sim. | The sim reads the aircraft package only when it starts. | Restart the sim. While the Companion runs, maps it makes on demand appear at once; everything else needs a sim restart. |
| After a sim update, the avionics misbehave (displays wrong, pages missing, softkeys dead). | The mod's avionics are modified copies of the stock SR22T avionics code. A sim update can change that code under the mod. | Look for a mod update on the flightsim.to page. Until then, fly the stock SR22T. Report it (see Reporting a problem) with the sim version. |
The Companion and its tray icon
| Symptom | Cause | Fix |
|---|---|---|
| No icon by the clock. | The Companion is not running, or the icon is hidden. | Click the ^ arrow by the clock. If it is not there, start SR20 Companion from the Start menu (or SR20Companion.exe). Tick Start with Windows so it starts at log-on. |
| The icon stays amber. | A helper is starting or restarting again and again. | Wait a few seconds. If it turns red, see below. |
| Red: "Airport maps (SafeTaxi, SurfaceWatch): the SR20 aircraft isn't in the Community2024 folder". | The Companion could not find paulw-aircraft-sr20 when it started: the aircraft is not installed yet, it is in the wrong folder, or your packages are somewhere the Companion did not look. |
Install the aircraft into Community2024. If your packages are in an unusual place, run Setup and choose the folder (it writes it to settings.json). Then Quit SR20 Companion and start it again: Restart all does not look for the aircraft again. |
| Red: "... keeps failing (see the log)". | That helper exits as soon as it starts. A common cause is another program using its port (see the next row). | Open log folder, look at that helper's log. Fix the cause, then Restart all. |
| Red on Airport maps or iPad and ForeFlight, and the log mentions the port. | Another program already uses port 47820 or 47822. The Companion does not share its ports. | Close the other program, or quit it, then Restart all. If TAWS's port 47821 is taken, TAWS still works but the TAWS impact areas are not drawn (the TAWS log says "port 47821 unavailable"). |
| The iPad setup page says "Can't receive flight plans: ... Restart the SR20 Companion." | The iPad listener could not open port 47823 (often another program uses it). | Close the other program and click Restart all. |
| Clicking iPad setup… opens "Start the SR20 Companion first". | The iPad helper is not answering: the Companion is not running, or is still starting. | Start the Companion, wait a few seconds, try again. |
Terrain alerts (TAWS)
| Symptom | Cause | Fix |
|---|---|---|
| TAWS FAIL on the PFD, "TAWS System Failure". | The aircraft gets no terrain alert data from the Companion: it is not running, or its TAWS helper stopped. TAWS FAIL appears about a minute after power-up, or after 20 seconds without data later in the flight. | Start the Companion, or Restart all. TAWS FAIL clears by itself after 5 seconds of fresh data. |
| TAWS N/A on the PFD, "TAWS Not Available". | The terrain ahead is not known yet: the tiles for this area are still downloading, or there is no internet connection and they were never downloaded. A GPS failure also gives TAWS N/A. | Wait for the download (it takes a moment on the first flight in a new area). Check your internet connection. "TAWS Available" plays when it is back. |
| TAWS TEST does not end at power-up. | The test cannot pass while TAWS has no data. | It ends by itself 5 seconds after the start when GPS is invalid or TAWS is FAIL / N/A. Fix the cause above. |
| Obstacle alerts never appear outside the US. | The obstacle data is the FAA Digital Obstacle File, US only. | None. Terrain alerts still work everywhere the terrain data covers. |
Glide range ring
The ring needs all of these:
- The Companion is running and Glide ring shows ✓.
- Glide Range Ring is on in the MFD Map Settings, Map group. It is on by default, and the sim remembers your last choice.
- You are in the air, above 1,050 ft AGL. The ring is hidden on the ground and below 1,000 ft AGL.
- The terrain around you is known. If more than 18 of the ring's 72 directions run into unknown terrain (tiles still downloading, or no internet), the ring is not drawn.
- You are looking at a map that shows it: the MFD navigation map, the MFD flight plan page map or the PFD inset map.
The ring disappears 3 seconds after the Companion stops sending it, for example when you quit the Companion.
Airport maps (SafeTaxi and SurfaceWatch)
| Symptom | Cause | Fix |
|---|---|---|
| No taxiways on the MFD map at an airport. | The map range is above 1.5 NM, or the airport is more than 4 NM from the map centre. | Zoom in to 1.5 NM or less. |
| No taxiways at an airport that is not one of the 50 included, and no MFD message. | The Companion is not running, so no map can be made. | Start the Companion. The MFD asks for maps of your flight plan's origin and destination, the airport you are on, and airports within 10 NM. |
| MFD message "SurfaceWatch: no taxiway map for ...". | The sim has no taxiway data for that airport (common at small strips and heliports). | None. The Companion tries again after 5 minutes. |
| MFD message "SurfaceWatch: ... airport map not available". | The Companion could not be reached when the map was asked for. | Check the tray icon, then Restart all. |
| Taxiways are drawn but their names are wrong or missing. | Names come from the sim, then are corrected from OpenStreetMap. If OpenStreetMap knows fewer than 3 named taxiways at the airport, or its taxiways match less than 40 % of the sim's, or OpenStreetMap could not be reached when the map was made, the sim's names stay. Where both are known and differ, the sim's name is shown in brackets. | Names are fetched once, when the map is made. An OpenStreetMap failure is logged in the airport maps log. The sim's names at autogenerated airports are often wrong; OpenStreetMap is the better source where it has data. |
| Maps made on demand are gone after an upgrade. | A new version starts with a clean package. | They are made again the next time you fly there. |
iPad and ForeFlight
| Symptom | Cause | Fix |
|---|---|---|
| The iPad says "This iPad isn't connected to this PC. On the PC, open SR20 iPad setup and scan code 2 again." | The pairing is missing: a new install, Disconnect all iPads was used, or the pairing data was deleted. | Open iPad setup… and scan code 2 again. |
| The iPad says "That code has expired. On the PC, reload SR20 iPad setup and scan the new code." | Pairing codes are valid for 30 minutes. | Reload the setup page and scan the new code. |
| The iPad says "The request timed out". | The iPad cannot reach the PC: the Companion is not running, the two are on different Wi-Fi networks (a guest network keeps devices apart), or the PC got a new address after a router change. | Start the Companion, put both on the same home Wi-Fi, scan code 2 again. |
| The setup page says "Windows treats ... as a Public network, which blocks the iPad." | Windows calls your home Wi-Fi a Public network, and the Companion is allowed only on Private networks. | Windows Settings > Network & internet > open this network > choose Private network. |
| The setup page says "A Windows Firewall rule is blocking the SR20 Companion." or "Windows hasn't been told to allow the SR20 Companion yet." | You clicked Cancel at the firewall prompt, or it never appeared. | Click Let the SR20 Companion receive on my home network on the setup page and confirm the administrator prompt. It removes a block rule left by Cancel and allows TCP 47823 and UDP 63093 on Private networks, from your local network only. |
| The setup page says "This PC is on a work (Domain) network." | Company network. | Ask whoever manages it to allow the SR20 Companion. |
| Send to SR20 is not in ForeFlight's share list. | The Shortcut is not installed or not shown. | Scroll the share list to the end, tap More, and turn on Send to SR20. Or scan code 1 again. |
| The plan was sent but nothing pops up on the MFD. | The plan waits until the sim is running, and the pop-up waits while a window or menu is open on the MFD. | Start the sim or close the MFD window. Approaches, departures and arrivals do not come across; load them on the PROC page. |
| ForeFlight's moving map does not show the sim. | ForeFlight must be in the foreground on the iPad, on the same Wi-Fi. Nothing is sent while the sim's GPS is failed. | Bring ForeFlight to the front. Check that the setup page lists the iPad under "ForeFlight's moving map is getting the sim's position". |
Autopilot and controls
| Symptom | Cause | Fix |
|---|---|---|
| The autopilot disconnects by itself, as a manual disconnect, with a controller whose stick does not centre (or drifts). | The autopilot override break-out. While the autopilot is engaged your pitch and roll input is held back and measured. Once the stick has been near centre (within 30 % of the break-out point, about 13 % of travel) for 0.3 seconds, moving it to 45 % of its travel in pitch or roll for 0.3 seconds disconnects the autopilot, as pushing through the servos does in the real aircraft. A stick that rests or drifts that far off centre does the same. | Centre the stick before you engage the autopilot, and leave it centred while the autopilot flies. Check the controller's calibration. A spring-centred stick or yoke avoids the problem. |
| The RealSimGear yoke has no force feel, or the RealSimGear software holds the yoke. | The Companion started after the sim. The yoke helper must open the yoke's port before the sim starts RealSimGear's software. | Close the sim. Check that the tray shows RealSimGear yoke feel with ✓. Start the sim. Tick Start with Windows so this does not happen again. |
| The yoke feel is not wanted. | Run Setup again and untick RealSimGear Cirrus yoke force feel, or create %LOCALAPPDATA%\SR20Companion\settings.json with {"yoke_feel": false} and restart the Companion. |
|
| After reloading the PFD or MFD in the sim's developer mode, the CDI stops working or the autopilot modes drop. | A mid-flight reload of a display restarts parts of the avionics that the flight depends on. The autopilot runs on the MFD. | Do not reload the PFD or MFD in flight. Restart the flight instead. |
Instructor Station
| Symptom | Cause | Fix |
|---|---|---|
| The approach setup stops with "terrain unknown (is the SR20 Companion running?)". | Setups that place you at a fix of the approach check the terrain first. The answer comes from the Companion, which waits up to 8 seconds for it. | Start the Companion, wait for the terrain to download (picking the airport starts that download), and try again. |
| "terrain less than 1,000 ft below: climb or move". | The chosen start point is too close to the terrain. | Choose a higher altitude or another fix. |
Reporting a problem
Support is best effort: open an issue on the mod's GitHub page, or comment on its flightsim.to page. Please say:
- the sim version (MSFS 2024 version number, and Steam or Microsoft Store);
- what you were doing when the problem appeared;
- the tray icon's colour and any red status row.
The logs are in tray icon > Open log folder if you are asked for them.
Known limitations
- Tested on the Steam version of MSFS 2024 (sim version 1.9.24.0). The Microsoft Store version should work but has not been tested.
- The exterior is the stock SR22T model. There are no SR20 exterior textures.
- A few avionics behaviours have not yet been fully flight-tested.
- New terrain needs an internet connection the first time you fly somewhere.
- A sim update can require an update of this mod, because the avionics build on the stock plugin code.
- Obstacle data covers the US only (FAA Digital Obstacle File, current as of 10/31/26).
- Reloading the PFD or MFD in flight can break the CDI or drop autopilot modes. Restart the flight instead.
- Not included: the full Pilot's Guide SurfaceWatch Setup page behaviour, and panel-to-iPad flight plan transfer.
Quick reference
| Control | Where | What it does |
|---|---|---|
| Tray icon dot | By the clock (maybe under ^) | Green: working. Amber: starting. Red: something stopped, see the tooltip. |
| iPad setup… (or left-click) | Tray menu | Opens the iPad setup page, http://127.0.0.1:47822/setup. |
| Status rows | Tray menu | One line per feature: ✓ running, … starting, - waiting or turned off, ✗ stopped with the reason. |
| Start with Windows | Tray menu | Starts the Companion at log-on (Startup shortcut "SR20 Companion"). |
| Restart all | Tray menu | Stops and restarts every helper. |
| Open log folder | Tray menu | Opens %LOCALAPPDATA%\SR20Companion\logs. |
| Quit SR20 Companion | Tray menu | Stops the helpers and exits. |
| SR20 iPad setup | Start menu > SR20 Realism Mod | Opens the iPad setup page. |
| Yoke feel off | Setup, or settings.json {"yoke_feel": false} |
Stops the Companion from driving the RealSimGear yoke. |
| iPad link off | data\efb\efb.json "lan_upload": false, "map": false |
No home-network listener, no moving map. |
| Local ports | 127.0.0.1 | 47820 airport maps, 47821 TAWS, 47822 iPad link and setup page. |
| Home-network ports | Your Wi-Fi | TCP 47823 iPad link, UDP 63093 ForeFlight discovery. |
| Terrain cache | %LOCALAPPDATA%\SR20Glide\tiles |
Up to 2 GB, safe to delete. |
| Source code | https://github.com/wazooda/SR20-Companion | AGPL-3.0. |
| Report a problem | GitHub issues or flightsim.to comments | Give the sim version and Steam or Store. |