Lamp-Da 0.1
A compact lantern project
Loading...
Searching...
No Matches
constants.h
Go to the documentation of this file.
1
5#ifndef SYSTEM_UTILS_CONSTANTS_H
6#define SYSTEM_UTILS_CONSTANTS_H
7
8#include <cmath>
9#include <cstdint>
10
11#ifdef USE_TINYUSB // For Serial when selecting TinyUSB
12#include <Adafruit_TinyUSB.h>
13#endif
14
15#include <stdint.h>
16
17#include "src/user/constants.h"
18
19namespace lampda {
20
22#define HARDWARE_VERSION_MAJOR 1
24#define HARDWARE_VERSION_MINOR 0
25
26// define hardware constants
27#if HARDWARE_VERSION_MAJOR == 1 && HARDWARE_VERSION_MINOR == 0
28#define IS_HARDWARE_1_0
29#endif
30#if HARDWARE_VERSION_MAJOR == 1 && HARDWARE_VERSION_MINOR == 1
31#define IS_HARDWARE_1_1
32#endif
33
36#define EXPECTED_FIRMWARE_VERSION_MAJOR 1
38#define EXPECTED_FIRMWARE_VERSION_MINOR 4
39
42static constexpr uint8_t BASE_SOFTWARE_VERSION_MAJOR = 1;
45static constexpr uint8_t BASE_SOFTWARE_VERSION_MINOR = 9;
46
47using byte = uint8_t;
48
49static constexpr uint8_t ADC_RES_EXP = 12;
50static const uint32_t ADC_MAX_VALUE = static_cast<uint32_t>(pow(2, ADC_RES_EXP));
51static constexpr float internalReferenceVoltage = 3.0f;
52
53// watchdog ids
54static constexpr uint8_t USER_WATCHDOG_ID = 0;
55static constexpr uint8_t POWER_WATCHDOG_ID = 2;
56
58namespace physical_constants {
59
61static constexpr uint8_t batterySeriesCount = 3;
63static constexpr uint8_t batteryParellelCount = 1;
64
65// define position of imu to the circuit center
66static constexpr float imuToCircuitRotationX_rad = 0.0f * c_degreesToRadians;
67static constexpr float imuToCircuitRotationY_rad = 0.0f * c_degreesToRadians;
68#ifdef IS_HARDWARE_1_0
69static constexpr float imuToCircuitRotationZ_rad = -9.0f * c_degreesToRadians;
70#else
71static constexpr float imuToCircuitRotationZ_rad = -4 * c_degreesToRadians;
72#endif
73
74static constexpr float imuToCircuitPositionX_m = 8.915f / 1000.0f;
75static constexpr float imuToCircuitPositionY_m = -5.769f / 1000.0f;
76static constexpr float imuToCircuitPositionZ_m = 0.0f / 1000.0f;
77
78// battery specific constants
79static constexpr float batteryChargeC_Rate = 0.33f;
80static constexpr float batteryDischargeC_Rate = 1.0f;
81static constexpr uint32_t batteryCapacity_mAH = batteryParellelCount * 4850;
82
83static constexpr uint16_t minLiionVoltage_mV = 2500;
84static constexpr uint16_t typicalLiionVoltage_mV = 3630;
85static constexpr uint16_t maxLiionVoltage_mV = 4200;
86
87// safe single cell voltage to use
88static constexpr uint16_t minSafeLiionVoltage_mV = 3100;
89static constexpr uint16_t maxSafeLiionVoltage_mV = 4100;
90
91static constexpr uint16_t minSingularBatteryVoltage_mV =
92 static_cast<uint16_t>(minLiionVoltage_mV * 0.9f);
93static constexpr uint16_t maxSingularBatteryVoltage_mV =
94 static_cast<uint16_t>(maxLiionVoltage_mV * 1.01f);
95
96// max temp setting
97static constexpr float maxSystemTemp_c = 70.0f;
98static constexpr float criticalSystemTemp_c = 80.0f;
99
100// battery settings
101static constexpr uint16_t batteryCritical = 300;
102static constexpr uint16_t batteryLow = 500;
103
104static constexpr uint32_t maxVbusWireCurrent_mA = 3000;
105static constexpr uint32_t maxBatteryConnectorCurrent_mA = 3000;
106static constexpr uint32_t maxChargerCurrent_mA = 6000;
107static constexpr uint32_t maxVbusGateCurrent_mA = 5000;
108static constexpr uint32_t maxOutputGateCurrent_mA = 35000;
109
126
127// physical parameters computations
129static constexpr float totalCons_Watt = consWattByMeter * ledStripLength_mm / 1000.0f;
131static constexpr float maxStripConsumption_A = 1000.0f * totalCons_Watt / stripInputMaxVoltage_mV;
132
134static constexpr uint32_t batteryMaxChargeCurrent_mA =
135 static_cast<uint32_t>(batteryChargeC_Rate * batteryCapacity_mAH); // mA
138static constexpr uint32_t batteryEndOfChargeCurrent_mA = batteryCapacity_mAH / 20; // mA
140static constexpr uint32_t batteryMaxDischargeCurrent_mA =
141 static_cast<uint32_t>(batteryDischargeC_Rate * batteryCapacity_mAH); // mA
144
145// asserts
146static_assert(maxSystemTemp_c < criticalSystemTemp_c, "max system temp must be less than critical temp");
147
148} // namespace physical_constants
149
151using brightness_t = uint16_t;
152namespace brightness {
155static constexpr brightness_t absoluteMinimumBrightness = 0;
156
157static_assert(absoluteMinimumBrightness < absoluteMaximumBrightness);
158
159// min brightness is always zero
160} // namespace brightness
161
166inline bool is_cell_voltage_valid(const uint16_t cellVoltage_mv)
167{
168 return
169 // minimum limit is not a hard stop, battery can be deeply discharged
170 // cellVoltage_mv > minSingularBatteryVoltage_mV &&
172}
173
174} // namespace lampda
175
176#endif
static constexpr uint16_t maxSingularBatteryVoltage_mV
with added margins to avoid wrong detection
Definition: constants.h:93
static constexpr uint32_t maxBatteryConnectorCurrent_mA
maximum current that the USB-C wires can carry
Definition: constants.h:105
static constexpr uint16_t batteryCritical
in % *100, critical battery level
Definition: constants.h:101
static constexpr float batteryChargeC_Rate
Maximum charge rate.
Definition: constants.h:79
static constexpr uint8_t batterySeriesCount
number of batteries in series for this model
Definition: constants.h:61
static constexpr uint32_t batteryMaxDischargeCurrent_mA
Battery maximum discharge current, in milliAmps.
Definition: constants.h:140
static constexpr uint16_t maxLiionVoltage_mV
Absolute maximum allowed Li-ion voltage.
Definition: constants.h:85
static constexpr uint16_t batteryMaxVoltage_mV
max voltage of a single li-ion cell
Definition: constants.h:117
static constexpr float batteryDischargeC_Rate
Typical discharge rate.
Definition: constants.h:80
static constexpr uint16_t batteryLow
in % *100, low battery level
Definition: constants.h:102
static constexpr uint32_t maxVbusWireCurrent_mA
maximum current that the USB-C wires can carry
Definition: constants.h:104
static constexpr float maxStripConsumption_A
Maximum led strip current usage, in Amps.
Definition: constants.h:131
static constexpr float criticalSystemTemp_c
absolute maximum microcontroler temperature, in degrees
Definition: constants.h:98
static constexpr uint32_t batteryEndOfChargeCurrent_mA
End of charge current (C/20), in milliAmps: in constant voltage phase, the charge is done below this ...
Definition: constants.h:138
static constexpr uint8_t batteryParellelCount
number of batteries in parallel for this model
Definition: constants.h:63
static constexpr uint32_t batteryMaxChargeCurrent_mA
Battery maximum charge current, in milliAmps.
Definition: constants.h:134
static constexpr uint32_t batteryTypicalPower_mWH
Battery standard power, in milliWatt*Hours.
Definition: constants.h:143
static constexpr uint16_t batteryMaxVoltageSafe_mV
max voltage of a li-ion cell to maximise lifetime
Definition: constants.h:119
static constexpr float totalCons_Watt
Total maximum power usage of the led strip.
Definition: constants.h:129
static constexpr uint16_t batteryTypicalVoltageSafe_mV
typical pack voltage
Definition: constants.h:121
static constexpr uint16_t batteryMinVoltage_mV
min voltage of a single li-ion cell
Definition: constants.h:123
static constexpr uint32_t maxOutputGateCurrent_mA
maximum current that the output gate can handle
Definition: constants.h:108
static constexpr float maxSystemTemp_c
maximum microcontroler temperature, in degrees
Definition: constants.h:97
static constexpr uint32_t batteryCapacity_mAH
Battery capacity, in mA*hours.
Definition: constants.h:81
static constexpr uint32_t maxVbusGateCurrent_mA
maximum current that the vbus gate can handle
Definition: constants.h:107
static constexpr uint16_t maxSafeLiionVoltage_mV
maximum allowed li-ion voltage safe zone
Definition: constants.h:89
static constexpr uint16_t minSingularBatteryVoltage_mV
with added margins to avoid wrong detection
Definition: constants.h:91
static constexpr uint16_t typicalLiionVoltage_mV
standard 50% charge Li-ion voltage
Definition: constants.h:84
static constexpr uint32_t maxChargerCurrent_mA
maximum current that the power circuit can handle
Definition: constants.h:106
static constexpr uint16_t minLiionVoltage_mV
minimum Li-ion voltage
Definition: constants.h:83
static constexpr uint16_t batteryMinVoltageSafe_mV
min voltage of a li-ion cell to maximise lifetime
Definition: constants.h:125
static constexpr uint16_t minSafeLiionVoltage_mV
minimum allowed li-ion voltage safe zone
Definition: constants.h:88
Program scope.
Definition: control_fixed_modes.hpp:14
bool is_cell_voltage_valid(const uint16_t cellVoltage_mv)
check battery cell voltage against min/max limits
Definition: constants.h:166
static constexpr uint8_t USER_WATCHDOG_ID
user thread watchdog
Definition: constants.h:54
static constexpr uint8_t BASE_SOFTWARE_VERSION_MINOR
Base minor software version, common to all systems. increment for every release.
Definition: constants.h:45
static constexpr uint8_t BASE_SOFTWARE_VERSION_MAJOR
Base major software version, common to all systems. increment for every release.
Definition: constants.h:42
static constexpr float c_degreesToRadians
convert degrees to radians
Definition: constants.h:44
static const uint32_t ADC_MAX_VALUE
corresponding ADC max value
Definition: constants.h:50
static constexpr float internalReferenceVoltage
internal voltage reference
Definition: constants.h:51
static constexpr uint8_t POWER_WATCHDOG_ID
power thread watchdog
Definition: constants.h:55
static constexpr uint8_t ADC_RES_EXP
resolution of the ADC, in bits (can be 8, 10, 12 or 14)
Definition: constants.h:49
uint16_t brightness_t
Define the type of the brightness parameters.
Definition: constants.h:151
static constexpr brightness_t absoluteMaximumBrightness
Maximum brightness value.
Definition: constants.h:154
User defined constants, relative to specific lamp types.