Skip to content

Latest commit

 

History

History
78 lines (49 loc) · 3.52 KB

README.md

File metadata and controls

78 lines (49 loc) · 3.52 KB
Raw

Simple and lightweight java wrapper for use in android and other applications.

Used to pull data from in-game using Forza's built in DATA OUT telemetry system.

HOW TO USE

If you want to run and see realtime data in the terminal, use the ExampleFile.java in an IDE (alongside ForzaApi.java of course), which has the variables for every set of data. It also contains the full UDP socket connection process which I will explain below.

This will also work on android, but note that you cannot update any views on the main thread so runOnUiThread() is required. This goes for using the Datagram functions as well (no network on main thread), which can be overriden with a Thread/Runnable. If you'd like to see an example of an android app using this data, check out this repo: https://github.com/Forza-Open-Tools/ForzaTelemetryAndroidApp

To use ForzaApi, initialize it and with a value of null. It will be re-initialized in a loop when data is ready to be received and parsed.

ForzaApi api = null;

Now, create a DatagramSocket and choose a port number. You can pick any, just set it to the same one in your forza settings.

DatagramSocket ds = null;  //Initialize UDP stream socket
    try {
        ds = new DatagramSocket(5300);
    } catch (SocketException e) {
        e.printStackTrace();
    }

Create your byte buffer/packet size. In this case, 323 bytes are received by the UDP stream.

byte[] receive = new byte[323];  //Create packet buffer size, which in this case is 323

Here is the fun part. Create a DatagramPacket and give it a value of null, and create an infinite (while) loop below it.

DatagramPacket dp;
    while (true) {
    
    }

To receive packet data from the socket, you must initialize the DatagramPacket with the byte buffer and length, then pass it to the DatagramSocket. Add this to your loop.

dp = new DatagramPacket(receive, receive.length); //Pass bytes and packet size

        try {
            ds.receive(dp); //receive UDP data stream and pass it to DatagramPacket
        } catch (IOException e) {
            e.printStackTrace();
        }

To clear the byte buffer after every loop, add this to the bottom of your loop. Don't put anything below it.

receive = new byte[323]; //Clear byte buffer

Now, to start getting data you have to initialize ForzaApi in the loop and pass it the bytes from DatagramPacket using getData().

api = new ForzaApi(dp.getData()); //Initialize ForzaApi and pass stream data to be parsed

You can now start getting data! Use ExampleFile.java to see all possible functions, aswell as what they return.

float engineMaxRpm     = api.getEngineMaxRpm();
float engineIdleRpm    = api.getEngineIdleRpm();
float engineCurrentRpm = api.getEngineCurrentRpm();

System.out.println("Current RPM: " + engineCurrentRpm);
System.out.println("Max RPM: " + engineMaxRpm);
System.out.println("Current RPM: " + engineIdleRpm);

If you need to debug, use this to get all the data in raw byte array form:

Arrays.toString(dp.getData());

IMPORTANT!

If you are a developer and want to know how to read the data for usage in other langauges or applications, read through ForzaApi.java to recreate it. You must receive a UDP stream of data from a socket, each chunk of data is 323 bytes. To parse it, you must order the bytes into an array using the LITTLE ENDIAN order. From there on its just a matter of parsing them based on length. (Float 4 bytes long, short 2 bytes long, bytes 1 byte long)