RSeries astromech firmware
List of all members | Classes | Public Member Functions
LogicEngineController< kDelayPin, kFadePin, kBriPin, kHuePin, kPalPin, kFrontJumperPin, kRearJumperPin > Class Template Reference

#include <dome/LogicEngineController.h>

Detailed Description

template<byte kDelayPin = LENGINE_DELAY_PIN, byte kFadePin = LENGINE_FADE_PIN, byte kBriPin = LENGINE_BRI_PIN, byte kHuePin = LENGINE_HUE_PIN, byte kPalPin = LENGINE_PAL_PIN, byte kFrontJumperPin = LENGINE_FJUMP_PIN, byte kRearJumperPin = LENGINE_RJUMP_PIN>
class LogicEngineController< kDelayPin, kFadePin, kBriPin, kHuePin, kPalPin, kFrontJumperPin, kRearJumperPin >

Settings adjust for LogicEngine logics.

Adjust the settings for a set of LogicEngine logics using PCB trimpots and jumpers.

+ Inheritance diagram for LogicEngineController< kDelayPin, kFadePin, kBriPin, kHuePin, kPalPin, kFrontJumperPin, kRearJumperPin >:
+ Collaboration diagram for LogicEngineController< kDelayPin, kFadePin, kBriPin, kHuePin, kPalPin, kFrontJumperPin, kRearJumperPin >:

Classes

class  StatusLED
 

Public Member Functions

 LogicEngineController (LogicEngineRenderer &FLD, LogicEngineRenderer &RLD)
 Constructor. More...
 
 LogicEngineController (LogicEngineRenderer &LD)
 Constructor. More...
 
virtual void animate () override
 Check the adjustment switch and read trimpots and adjust settings. More...
 
 LogicEngineController (Preferences &preferences)
 Constructor. More...
 
void setWifiReset (void(*resetFunction)())
 
void setWifiToggle (void(*toggleFunction)())
 
virtual void setup () override
 
void configure (LogicEngineRenderer *FLD, LogicEngineRenderer *RLD)
 Check the adjustment switch and read trimpots and adjust settings. More...
 
LogicEngineSettings & getSettings (unsigned logicNum)
 
void restoreFactoryDefaults (unsigned logicNum)
 
void changeSetting (unsigned logicNum, unsigned settingNum, unsigned val)
 
bool commit ()
 
virtual void animate () override
 Check the adjustment switch and read trimpots and adjust settings. More...
 
- Public Member Functions inherited from AnimatedEvent
 AnimatedEvent ()
 Default Constructor. More...
 
void setLoopDoneCallback (AnimatedLoopDone loopProc)
 

Additional Inherited Members

- Static Public Member Functions inherited from AnimatedEvent
static void process ()
 Calls animate() for each created AnimatedEvent subclass. More...
 

Constructor & Destructor Documentation

◆ LogicEngineController() [1/3]

template<byte kDelayPin = LENGINE_DELAY_PIN, byte kFadePin = LENGINE_FADE_PIN, byte kBriPin = LENGINE_BRI_PIN, byte kHuePin = LENGINE_HUE_PIN, byte kPalPin = LENGINE_PAL_PIN, byte kFrontJumperPin = LENGINE_FJUMP_PIN, byte kRearJumperPin = LENGINE_RJUMP_PIN>
LogicEngineController< kDelayPin, kFadePin, kBriPin, kHuePin, kPalPin, kFrontJumperPin, kRearJumperPin >::LogicEngineController ( LogicEngineRenderer &  FLD,
LogicEngineRenderer &  RLD 
)
inline

Constructor.

◆ LogicEngineController() [2/3]

template<byte kDelayPin = LENGINE_DELAY_PIN, byte kFadePin = LENGINE_FADE_PIN, byte kBriPin = LENGINE_BRI_PIN, byte kHuePin = LENGINE_HUE_PIN, byte kPalPin = LENGINE_PAL_PIN, byte kFrontJumperPin = LENGINE_FJUMP_PIN, byte kRearJumperPin = LENGINE_RJUMP_PIN>
LogicEngineController< kDelayPin, kFadePin, kBriPin, kHuePin, kPalPin, kFrontJumperPin, kRearJumperPin >::LogicEngineController ( LogicEngineRenderer &  LD)
inline

