com.SIMRacingApps.SIMPluginCallbacks.LIFX

Class Flags

java.lang.Object

com.SIMRacingApps.SIMPluginCallbacks.SIMPluginCallback

com.SIMRacingApps.SIMPluginCallbacks.LIFX.Flags

All Implemented Interfaces:

SIMPlugin.Callback

public class Flags
extends SIMPluginCallback

This plugin uses your LIFX Lights to represent the current flag that is waving in the flagman stand.

This plugin requires the following entries in the settings.

 LIFX-Flags = Y
 LIFX-token = YourToken
 LIFX-flags-brightness = 1.0
 LIFX-always-green = Y
 

To obtain a token, go to https://cloud.lifx.com and login to your account. Then click on your name in the upper right corner of the screen and select "settings". Click on "Generate a new Token" and give it the name "SIMRacingApps" and click "Generate". Copy the token it generates and paste it in the SIMRacingApps settings.

NOTE: You must have the light(s) you want SIMRacingApps to use assigned to your cloud account using the LIFX app and assigned to the group "SRA-flags". There is an option in the app, under each light's settings, to add the light to the cloud and assign the group. This field is case sensitive, so type it exactly as you see here.

Since:

1.4

Author:

Jeffrey Gilliam

Copyright:

Copyright (C) 2015 - 2024 Jeffrey Gilliam

License:

Apache License 2.0

Constructor Summary

Constructors

Constructor and Description
Flags(SIMPlugin SIMPlugin) Constructor.

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

Constructor Detail

Flags

public Flags(SIMPlugin SIMPlugin)
      throws SIMPlugin.SIMPluginException

Constructor. Use the constructor to initialize your plug-in.

Parameters:

SIMPlugin - An instance of the current SIM.

Throws:

SIMPlugin.SIMPluginException - If there's a problem constructing your plug-in.

Method Detail

destroy

public void destroy()

Called when the SIMPlugin is destroyed. It's always best to call super.destroy() for future compatibility.

Overrides:

destroy in class SIMPluginCallback

ProcessData

public 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. At this point in the design, it will get called every 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.