TruckSim Telemetry

https://kniffen.dev/TruckSim-Telemetry
Admin
TruckSim Telemetry provides real-time telemetry data and event-driven notifications for Euro Truck...
Tokens:13,638
Snippets:242
Trust Score:6.2
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install trucksim-telemetry via NPM

Source: https://kniffen.dev/TruckSim-Telemetry/index.html

Install the package using NPM. Ensure Node.js and C++ build tools are installed, along with the scs-sdk-plugin.

```bash
npm install trucksim-telemetry
Copy
```

--------------------------------

### Get Telemetry Buffer with Default and Custom Config

Source: https://kniffen.dev/TruckSim-Telemetry/functions/main.getBuffer.html

Demonstrates how to get the telemetry buffer using default settings and with a custom configuration specifying a shared memory name.

```typescript
import { getBuffer } from 'trucksim-telemetry';

const buffer = getBuffer();
const bufferWithCustomConfig = getBuffer({ sharedMemoryName: '/CustomTelemetry' });
```

--------------------------------

### Initialize and listen for telemetry events

Source: https://kniffen.dev/TruckSim-Telemetry/index.html

Initialize the telemetry client and subscribe to 'connected' and 'job-started' events. This example demonstrates basic event handling for telemetry data.

```javascript
import { truckSimTelemetry } from 'trucksim-telemetry';  
  
const telemetry = truckSimTelemetry();  
  
telemetry.on('connected', () => {  
  console.log('SDK connected');  
});  
  
telemetry.on('job-started', (data) => {  
  console.log('New job started', data);  
});
Copy
```

--------------------------------

### Get Raw Buffer

Source: https://kniffen.dev/TruckSim-Telemetry/documents/Quick_start.html

The `getBuffer` function returns the raw shared memory buffer. This is useful if you want to process the data yourself.

```APIDOC
## Get raw buffer
The `getBuffer` function returns the raw shared memory buffer. This is useful if you want to process the data yourself.
```javascript
import { getBuffer } from 'trucksim-telemetry';

const buffer = getBuffer();
```
```

--------------------------------

### Get Telemetry Data

Source: https://kniffen.dev/TruckSim-Telemetry/documents/Quick_start.html

The `getData` function returns the latest telemetry data as a structured object. This is useful for when you only need to get the data once.

```APIDOC
## Get data
The `getData` function returns the latest telemetry data as a structured object. This is useful for when you only need to get the data once.
```javascript
import { getData } from 'trucksim-telemetry';

const data = getData();
```
```

--------------------------------

### TSTJobStartedEvent Interface

Source: https://kniffen.dev/TruckSim-Telemetry/interfaces/main.TSTJobStartedEvent.html

The TSTJobStartedEvent interface defines the structure of data emitted when a job starts. It includes details about the cargo, source and destination cities and companies, job income, distance, and delivery time.

```APIDOC
## Interface TSTJobStartedEvent
interface TSTJobStartedEvent {
  cargo: string;
  cargoId: string;
  cargoMass: number;
  cityDst: string;
  cityDstId: string;
  citySrc: string;
  citySrcId: string;
  compDst: string;
  compDstId: string;
  compSrc: string;
  compSrcId: string;
  jobIncome: bigint;
  jobMarket: string;
  jobStartingTime: number;
  plannedDistanceKm: number;
  specialJob: boolean;
  timeAbsDelivery: number;
  unitCount: number;
  unitMass: number;
}

### Properties

*   **cargo** (string) - Cargo display name
*   **cargoId** (string) - Cargo id
*   **cargoMass** (number) - Mass of the cargo in kilograms
*   **cityDst** (string) - Destination city display name
*   **cityDstId** (string) - Destination city id
*   **citySrc** (string) - Source city display name
*   **citySrcId** (string) - Source city id
*   **compDst** (string) - Destination company display name
*   **compDstId** (string) - Destination company id
*   **compSrc** (string) - Source company display name
*   **compSrcId** (string) - Source company id
*   **jobIncome** (bigint) - Job estimated income amount in the game's native currency (ATS=USD, ETS2=Euro)
*   **jobMarket** (string) - The job market the current job is from
*   **jobStartingTime** (number) - Time the job started (in in-game minutes)
*   **plannedDistanceKm** (number) - Navigation planned distance in km
*   **specialJob** (boolean) - Indicates if the current job is a special transport
*   **timeAbsDelivery** (number) - Absolute in-game time of end of job delivery window
*   **unitCount** (number) - How many units of the cargo the job consist of
*   **unitMass** (number) - Mass of the single unit of the cargo in kilograms
```

