Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/alexanderzobnin/grafana-simracing-telemetry


https://github.com/alexanderzobnin/grafana-simracing-telemetry

grafana simracing

Last synced: about 1 month ago
JSON representation

Awesome Lists containing this project

README 

        
# Simracing telemetry



Simracing Telemetry data source plugin makes it possible to visualize telemetry

data from various simracing titles such as Assetto Corsa Competizione, iRacing 

and others in [Grafana](https://grafana.com/).



![Simracing telemetry dashboards hi-res](https://user-images.githubusercontent.com/4932851/167926449-883b2163-c980-4c5c-8b91-31afc551d1a0.png)



## Features



- Real-time telemetry data visualization

- Highly customizable dashboards



Here's a [demo video](https://youtu.be/vub072-zbCE) showing plugin capabilities.



## Supported titles



Currently, plugin supports following games:



- Assetto Corsa Competizione

- Assetto Corsa (experimental)

- iRacing

- Dirt Rally 2.0

- BeamNG Drive

- Forza Horizon 5

- Forza Horizon 4 (experimental)



## Supported platforms



Most of simracing titles are intended to be run on Windows. In general, 

Grafana and plugin can be run on any supported platform, since some titles

send telemetry over the network. But Assetto Corsa Competizione and iRacing

provide its telemetry via [Memory-mapped files](https://docs.microsoft.com/en-us/dotnet/standard/io/memory-mapped-files),

so Grafana, plugin and game should be running on the same system (Windows).

Thus, Windows now is the only supported platform.



## Getting started



If you're not familiar with [Grafana](https://grafana.com/) software, I would recommend

to use bundled Grafana package which shipped with this plugin. It contains Grafana with 

installed and preconfigured data source and dashboards. In order to use it, navigate to the

[github releases](https://github.com/alexanderzobnin/grafana-simracing-telemetry/releases) page

and download `grafana-bundled.windows-amd64.zip` package from assets. Then, unpack it and go to the

`grafana-x.x.x\bin` folder. Right click `grafana-server.exe` and run it as an admin to start Grafana server. 

Windows might ask you to allow network access for the Grafana server (it required to get telemetry from games over the network). 

Then open http://localhost:3000 in a browser. You will see Grafana login page. 

Default credentials are admin:admin. Now you're ready to go. Click on _General/Home_ at the top and select

dashboard you want to start with.



### Install Grafana



[Download](https://grafana.com/grafana/download?edition=oss&platform=windows) Grafana from

official website and install it (select OSS edition and Windows platform). Read the Windows [installation guide](https://grafana.com/docs/grafana/latest/installation/windows/).

Refer to [plugin installation](https://grafana.com/docs/grafana/latest/plugins/installation/) guide and

read how to install plugin. There are few ways how to do it.



**Important note:** I recommend installing Grafana as a [standalone Windows binary](https://grafana.com/docs/grafana/latest/installation/windows/#install-standalone-windows-binary)

and not running it as a Windows service, because there's an issue with accessing 

memory-mapped files (so it affects Assetto Corsa and iRacing) in this mode. Read more in [corresponding issue](https://github.com/alexanderzobnin/grafana-simracing-telemetry/issues/5).



### Install plugin



#### Install plugin from package



Go to the [github releases](https://github.com/alexanderzobnin/grafana-simracing-telemetry/releases)

and select latest release. Download `alexanderzobnin-simracingtelemetry-datasource-x.x.x.zip` file from the assets.

Unpack it into your grafana plugins directory (by default it's `C:\Program Files\GrafanaLabs\grafana\data\plugins` or

`data\plugins` inside unpacked grafana folder when it's installed from zip file). 

Create `plugins` folder if it's not exist. Then, restart Grafana server. It can be done within a task manager (services tab).



#### Install via Plugin catalog



In order to be able to install / uninstall / update plugins using plugin catalog, 

you must enable it via the `plugin_admin_enabled` flag in the [configuration](https://grafana.com/docs/grafana/latest/administration/configuration/#plugin_admin_enabled) file. 

Before following the steps below, make sure you are logged in as a Grafana administrator.



To install a plugin:



1. In Grafana, [navigate to the Plugin catalog](https://grafana.com/docs/grafana/latest/plugins/catalog/#plugin-catalog-entry) to view installed plugins.

2. Browse and find a plugin.

3. Click on the plugin logo.

4. Click Install.



### Create data source



Navigate to the [Configuration -> Data sources](http://localhost:3000/datasources) in Grafana

side menu and click _Add data source_. Select _Simracing Telemetry_ from the list 

and press _Save & test_. You can also enable _Default_ toggle near data source name

to make data source default source when you create new queries.



### Import dashboards



At the data source config page, navigate to _Dashboards_ tab and import

dashboards for the game you want to use.



Then, go to the Grafana [home page](http://localhost:3000/) and select dashboard 

from the dropdown at the top left. Now, you can run the game and start exploring your telemetry.



## Game-specific configs



Some games do not send telemetry by default, so you need to perform some

extra steps to enable it.



### Dirt Rally 2.0



Here's instruction from [Race Department](https://www.racedepartment.com/downloads/dirt-rally-2-0-dashboard-telemetry-tool.26703/): 



1. Locate the config file by going to the following path in Windows explorer (Note: this may be different for you, depending on your operating system). Replace "{Yourusername}" with your username.

   `C:\Users\{Yourusername}\Documents\My Games\DiRT Rally 2.0\hardwaresettings`

2. Locate a file called "hardware_settings_config"

3. Make a backup of this file (just in case).

4. Open the file in a text editor (like notepad).

5. Locate the following line:



   ``

6. Update "enabled" to "true".

7. Update "extradata" to "3"

8. Your new line of code should look like this:



   ``

9. Save the file and start the game.



### BeamNG Drive



BeamNG Drive can export telemetry via OutGauge protocol. It should be enabled

in _Options_ -> _Other_ -> _Utilities_ -> _OutGauge support_. Use default

values (IP `127.0.0.1` and port `44444`).