Giter VIP home page Giter VIP logo

trucksim-telemetry-kotlin's Introduction

TruckSim-Telemetry-Kotlin

CodeFactor GitHub repo size GitHub

TruckSim-Telemetry-Kotlin is a library built in kotlin using flows and coroutines that takes telemetry data for Euro Truck Simulator 2 and American Truck Simulator provided by the scs-sdk-plugin and outputs parsed data and events.

This Kotlin module is based on and inspired by the Js library TruckSim-Telemetry by kniffen

Documentation

See in https://figonzal1.github.io/TruckSim-Telemetry-Kotlin/

Getting started

Prerequisites

Download and install the ๓ € ๓ € ๓ € ๓ € scs-sdk-plugin by RenCloud

Supported plugin versions

โœ… v1.12.0

Install the ๓ € ๓ € ๓ € ๓ € windows-build-tools

Installing

  • Add it in your root build.gradle at the end of repositories:
allprojects {
    repositories {
        maven { url 'https://jitpack.io' }
    }
}
  • Add the dependency
dependencies {
    implementation 'com.github.figonzal1:TruckSim-Telemetry-Kotlin:tag'
}

How to use it

Example from Main.kt

  • Instantiate ScsTelemetry class
coroutineScope {
    val telemetry = ScsTelemetry()
}
  • Start observing changes (inside of coroutineScope)
//Listen changes every delayTime. Default: 1000ms
...
launch {
    telemetry.watch(delayTime = 2000L)
}
... 
  • Consume data flow (inside of coroutineScope)
...
launch {
    //Collect only one value
    telemetry.telemetryFlow.first {
        println("Telemetry data: $it")
        true
    }

    //Collect infinite values
    telemetry.telemetryFlow.collect {
        println("Telemetry data: $it")
    }
}
...

Telemetry flow return TelemetryData data class

License

This project is licensed under the MIT License - see the LICENSE file for details

trucksim-telemetry-kotlin's People

Contributors

figonzal1 avatar

Stargazers

 avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.