The simconnect-java-util project contains a java client for the simconnect interface of the microsoft flight simulator 2020. The client connects to the flight simulator directly over an IP network connection, so that it is able to run on the same machine as the simulator or on another machine in the local network. As this java client communicates directly with the flight simulator, it is not necessary to install the Flight Simulators simconnect API written in C++ or C#.

The project is inspired by Marko Harjulas jsimconnect project, which supports the API for Flight Simulator X but does not contain some of the newer methods for Flight Simulator 2020.

https://github.com/EvenAR/node-simconnect/tree/master

https://github.com/EvenAR/node-simconnect/blob/master/src/SimConnectConnection.ts

Just clone the project and compile it with your local maven installation:

git clone https://github.com/chrlembeck/simconnect-java-util.git
cd simconnect-java-util.git
mvn install

To integrate the simconnect-java-util in your own project just add it to the maven dependencies in the projects pom.xml:

<depenencies>
    <!-- ... other dependencies ... --> 
    <dependency>
        <groupId>org.lembeck</groupId>
        <artifactId>simconnect-java-util</artifactId>
        <version>0.1</version>
    </dependency>
</dependencies

Yes, the project contains some example programs to show some of its features. The examples can be found in the package org.lembeck.fs.simconnect.examples.

To be able to connect to your instance of Flight Simulator 2020, you have to tell the integrated simconnect server interface to listen for incoming IP connections out of your local network. To do so, you have to inspect and possibly edit the simconnect.xml file of your Flight Simulator installation. This file should be located on the computer, the Flight Simulator is running on. The detailed location is depending on the way, the Flight Simulator was installed.

If you installed the simulator out of the Microsoft Store, the simconnect.xml file ist located here:

C:\Users\<user_name>\AppData\Local\Packages\Microsoft.FlightSimulator_8wekyb3d8bbwe\LocalCache\

Installations of the Steam edition have the simconnect.xml file here:

C:\Users\<user_name>\AppData\Roaming\Microsoft Flight Simulator\

The simconnect.xml file is structured as a usual xml file and should have some <SimConnect.Comm> sections in it. Each of them defines a way to get into contact with the server. To open a listener on a specific network port (for example 12345), you have to add a new SimConnect.Comm entry into the file as shown below:

<?xml version="1.0" encoding="Windows-1252"?>
<SimBase.Document Type="SimConnect" version="1,0">
    <Descr>SimConnect Server Configuration</Descr>
    <Filename>SimConnect.xml</Filename>
    <SimConnect.Comm>
        ...
    </SimConnect.Comm>
    ...
    <SimConnect.Comm>
        <Descr>Static Open IP4 port</Descr>
        <Protocol>IPv4</Protocol>
        <Scope>global</Scope>
        <Port>12345</Port>
        <MaxClients>64</MaxClients>
        <MaxRecvSize>41088</MaxRecvSize>
    </SimConnect.Comm>
</SimBase.Document>

Feel free to use any unused port that is available on your local installation. For connections from outside the local computer it may be necessary to open the port in the firewall of the machine, the flight simulator is running on.

Remember the port, you entered into the simconnect.xml file as it will be required when you want to call the connect method of the simconnect-java-util API.

For more information see the official documentation: https://docs.flightsimulator.com/html/Programming_Tools/SimConnect/SimConnect_XML_Definition.htm

This project mainly aims to implement a java client for the newer Flight Simulator 2020. Therefore, methods that were originally used for FSX but are marked as deprecated in the current simconnect API specification are not implemented.

It is possible that some methods are backwards compatible with FSX and these can be used for connections to FSX. However, this has not been tested and correct functioning cannot be guaranteed.

You can build a panel showing some information about your plane and additional infos of your flight including some switches and instruments to show and use them on another machine or a secondary screen as i did in the following example: