
            RbrTelemetryProvider Plugin (Version 1.1) for SFX-100
===============================================================================

This provider plugin for the SFX-100 platform implements the interface to
Richard Burns Rally's Next Generation Physics (NGP) UDP telemetry.
Data is received on port 6776, so you should enable this port in your
operating system's firewall configuration.


Installation
---------------------------------------------------------------------
Prerequisites:
This provider needs Richard Burns Rally with RBR patch 1.02 SSE and
Next Generation Physics (NGP) 6.2 plugin or higher to work.

Extract the entire (!) RbrTelemetryProvider installation archive into your
SFX-100 installation root folder. The archive contains all the required
folders.


Telemetry Values
----------------
Values related to the car's position and motion are given in meters,
meters/second, degrees, degrees/second etc.
Accelerations are measured in G's.
The coordinate system is the one defined by SAE.

The following named telemetry values are supported:

TotalSteps											
Stage.Index											
Stage.Progress										
Stage.RaceTime										
Stage.DriveLineLocation								
Stage.DistanceToEnd									
Control.Steering									
Control.Throttle									
Control.Brake										
Control.Handbrake									
Control.Clutch										
Control.Gear										
Control.FootbrakePressure							
Control.HandbrakePressure							
Car.Index											
Car.Speed											
Car.PositionX										
Car.PositionY										
Car.PositionZ										
Car.Roll											
Car.Pitch								    		
Car.Yaw									    		
Car.Velocities.Surge								
Car.Velocities.Sway									
Car.Velocities.Heave								
Car.Velocities.Roll									
Car.Velocities.Pitch								
Car.Velocities.Yaw									
Car.Accelerations.Surge								
Car.Accelerations.Sway								
Car.Accelerations.Heave								
Car.Accelerations.Roll								
Car.Accelerations.Pitch								
Car.Accelerations.Yaw								
Car.Engine.Rpm										
Car.Engine.RadiatorCoolantTemperature				
Car.Engine.EngineCoolantTemperature					
Car.Engine.EngineTemperature						
Car.SuspensionLF.SpringDeflection					
Car.SuspensionLF.RollbarForce						
Car.SuspensionLF.SpringForce						
Car.SuspensionLF.DamperForce						
Car.SuspensionLF.StrutForce							
Car.SuspensionLF.HelperSpringIsActive				
Car.SuspensionLF.Damper.Damage						
Car.SuspensionLF.Damper.PistonVelocity				
Car.SuspensionLF.Wheel.BrakeDisk.LayerTemperature	
Car.SuspensionLF.Wheel.BrakeDisk.Temperature		
Car.SuspensionLF.Wheel.BrakeDisk.Wear				
Car.SuspensionLF.Wheel.Tire.Pressure				
Car.SuspensionLF.Wheel.Tire.Temperature				
Car.SuspensionLF.Wheel.Tire.CarcassTemperature		
Car.SuspensionLF.Wheel.Tire.TreadTemperature		
Car.SuspensionLF.Wheel.Tire.CurrentSegment			
Car.SuspensionLF.Wheel.Tire.Segment1.Temperature	
Car.SuspensionLF.Wheel.Tire.Segment1.Wear			
Car.SuspensionLF.Wheel.Tire.Segment2.Temperature	
Car.SuspensionLF.Wheel.Tire.Segment2.Wear			
Car.SuspensionLF.Wheel.Tire.Segment3.Temperature	
Car.SuspensionLF.Wheel.Tire.Segment3.Wear			
Car.SuspensionLF.Wheel.Tire.Segment4.Temperature	
Car.SuspensionLF.Wheel.Tire.Segment4.Wear			
Car.SuspensionLF.Wheel.Tire.Segment5.Temperature	
Car.SuspensionLF.Wheel.Tire.Segment5.Wear			
Car.SuspensionLF.Wheel.Tire.Segment6.Temperature	
Car.SuspensionLF.Wheel.Tire.Segment6.Wear			
Car.SuspensionLF.Wheel.Tire.Segment7.Temperature	
Car.SuspensionLF.Wheel.Tire.Segment7.Wear			
Car.SuspensionLF.Wheel.Tire.Segment8.Temperature	
Car.SuspensionLF.Wheel.Tire.Segment8.Wear			
Car.SuspensionRF.SpringDeflection					
Car.SuspensionRF.RollbarForce						
Car.SuspensionRF.SpringForce						
Car.SuspensionRF.DamperForce						
Car.SuspensionRF.StrutForce							
Car.SuspensionRF.HelperSpringIsActive				
Car.SuspensionRF.Damper.Damage						
Car.SuspensionRF.Damper.PistonVelocity				
Car.SuspensionRF.Wheel.BrakeDisk.LayerTemperature	
Car.SuspensionRF.Wheel.BrakeDisk.Temperature		
Car.SuspensionRF.Wheel.BrakeDisk.Wear				
Car.SuspensionRF.Wheel.Tire.Pressure				
Car.SuspensionRF.Wheel.Tire.Temperature				
Car.SuspensionRF.Wheel.Tire.CarcassTemperature		
Car.SuspensionRF.Wheel.Tire.TreadTemperature		
Car.SuspensionRF.Wheel.Tire.CurrentSegment			
Car.SuspensionRF.Wheel.Tire.Segment1.Temperature	
Car.SuspensionRF.Wheel.Tire.Segment1.Wear			
Car.SuspensionRF.Wheel.Tire.Segment2.Temperature	
Car.SuspensionRF.Wheel.Tire.Segment2.Wear			
Car.SuspensionRF.Wheel.Tire.Segment3.Temperature	
Car.SuspensionRF.Wheel.Tire.Segment3.Wear			
Car.SuspensionRF.Wheel.Tire.Segment4.Temperature	
Car.SuspensionRF.Wheel.Tire.Segment4.Wear			
Car.SuspensionRF.Wheel.Tire.Segment5.Temperature	
Car.SuspensionRF.Wheel.Tire.Segment5.Wear			
Car.SuspensionRF.Wheel.Tire.Segment6.Temperature	
Car.SuspensionRF.Wheel.Tire.Segment6.Wear			
Car.SuspensionRF.Wheel.Tire.Segment7.Temperature	
Car.SuspensionRF.Wheel.Tire.Segment7.Wear			
Car.SuspensionRF.Wheel.Tire.Segment8.Temperature	
Car.SuspensionRF.Wheel.Tire.Segment8.Wear			
Car.SuspensionLB.SpringDeflection					
Car.SuspensionLB.RollbarForce						
Car.SuspensionLB.SpringForce						
Car.SuspensionLB.DamperForce						
Car.SuspensionLB.StrutForce							
Car.SuspensionLB.HelperSpringIsActive				
Car.SuspensionLB.Damper.Damage						
Car.SuspensionLB.Damper.PistonVelocity				
Car.SuspensionLB.Wheel.BrakeDisk.LayerTemperature	
Car.SuspensionLB.Wheel.BrakeDisk.Temperature		
Car.SuspensionLB.Wheel.BrakeDisk.Wear				
Car.SuspensionLB.Wheel.Tire.Pressure				
Car.SuspensionLB.Wheel.Tire.Temperature				
Car.SuspensionLB.Wheel.Tire.CarcassTemperature		
Car.SuspensionLB.Wheel.Tire.TreadTemperature		
Car.SuspensionLB.Wheel.Tire.CurrentSegment			
Car.SuspensionLB.Wheel.Tire.Segment1.Temperature	
Car.SuspensionLB.Wheel.Tire.Segment1.Wear			
Car.SuspensionLB.Wheel.Tire.Segment2.Temperature	
Car.SuspensionLB.Wheel.Tire.Segment2.Wear			
Car.SuspensionLB.Wheel.Tire.Segment3.Temperature	
Car.SuspensionLB.Wheel.Tire.Segment3.Wear			
Car.SuspensionLB.Wheel.Tire.Segment4.Temperature	
Car.SuspensionLB.Wheel.Tire.Segment4.Wear			
Car.SuspensionLB.Wheel.Tire.Segment5.Temperature	
Car.SuspensionLB.Wheel.Tire.Segment5.Wear			
Car.SuspensionLB.Wheel.Tire.Segment6.Temperature	
Car.SuspensionLB.Wheel.Tire.Segment6.Wear			
Car.SuspensionLB.Wheel.Tire.Segment7.Temperature	
Car.SuspensionLB.Wheel.Tire.Segment7.Wear			
Car.SuspensionLB.Wheel.Tire.Segment8.Temperature	
Car.SuspensionLB.Wheel.Tire.Segment8.Wear			
Car.SuspensionRB.SpringDeflection					
Car.SuspensionRB.RollbarForce						
Car.SuspensionRB.SpringForce						
Car.SuspensionRB.DamperForce						
Car.SuspensionRB.StrutForce							
Car.SuspensionRB.HelperSpringIsActive				
Car.SuspensionRB.Damper.Damage						
Car.SuspensionRB.Damper.PistonVelocity				
Car.SuspensionRB.Wheel.BrakeDisk.LayerTemperature	
Car.SuspensionRB.Wheel.BrakeDisk.Temperature		
Car.SuspensionRB.Wheel.BrakeDisk.Wear				
Car.SuspensionRB.Wheel.Tire.Pressure				
Car.SuspensionRB.Wheel.Tire.Temperature				
Car.SuspensionRB.Wheel.Tire.CarcassTemperature		
Car.SuspensionRB.Wheel.Tire.TreadTemperature		
Car.SuspensionRB.Wheel.Tire.CurrentSegment			
Car.SuspensionRB.Wheel.Tire.Segment1.Temperature	
Car.SuspensionRB.Wheel.Tire.Segment1.Wear			
Car.SuspensionRB.Wheel.Tire.Segment2.Temperature	
Car.SuspensionRB.Wheel.Tire.Segment2.Wear			
Car.SuspensionRB.Wheel.Tire.Segment3.Temperature	
Car.SuspensionRB.Wheel.Tire.Segment3.Wear			
Car.SuspensionRB.Wheel.Tire.Segment4.Temperature	
Car.SuspensionRB.Wheel.Tire.Segment4.Wear			
Car.SuspensionRB.Wheel.Tire.Segment5.Temperature	
Car.SuspensionRB.Wheel.Tire.Segment5.Wear			
Car.SuspensionRB.Wheel.Tire.Segment6.Temperature	
Car.SuspensionRB.Wheel.Tire.Segment6.Wear			
Car.SuspensionRB.Wheel.Tire.Segment7.Temperature	
Car.SuspensionRB.Wheel.Tire.Segment7.Wear			
Car.SuspensionRB.Wheel.Tire.Segment8.Temperature	
Car.SuspensionRB.Wheel.Tire.Segment8.Wear			


Configuration
-------------
Configuration parameters are located in the RbrTelemetryProvider.dll.config
file located in the "provider" folder.

* surgeFilterWidth
* swayFilterWidth
* heaveFilterWidth
You may specify the filter width used by the Savitzky-Golay smoothing
algorithm separately for each of the motion values, Surge, Sway and Heave.

A filter width has to be specified as an odd value greater or equal to 3.
If set to 0 (zero), no smoothing is applied.

* udpPort
UDP port to read telemetry data from, default is 6776.
Has to match the value in RichardBurnsRally.ini.

* updateFrequency
Telemetry update frequency.
Has to match the value used by the RBR NGP plugin.
NGP Version 6.2: 142
NGP Version 6.3: 150
NGP Version 7.2: 720



Disclaimer
---------------------------------------------------------------------

This software and the accompanying files are supplied "as is" and
without warranties as to performance or merchantibility or any other
warranties whether expressed or implied. No warranty of fitness for
a particular purpose is offered.


Version History
---------------------------------------------------------------------
1.1 2023-10-26
    * Slightly faster processing, support NGP7.

1.0 2020-01-25
    * Initial release.

_____________________________________________________________________
WorkerBee

mail to guenter.schlupf at gmx.net

vim: set nocindent :