--------------------------------

### Get Raw Telemetry Buffer

Source: https://kniffen.dev/TruckSim-Telemetry/documents/Quick_start.html

Use `getBuffer` to access the raw shared memory buffer. Suitable for custom data processing.

```javascript
import { getBuffer } from 'trucksim-telemetry';

const buffer = getBuffer();
```

--------------------------------

### Get Latest Telemetry Data

Source: https://kniffen.dev/TruckSim-Telemetry/documents/Quick_start.html

Use `getData` to retrieve the most recent telemetry information as a structured object. Ideal for single data fetches.

```javascript
import { getData } from 'trucksim-telemetry';

const data = getData();
```

--------------------------------

### getBuffer

Source: https://kniffen.dev/TruckSim-Telemetry/functions/main.getBuffer.html

Gets the shared memory buffer for telemetry data. Accepts an optional configuration object to specify a custom shared memory name.

```APIDOC
## getBuffer

### Description
Gets the shared memory buffer for telemetry data.

### Method Signature
getBuffer(config?: TSTConfig): Buffer<ArrayBufferLike> | null

### Parameters
#### config (TSTConfig) - Optional
Configuration object for the telemetry buffer. If not provided, default settings are used.

### Returns
Buffer<ArrayBufferLike> | null - The telemetry data buffer or null if it cannot be accessed.

### Example
```javascript
import { getBuffer } from 'trucksim-telemetry';

// Get buffer with default configuration
const buffer = getBuffer();

// Get buffer with a custom shared memory name
const bufferWithCustomConfig = getBuffer({ sharedMemoryName: '/CustomTelemetry' });
```
```

--------------------------------

### Event Emitter

Source: https://kniffen.dev/TruckSim-Telemetry/documents/Quick_start.html

The `truckSimTelemetry` function returns an event emitter that emits various events, such as when a job is started, or when the SDK is connected. See the Events page for a list of all possible events.

```APIDOC
## Events
The `truckSimTelemetry` function returns an event emitter that emits various events, such as when a job is started, or when the SDK is connected. See the Events page for a list of all possible events.
```javascript
import { truckSimTelemetry } from 'trucksim-telemetry';

const telemetry = truckSimTelemetry();

telemetry.on('connected', () => {
  console.log('SDK connected');
});

telemetry.on('job-started', (data) => {
  console.log('New job started', data);
});
```
```

--------------------------------

### Get TruckSim Telemetry Data

Source: https://kniffen.dev/TruckSim-Telemetry/functions/main.getData.html

Call getData with no arguments to use default shared memory. Provide a TSTConfig object to specify a custom shared memory name.

```typescript
import { getData } from 'trucksim-telemetry';

const data = getData();
const dataWithCustomConfig = getData({ sharedMemoryName: '/CustomTelemetry' });
```

--------------------------------

### TSTOptions Interface

Source: https://kniffen.dev/TruckSim-Telemetry/interfaces/main.TSTOptions.html

Defines optional properties for configuring TruckSim telemetry. This includes an optional callback function to receive telemetry updates and an optional string for the shared memory name.

```APIDOC
## Interface TSTOptions

### Description
An interface for optional TruckSim telemetry settings.

### Properties

#### `Optional` onUpdate
- **Type**: `(data: SCSSDKTelemetry) => void`
- **Description**: A callback function that is invoked when telemetry data is updated. It receives the telemetry data as an argument.

#### `Optional` sharedMemoryName
- **Type**: `string`
- **Description**: The name or path of the shared memory segment to be used for telemetry data.
```

--------------------------------

### Handle Telemetry Events

Source: https://kniffen.dev/TruckSim-Telemetry/documents/Quick_start.html

Initialize an event emitter using `truckSimTelemetry` to listen for SDK events like 'connected' and 'job-started'. Refer to the Events page for a full list.

```javascript
import { truckSimTelemetry } from 'trucksim-telemetry';

const telemetry = truckSimTelemetry();

telemetry.on('connected', () => {
  console.log('SDK connected');
});

telemetry.on('job-started', (data) => {
  console.log('New job started', data);
});
```

--------------------------------

### Use Telemetry as an Update Loop

Source: https://kniffen.dev/TruckSim-Telemetry/documents/Quick_start.html

Configure `truckSimTelemetry` with an `onUpdate` callback to receive data updates approximately 60 times per second.

```javascript
import { truckSimTelemetry } from 'trucksim-telemetry';

const telemetry = truckSimTelemetry({
  onUpdate: (data) => {
    // Process data
  }
});
```

--------------------------------

### Importing getData in TruckSim Telemetry

Source: https://kniffen.dev/TruckSim-Telemetry/documents/Migrating_to_1.0.html

Update import statements from 'trucksim-telemetry' to use named imports for getData.

```javascript
- const tst = require('trucksim-telemetry');
+ import { getData } from 'trucksim-telemetry';
```

```javascript
- const data = tst.getData();
+ const data = getData();
```

--------------------------------

### Update Loop

Source: https://kniffen.dev/TruckSim-Telemetry/documents/Quick_start.html

You can also use the `truckSimTelemetry` function as an update loop. The `onUpdate` callback function will be called on each update (60 times per second).

```APIDOC
## Update loop
You can also use the `truckSimTelemetry` function as an update loop. The `onUpdate` callback function will be called on each update (60 times per second).
```javascript
import { truckSimTelemetry } from 'trucksim-telemetry';

const telemetry = truckSimTelemetry({
  onUpdate: (data) => {
    // Process data
  }
});
```
```

--------------------------------

### SCSSDKTrailerTelemetry Interface Properties

Source: https://kniffen.dev/TruckSim-Telemetry/interfaces/main.SCSSDKTrailerTelemetry.html

The SCSSDKTrailerTelemetry interface exposes numerous properties that provide detailed telemetry information about a trailer. These include physical properties like position, velocity, acceleration, and rotation, as well as specific trailer attributes such as its body type, brand, license plate, and cargo details. It also includes extensive data about the trailer's wheels, such as their lift status, position, and rotation.

```APIDOC
## Interface SCSSDKTrailerTelemetry

### Description
Provides access to telemetry data for a trailer.

### Properties
- **angularAccelerationX** (number): Angular acceleration around the X-axis.
- **angularAccelerationY** (number): Angular acceleration around the Y-axis.
- **angularAccelerationZ** (number): Angular acceleration around the Z-axis.
- **angularVelocityX** (number): Angular velocity around the X-axis.
- **angularVelocityY** (number): Angular velocity around the Y-axis.
- **angularVelocityZ** (number): Angular velocity around the Z-axis.
- **attached** (boolean): Indicates if the trailer is attached.
- **bodyType** (string): The type of the trailer body.
- **brand** (string): The brand of the trailer.
- **brandId** (string): The ID of the trailer brand.
- **cargoAcessoryId** (string): The accessory ID of the cargo.
- **cargoDamage** (number): The damage level of the cargo.
- **chainType** (string): The type of the trailer chain.
- **hookPositionX** (number): The X-coordinate of the trailer hook position.
- **hookPositionY** (number): The Y-coordinate of the trailer hook position.
- **hookPositionZ** (number): The Z-coordinate of the trailer hook position.
- **id** (string): The unique identifier of the trailer.
- **licensePlate** (string): The license plate of the trailer.
- **licensePlateCountry** (string): The country of the trailer's license plate.
- **licensePlateCountryId** (string): The ID of the trailer's license plate country.
- **linearAccelerationX** (number): Linear acceleration along the X-axis.
- **linearAccelerationY** (number): Linear acceleration along the Y-axis.
- **linearAccelerationZ** (number): Linear acceleration along the Z-axis.
- **linearVelocityX** (number): Linear velocity along the X-axis.
- **linearVelocityY** (number): Linear velocity along the Y-axis.
- **linearVelocityZ** (number): Linear velocity along the Z-axis.
- **name** (string): The name of the trailer.
- **rotationX** (number): Rotation around the X-axis.
- **rotationY** (number): Rotation around the Y-axis.
- **rotationZ** (number): Rotation around the Z-axis.
- **wearBody** (number): The wear level of the trailer body.
- **wearChassis** (number): The wear level of the trailer chassis.
- **wearWheels** (number): The wear level of the trailer wheels.
- **wheelCount** (number): The number of wheels on the trailer.
- **wheelLift** (number[]): An array indicating the lift status of each wheel.
- **wheelLiftable** (boolean[]): An array indicating if each wheel is liftable.
- **wheelLiftOffset** (number[]): An array of offsets for wheel lift.
- **wheelOnGround** (boolean[]): An array indicating if each wheel is on the ground.
- **wheelPositionX** (number[]): An array of X-coordinates for each wheel's position.
- **wheelPositionY** (number[]): An array of Y-coordinates for each wheel's position.
- **wheelPositionZ** (number[]): An array of Z-coordinates for each wheel's position.
- **wheelPowered** (boolean[]): An array indicating if each wheel is powered.
- **wheelRadius** (number[]): An array of radii for each wheel.
- **wheelRotation** (number[]): An array of rotation values for each wheel.
- **wheelSimulated** (boolean[]): An array indicating if each wheel is simulated.
- **wheelSteerable** (boolean[]): An array indicating if each wheel is steerable.
- **wheelSteering** (number[]): An array of steering values for each wheel.
- **wheelSubstance** (number[]): An array of substance values for each wheel.
- **wheelSuspDeflection** (number[]): An array of suspension deflection values for each wheel.
- **wheelVelocity** (number[]): An array of velocity values for each wheel.
- **worldX** (number): The world X-coordinate of the trailer.
- **worldY** (number): The world Y-coordinate of the trailer.
- **worldZ** (number): The world Z-coordinate of the trailer.
```

--------------------------------

### truckSimTelemetry

Source: https://kniffen.dev/TruckSim-Telemetry/functions/main.truckSimTelemetry.html

Creates an event listener that emits telemetry events. It can optionally be configured with TSTOptions.

```APIDOC
## truckSimTelemetry(opts?: TSTOptions): TruckSimTelemetry

### Description
Creates an event listener that emits telemetry events.

### Parameters
#### Optional Parameters
- **opts** (TSTOptions) - Optional - Configuration options for the telemetry listener.

### Returns
- **TruckSimTelemetry** - An object that emits telemetry events.

### Example
```javascript
import { truckSimTelemetry } from 'trucksim-telemetry';

const telemetry = truckSimTelemetry();

telemetry.on('connected', () => {
  console.log('SDK connected');
});
```
```

--------------------------------

### Format In-Game Time

Source: https://kniffen.dev/TruckSim-Telemetry/documents/Units.html

Use this snippet to format the `timeAbs` property into a human-readable day, hour, and minute format. Ensure `timeAbs` is retrieved using `getData()`.

```javascript
const { timeAbs } = getData();

const day   = Math.floor(timeAbs / (60 * 24));
const hours = Math.floor(timeAbs / 60) % 24;
const min   = timeAbs % 60;

console.log(`Day ${day} at ${hours.toString().padStart(2, '0')}:${min.toString().padStart(2, '0')}`); // Day 5 at 12:00
```

--------------------------------

### Updating Event Handling in TruckSim Telemetry

Source: https://kniffen.dev/TruckSim-Telemetry/documents/Migrating_to_1.0.html

Change event listeners from telemetry.game.on to telemetry.on for game connection and disconnection events.

```javascript
- const tst = require('trucksim-telemetry');
+ import { truckSimTelemetry } from 'trucksim-telemetry';
```

```javascript
- const telemetry = tst();
- telemetry.watch();
- telemetry.game.on("connected", console.log);
- telemetry.game.on("disconnected", console.log);
+ const telemetry = truckSimTelemetry();
+ telemetry.on("connected", console.log);
+ telemetry.on("disconnected", console.log);
```

--------------------------------

### Create TruckSim Telemetry Listener

Source: https://kniffen.dev/TruckSim-Telemetry/functions/main.truckSimTelemetry.html

