BionxControl/bcdata.h

/***************************************************************************

 BionxControl
 Copyright © 2025 christoph holzheuer
 christoph.holzheuer@gmail.com

 Using:

 BigXionFlasher USB V 0.2.4 rev. 97
 © 2011-2013 by Thomas Koenig <info@bigxionflasher.org>
 @see www.bigxionflasher.org

 Bionx Bike Info
 © 2018 Thorsten Schmidt (tschmidt@ts-soft.de)
 @see www.ts-soft.de

 mhs_can_drv.c 3.00
 © 2011 - 2015 by MHS-Elektronik GmbH & Co. KG, Germany
 Demlehner Klaus, info@mhs-elektronik.de
 @see www.mhs-elektronik.de

 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.
 @see https://github.com/bikemike/bionx-bikeinfo

 ***************************************************************************/


#ifndef BCDATA_H
#define BCDATA_H

#include <QObject>
#include <QString>
#include <QList>
#include <QVariant>

#include <bc.h>


/*
  Werte haben verschiedene Längen (1,2 und 4 Byte) und werder auf unterschiedliche Art und Weise
  ausgelesen und geschrieben (Siehe ODO). Sin können also Wert-Typen zugeordnet werden. Ein Werttyp
  lässet über eine ID identifizieren, die mit der phyikalische Einheit des Wertes überschneiden kann,
  aber nicht muss: : Km/h, kWh, ODO ... bilden eigene Typen, SoC, Assistence Level sind auch eigene Typen,
  Teilen sich jedoch die Einheit '%'.

  Das ist natürlich annalog zu den ItemTypes:
  - ein Value hat einen ValueType, der bestimmt folgendes:
    - long or short or quad
    - unit (mm, km/h, odo ... )
    -
*/



class BCAbstractTransmitter
{

public:

  //
  virtual bcdata_t readRawValue( BCDevice::ID deviceID_, BC::ID registerID_ ) const = 0;
  virtual void     writeRawValue( BCDevice::ID deviceID_, BC::ID registerID_, uint8_t value_ ) const = 0;
};


using optDouble = std::optional<double>;

struct BCDataType
{

  Q_GADGET

public:

  enum class TypeID : uint8_t
  {
    Invalid = 0x0,
    Text,
    Number,
    Float,
    Byte,
    Word,
    Quad,
    Percent,
    KWh,
    Watt,
    Km,
    Kmh,
    Mm,
    Sec,
    SoC,
    Odo,
    Assist,
    AssistFac,
    Date
  };
  Q_ENUM(TypeID)

  BCDataType();
  BCDataType( TypeID ID_, QString unitLabel_="", optDouble factor_=std::nullopt, optDouble min_=std::nullopt, optDouble max_= std::nullopt );

  TypeID        ID{TypeID::Invalid};
  QString       unitLabel;
  optDouble     factor;
  optDouble     min;
  optDouble     max;

};

// really needed?
using BCDataTypeCRef = std::optional<std::reference_wrapper<const BCDataType>>;


class BCData
{

public:

  BCData( const BCDataType& valueType_, BCDevice::ID deviceID_, BC::ID registerID_ );
  
  void readRawValue( const BCAbstractTransmitter& transmitter ) const;
  void writeRawValue( const BCAbstractTransmitter& transmitter ) const;
  // void reset()

  BCDataTypeCRef valueType;
  BCDevice::ID   deviceID{BCDevice::ID::Invalid};
  BC::ID         registerID{BC::ID::Invalid};
  int            rowInModel{-1};
  QString        label;
  QVariant       value;
  QVariant       defaultValue;

  bool           inSync{false};
  bool           readOnly{false};

  mutable std::optional<bcdata_t> rawValue;



};
Q_DECLARE_METATYPE(BCData*)


struct BCDataParams
{
  QString ID;
  QString Label;
  QString Default;
  QString UnitType;
};

// abbreviations:
//   SOC = State Of Charge
//   LMD = Last Measured Discharge
//   NIP = ?

/*

Needed ?
#include <type_traits>

template <typename E>
constexpr auto to_u(E e) noexcept {
 return static_cast<std::underlying_type_t<E>>(e);
}
*/

using BCDataList = QVector<BCData>;


#endif // BCDATA_H