WLED/usermods/Battery/battery_defaults.h at d1ec2c4aa96a9e4d9e61e4d4e2904015082070e3 · wled/WLED · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
#ifndef UMBDefaults_h
#define UMBDefaults_h

#include "wled.h"

// pin defaults
// for the esp32 it is best to use the ADC1: GPIO32 - GPIO39
// https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/peripherals/adc.html
#ifndef USERMOD_BATTERY_MEASUREMENT_PIN
  #ifdef ARDUINO_ARCH_ESP32
    #define USERMOD_BATTERY_MEASUREMENT_PIN 35
  #else //ESP8266 boards
    #define USERMOD_BATTERY_MEASUREMENT_PIN A0
  #endif
#endif

// The initial delay before the first battery voltage reading after power-on.
// This allows the voltage to stabilize before readings are taken, improving accuracy of initial reading.
#ifndef USERMOD_BATTERY_INITIAL_DELAY
  #define USERMOD_BATTERY_INITIAL_DELAY 10000 // (milliseconds)
#endif

// the frequency to check the battery, 30 sec
#ifndef USERMOD_BATTERY_MEASUREMENT_INTERVAL
  #define USERMOD_BATTERY_MEASUREMENT_INTERVAL 30000
#endif


/* Default Battery Type
 * 1 = Lipo
 * 2 = Lion
 * 3 = LiFePO4
 */
#ifndef USERMOD_BATTERY_DEFAULT_TYPE
  #define USERMOD_BATTERY_DEFAULT_TYPE 1
#endif

/*
 *
 *  Lithium polymer (Li-Po) defaults
 *
 */
#ifndef USERMOD_BATTERY_LIPO_MIN_VOLTAGE
  // LiPo "1S" Batteries should not be dischared below 3V !!
  #define USERMOD_BATTERY_LIPO_MIN_VOLTAGE 3.2f
#endif
#ifndef USERMOD_BATTERY_LIPO_MAX_VOLTAGE
  #define USERMOD_BATTERY_LIPO_MAX_VOLTAGE 4.2f
#endif

/*
 *
 *  Lithium-ion (Li-Ion) defaults
 *
 */
#ifndef USERMOD_BATTERY_LION_MIN_VOLTAGE
  // default for 18650 battery
  #define USERMOD_BATTERY_LION_MIN_VOLTAGE 2.6f
#endif
#ifndef USERMOD_BATTERY_LION_MAX_VOLTAGE
  #define USERMOD_BATTERY_LION_MAX_VOLTAGE 4.2f
#endif

/*
 *
 *  Lithium Iron Phosphate (LiFePO4) defaults
 *
 */
#ifndef USERMOD_BATTERY_LIFEPO4_MIN_VOLTAGE
  #define USERMOD_BATTERY_LIFEPO4_MIN_VOLTAGE 2.8f
#endif
#ifndef USERMOD_BATTERY_LIFEPO4_MAX_VOLTAGE
  #define USERMOD_BATTERY_LIFEPO4_MAX_VOLTAGE 3.6f
#endif

// the default ratio for the voltage divider
#ifndef USERMOD_BATTERY_VOLTAGE_MULTIPLIER
  #ifdef ARDUINO_ARCH_ESP32
    #define USERMOD_BATTERY_VOLTAGE_MULTIPLIER 2.0f
  #else //ESP8266 boards
    #define USERMOD_BATTERY_VOLTAGE_MULTIPLIER 4.2f
  #endif
#endif

#ifndef USERMOD_BATTERY_AVERAGING_ALPHA
  #define USERMOD_BATTERY_AVERAGING_ALPHA 0.1f
#endif

// offset or calibration value to fine tune the calculated voltage
#ifndef USERMOD_BATTERY_CALIBRATION
  #define USERMOD_BATTERY_CALIBRATION 0
#endif

// auto-off feature
#ifndef USERMOD_BATTERY_AUTO_OFF_ENABLED
  #define USERMOD_BATTERY_AUTO_OFF_ENABLED true
#endif

#ifndef USERMOD_BATTERY_AUTO_OFF_THRESHOLD
  #define USERMOD_BATTERY_AUTO_OFF_THRESHOLD 10
#endif

// low power indication feature
#ifndef USERMOD_BATTERY_LOW_POWER_INDICATOR_ENABLED
  #define USERMOD_BATTERY_LOW_POWER_INDICATOR_ENABLED true
#endif

#ifndef USERMOD_BATTERY_LOW_POWER_INDICATOR_PRESET
  #define USERMOD_BATTERY_LOW_POWER_INDICATOR_PRESET 0
#endif

#ifndef USERMOD_BATTERY_LOW_POWER_INDICATOR_THRESHOLD
  #define USERMOD_BATTERY_LOW_POWER_INDICATOR_THRESHOLD 20
#endif

#ifndef USERMOD_BATTERY_LOW_POWER_INDICATOR_DURATION
  #define USERMOD_BATTERY_LOW_POWER_INDICATOR_DURATION 5
#endif

// battery capacity in mAh (used for runtime estimation with INA226 current sensor)
#ifndef USERMOD_BATTERY_CAPACITY
  #define USERMOD_BATTERY_CAPACITY 3000
#endif

// battery types
typedef enum
{
  lipo=1,
  lion=2,
  lifepo4=3
} batteryType;

// used for initial configuration after boot
typedef struct bconfig_t
{
  batteryType type;
  float minVoltage;
  float maxVoltage;
  float voltage;          // current voltage
  int8_t level;           // current level
  float calibration;      // offset or calibration value to fine tune the calculated voltage
  float voltageMultiplier;
} batteryConfig;

#endif