Use this function to create an event listener for telemetry events. It returns an object with an 'on' method to subscribe to events like 'connected'.

```typescript
import { truckSimTelemetry } from 'trucksim-telemetry';

const telemetry = truckSimTelemetry();

telemetry.on('connected', () => {
  console.log('SDK connected');
});
```

--------------------------------

### Updating the Update Loop in TruckSim Telemetry

Source: https://kniffen.dev/TruckSim-Telemetry/documents/Migrating_to_1.0.html

Modify the initialization of the telemetry object to use truckSimTelemetry and provide an onUpdate callback.

```javascript
- const tst = require('trucksim-telemetry');
+ import { truckSimTelemetry } from 'trucksim-telemetry';
```

```javascript
- const telemetry = tst();
- telemetry.watch({}, (data) => { console.log(data) });
+ const telemetry = truckSimTelemetry({
+   onUpdate: (data) => { console.log(data) }
+ });
```

--------------------------------

### getData

Source: https://kniffen.dev/TruckSim-Telemetry/functions/main.getData.html

Retrieves telemetry data from TruckSim. It can optionally accept a configuration object to specify a custom shared memory name.

```APIDOC
## getData

### Description
Gets the telemetry data. Allows for optional configuration to specify a custom shared memory name.

### Method
Function Call

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### config (TSTConfig)
Optional - Configuration object for telemetry. Defaults to a standard shared memory name.

### Returns SCSSDKTelemetry | null
Returns the telemetry data object if available, otherwise null.

### Example
```javascript
import { getData } from 'trucksim-telemetry';

// Get data with default configuration
const data = getData();

// Get data with a custom shared memory name
const dataWithCustomConfig = getData({ sharedMemoryName: '/CustomTelemetry' });
```
```

--------------------------------

### TSTOilPressureWarningEvent Interface Definition

Source: https://kniffen.dev/TruckSim-Telemetry/interfaces/main.TSTOilPressureWarningEvent.html

Defines the structure for oil pressure warning events, including oil pressure, warning status, warning factor, and oil temperature.

```APIDOC
## Interface TSTOilPressureWarningEvent
interface TSTOilPressureWarningEvent {
  oilPressure: number;
  oilPressureWarning: boolean;
  oilPressureWarningFactor: number;
  oilTemperature: number;
}

### Properties

#### oilPressure

- **Type**: number
- **Description**: Pressure of the oil in psi

#### oilPressureWarning

- **Type**: boolean
- **Description**: Indicates if the oil pressure warning is active

#### oilPressureWarningFactor

- **Type**: number
- **Description**: Pressure of the oil below which the warning activates

#### oilTemperature

- **Type**: number
- **Description**: Temperature of the oil in degrees celsius
```

--------------------------------

### TSTJobDeliveredEvent Interface

Source: https://kniffen.dev/TruckSim-Telemetry/interfaces/main.TSTJobDeliveredEvent.html

The TSTJobDeliveredEvent interface provides a comprehensive set of properties that capture all relevant data points when a job is delivered. This includes information about the cargo, origin and destination cities and companies, whether specific features like autoload or autopark were used, damage incurred, delivery time, distance traveled, earned experience, revenue, and job market details.

```APIDOC
## Interface TSTJobDeliveredEvent

### Description
Represents the data structure for an event when a job is delivered.

### Properties

*   **cargo** (string) - Cargo display name.
*   **cargoId** (string) - Cargo id.
*   **cargoMass** (number) - Mass of the cargo in kilograms.
*   **cityDst** (string) - Destination city display name.
*   **cityDstId** (string) - Destination city id.
*   **citySrc** (string) - Source city display name.
*   **citySrcId** (string) - Source city id.
*   **compDst** (string) - Destination company display name.
*   **compDstId** (string) - Destination company id.
*   **compSrc** (string) - Source company display name.
*   **compSrcId** (string) - Source company id.
*   **jobDeliveredAutoloadUsed** (boolean) - Indicates if auto loading was used when delivering a job.
*   **jobDeliveredAutoparkUsed** (boolean) - Indicates if auto parking was used when delivering a job.
*   **jobDeliveredCargoDamage** (number) - Cargo damage when a job is delivered.
*   **jobDeliveredDeliveryTime** (number) - Total time spent on the job (in in-game minutes).
*   **jobDeliveredDistanceKm** (number) - Distance in kilometers used to deliver a job.
*   **jobDeliveredEarnedXp** (number) - XP earned when a job is delivered.
*   **jobDeliveredRevenue** (bigint) - Job delivered revenue amount in the game's native currency.
*   **jobFinishedTime** (number) - Time the job finished (in in-game minutes).
*   **jobMarket** (string) - The job market the current job is from.
*   **jobStartingTime** (number) - Time the job started (in in-game minutes).
*   **plannedDistanceKm** (number) - Navigation planned distance in km.
*   **specialJob** (boolean) - Indicates if the current job is a special transport.
*   **timeAbsDelivery** (number) - Absolute in-game time of the end of the job delivery window.
*   **unitCount** (number) - How many units of the cargo the job consists of.
*   **unitMass** (number) - Mass of a single unit of the cargo in kilograms.
```

