constants.h

Go to the documentation of this file.

 
#ifndef SYSTEM_UTILS_CONSTANTS_H
#define SYSTEM_UTILS_CONSTANTS_H
 
#include <cmath>
#include <cstdint>
 
#ifdef USE_TINYUSB // For Serial when selecting TinyUSB
#include <Adafruit_TinyUSB.h>
#endif
 
#include <stdint.h>
 
#include "src/user/constants.h"
 
namespace lampda {
 
#define HARDWARE_VERSION_MAJOR 1
#define HARDWARE_VERSION_MINOR 0
 
// define hardware constants
#if HARDWARE_VERSION_MAJOR == 1 && HARDWARE_VERSION_MINOR == 0
#define IS_HARDWARE_1_0
#endif
#if HARDWARE_VERSION_MAJOR == 1 && HARDWARE_VERSION_MINOR == 1
#define IS_HARDWARE_1_1
#endif
 
#define EXPECTED_FIRMWARE_VERSION_MAJOR 1
#define EXPECTED_FIRMWARE_VERSION_MINOR 3
 
static constexpr uint8_t BASE_SOFTWARE_VERSION_MAJOR = 1;
static constexpr uint8_t BASE_SOFTWARE_VERSION_MINOR = 8;
 
using byte = uint8_t;
 
static constexpr uint8_t ADC_RES_EXP = 12; 
static const uint32_t ADC_MAX_VALUE = static_cast<uint32_t>(pow(2, ADC_RES_EXP)); 
static constexpr float internalReferenceVoltage = 3.0f;                           
 
static constexpr uint8_t batteryCount = 3;
 
// define position of imu to the circuit center
static constexpr float imuToCircuitRotationX_rad = 0.0f * c_degreesToRadians;
static constexpr float imuToCircuitRotationY_rad = 0.0f * c_degreesToRadians;
#ifdef IS_HARDWARE_1_0
static constexpr float imuToCircuitRotationZ_rad = -9.0f * c_degreesToRadians;
#else
static constexpr float imuToCircuitRotationZ_rad = -4 * c_degreesToRadians;
#endif
 
static constexpr float imuToCircuitPositionX_m = 8.915f / 1000.0f;
static constexpr float imuToCircuitPositionY_m = -5.769f / 1000.0f;
static constexpr float imuToCircuitPositionZ_m = 0.0f / 1000.0f;
 
// battery specific constants
static constexpr float batteryChargeC_Rate = 0.33f;   
static constexpr float batteryDischargeC_Rate = 1.0f; 
static constexpr uint32_t batteryCapacity_mAH = 4850; 
 
static constexpr uint16_t minLiionVoltage_mV = 2500;     
static constexpr uint16_t typicalLiionVoltage_mV = 3630; 
static constexpr uint16_t maxLiionVoltage_mV = 4200;     
 
// safe single cell voltage to use
static constexpr uint16_t minSafeLiionVoltage_mV = 3100; 
static constexpr uint16_t maxSafeLiionVoltage_mV = 4100; 
 
static constexpr uint16_t minSingularBatteryVoltage_mV =
        static_cast<uint16_t>(minLiionVoltage_mV * 0.9f); 
static constexpr uint16_t maxSingularBatteryVoltage_mV =
        static_cast<uint16_t>(maxLiionVoltage_mV * 1.01f); 
 
// max temp setting
static constexpr float maxSystemTemp_c = 70.0f;      
static constexpr float criticalSystemTemp_c = 80.0f; 
 
// battery settings
static constexpr uint16_t batteryCritical = 300; 
static constexpr uint16_t batteryLow = 500;      
 
// watchdog ids
static constexpr uint8_t USER_WATCHDOG_ID = 0;  
static constexpr uint8_t POWER_WATCHDOG_ID = 2; 
 
static constexpr float loopDeltaTime = MAIN_LOOP_UPDATE_PERIOD_MS / 1000.0f;
 
static constexpr uint16_t batteryMaxVoltage_mV = maxLiionVoltage_mV * batteryCount;
static constexpr uint16_t batteryMaxVoltageSafe_mV = maxSafeLiionVoltage_mV * batteryCount;
static constexpr uint16_t batteryTypicalVoltageSafe_mV = typicalLiionVoltage_mV * batteryCount;
static constexpr uint16_t batteryMinVoltage_mV = minLiionVoltage_mV * batteryCount;
static constexpr uint16_t batteryMinVoltageSafe_mV = minSafeLiionVoltage_mV * batteryCount;
 
// physical parameters computations
static constexpr float totalCons_Watt = consWattByMeter * ledStripLength_mm / 1000.0f;
static constexpr float maxStripConsumption_A = 1000.0f * totalCons_Watt / stripInputMaxVoltage_mV;
 
static constexpr uint32_t batteryMaxChargeCurrent_mA =
        static_cast<uint32_t>(batteryChargeC_Rate * batteryCapacity_mAH); // mA
static constexpr uint32_t batteryMaxDischargeCurrent_mA =
        static_cast<uint32_t>(batteryDischargeC_Rate * batteryCapacity_mAH); // mA
static constexpr uint32_t batteryTypicalPower_mWH = batteryCapacity_mAH * batteryTypicalVoltageSafe_mV / 1000;
 
inline bool is_cell_voltage_valid(const uint16_t cellVoltage_mv)
{
  return
          // minimum limit is not a hard stop, battery can be deeply discharged
          // cellVoltage_mv > minSingularBatteryVoltage_mV &&
          cellVoltage_mv < maxSingularBatteryVoltage_mV;
}
 
using brightness_t = uint16_t;
namespace brightness {
static constexpr brightness_t absoluteMaximumBrightness = 1024;
// min brightness is always zero
} // namespace brightness
 
// asserts
static_assert(maxSystemTemp_c < criticalSystemTemp_c, "max system temp must be less than critical temp");
 
} // namespace lampda
 
#endif