SprintTimer.h

Go to the documentation of this file.

 
#ifndef _DOVES_SPRINT_TIMER_H
#define _DOVES_SPRINT_TIMER_H
 
#include <Arduino.h>
#include "GeoMath.h"
#include "CrossingEngine.h"
#include "DovesLapTimer.h"  // DIR_UNKNOWN, GPS_* validation constants
 
// The maximum number of split (sector) lines between start and finish.
#define SPRINT_MAX_SPLITS  2
 
class SprintTimer {
public:
  SprintTimer(double crossingThresholdMeters = 7, Stream *debugSerial = NULL);
 
  int loop(double currentLat, double currentLng, float currentAltitudeMeters, float currentSpeedKnots);
  void updateCurrentTime(unsigned long currentTimeMilliseconds);
  void reset();
 
  // Configuration
 
  void setStartLine(double pointALat, double pointALng, double pointBLat, double pointBLng);
  void setFinishLine(double pointALat, double pointALng, double pointBLat, double pointBLng);
  void setSector2Line(double pointALat, double pointALng, double pointBLat, double pointBLng);
  void setSector3Line(double pointALat, double pointALng, double pointBLat, double pointBLng);
 
  bool isStartLineConfigured() const;
  bool isFinishLineConfigured() const;
  bool areSectorLinesConfigured() const;
 
  void forceLinearInterpolation();
  void forceCatmullRomInterpolation();
 
  // Run-native surface
 
  bool isRunActive() const;
  int getRuns() const;
  int getCancelledRunCount() const;
  unsigned long getCurrentRunTime() const;
  unsigned long getLastRunTime() const;
  unsigned long getBestRunTime() const;
  int getBestRunNumber() const;
  float getCurrentRunDistance() const;
  float getLastRunDistance() const;
  float getBestRunDistance() const;
 
  // Duck-typed DovesLapTimer surface (laps == runs)
 
  bool getRaceStarted() const;
  bool getCrossing() const;
  int getLaps() const { return getRuns(); }
  unsigned long getCurrentLapTime() const { return getCurrentRunTime(); }
  unsigned long getLastLapTime() const { return getLastRunTime(); }
  unsigned long getBestLapTime() const { return getBestRunTime(); }
  int getBestLapNumber() const { return getBestRunNumber(); }
  float getCurrentLapDistance() const { return getCurrentRunDistance(); }
  float getLastLapDistance() const { return getLastRunDistance(); }
  float getBestLapDistance() const { return getBestRunDistance(); }
  float getTotalDistanceTraveled() const;
  float getPaceDifference() const;
  float getCurrentSpeedKmh() const;
  float getCurrentSpeedMph() const;
 
  int getCurrentSector() const;
  unsigned long getCurrentLapSector1Time() const;
  unsigned long getCurrentLapSector2Time() const;
  unsigned long getCurrentLapSector3Time() const;
  unsigned long getBestSector1Time() const;
  unsigned long getBestSector2Time() const;
  unsigned long getBestSector3Time() const;
  int getBestSector1LapNumber() const;
  int getBestSector2LapNumber() const;
  int getBestSector3LapNumber() const;
  unsigned long getOptimalLapTime() const;
 
  unsigned int getRejectedCrossingCount() const;
 
  // Direction (not applicable point-to-point)
  int getDirection() const { return DIR_UNKNOWN; }
  bool isDirectionResolved() const { return false; }
 
private:
#ifdef DOVES_DISABLE_DEBUG
  // Compile-time debug kill switch: the runtime _serial null-check still
  // keeps every debug string and print call-site in flash on production
  // builds that never attach a debug Stream. Defining DOVES_DISABLE_DEBUG
  // (e.g. -DDOVES_DISABLE_DEBUG in build flags) replaces the debug
  // templates with empty inlines so the compiler drops it all — several
  // KB on a fully-featured firmware. Debug behavior is unchanged when
  // the macro is not defined.
  template<typename... Args> void debug_print(Args&&...) {}
  template<typename... Args> void debug_println(Args&&...) {}
#else
  template<typename... Args>
  void debug_print(Args&&... args) {
    if(_serial) { _serial->print(std::forward<Args>(args)...); }
  }
  template<typename... Args>
  void debug_println(Args&&... args) {
    if(_serial) { _serial->println(std::forward<Args>(args)...); }
  }
#endif
 
  int _expectedSegments() const;
  int _segmentClosedBySector(int sectorLabel) const;
  void _handleStartCrossing(unsigned long crossingTime, double crossingOdometer);
  void _handleFinishCrossing(unsigned long crossingTime, double crossingOdometer);
  void _handleSplitCrossing(int sectorLabel, unsigned long crossingTime);
  void _updateBestSegments();
 
  Stream *_serial;
  double _crossingThresholdMeters;
 
  // One engine per line: independent buffers, so zones may overlap and all
  // lines stay hot on every fix. This is the deliberate opposite of
  // DovesLapTimer's shared-buffer design — see the header comment.
  CrossingEngine _startEngine;
  CrossingEngine _finishEngine;
  CrossingEngine _sector2Engine;
  CrossingEngine _sector3Engine;
 
  // Line endpoints + configuration + in-zone flags
  double _startALat = 0, _startALng = 0, _startBLat = 0, _startBLng = 0;
  double _finishALat = 0, _finishALng = 0, _finishBLat = 0, _finishBLng = 0;
  double _sector2ALat = 0, _sector2ALng = 0, _sector2BLat = 0, _sector2BLng = 0;
  double _sector3ALat = 0, _sector3ALng = 0, _sector3BLat = 0, _sector3BLng = 0;
  bool _startLineConfigured = false;
  bool _finishLineConfigured = false;
  bool _sector2LineConfigured = false;
  bool _sector3LineConfigured = false;
  bool _crossingStart = false;
  bool _crossingFinish = false;
  bool _crossingSector2 = false;
  bool _crossingSector3 = false;
 
  // Vehicle state (same intake pipeline as DovesLapTimer::loop)
  unsigned long _millisecondsSinceMidnight = 0;
  float _totalDistanceTraveled = 0;
  double _positionPrevLat = 0;
  double _positionPrevLng = 0;
  float _positionPrevAlt = 0;
  bool _firstPositionReceived = false;
  int _consecutiveJumpCount = 0;
  float _currentSpeedKmh = 0;
  crossingPointBufferEntry _prevFix = {0, 0, 0, 0, 0};
  bool _hasPrevFix = false;
 
  // Run state
  bool _raceStarted = false;   // any run ever started this session
  bool _runActive = false;     // RUNNING vs WAITING
  int _runs = 0;
  int _cancelledRuns = 0;
  unsigned long _currentRunStartTime = 0;
  double _currentRunOdometerStart = 0;
  unsigned long _lastRunTime = 0;
  float _lastRunDistance = 0;
  unsigned long _bestRunTime = 0;
  float _bestRunDistance = 0;
  int _bestRunNumber = 0;
 
  // Segment (split) state for the run in progress
  int _currentSegment = 0;             // 0 = WAITING, 1..N while RUNNING
  unsigned long _segmentStartTime = 0;
  bool _segmentOrderValid = true;
  unsigned long _currentRunSegTime[SPRINT_MAX_SPLITS + 1] = {0, 0, 0};
 
  // Best segment times across runs (valid, in-order runs only)
  unsigned long _bestSegTime[SPRINT_MAX_SPLITS + 1] = {0, 0, 0};
  int _bestSegRunNumber[SPRINT_MAX_SPLITS + 1] = {0, 0, 0};
};
 
#endif