--------------------------------

### TSTAirPressureWarningEvent Interface

Source: https://kniffen.dev/TruckSim-Telemetry/interfaces/main.TSTAirPressureWarningEvent.html

The TSTAirPressureWarningEvent interface defines the structure for air pressure warning data. It includes the current air pressure, a flag indicating if a warning is active, and the threshold factor for the warning.

```APIDOC
## Interface TSTAirPressureWarningEvent

### Description
Represents air pressure warning data, including current pressure, warning status, and warning threshold.

### Properties
- **airPressure** (number) - Required - Pressure in the brake air tank in psi.
- **airPressureWarning** (boolean) - Required - Indicates if the air pressure warning is active.
- **airPressureWarningFactor** (number) - Required - Pressure of the air in the tank below which the warning activates.
```

--------------------------------

### TSTAdBlueWarningEvent Interface Properties

Source: https://kniffen.dev/TruckSim-Telemetry/interfaces/main.TSTAdBlueWarningEvent.html

This snippet outlines the properties available within the TSTAdBlueWarningEvent interface, detailing the AdBlue level, capacity, warning status, and warning factor.

```APIDOC
## Interface TSTAdBlueWarningEvent

### Description
Provides information about the AdBlue system, including its current level, capacity, and warning status.

### Properties

*   **adblue** (number) - Amount of AdBlue in liters.
*   **adblueCapacity** (number) - AdBlue tank capacity in litres.
*   **adblueWarning** (boolean) - Indicates if the adblue warning is active.
*   **adblueWarningFactor** (number) - Fraction of the adblue capacity below which the adblue warning is activated.
```

--------------------------------

### TSTWaterTempWarningEvent Interface Definition

Source: https://kniffen.dev/TruckSim-Telemetry/interfaces/main.TSTWaterTempWarningEvent.html

Defines the structure of the TSTWaterTempWarningEvent, which provides telemetry data related to water temperature warnings.

```APIDOC
## Interface TSTWaterTempWarningEvent

### Description
Represents telemetry data for water temperature warnings.

### Properties
- **waterTemperature** (number) - The current temperature of the water in degrees Celsius.
- **waterTemperatureWarning** (boolean) - Indicates if the water temperature warning is currently active.
- **waterTemperatureWarningFactor** (number) - The temperature threshold above which the water temperature warning activates.
```

--------------------------------

### TSTGearChangeEvent Interface

Source: https://kniffen.dev/TruckSim-Telemetry/interfaces/main.TSTGearChangeEvent.html

This interface defines the properties available for truck gear telemetry events.

```APIDOC
## Interface TSTGearChangeEvent

### Description
Represents a telemetry event related to the truck's gear.

### Properties
- **gear** (number) - The gear selected in the transmission.
- **gearDashboard** (number) - The gear displayed on the dashboard.
```

--------------------------------

### TSTAirPressureEmergencyEvent Interface

Source: https://kniffen.dev/TruckSim-Telemetry/interfaces/main.TSTAirPressureEmergencyEvent.html

The TSTAirPressureEmergencyEvent interface defines properties related to air pressure and emergency brake status.

