keepAlive.ino

/*
miniThrottle, A WiThrottle/DCC-Ex Throttle for model train control

MIT License

Copyright (c) [2021-2024] [Enfield Cat]

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/



/* ***********************************************************************\
 * Only use keep alive packets if operating over a network
\*********************************************************************** */
#ifdef USEWIFI
static TimerHandle_t keepAliveTimer = NULL;
static QueueHandle_t keepAliveQueue = NULL;

// Use a timer to set the semaphore to permit sending of keep alive packets
// Do not use interrupt type routines to generate I/O directly
static void keepAliveTimerHandler (TimerHandle_t xTimer)
{
static uint8_t tint = 0; //nominal payload to pplace into queue

xQueueSend (keepAliveQueue, &tint, 0);
}

void keepAlive(void *pvParameters)
// This is the keepalive task.
{
  (void)  pvParameters;
  int     lastTime;
  uint8_t queueData;
  bool turnOff = true;

  if (debuglevel>2 && xSemaphoreTake(consoleSem, pdMS_TO_TICKS(TIMEOUT)) == pdTRUE) {
    Serial.printf ("%s keepAlive(NULL)\r\n", getTimeStamp());
    xSemaphoreGive(consoleSem);
  }
  if (keepAliveQueue == NULL) {
    keepAliveQueue = xQueueCreate (1, sizeof(uint8_t));
  }
  if (keepAliveTimer == NULL) {
    keepAliveTimer = xTimerCreate ("keepAliveTimer", pdMS_TO_TICKS(keepAliveTime * 1000), pdTRUE, (void *) NULL, keepAliveTimerHandler);
  }
  if (keepAliveQueue == NULL || keepAliveTimer == NULL) {
    if (xSemaphoreTake(consoleSem, pdMS_TO_TICKS(TIMEOUT)) == pdTRUE) {
      Serial.printf ("%s Failed to create timer for keep alive packets\r\n", getTimeStamp());
      xSemaphoreGive(consoleSem);
    }
  }
  else {
    if (diagIsRunning && xSemaphoreTake(diagPortSem, pdMS_TO_TICKS(TIMEOUT)) == pdTRUE) {
      diagEnqueue ('e', (char *) "### Starting keep alive thread --------------------------------------------", true);
      xSemaphoreGive(diagPortSem);
    }
    lastTime = keepAliveTime;
    if (lastTime > 0) xTimerStart (keepAliveTimer, pdMS_TO_TICKS(lastTime * 1000));
    while (lastTime > 0 && cmdProtocol != DCCEX) {
      while (lastTime > 0 && (APrunning || WiFi.status() == WL_CONNECTED) && cmdProtocol != DCCEX) {
        while (lastTime > 0 && wiCliConnected && cmdProtocol != DCCEX) {
          if (xQueueReceive(keepAliveQueue, &queueData, pdMS_TO_TICKS((lastTime*1000)+1000)) == pdPASS) {
            if (lastTime > 0 && !turnOff) sendKeepAlive ("*");    // send the heartbeat, if we have started the sequence
            if (lastTime != keepAliveTime) { // has the period changed?
              lastTime = keepAliveTime;
              if (lastTime > 0) xTimerChangePeriod(keepAliveTimer, pdMS_TO_TICKS(lastTime * 1000), pdMS_TO_TICKS(1100));
            }
            if (turnOff) { // Enable heartbeats if they have stopped.
              turnOff = false;
              sendKeepAlive ("*+");
            }
          }
        }
        turnOff = true;
        delay (1000); // wait for client connection
      }
      delay (1000);   // wait for WiFi reconnect
    }
  }
  if (wiCliConnected && cmdProtocol == WITHROT) {
    sendKeepAlive ("*-");
  }
  if (xSemaphoreTake(consoleSem, pdMS_TO_TICKS(TIMEOUT)) == pdTRUE) {
    Serial.println ("Keep alive manager exits");
    xSemaphoreGive(consoleSem);
  }
  if (keepAliveTimer != NULL) xTimerDelete (keepAliveTimer, pdMS_TO_TICKS(TIMEOUT));
  if (keepAliveQueue != NULL) vQueueDelete (keepAliveQueue);
  if (diagIsRunning && xSemaphoreTake(diagPortSem, pdMS_TO_TICKS(TIMEOUT)) == pdTRUE) {
    diagEnqueue ('e', (char *) "### Stopping keep alive thread --------------------------------------------", true);
    xSemaphoreGive(diagPortSem);
  }
  vTaskDelete( NULL );
}

/*
 * Keep keep alive transmit data separate from normal keep alive transmits so that
 * console show flags are separate from normal packet transmit reporting
 */
void sendKeepAlive(const char *pktData)
{
  if (debuglevel>2 && xSemaphoreTake(consoleSem, pdMS_TO_TICKS(TIMEOUT)) == pdTRUE) {
    Serial.printf ("%s sendKeepAlive(%s)\r\n", getTimeStamp(), pktData);
    xSemaphoreGive(consoleSem);
  }
  if (xSemaphoreTake(tcpipSem, pdMS_TO_TICKS(TIMEOUT)) == pdTRUE) {
    if (pktData!= NULL) {
      if (wiCliConnected && client.write ((const uint8_t*) pktData, strlen(pktData)) < 0) wiCliConnected = false;
      if (wiCliConnected && client.write ((const uint8_t*) "\r\n", 2) < 0) wiCliConnected = false;
      // client.println (pktData);
      client.flush();
    }
    xSemaphoreGive(tcpipSem);
    if (showKeepAlive) {
      if (xSemaphoreTake(consoleSem, pdMS_TO_TICKS(TIMEOUT)) == pdTRUE) {
        if (pktData!= NULL) Serial.printf ("--> %s\r\n", pktData);
        xSemaphoreGive(consoleSem);
      }
    }
    if (diagIsRunning && xSemaphoreTake(diagPortSem, pdMS_TO_TICKS(TIMEOUT)) == pdTRUE) {
      if (!wiCliConnected) diagEnqueue ('p', (char*) "connection failed on: ", false);
      diagEnqueue ('p', (char*) "KA> ", false);
      diagEnqueue ('p', (char*) pktData, true);
      xSemaphoreGive(diagPortSem);
    }
  }
  else semFailed ("tcpipSem", __FILE__, __LINE__);
}

void resetKeepAlive()
{
  if (resetKeepAliveInd && cmdProtocol == WITHROT && keepAliveTimer != NULL) {
    xTimerReset( keepAliveTimer, 0 );
  }
}
#endif