irsdk

README

goirsdk

Go module for iRacing Telemetry API access

Initial Setup

This section is intended to help developers and contributors get a working copy of goirsdk on their end

Clone this repository

git clone https://github.com/mpapenbr/goirsdk
cd goirsdk

Option: Do you own setup

Install golangci-lint from the official website for your OS

Local Development

This section will guide you to setup a fully-functional local copy of goirsdk on your end and teach you how to use it! Make sure you have installed golangci-lint before following this section!

Note: This section relies on the usage of Makefile. If you can't (or don't) use Makefile, you can follow along by running the internal commands from goirsdk's Makefile (most of which are OS-independent)!

Installing dependencies

To install all dependencies associated with goirsdk, run the command

make install

Using Code Formatters

Code formatters format your code to match pre-decided conventions. To run automated code formatters, use the Makefile command

make codestyle

Using Code Linters

Linters are tools that analyze source code for possible errors. This includes typos, code formatting, syntax errors, calls to deprecated functions, potential security vulnerabilities, and more!

To run pre-configured linters, use the command

make lint

Additional Resources

Makefile help

Tap for a list of Makefile commands

Command	Description	Prerequisites
help	Generate help dialog listing all Makefile commands with description	NA

| install | Fetch project dependencies | NA | | codestyle | Run code-formatters | golangci-lint | | lint | Check codestyle and run linters | golangci-lint |

Optionally, to see a list of all Makefile commands, and a short description of what they do, you can simply run

make

Which is equivalent to;

make help

Both of which will list out all Makefile commands available, and a short description of what they do!

Releases

You can check out a list of previous releases on the Github Releases page.

Semantic versioning with Release Drafter

What is Semantic Versioning?

Semantic versioning is a versioning scheme aimed at making software management easier. Following semantic versioning, version identifiers are divided into three parts;

    <major>.<minor>.<patch>

MAJOR version when you make incompatible API changes [breaking changes]
MINOR version when you add functionality in a backwards compatible manner [more features]
PATCH version when you make backwards compatible bug fixes [bug fixes and stuff]

For a more detailed description, head over to semver.org

Release Drafter automatically updates the release version as pull requests are merged.

Labels allowed;

• major: Affects the <major> version number for semantic versioning
• minor, enhancement, update, feature: Affects the <minor> version number for semantic versioning
• all other labels affect the <patch> version number

Whenever a pull request with one of these labels is merged to the master branch, the corresponding version number will be bumped by one digit!

List of Labels

Pull requests once merged, will be classified into categories by release-drafter based on pull request labels

This is managed by the release-drafter.yml config file.

Label	Title in Releases
security	🔒 Security
enhancement, feature, update	🚀 Updates
bug, bugfix, fix	🐛 Bug Fixes
documentation, docs	📝 Documentation
wip, in-progress, incomplete, partial, hotfix	🚧 Work in Progress
dependencies, dependency	📦 Dependencies
refactoring, refactor, tests, testing	🧪 Tests and Refactor
build, ci, pipeline	🤖 CI/CD and Pipelines

The labels bug, enhancement, and documentation are automatically created by Github for repositories. Dependabot will implicitly create the dependencies label with the first pull request raised by it.

The remaining labels can be created as needed!

Credits

goirsdk is powered by a template generated using cookiecutter-go which is based on go-template

Documentation

Index

• Constants
• Variables
• func CheckIfSimIsRunning() bool
• type ApiConfig
• type Header
• type Irsdk
  • func NewIrsdk() *Irsdk
  • func NewIrsdkWithConfig(config ApiConfig) *Irsdk
  • func NewIrsdkWithFile(f *os.File) *Irsdk
  • func (irsdk *Irsdk) Close()
  • func (irsdk *Irsdk) DumpHeaders()
  • func (irsdk *Irsdk) GetData() bool
  • func (irsdk *Irsdk) GetValue(name string) (any, error)
  • func (irsdk *Irsdk) GetValueKeys() []string
  • func (irsdk *Irsdk) GetYaml() (*yaml.IrsdkYaml, error)
  • func (irsdk *Irsdk) GetYamlString() string
  • func (irsdk *Irsdk) WaitForValidData() bool
  • func (irsdk *Irsdk) WriteDump(w io.Writer) (int, error)
• type MMap
• type VarBuffer
• type VarHeader
• type VarType

Constants

const (
	SimStatusUrl       = "http://127.0.0.1:32034/get_sim_status?object=simStatus"
	DataValidEventName = "Local\\IRSDKDataValidEvent"
)

const (
	MemMapFileSize = 1164 * 1024
	MemMapFile     = "Local\\IRSDKMemMapFileName"

	IrsdkMaxBufs   = 3
	IrsdkMaxString = 32
	IrsdkMaxDesc   = 64
)

Variables

var ErrInvalidDataRequest = errors.New("Invalid data request")

Functions

func CheckIfSimIsRunning

func CheckIfSimIsRunning() bool

Types

type ApiConfig

type ApiConfig struct {
	WaitForSimTimeout int
}

type Header

type Header struct {
	Version           int32
	Status            int32
	TickRate          int32
	SessionInfoUpdate int32
	SessionInfoLen    int32
	SessionInfoOffset int32
	NumVars           int32
	VarOffsetHeader   int32
	NumBuf            int32
	BufLen            int32
	Pad               [2]int32
	VarBufs           [IrsdkMaxBufs]VarBuffer
}

type Irsdk

type Irsdk struct {
	SimIsRunning bool
	// contains filtered or unexported fields
}

func NewIrsdk

func NewIrsdk() *Irsdk

func NewIrsdkWithConfig

func NewIrsdkWithConfig(config ApiConfig) *Irsdk

func NewIrsdkWithFile

func NewIrsdkWithFile(f *os.File) *Irsdk

func (*Irsdk) Close

func (irsdk *Irsdk) Close()

func (*Irsdk) DumpHeaders

func (irsdk *Irsdk) DumpHeaders()

func (*Irsdk) GetData

func (irsdk *Irsdk) GetData() bool

returns true if new valid data is copied from iRacing telemetry to this Irdsk struct

func (*Irsdk) GetValue

func (irsdk *Irsdk) GetValue(name string) (any, error)

func (*Irsdk) GetValueKeys

func (irsdk *Irsdk) GetValueKeys() []string

func (*Irsdk) GetYaml

func (irsdk *Irsdk) GetYaml() (*yaml.IrsdkYaml, error)

func (*Irsdk) GetYamlString

func (irsdk *Irsdk) GetYamlString() string

func (*Irsdk) WaitForValidData

func (irsdk *Irsdk) WaitForValidData() bool

func (*Irsdk) WriteDump

func (irsdk *Irsdk) WriteDump(w io.Writer) (int, error)

type MMap

type MMap []byte

type VarBuffer

type VarBuffer struct {
	TickCount int32
	BufOffset int32
	Pad       [2]int32
}

type VarHeader

type VarHeader struct {
	Type        VarType
	Offset      int32
	Count       int32
	CountAsTime bool
	Pad         [3]byte
	Name        [IrsdkMaxString]byte
	Desc        [IrsdkMaxDesc]byte
	Unit        [IrsdkMaxString]byte
}

type VarType

type VarType int32