Files
esphome-axp2101/README.md
Ludovic BOUÉ 4c5c859321 Add link to Core2 V1.1 doc
Add link to Core2 V1.1 doc
2024-01-27 15:12:50 +01:00

60 lines
1.7 KiB
Markdown

# ESPHome AXP2101 Component
This custom component implements AXP2101 support for the [M5Stack Core2 V1.1](https://docs.m5stack.com/en/core/Core2%20v1.1), building on top of https://github.com/martydingo/esphome-axp192 and https://github.com/lewisxhe/XPowersLib. The [Core2 V1.1](https://docs.m5stack.com/en/core/Core2%20v1.1) uses an AXP2101 while the older Core2 uses an AXP192.
*This component does not offer full functionality yet, it only covers part of the AXP2101 features and is not fully tested.*
## Installation
Copy the components to a custom_components directory next to your .yaml configuration file, or include directly from this repository.
## Configuration
Sample configurations are found in the `/sample-config` folder.
This component adds a new model configuration to the AXP2101 sensor which determines which registers are needed for each device. The only available model is `model: M5CORE2`.
### Include AXP2101 Component
```yaml
external_components:
- source: github://stefanthoss/esphome-axp2101
components: [ axp2101 ]
```
### M5Stack Core2 V1.1
```yaml
sensor:
- platform: axp2101
model: M5CORE2
address: 0x34
i2c_id: bus_a
update_interval: 30s
brightness: 75%
battery_voltage:
name: "Battery Voltage"
battery_level:
name: "Battery Level"
battery_charging:
name: "Battery Charging"
```
The display component required for the M5Stack Core2 V1.1 is as follows:
```yaml
font:
- file: "gfonts://Roboto"
id: roboto
size: 24
display:
- platform: ili9xxx
model: M5STACK
dimensions: 320x240
cs_pin: GPIO5
dc_pin: GPIO15
lambda: |-
it.print(0, 0, id(roboto), "Hello World");
```