README

Currently only supports Codemasters F1 2020

See: https://forums.codemasters.com/topic/54423-f1%C2%AE-2020-udp-specification/

Many sim racing games can send telemetry data over the network to a 3rd party app.

The data format varies from game-to-game, but often includes:

Car data like speed & engine RPM
Control data like throttle position & steering angle
Lap data like current lap time and fastest sectors

The data sent in the UDP packets comes through as a raw binary stream. The aim of this library is to take that binary stream and turn it into something we can work with in PHP.

Note that this library does NOT handle receiving the binary stream or display it - merely parsing the raw data and turning it into a friendly model.

How to use

Use Composer to install

$ composer require VirginEnt/sim-telemetry-parser

Use it!

// Create parser class
$parser = VirginEnt\SimTelemetryParser\Parser::getParser();

// Parse a stream
$packet = $parser->streamToModels($binaryStream);

// Get index of player  car
$playerCar = $packet->getHeader()->getPlayerCarIndex();
                        
// Each packet contains different data. Speed is only contained in the car telemetry packet
if ($packet instanceof \VirginEnt\SimTelemetryParser\Game\F12020\Structs\PacketCarTelemetryData) {
 echo "You are traveling at ".$packet->getCarTelemetry($playerCar)->getSpeed()."kph";
}

For a scrappy demo of it in use, see demo.php

Types of model that can be returned by parse function

VirginEnt\SimTelemetryParser\Game\F12020\PacketCarSetupData
VirginEnt\SimTelemetryParser\Game\F12020\PacketCarStatusData
VirginEnt\SimTelemetryParser\Game\F12020\PacketCarTelemetryData
VirginEnt\SimTelemetryParser\Game\F12020\PacketEventData
VirginEnt\SimTelemetryParser\Game\F12020\PacketFinalClassificationData
VirginEnt\SimTelemetryParser\Game\F12020\PacketHeader
VirginEnt\SimTelemetryParser\Game\F12020\PacketLapData
VirginEnt\SimTelemetryParser\Game\F12020\PacketLobbyInfoData
VirginEnt\SimTelemetryParser\Game\F12020\PacketMotionData
VirginEnt\SimTelemetryParser\Game\F12020\PacketParticipantsData
VirginEnt\SimTelemetryParser\Game\F12020\PacketSessionData
VirginEnt\SimTelemetryParser\Game\F12020\FastestLap
VirginEnt\SimTelemetryParser\Game\F12020\Penalty
VirginEnt\SimTelemetryParser\Game\F12020\RaceWinner
VirginEnt\SimTelemetryParser\Game\F12020\Retirement
VirginEnt\SimTelemetryParser\Game\F12020\SpeedTrap
VirginEnt\SimTelemetryParser\Game\F12020\TeamMateInPits

Future development

I plan to write a much nicer server application & visualiser which will use this library.

For a complete reference of packets & their contents, see: https://forums.codemasters.com/topic/54423-f1%C2%AE-2020-udp-specification/

virginent / sim-telemetry-parser

Maintainers

Details

README

How to use

Types of model that can be returned by parse function

Future development