ESP_IOT.ino

Go to the documentation of this file.

/*
  Name:     NimBLE_PetTutor_Server.ino
  Created:  8/25/2021 7:49:11 PM
  Author:   wes and scott
*/
 
//!defines.h defines the #ifdef USE_MODULE statements, as they are included elsewhere.. Don't define them here.
#include "Defines.h"
 
#ifdef ESP_M5
//NEED to fix the port to use...   /dev/cu.usbserial-61CEEBBFAD
//todo..
//#define HIGH 1
#define LED 2
//#include "src/ButtonModule/ButtonProcessing.h"
//NOTE: the Board has to be modified to M5Stick-C-Plus
 
//called from BLEServerNetworking, MainModule and StepperModule(Dispense.cpp)
void stepperModule_ProcessClientCmd(char cmd)
{
  SerialError.printf("UNDEFINED: stepperModule_processClientCmd: %c\n", cmd);
}
#else
 
#endif  //ESP_M5
 
 
 
//NOTE: there might be an issue that the REGISTERED methods aren't done yet .. so cannot call them..
boolean _finishSetupCalledAlready;
 
//forward definition
void finishSetup();
 
#include "nvs_flash.h"
// ******************************************
//!note: setup only called one time...
//! so, the first time the doneWIFIModuleCredentials is set.. call setup()
//!main setup
void setup() {
 
#ifdef ERASE_ALL
//https://github.com/espressif/arduino-esp32/issues/2144
  ESP_ERROR_CHECK(nvs_flash_erase());
  nvs_flash_init();
 
 #endif
  Serial.begin(115200);
  Serial.println();
  pinMode(LED, OUTPUT);
  
  //This must be first .. as it inializes the display and Serial Ports..
  //! called for the loop() of this plugin
  setup_displayModule();
 
  
 
    
  SerialInfo.println("******************");
  SerialMin.println(VERSION);
  
  //Timestamp the compile
  SerialDebug.print("Compiled ");
  SerialDebug.print(__DATE__);
  SerialDebug.print(" @ ");
  SerialDebug.println(__TIME__);
 
  //not good time .. since no WIFI to get global time..
//  printInt_SPIFFModule(getTimeStamp_mainModule());
//  println_SPIFFModule((char*)" time");
 
 
 
  //called in setup() to init the async calls
  initAsyncCallFlags();
 
  //!4.17.22
  //! MainModule does all the preferences, etc..
  setup_mainModule();
 
 
  main_printModuleConfiguration();
  SerialInfo.println("******************");
  
#ifdef USE_SPIFF_MODULE
   //!SPIFF must be after main_setup() since it reads preferences .. is first so debug can be saved
  setup_SPIFFModule();
  println_SPIFFModule((char*)VERSION);
 
#endif
 
#ifdef USE_CAMERA_MODULE
  setup_CameraModule();
#endif
 
#ifdef USE_BUTTON_MODULE
  //calls the setup() for ButtonModule
  setup_ButtonModule();
 
  //register the single click
  registerCallbackMain(CALLBACKS_BUTTON_MODULE, SINGLE_CLICK_BM, &singleClickTouched);
 
#endif
 
    //!12.8.22 add audio
#ifdef USE_AUDIO_MODULE
    setup_AudioModule();
#endif
 
#ifdef USE_STEPPER_MODULE
  //reads credentials, etc..
  setup_StepperModule();
#endif
 
#ifdef USE_UI_MODULE
  //setup the stepper for the feeder
  setup_UIModule();
#endif
 
  SerialInfo.println("Starting PetTutor_Server");
  SerialDebug.printf("M5STACK VERSION = %s\n", M5STACK_VERSION);
  
    //APril 8, refactoring. Moved up to here..
#ifdef USE_MQTT_NETWORKING
 
  //pass the callbacks, (1) the message callback, and the (blinkLed) implementation
  //setMessageCallbacks(&feedMessageCallback, &blinkMessageCallback);
  //register the 2 callbacks for now..
  registerCallbackMain(CALLBACKS_MQTT, MQTT_CALLBACK_FEED, &feedMessageCallback);
  registerCallbackMain(CALLBACKS_MQTT, MQTT_CALLBACK_BLINK, &blinkMessageCallback);
  registerCallbackMain(CALLBACKS_MQTT, MQTT_CALLBACK_SOLID_LIGHT, &solidLightMessageCallback); //use the string "ON", "OFF"
 
  //3.25.22 -- register the cleanSSID_EPROM
  registerCallbackMain(CALLBACKS_MQTT, MQTT_CLEAN_SSID_EPROM, &cleanSSID_EPROM_MessageCallback);
 
    //NOTE: 6.3.22 .. this is breaking the AP mode, preSetup_WIF_APModule must be called first..
  //try call from loop():
//  setup_MQTTNetworking();
 
    
   //the tilt  5.2.22  (no one calls this ...)
    registerCallbackMain(CALLBACKS_MQTT, MQTT_CALLBACK_TILT_MOTION_DETECTED, &feedMessageCallback);
#endif
 
#ifdef USE_WIFI_AP_MODULE
  //called to validate the doneWIFI() call...
  preSetup_WIFI_APModule();
#endif
    
   
        //init the BLE here.
#ifdef USE_BLE_SERVER_NETWORKING   //yes
                                   //!if the BLE_SERVER is turned on..
#ifdef ESP_M5
    if (getPreferenceBoolean_mainModule(PREFERENCE_MAIN_BLE_SERVER_VALUE))
    {
#endif
        
        //Initialize the BLE Server, using the service name PTFeeder
        //https://stackoverflow.com/questions/20944784/why-is-conversion-from-string-constant-to-char-valid-in-c-but-invalid-in-c
#ifdef USE_MQTT_NETWORKING
        
        //*** The callback for "onWrite" of the bluetooth "onWrite'
        registerCallbackMain(CALLBACKS_BLE_SERVER, BLE_SERVER_CALLBACK_ONWRITE, &onWriteBLEServerCallback);
        //*** The callback for "onWrite" of the bluetooth "onWrite'
        registerCallbackMain(CALLBACKS_BLE_SERVER, BLE_SERVER_CALLBACK_STATUS_MESSAGE, &onStatusMessageBLEServerCallback);
        
        //strdup() get away from the
        setup_BLEServerNetworking(MAIN_BLE_SERVER_SERVICE_NAME, getDeviceNameMQTT(), strdup(PT_SERVICE_UUID), strdup(PT_CHARACTERISTIC_UUID));
        
        SerialDebug.println("done setupBLEServerNetworking");
#else
        setup_BLEServerNetworking(MAIN_BLE_SERVER_SERVICE_NAME, (char*)"undefined", strdup(PT_SERVICE_UUID), strdup(PT_CHARACTERISTIC_UUID));
#endif //MQTT_NETWORKING
#ifdef ESP_M5
    }
#endif
 
#endif //USE_BLE_SERVER_NETWORKING
    
  //BLE Client --
#ifdef  USE_BLE_CLIENT_NETWORKING
  setup_BLEClientNetworking(MAIN_BLE_CLIENT_SERVICE, (char*) PT_SERVICE_UUID, (char*) PT_CHARACTERISTIC_UUID);
#endif //USE_BLE_CLIENT_NETWORKING
 
 
#ifdef USE_WIFI_AP_MODULE
 
  //MAJOR ISSUE:  if the port/server are wrong .. can never reset unless we can get a BUTTON..
  //If BOOTSTRAP (a compile time ifdef in Defines.h is set, then bypass the AP mode, and use the constants in MQTTNetworking.cpp
#ifndef BOOTSTRAP
  if (!doneWIFI_APModule_Credentials())
  {
    //Turn on light until out of the AP mode..
    solidLightOnOff(true);
    //test
    WIFI_APModule_ResetCredentials();
 
    //set flag ..
    _finishSetupCalledAlready = false;
 
    setup_WIFI_APModule();
 
    
  }
#endif //BOOTSTRAP
#else   //not USE_WIFI_AP_MODE
  finishSetup();
#endif
}
 