```APIDOC
## Interface TSTAirPressureEmergencyEvent

### Description
This interface provides information about the vehicle's air pressure system, including the current pressure, whether emergency brakes are active due to low pressure, and the threshold at which emergency braking is triggered.

### Properties

*   **airPressure** (number) - The current pressure in the brake air tank in psi.
*   **airPressureEmergency** (boolean) - Indicates if the emergency brakes are active as a result of low air pressure.
*   **airPressureEmergencyFactor** (number) - The pressure threshold in the air tank below which the emergency brakes will activate.
```

--------------------------------

### TSTRefuelEvent Interface

Source: https://kniffen.dev/TruckSim-Telemetry/interfaces/main.TSTRefuelEvent.html

The TSTRefuelEvent interface provides key metrics related to the truck's fuel system.

```APIDOC
## Interface TSTRefuelEvent

### Description
Represents fuel-related telemetry data for a truck.

### Properties

*   **fuel** (number) - The current amount of fuel in liters.
*   **fuelAvgConsumption** (number) - The average fuel consumption in liters per kilometer.
*   **fuelCapacity** (number) - The total fuel tank capacity in liters.
*   **fuelRange** (number) - The estimated remaining range of the truck in kilometers.
```

--------------------------------

### TSTFerryEvent Interface Properties

Source: https://kniffen.dev/TruckSim-Telemetry/interfaces/main.TSTFerryEvent.html

This snippet details the properties available within the TSTFerryEvent interface.

```APIDOC
## Interface TSTFerryEvent

### Description
Represents an event related to a ferry transportation, including details about the source, target, and payment.

### Properties

*   **ferryPayAmount** (bigint) - Ferry pay amount in the game's native currency (ATS=USD, ETS2=Euro).
*   **ferrySourceId** (string) - The id of the transportation source.
*   **ferrySourceName** (string) - The name of the transportation source.
*   **ferryTargetId** (string) - The id of the transportation target.
*   **ferryTargetName** (string) - The name of the transportation target.

### Hierarchy
  * Pick<
SCSSDKTelemetry,
| "ferrySourceId"
| "ferrySourceName"
| "ferryTargetId"
| "ferryTargetName"
| "ferryPayAmount",
>
    * TSTFerryEvent
```

--------------------------------

### Updating Function Imports in TruckSim Telemetry

Source: https://kniffen.dev/TruckSim-Telemetry/documents/Migrating_to_1.0.html

Update import statements to use named imports for getBuffer and getData, and remove unused function imports.

```javascript
- const tst = require('trucksim-telemetry');
+ import { getBuffer, getData } from 'trucksim-telemetry';
```

```javascript
- const buffer     = tst.getBuffer();
- const data       = tst.getData();
- const game       = tst.getGame();
- const controls   = tst.getControls();
- const truck      = tst.getTruck();
- const trailers   = tst.getTrailers();
- const trailer    = tst.getTrailer();
- const job        = tst.getJob();
- const navigation = tst.getNavigation();
+ const buffer     = getBuffer();
+ const data       = getData();
```

--------------------------------

### TSTRetarderEvent

Source: https://kniffen.dev/TruckSim-Telemetry/interfaces/main.TSTRetarderEvent.html

Represents the retarder event data, including the current brake level and the number of retarder steps.

```APIDOC
## Interface TSTRetarderEvent

### Description
Represents the retarder event data, including the current brake level and the number of retarder steps.

### Properties

* **retarderBrake** (number) - The current level of the retarder.
* **retarderStepCount** (number) - The number of steps in the retarder.
```

--------------------------------

### TSTTrainEvent Interface

Source: https://kniffen.dev/TruckSim-Telemetry/interfaces/main.TSTTrainEvent.html

The TSTTrainEvent interface defines the structure for train-related telemetry events, including source, target, and payment information.

```APIDOC
## Interface TSTTrainEvent

interface TSTTrainEvent {
  trainPayAmount: bigint;
  trainSourceId: string;
  trainSourceName: string;
  trainTargetId: string;
  trainTargetName: string;
}

### Properties

#### trainPayAmount

- **Type**: bigint
- **Description**: Train pay amount in the game's native currency (ATS=USD, ETS2=Euro)

#### trainSourceId

- **Type**: string
- **Description**: The id of the transportation source

#### trainSourceName

- **Type**: string
- **Description**: The name of the transportation source

#### trainTargetId

- **Type**: string
- **Description**: The id of the transportation source

#### trainTargetName

- **Type**: string
- **Description**: The name of the transportation target
```

