forked from thisismyrobot/python-iracing-api
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.txt
45 lines (29 loc) · 892 Bytes
/
README.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
iRacing Python API client
=========================
Will build this as I learn how it works as there's no worked Python example.
Description
-----------
Uses memory-mapped files, has slow-updating YAML data and fast (60Hz) updating
telemetry data.
API
---
This file api.py provides read-only access to the iRacing memory mapped file
session and telemetry API.
To get all meta, the api.py has an API of it's own. It's a very simple dict
interface:
api.API()[KEY]
And there's a dict-like .keys() helper:
api.API().keys()
I'll do my best to support this as a minimum, going forward, but I'm hoping to
add more clevers as well of course.
Tests
-----
Run using:
python runtests.py
Benchmarking
------------
To check telemetry read performance on your machine, run:
python benchmark.py
Requires
--------
Python 2.7, PyYAML