Constructor.

For AVR ProMini boards with restricted memory we can only support a single logic display if using a controller.

◆ LogicEngineController() [3/3]

template<byte kDelayPin = LENGINE_DELAY_PIN, byte kFadePin = LENGINE_FADE_PIN, byte kBriPin = LENGINE_BRI_PIN, byte kHuePin = LENGINE_HUE_PIN, byte kPalPin = LENGINE_PAL_PIN, byte kFrontJumperPin = LENGINE_FJUMP_PIN, byte kRearJumperPin = LENGINE_RJUMP_PIN>
LogicEngineController< kDelayPin, kFadePin, kBriPin, kHuePin, kPalPin, kFrontJumperPin, kRearJumperPin >::LogicEngineController ( Preferences &  preferences)
inline

Constructor.

Member Function Documentation

◆ animate() [1/2]

template<byte kDelayPin = LENGINE_DELAY_PIN, byte kFadePin = LENGINE_FADE_PIN, byte kBriPin = LENGINE_BRI_PIN, byte kHuePin = LENGINE_HUE_PIN, byte kPalPin = LENGINE_PAL_PIN, byte kFrontJumperPin = LENGINE_FJUMP_PIN, byte kRearJumperPin = LENGINE_RJUMP_PIN>
virtual void LogicEngineController< kDelayPin, kFadePin, kBriPin, kHuePin, kPalPin, kFrontJumperPin, kRearJumperPin >::animate ( )
inlineoverridevirtual

Check the adjustment switch and read trimpots and adjust settings.

Implements AnimatedEvent.

◆ animate() [2/2]

template<byte kDelayPin = LENGINE_DELAY_PIN, byte kFadePin = LENGINE_FADE_PIN, byte kBriPin = LENGINE_BRI_PIN, byte kHuePin = LENGINE_HUE_PIN, byte kPalPin = LENGINE_PAL_PIN, byte kFrontJumperPin = LENGINE_FJUMP_PIN, byte kRearJumperPin = LENGINE_RJUMP_PIN>
virtual void LogicEngineController< kDelayPin, kFadePin, kBriPin, kHuePin, kPalPin, kFrontJumperPin, kRearJumperPin >::animate ( )
inlineoverridevirtual

Check the adjustment switch and read trimpots and adjust settings.

Implements AnimatedEvent.

◆ changeSetting()

template<byte kDelayPin = LENGINE_DELAY_PIN, byte kFadePin = LENGINE_FADE_PIN, byte kBriPin = LENGINE_BRI_PIN, byte kHuePin = LENGINE_HUE_PIN, byte kPalPin = LENGINE_PAL_PIN, byte kFrontJumperPin = LENGINE_FJUMP_PIN, byte kRearJumperPin = LENGINE_RJUMP_PIN>
void LogicEngineController< kDelayPin, kFadePin, kBriPin, kHuePin, kPalPin, kFrontJumperPin, kRearJumperPin >::changeSetting ( unsigned  logicNum,
unsigned  settingNum,
unsigned  val 
)
inline

◆ commit()

template<byte kDelayPin = LENGINE_DELAY_PIN, byte kFadePin = LENGINE_FADE_PIN, byte kBriPin = LENGINE_BRI_PIN, byte kHuePin = LENGINE_HUE_PIN, byte kPalPin = LENGINE_PAL_PIN, byte kFrontJumperPin = LENGINE_FJUMP_PIN, byte kRearJumperPin = LENGINE_RJUMP_PIN>
bool LogicEngineController< kDelayPin, kFadePin, kBriPin, kHuePin, kPalPin, kFrontJumperPin, kRearJumperPin >::commit ( )
inline

◆ configure()