--------------------------------

### TSTJobCancelledEvent Interface

Source: https://kniffen.dev/TruckSim-Telemetry/interfaces/main.TSTJobCancelledEvent.html

This interface defines the structure of the TSTJobCancelledEvent, providing details about a cancelled job.

```APIDOC
## Interface TSTJobCancelledEvent

This interface represents the data associated with a job cancellation event.

### Properties

*   **cargo** (string) - Cargo display name.
*   **cargoId** (string) - Cargo id.
*   **cargoMass** (number) - Mass of the cargo in kilograms.
*   **cityDst** (string) - Destination city display name.
*   **cityDstId** (string) - Destination city id.
*   **citySrc** (string) - Source city display name.
*   **citySrcId** (string) - Source city id.
*   **compDst** (string) - Destination company display name.
*   **compDstId** (string) - Destination company id.
*   **compSrc** (string) - Source company display name.
*   **compSrcId** (string) - Source company id.
*   **jobCancelledPenalty** (bigint) - Job cancellation penalty amount in the game's native currency (ATS=USD, ETS2=Euro).
*   **jobMarket** (string) - The job market the current job is from.
*   **jobStartingTime** (number) - Time the job started (in in-game minutes).
*   **plannedDistanceKm** (number) - Navigation planned distance in km.
*   **specialJob** (boolean) - Indicates if the current job is a special transport.
*   **unitCount** (number) - How many units of the cargo the job consist of.
*   **unitMass** (number) - Mass of the single unit of the cargo in kilograms.
```

--------------------------------

### TSTBatteryVoltageWarningEvent Interface

Source: https://kniffen.dev/TruckSim-Telemetry/interfaces/main.TSTBatteryVoltageWarningEvent.html

The TSTBatteryVoltageWarningEvent interface defines properties related to the battery voltage warning system.

```APIDOC
## Interface TSTBatteryVoltageWarningEvent

### Description
This interface provides details about the battery voltage, including whether a warning is active and the factor that triggers the warning.

### Properties

#### batteryVoltage
- **Type**: number
- **Description**: Voltage of the battery in volts.

#### batteryVoltageWarning
- **Type**: boolean
- **Description**: Indicates if the battery voltage warning is active.

#### batteryVoltageWarningFactor
- **Type**: number
- **Description**: Voltage of the battery below which the warning activates.
```

--------------------------------

### TSTFuelWarningEvent Interface

Source: https://kniffen.dev/TruckSim-Telemetry/interfaces/main.TSTFuelWarningEvent.html

The TSTFuelWarningEvent interface exposes properties related to the truck's fuel status, including current fuel level, average consumption, tank capacity, estimated range, and a boolean flag indicating if the fuel warning is active.

```APIDOC
## Interface TSTFuelWarningEvent

### Description
Provides detailed information about the truck's fuel status.

### Properties

*   **fuel** (number) - Amount of fuel in liters.
*   **fuelAvgConsumption** (number) - Average consumption of the fuel in liters/km.
*   **fuelCapacity** (number) - Fuel tank capacity in litres.
*   **fuelRange** (number) - Estimated range of truck with current amount of fuel in km.
*   **fuelWarning** (boolean) - Indicates if the fuel warning is active.
*   **fuelWarningFactor** (number) - Fraction of the fuel capacity below which the fuel warning is activated.
```

--------------------------------

### TSTCruiseControlEvent Interface

Source: https://kniffen.dev/TruckSim-Telemetry/interfaces/main.TSTCruiseControlEvent.html

The TSTCruiseControlEvent interface exposes properties related to the cruise control system.

```APIDOC
## Interface TSTCruiseControlEvent

### Description
Represents the cruise control state and speed settings.

### Properties

#### cruiseControl
- **Type**: boolean
- **Description**: Indicates if the cruise control is enabled.

#### cruiseControlSpeed
- **Type**: number
- **Description**: Speed selected for the cruise control in m/s.
```
Tokens:
Raw