StepperModule.cpp

Go to the documentation of this file.

/**
*  \link StepperModule
*/
 
#include "StepperModule.h"
#include "PTStepper.h"
 
#ifdef ESP_M5
 
void setup_StepperModule()
{
    
}
 
//!the main loop fro the StepperModule. This used be called FeederStateMachine()
void loop_StepperModule()
{
    
}
#else
 
 
//! called to set a preference (which will be an identifier and a string, which can be converted to a number or boolean)
void stepperModule_savePreference(int preferenceID, String preferenceValue);
 
/*feederState*/
#define FEED_STOPPED    0
#define SINGLE_FEED    1
#define AUTO_FEED    2
#define JACKPOT_FEED    3
 
int _feedState = FEED_STOPPED;
int _feedsPerJackpot = 3; //this will be set by user at some point
int _feedCount = _feedsPerJackpot; //init to max feeds per Jackpot
 
#define FEED_INTERVAL 1000           // make this a variable determined by user input and stored in JSON
unsigned long feedPreviousMillis = 0;
 
//proteced
// someone else the "savePreferenceBoolean_mainModule(PREFERENCE_STEPPER_BUZZER_VALUE) knows where to save it..
 
//!returns the buzzer status
boolean getBuzzStatus_StepperModule()
{
    boolean buzzStatus = getPreferenceBoolean_mainModule(PREFERENCE_STEPPER_BUZZER_VALUE);
    return buzzStatus;
}
 
//! retreives the feeder type (versus grabbing a global variable)
int getFeederType()
{
    return getFeederType_mainModule();
}
 
//!called on setup()
void setup_StepperModule()
{
    _feedState = FEED_STOPPED;
 
    //calls the PTStepper setup
    setup_PTStepper();
}
 
//TODO: this isn't directly called.. but called from the main processsClientCommand(String cmd)
////Keep ProcessClientCmd short to let the callback run. instead change the feeder state flag
void stepperModule_ProcessClientCmdFinal(char cmd) {
    SerialLots.printf("***** ProcessClientCmd(%c) from client*****\n", cmd);
    
    if ((cmd == 0x00) || (cmd == 's') || (cmd == 'c'))
    {
        SerialLots.println("Setting FeedState = SINGLE_FEED");
        _feedState = SINGLE_FEED;  // Gen 3 Pet Tutor used 0x00 to feed so 0x00 is to make it backward compatible  's' is the new version
                                   //not used .. for awhile.. So let's stop writing to EPROM all the time.
    }
    else if (cmd == 'a')
    {
        SerialLots.println("Setting FeedState = AUTO_FEED");
        _feedState = AUTO_FEED;
 
    }
    else if (cmd == 'j')
    {
        SerialLots.println("Setting FeedState = JACKPOT_FEED");
        _feedState = JACKPOT_FEED;
 
    }
    else if (cmd == 'B')
    {
        SerialLots.println("1.Setting buzzStatus = BUZZON");
        
        //set the flag, then buz..  (or don't care, and the value is stored in mainModule.. TODO: maybe that should cache the result)
        
        //make a buzz sound..
        blinkLED_UIModule();
        setBuzzerLight_UIModule(true);
 
    }
    else if (cmd == 'b')
    {
        SerialLots.println("2.Setting buzzStatus = BUZZOFF");
        setBuzzerLight_UIModule(false);
    }
 
    //!NOTE: There are other commands, but these are only the ones that require a action.
    //!TODO: make these "events" on the setting of those values. eg. register for stepperValue true or false, etc.. They would be invoked from the 'savePreferencesBoolean' call.
}
//void FeederStateMachine() {
 
//!the main loop fro the StepperModule. This used be called FeederStateMachine()
void loop_StepperModule()
{
    // FeedState is NO LONGER public and can be set by BLE client via the GATT for the characteristic
    
    switch (_feedState)
    {
        case SINGLE_FEED:
        {
            blinkLED_UIModule();
            start_PTStepper();
            SerialDebug.println("SINGLE Feed"); //this should write a 0x01 for feed ack
            _feedState = FEED_STOPPED; //this will cancel Continous feed if it is set
            break;
        }
#ifdef MOVED_TO_TIMER_LOGIC
 
        case AUTO_FEED:  //note: the only difference in this case is the FEED_STOPPED does NOT get set
        {
            unsigned long feedCurrentMillis = millis();
 
            if (feedCurrentMillis - feedPreviousMillis >= FEED_INTERVAL) {  // changed this to check a timer to see when to fire the feeder..session length,random interval, auto increment time
                blinkLED_UIModule();
                start_PTStepper();
                SerialDebug.println("AUTO Feed");
                feedPreviousMillis = feedCurrentMillis;
            }
            break;
        }
#endif
        case JACKPOT_FEED:  //note: the only difference in this case is the FEED_STOPPED does NOT get set
        {
            if (_feedCount > 0) {
                unsigned long feedCurrentMillis = millis();
                if (feedCurrentMillis - feedPreviousMillis >= FEED_INTERVAL) {  // changed this to check a timer to see when to fire the feeder
                    blinkLED_UIModule();                          // Moved 021622 WJL
                    start_PTStepper();
                    SerialDebug.println("JACKPOT Feed");
                    _feedCount--;
                    feedPreviousMillis = feedCurrentMillis;
                }
            }
            else {
                _feedCount = _feedsPerJackpot; //reset counter after all feeds for Jackpot completed
                _feedState = FEED_STOPPED;
            }
            break;
        }
        case FEED_STOPPED:
        {
            //SerialDebug.println("Feed Stopped --  ");
            //do nothing
            break;
        }
        default:
        {
            _feedState = FEED_STOPPED;
            break;
        }
    }
}
 
 
#endif  //ESP_M5