template<byte kDelayPin = LENGINE_DELAY_PIN, byte kFadePin = LENGINE_FADE_PIN, byte kBriPin = LENGINE_BRI_PIN, byte kHuePin = LENGINE_HUE_PIN, byte kPalPin = LENGINE_PAL_PIN, byte kFrontJumperPin = LENGINE_FJUMP_PIN, byte kRearJumperPin = LENGINE_RJUMP_PIN>
void LogicEngineController< kDelayPin, kFadePin, kBriPin, kHuePin, kPalPin, kFrontJumperPin, kRearJumperPin >::configure ( LogicEngineRenderer *  FLD,
LogicEngineRenderer *  RLD 
)
inline

Check the adjustment switch and read trimpots and adjust settings.

◆ getSettings()

template<byte kDelayPin = LENGINE_DELAY_PIN, byte kFadePin = LENGINE_FADE_PIN, byte kBriPin = LENGINE_BRI_PIN, byte kHuePin = LENGINE_HUE_PIN, byte kPalPin = LENGINE_PAL_PIN, byte kFrontJumperPin = LENGINE_FJUMP_PIN, byte kRearJumperPin = LENGINE_RJUMP_PIN>
LogicEngineSettings& LogicEngineController< kDelayPin, kFadePin, kBriPin, kHuePin, kPalPin, kFrontJumperPin, kRearJumperPin >::getSettings ( unsigned  logicNum)
inline

◆ restoreFactoryDefaults()

template<byte kDelayPin = LENGINE_DELAY_PIN, byte kFadePin = LENGINE_FADE_PIN, byte kBriPin = LENGINE_BRI_PIN, byte kHuePin = LENGINE_HUE_PIN, byte kPalPin = LENGINE_PAL_PIN, byte kFrontJumperPin = LENGINE_FJUMP_PIN, byte kRearJumperPin = LENGINE_RJUMP_PIN>
void LogicEngineController< kDelayPin, kFadePin, kBriPin, kHuePin, kPalPin, kFrontJumperPin, kRearJumperPin >::restoreFactoryDefaults ( unsigned  logicNum)
inline

◆ setup()

template<byte kDelayPin = LENGINE_DELAY_PIN, byte kFadePin = LENGINE_FADE_PIN, byte kBriPin = LENGINE_BRI_PIN, byte kHuePin = LENGINE_HUE_PIN, byte kPalPin = LENGINE_PAL_PIN, byte kFrontJumperPin = LENGINE_FJUMP_PIN, byte kRearJumperPin = LENGINE_RJUMP_PIN>
virtual void LogicEngineController< kDelayPin, kFadePin, kBriPin, kHuePin, kPalPin, kFrontJumperPin, kRearJumperPin >::setup ( )
inlineoverridevirtual

◆ setWifiReset()

template<byte kDelayPin = LENGINE_DELAY_PIN, byte kFadePin = LENGINE_FADE_PIN, byte kBriPin = LENGINE_BRI_PIN, byte kHuePin = LENGINE_HUE_PIN, byte kPalPin = LENGINE_PAL_PIN, byte kFrontJumperPin = LENGINE_FJUMP_PIN, byte kRearJumperPin = LENGINE_RJUMP_PIN>
void LogicEngineController< kDelayPin, kFadePin, kBriPin, kHuePin, kPalPin, kFrontJumperPin, kRearJumperPin >::setWifiReset ( void(*)()  resetFunction)
inline

◆ setWifiToggle()

template<byte kDelayPin = LENGINE_DELAY_PIN, byte kFadePin = LENGINE_FADE_PIN, byte kBriPin = LENGINE_BRI_PIN, byte kHuePin = LENGINE_HUE_PIN, byte kPalPin = LENGINE_PAL_PIN, byte kFrontJumperPin = LENGINE_FJUMP_PIN, byte kRearJumperPin = LENGINE_RJUMP_PIN>
void LogicEngineController< kDelayPin, kFadePin, kBriPin, kHuePin, kPalPin, kFrontJumperPin, kRearJumperPin >::setWifiToggle ( void(*)()  toggleFunction)
inline
The documentation for this class was generated from the following files: