Historia

Henry Gabryjelski 38bc618ee5 Float and better 3rd party library compatibility (#2534 ) * define as float (not double) * Avoid #define of 1 or 2 char symbols Having this file define 'A' and 'C' pollutes the global namespace, and causes conflicts with other libraries that also pollute the global namespace with short #defines. It's easier to fix this header. * unused variable warning		2022-02-09 09:46:54 +01:00
..
assets	…
readme.md	…
usermod_v2_battery_status_basic.h	Float and better 3rd party library compatibility (#2534 )	2022-02-09 09:46:54 +01:00

readme.md

🔋 Battery status/level Usermod 🔋

This Usermod allows you to monitor the battery level of your battery powered project.

You can see the battery level and voltage in the info modal.

For this to work the positive side of the (18650) battery must be connected to pin A0 of the d1mini/esp8266 with a 100k ohm resistor (see Useful Links).

If you have a esp32 board it is best to connect the positive side of the battery to ADC1 (GPIO32 - GPIO39)

Installation

define USERMOD_BATTERY_STATUS_BASIC in my_config.h

Basic wiring diagram

Define Your Options

USERMOD_BATTERY_STATUS_BASIC - define this (in my_config.h) to have this user mod included wled00\usermods_list.cpp
USERMOD_BATTERY_MEASUREMENT_PIN - defaults to A0 on esp8266 and GPIO32 on esp32
USERMOD_BATTERY_MEASUREMENT_INTERVAL - the frequency to check the battery, defaults to 30 seconds
USERMOD_BATTERY_MIN_VOLTAGE - minimum voltage of the Battery used, default is 2.6 (18650 battery standard)
USERMOD_BATTERY_MAX_VOLTAGE - maximum voltage of the Battery used, default is 4.2 (18650 battery standard)

All parameters can be configured at runtime using Usermods settings page.

Important ⚠️

Make sure you know your battery specification ! not every battery is the same !
Example:

Your battery specification table		Options you can define
Capacity	3500mAh 12,5 Wh
Minimum capacity	3350mAh 11,9 Wh
Rated voltage	3.6V - 3.7V
Charging end voltage	4,2V ± 0,05	`USERMOD_BATTERY_MAX_VOLTAGE`
Discharge voltage	2,5V	`USERMOD_BATTERY_MIN_VOLTAGE`
Max. discharge current (constant)	10A (10000mA)
max. charging current	1.7A (1700mA)
...	...	...
..	..	..

Specification from: Molicel INR18650-M35A, 3500mAh 10A Lithium-ion battery, 3.6V - 3.7V

Useful Links

Change Log

2021-09-02

added "Battery voltage" to info
added circuit diagram to readme
added MQTT support, sending battery voltage
minor fixes

2021-08-15

changed USERMOD_BATTERY_MIN_VOLTAGE to 2.6 volt as default for 18650 batteries
Updated readme, added specification table

2021-08-10

Created