com.SIMRacingApps.SIMPluginCallbacks.MSPEC

Class ShiftLight

java.lang.Object

com.SIMRacingApps.SIMPluginCallbacks.SIMPluginCallback

com.SIMRacingApps.SIMPluginCallbacks.MSPEC.ShiftLight

All Implemented Interfaces:

SIMPlugin.Callback

public class ShiftLight
extends SIMPluginCallback

This class implements the interface to the MSPEC Shift Light. This light can be purchase from MSPEC ShiftLight

Each light must have a unique port assigned to it in the settings. For example: If your light is on COM3, then use

 
     mspec-rpm = 3
 

By default the light will come on when speeding. You can control this with the "mspec-speeding = true or false" variable. This document was used as the reference to this implementation.

Since:

1.0

Author:

Jeffrey Gilliam

Copyright:

Copyright (C) 2015 - 2024 Jeffrey Gilliam

License:

Apache License 2.0

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String[]	types

Constructor Summary

Constructors

Constructor and Description
ShiftLight(SIMPlugin SIMPlugin)

Method Summary

Modifier and Type	Method and Description
void	destroy() Called when the SIMPlugin is destroyed.
boolean	ProcessData(SIMPlugin SIMPlugin, java.util.Map<java.lang.String,Data> data) ProcessData is called from within the dedicated thread for this plug-in every time there is data available in the queue it pops it off the queue and passes it to this method.

Methods inherited from class com.SIMRacingApps.SIMPluginCallbacks.SIMPluginCallback

DataReady, Waiting

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

types

public static java.lang.String[] types

Constructor Detail

ShiftLight

public ShiftLight(SIMPlugin SIMPlugin)
           throws SIMPlugin.SIMPluginException

Throws:

SIMPlugin.SIMPluginException

Method Detail

destroy

public void destroy()

Description copied from class: SIMPluginCallback

Called when the SIMPlugin is destroyed. If you override this method, be sure to call super.destroy() first.

Overrides:

destroy in class SIMPluginCallback

ProcessData

public boolean ProcessData(SIMPlugin SIMPlugin,
                           java.util.Map<java.lang.String,Data> data)

Description copied from class: SIMPluginCallback

ProcessData is called from within the dedicated thread for this plug-in every time there is data available in the queue it pops it off the queue and passes it to this method. A should override this method to implement your plug-in's functionality. If this method takes too long to process the data in the queue, you could miss data that the SIM is sending. Design accordingly. There's no way to even guarantee that you will get every update from the SIM. At this point in the design, ProcessData will get called on the same frequency as the SIM (typically 16ms). At some point, I may change it to only get called if the subscribed to data changes. NOTE: If you find you need to use the SIMPlugin argument, inclose it in a synchronized block. You are in a separate thread, so this will block the main thread. Do not keep it locked very long.

     //When calling the SIMPlugin from this method, you must synchronize on it first. It is not thread safe.
     Data d;
     synchronized (SIMPlugin) {
         //do not spend much time in here, we are blocking the main thread 
         //Get the data and get out of the synchronized block 
         d = SIMPlugin.getData("/Session/IsGreenFlag");
         d = SIMPlugin.getSession().getIsGreenFlag();
     }
     //do something with the data
 

Overrides:

ProcessData in class SIMPluginCallback

Parameters:

SIMPlugin - A reference to the SIMPlugin instance.

data - The Data objects added to the queue.

Returns:

true to keep the plug-in alive, false to kill it.