Plotter.h

/*
 * Plotter.h
 *
 * (c) 2025 Sofian Audry        :: info(@)sofianaudry(.)com
 * (c) 2025 Thomas O Fredericks :: tof(@)t-o-f(.)info
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
#ifndef PQ_PLOTTER_H_
#define PQ_PLOTTER_H_
 
#include "PqCore.h"
#include "PlotterFormat.h"
#include "pq_serial.h"
 
namespace pq {
 
enum PlotterFormatPreset {
  PLOTTER_DEFAULT = 0,
  PLOTTER_CSV,
  PLOTTER_JSON
};
 
class Plotter : public Unit {
public:
  Plotter(unsigned long baudRate,
          const char* labels = nullptr,
          Engine& engine = Engine::primary());
 
  Plotter(SerialType& serial,
          unsigned long baudRate,
          const char* labels = nullptr,
          Engine& engine = Engine::primary());
 
  explicit Plotter(Print& out,
                   const char* labels = nullptr,
                   Engine& engine = Engine::primary());
 
  static PlotterFormat formatFromPreset(PlotterFormatPreset preset, const char* labelsSchema = nullptr);
 
  const char* labels() const { return _labels; }
 
  void format(PlotterFormatPreset preset);
 
  void format(PlotterFormat format);
 
  PlotterFormat format() { return _format; }
 
  void precision(uint8_t digits) { _digits = digits; }
 
  uint8_t precision() const { return _digits; }
 
  float put(float value) override;
 
  float get() override { return _lastValue; }
 
  void beginPlot();
 
  void endPlot();
 
protected:
  void begin() override;
  void step() override;
 
private:
  // Output backend
  Print* _out = nullptr;
 
  // If output is serial, we begin it in begin()
  SerialType* _serial = nullptr;
  unsigned long _baudRate = 0;
 
  // Mode & format
  PlotterFormat _format;
 
  // Labels schema (comma-separated)
  const char* _labels = nullptr;
  uint16_t _labelCount = 0;
  bool _headerPrinted = false;
 
  // Numeric precision
  uint8_t _digits = PLAQUETTE_PRINT_DEFAULT_DIGITS;
 
  // Row state.
  bool _rowOpen = false;
  uint16_t _valueIndex = 0;
 
  float _lastValue = 0.0f;
 
  // Plot state.
  bool _plotOpen = true;
 
  // Scheduling flags.
  bool _scheduleBeginPlot = false;
  bool _scheduleEndRow = false;
 
private:
  // Manually ends the current row (prints rowEnd if a row is open).
  void _endRow();
 
  // Internal helpers
  void _rebuildFormat(PlotterFormatPreset preset);
  void _ensureHeader();
  void _openRowIfNeeded();
  void _closeRowIfOpen(bool printEndRow);
 
  // Print value to output.
  void _printValue(float value);
 
  // Label parsing helpers (comma-separated schema)
  static bool _isSpace(char c);
  static LabelView _trimSpaces(const char* start, const char* end);
 
  uint16_t _countLabels(const char* schema) const;
  LabelView _labelAt(uint16_t index) const;
};
 
} // namespace pq
 
#endif // PQ_PLOTTER_H_