Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Remote simbridge docs #749

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/simbridge/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ require fewer extra steps before launching into your flights.
| [Company Routes Support](simbridge-feature-guides/coroute.md) | Available in [All Versions](../fbw-a32nx/fbw-versions.md) |
| [flyPad Local Charts](../fbw-a32nx/feature-guides/flypados3/charts.md#local-files) | Available in [All Versions](../fbw-a32nx/fbw-versions.md) |
| Remote Displays | Work in Progress |
| Remote SimBridge | In [Development](../fbw-a32nx/fbw-versions.md#development-version-recommended) Version |

!!! warning "Important Notes"
Please keep SimBridge updated at all times regardless of the version of aircraft you are currently flying!
Expand Down
3 changes: 2 additions & 1 deletion docs/simbridge/simbridge-feature-guides/.pages
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,5 @@ nav:
- Remote Displays: remote-displays
- Terrain Display: terrain.md
- Company Routes: coroute.md
- Local Files: local-files.md
- Local Files: local-files.md
- Remote SimBridge: remote-simbridge.md
71 changes: 71 additions & 0 deletions docs/simbridge/simbridge-feature-guides/remote-simbridge.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# Remote SimBridge

This guide details how to run SimBridge on a different computer (remote machine) than the one running your simulator (local machine).

## PC Requirements

- FlyByWire Installer running on the remote machine - See [Starting SimBridge](../install-configure/start-simbridge.md)
- SimBridge running on the remote machine - See [Starting SimBridge](../install-configure/start-simbridge.md)

## Configuring your aircraft

In order to let the aircraft know that SimBridge is running on a different machine, you will need to go the [EFB settings](../../fbw-a32nx/feature-guides/flypados3/settings/) and enter the 'Sim Options' page.

Locate the 'SimBridge Host Machine' option. By default it will be set to 'This PC' as shown below:
{{image 1}}

Click the 'Remote PC' option, which will reveal a new field which is the Ip Address for the remote machine (defaults to `localhost`)
{{image 2}}

Enter the IP Address for the Remote Machine in the field and hit enter to save. You will now have to disable and enable the SimBridge connection either via the same options page or the quick notifications panel of the EFB
{{image 3 + 4}}

If everything is correct, you will receive a notification that SimBridge is connected and the WiFi icon on the EFB will also be displayed.
{{image 5 + 6}}

##########################

## Finding your IP Address using SimBridge

Typically, if you are running SimBridge on the same network (via ethernet or WiFi) as the local (sim) machine, you will need to use your LAN IP Address in the EFB settings.
But, if you are running SimBridge on a different network than your own, for example in another home or at a friend's computer, you will need to use the Public IP Address instead.

SimBridge will display the local IP address it's using. To find it, open the SimBridge console (right click on the SimBridge tray icon and click 'Show/Hide') and locate the following entry: `[NetworkService] Local IP is XXXXXXXXXXX`
{{image 9}}

The numbers displayed, is local IP address SimBridge is running on. You can set this value now in the EFB and the airplane will connect.


### Manually finding the LAN IP Address

!!! info
If for some reason you can not locate the Ip Address from SimBridge it self or you still can't connect, you can try finding it manually.

You will need to perform the following instructions on the machine that is running SimBridge!

#### Windows

Press `Win + R` at the same time, in the new window that opened, type `cmd` and hit enter/OK. You will now see a terminal window. Copy and paste the following command:
`ipconfig`
A list of your available internet connections will be printed. Typically, you should see one or two 'adapters'.
Locate the one that an 'IPv4 Address', it should look something like this:
{{image 7}}
Depending on your router, your IP may look similar to the one above, or `10.10.X.X` or similar.

You can now copy the value next to 'IpV4 Address' and use it on the local machine running the simulator.

#### Linux

Open a terminal (A common keybind for desktop operating systems is `CTRL + SHIFT + T`) and run the command:
`ifconfig`
A list with all the available connections will be printeded. Depending on your configuration, you will see more than two 'adapters'. Locate the one responsible for connecting to your local network (and router) and that contains an 'inet' field, as shown below:
{{image 8}}
Depending on your router, your IP may look similar to the one above, or `10.10.X.X` or similar.

You can now copy the value inside 'inet' and use it on the local machine running the simulator.

### Manually fetching your public IP Address


To fetch the public IP address, on the remote PC open a website like https://ipchicken.com/ or https://whatismyipaddress.com/
The 'IPv4 IP Address' is the value you will need to copy and enter into the EFB settings.