// **************** finishSetup()
//! called to finsh the setup.. this is because the MQTT and WIFI aren't run if in AP mode..
void finishSetup()
{
#ifdef USE_WIFI_AP_MODULE
  //basically after the AP module finished, the function WIFI_APModule_JsonOutputString() stores the credentials (versus them calling here ..)
  if (doneWIFI_APModule_Credentials())
  {
    //Turn on light until out of the AP mode..
    solidLightOnOff(false);
 
    String jsonOutputString = WIFI_APModule_JsonOutputString();
    // now this could be passed onto the MQTT processor..
    SerialDebug.print("From WIFI -> JSON = ");
    SerialDebug.println(jsonOutputString);
#endif
 
#ifdef USE_MQTT_NETWORKING
      //moved here 6.3.22
      setup_MQTTNetworking();
#ifdef USE_WIFI_AP_MODULE
    //pass the json string onto the MQTT code..
    // 3.26.22
    SerialDebug.println("calling .. processJSONMessage");
    //NOTE: if done was because credentials .. then don't call this..
    //basically if MQTT running .. don't call this..
    processJSONMessageMQTT(&jsonOutputString[0], NULL);
#endif
    //NOTE: we are still in the BLE callback .. and then we call setup_MQTTNetworking..
    //LETS try setting state in MQTT that is waiting for WIFI..
 
 
    //perform the setup() in the MQTTNetworking
    //NOTE: this is called 2 times if processJSONMessage() sets the eprom data .. since the network was already setup
    //there is a state flag internally that won't setup 2 times (unless MQTT was kicked out via AP mode, or cleaned credentials)
    //try call from loop():
      //setup_MQTTNetworking();
 
    // sets the _chipName (from MQTT Module)
    char *deviceName = getDeviceNameMQTT();
 
    //THIS should output the device name, user name, etc...
    //    SerialDebug.print("pFoodCharacteristic->setValue: ");
    //    SerialDebug.println(_fullJSONString);
    SerialDebug.print("DeviceName: ");
    SerialDebug.println(deviceName);
 
#endif  //USE_MQTT_NETWORKING
 
 
#ifdef USE_WIFI_AP_MODULE
 
  } //doneWIFI_APModule_Credentials()
#endif
 
}
 
 
// ****************************************
//! main loop() of the Arduino runtime
void loop() {
//#define USE_STOP_ALL
 
 #ifdef USE_STOP_ALL
  if (stopAllProcesses_mainModule())
  {
    delay(100);
    return;
  }
 #endif
    
  //4.17.22
  loop_mainModule();
    
    //!12.8.22 add audio
#ifdef USE_AUDIO_MODULE
    loop_AudioModule();
#endif
  
 #ifdef USE_CAMERA_MODULE
  loop_CameraModule();
#endif
 
 
#ifdef USE_WIFI_AP_MODULE
 
  if (doneWIFI_APModule_Credentials())
  {
    //since the MQTT and BLE were not started, the first time the WIFI credentials are finished (after submit)
    // finish the setup (which are the MQTT and WIFI.
    //NOTE: this needs to get the credentials in JSON format and store ..
    if (!_finishSetupCalledAlready)
    {
      _finishSetupCalledAlready = true;
      SerialDebug.println("doneWIFI_APModuleCredentials,  and now calling finishSetup()");
      finishSetup();
    }
  }
 
#endif //USE_WIFI_AP_MODE
 
  // called to check if any Async Commands are in dispatch mode
  invokeAsyncCommands();
 
    //! note: displayModule() musts be called before buttonModule (as the "model" is updated (initiated) in the display module
    //! called for the loop() of this plugin (this is almost the "frames" of the graphic, as fast as the runtime can make this loop! FAST.. 24 fps ??
  loop_displayModule();
    
#ifdef USE_BUTTON_MODULE
  loop_ButtonModule();
#endif
 
  /** Do your thing here, this just spams notifications to all connected clients */
#ifdef USE_STEPPER_MODULE
  loop_StepperModule(); //was FeederStateMachine
#endif //USE_STEPPER_MODULE
 
#ifdef USE_UI_MODULE
  loop_UIModule();
#endif
 
  //BLE Client --
#ifdef  USE_BLE_CLIENT_NETWORKING
  loop_BLEClientNetworking();
#endif //USE_BLE_CLIENT_NETWORKING
 
 
  //** NOTE: the WIFI_AP_MODULE is tricky. The doneWIFI_APModule_Credentials() is set when done, but also when the MQTT networking is running (meaning the credentials were specified via BLE, or from EPROM)
#ifdef USE_WIFI_AP_MODULE
  //if the APmodule credentials are finished .. then continue normal loop
  // Otherwise just BLE and AP (for now)
  if (doneWIFI_APModule_Credentials())
  {
#endif
 
 
    /*******************************MQTT*************************************/
#ifdef USE_MQTT_NETWORKING
    loop_MQTTNetworking();
#endif
 
      
#ifdef USE_BLE_SERVER_NETWORKING
      //!if the BLE_SERVER is turned on..
#ifdef ESP_M5
      if (getPreferenceBoolean_mainModule(PREFERENCE_MAIN_BLE_SERVER_VALUE))
      {
#endif
          loop_BLEServerNetworking();
#ifdef ESP_M5
      }
#endif
      
#else
#endif // USE_BLE_SERVER_NETWORKING
 
 
#ifdef USE_WIFI_AP_MODULE
  } //!doneWIFI_APModuleCredentials
#endif
 
#ifdef USE_WIFI_AP_MODULE
  if (!doneWIFI_APModule_Credentials())
  {
    loop_WIFI_APModule();
  }
#endif
  //APril 8, 2022
  //loop always, we just don't have WIFI working yet...?
  //NOTE: the loopBLE will call the register for a message (and call processJSONMessage on BLE commands)
  //NEED: to set the doneWIFI_APModuleCredentials  iff a processJSONMessage resulted in credential updates,
  // not all JSON are credentials. Others are setting options, like OTA.  -- and kill the AP module..
  //UNFORTUNATELY .. the WIFI and MQTT might fail .. and slow things down. NEED a better way to
  // run the MQTT loop (so others can get some time, like BLE).
 
 
  delay(100);  //this delays the feed trigger response
 
}