# F1 Telemetry Data Collector
This Python application uses InfluxDB to collect telemetry data from the
official F1 game.
<p align="center">
<img src="art/telemetry-demo.gif"/>
</p>
It is also possible to display live session and car data.
<p align="center">
<img src="art/live-data.png"/>
</p>
## Installation
The application requires Python >= 3.8 to work.
~~~
pip install pipx
pipx install f1-telemetry
~~~
## Usage
Ensure that InfluxDB is running with at least an Org and an access token, and
configured with an `f1-telemetry` bucket.
~~~
f1-tel <org> <token>
~~~
This also serves a very basic web application for telemetry and live data
visualisations. With InfluxDB still running, navigate to
`http://localhost:20776/index.html` page in the browser with the `org` and
`token` parameters, e.g.
~~~
http://localhost:20776/index.html?org=P403n1x87&token=NLyjW4ml8XuTPTwCbtC5PC1Z-JJ6lwjAm7B1-ScM_XP9N_eoCkIGTmm3wHrC92cQVsMmKofgqbx6PM-ZZgVQKw==
~~~
> **NOTE**: The application can run without InfluxDB. In this case, no telemetry
> data will be stored. If you are using this tool without a running instance of
> InfluxDB, the `<org>` and `<token>` arguments must still be provided, but they
> can be random values, e.g.
> ~~~
> f1-tel no influxdb
> ~~~
## Additional Features
### TT Rival Data
When collecting data from Time Trials and competing against a rival, some of
the rival's car data is also collected, like throttle, brake, speed, and gears,
for comparison.
### Reporting
After sessions like Qualifying and Race, the final classification data can be
collected in CSV reports by passing the `-r`,`--report` option from the command
line. The files are generated in the current working directory. The collected
data can be useful for league coordinators.
Raw data
{
"_id": null,
"home_page": "https://github.com/P403n1x87/f1-telemetry",
"name": "f1-telemetry",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Gabriele N. Tornetta",
"author_email": "phoenix1987@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/d0/a9/027bec50628568ce441ecb08c38366ea23de14b55caa713ac609354091b3/f1_telemetry-2024.1.1.tar.gz",
"platform": null,
"description": "# F1 Telemetry Data Collector\n\nThis Python application uses InfluxDB to collect telemetry data from the\nofficial F1 game.\n\n<p align=\"center\">\n <img src=\"art/telemetry-demo.gif\"/>\n</p>\n\nIt is also possible to display live session and car data.\n\n<p align=\"center\">\n <img src=\"art/live-data.png\"/>\n</p>\n\n\n## Installation\n\nThe application requires Python >= 3.8 to work.\n\n~~~\npip install pipx\npipx install f1-telemetry\n~~~\n\n## Usage\n\nEnsure that InfluxDB is running with at least an Org and an access token, and\nconfigured with an `f1-telemetry` bucket.\n\n~~~\nf1-tel <org> <token>\n~~~\n\nThis also serves a very basic web application for telemetry and live data\nvisualisations. With InfluxDB still running, navigate to\n`http://localhost:20776/index.html` page in the browser with the `org` and\n`token` parameters, e.g.\n\n~~~\nhttp://localhost:20776/index.html?org=P403n1x87&token=NLyjW4ml8XuTPTwCbtC5PC1Z-JJ6lwjAm7B1-ScM_XP9N_eoCkIGTmm3wHrC92cQVsMmKofgqbx6PM-ZZgVQKw==\n~~~\n\n\n> **NOTE**: The application can run without InfluxDB. In this case, no telemetry\n> data will be stored. If you are using this tool without a running instance of\n> InfluxDB, the `<org>` and `<token>` arguments must still be provided, but they\n> can be random values, e.g.\n> ~~~\n> f1-tel no influxdb\n> ~~~\n\n\n## Additional Features\n\n### TT Rival Data\n\nWhen collecting data from Time Trials and competing against a rival, some of\nthe rival's car data is also collected, like throttle, brake, speed, and gears,\nfor comparison.\n\n\n### Reporting\n\nAfter sessions like Qualifying and Race, the final classification data can be\ncollected in CSV reports by passing the `-r`,`--report` option from the command\nline. The files are generated in the current working directory. The collected\ndata can be useful for league coordinators.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "F1 telemetry data collection and visualisation",
"version": "2024.1.1",
"project_urls": {
"Homepage": "https://github.com/P403n1x87/f1-telemetry",
"Repository": "https://github.com/P403n1x87/f1-telemetry",
"issues": "https://github.com/P403n1x87/f1-telemetry/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f55230b13c0798a82fb29c3069215b31b3c06b96e14fb3cab667d29028cdf37e",
"md5": "2c317b6cd1125026d237fa537ca6ab1c",
"sha256": "d1ed12c182c865af4c119e0ea515b12300ad95d3389b526ed69319f93c824c52"
},
"downloads": -1,
"filename": "f1_telemetry-2024.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2c317b6cd1125026d237fa537ca6ab1c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 198896,
"upload_time": "2024-08-23T17:26:48",
"upload_time_iso_8601": "2024-08-23T17:26:48.130813Z",
"url": "https://files.pythonhosted.org/packages/f5/52/30b13c0798a82fb29c3069215b31b3c06b96e14fb3cab667d29028cdf37e/f1_telemetry-2024.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d0a9027bec50628568ce441ecb08c38366ea23de14b55caa713ac609354091b3",
"md5": "729b1d1360a21589925628bf052d662a",
"sha256": "a8546533af891215831c8eb5053fd049969cd4d9f81a8573549d6bb48b1c3ef4"
},
"downloads": -1,
"filename": "f1_telemetry-2024.1.1.tar.gz",
"has_sig": false,
"md5_digest": "729b1d1360a21589925628bf052d662a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 195384,
"upload_time": "2024-08-23T17:26:49",
"upload_time_iso_8601": "2024-08-23T17:26:49.329653Z",
"url": "https://files.pythonhosted.org/packages/d0/a9/027bec50628568ce441ecb08c38366ea23de14b55caa713ac609354091b3/f1_telemetry-2024.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-23 17:26:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "P403n1x87",
"github_project": "f1-telemetry",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "f1-telemetry"
}
JSON
