Support for ILI9342C display (M5 stack Core 2 display)

[sj3fk3]

Describe the problem you have/What new integration you would like The dev branch currently does support ILI9341 (but) the new M5Stack Core 2 device uses the slightly different ILI9342C display drivers. I would very much like to use the M5stack Core2 with ESPhome.

From what I have read, it is really similar to the ILI9341 with some some small changes.

http://www.buydisplay.com/download/ic/ILI9342.pdf

Please describe your use case for this integration and alternatives you've tried:

I cannot get the M5stack Core 2 display to work with the ILI9341 settings, it might need some slight changes to also support ILI9342C or it might also be that the changes from the old m5stack to the "core 2" are interfering. Notably setting of the display led is not done by a gpio pin, but by an AXP192?

https://docs.m5stack.com/#/en/core/core2?id=pinmap

Additional context This discussion could help: https://www.eevblog.com/forum/microcontrollers/2-4-tft-screen-ili9342-problems-help-me-please-!/

and: https://forum.arduino.cc/index.php?topic=473885.0

[kelchm]

I would love to see this as well. I don't have time at the moment, but may take a look at getting this implemented at some point in the next few weeks.

[sj3fk3]

I would love to see this as well. I don't have time at the moment, but may take a look at getting this implemented at some point in the next few weeks.

Do you have a Core 2? I'd be willing to ship you one if needed

[marcvl64]

I think it's more than just the display. The Core 2 also has a touch controller.

[dummylabs]

Yes, the support of ILI9342C would be highly desirable maybe even without a touch screen as a first step.

[richardklingler]

Planned as one of the next components as I have some m5core2 here....

Not on the top list...but it also requires AXP PMIOC support as some of the control lines for the display run over this PMIC chip...

[scargill]

Would be wonderful to have Core2 support as its a very neat boxed product ready to go... any chance of this in the near future? Tasmota now has the display part of this but not the AXP PMIOC...

[martydingo]

+1 for support for AXP 192, the various libraries (custom_components) I have searched and tested across github & gitlab all result in odd and unexpected behaviour.

Without this, half the functionality of the M5Stack Core2, M5Stick-C (and the respective PLUS model), and perhaps some other M5Stack boards, is completely missing, which makes the entire platform unusable.

The M5Stack line of products seem to be making microelectronics more accessible to the general public, it really does make a lot of sense to add support

[sj3fk3]

Could not agree more. It would be very nice when Nabu Casa and M5Core would do a joint venture. IMHO it's the missing link.

[granvillebarker]

I think the main issue is the reset for the display on the Core2 is done on a GPIO line of the axp192 instead of the esp32, so there needs to be some way for the display functions to reset the display via the axp192. I've been able to take some axp192 m5 stick code and alter it to power up the display, power the motor on and off, as well as send resets to the display, but I am not sure how to get the existing display library to use the axp192 code to reset the display. In looking at the aurdino library that works with the core2 display, they appear to be using ili9341 library with this display other than the reset method.

[trunneml]

+1 for M5Stack Core 2 support

[granvillebarker]

I've recently been able to get the core2 to work using the standard ili9341 driver and a custom axp192 component, but it only works from power up. Any reboot display is lost.

[trunneml]

I've recently been able to get the core2 to work using the standard ili9341 driver and a custom axp192 component, but it only works from power up. Any reboot display is lost.

Could you share your code? I'm currently trying the same. 😀

[cmet7]

There's a custom axp192 component on gitlab that works with the M5 Stick C Plus. Seems to work well.

https://gitlab.com/geiseri/esphome_extras/-/tree/main/components/axp192

[trunneml]

@granvillebarker I tried the turn on the display but failed. Could you share your axp192 component?

[tuupola]

I think the main issue is the reset for the display on the Core2 is done on a GPIO line of the axp192 instead of the esp32, so there needs to be some way for the display functions to reset the display via the axp192.

This is an annoyance with Core2. However the hard reset does not necessarily need be in the display functions. You can do it while initialising the board and then later do only soft reset in the display functions. This is not optimal but atleast there is no need to add axp192 dependency to the display functions.

[martydingo]

I think the main issue is the reset for the display on the Core2 is done on a GPIO line of the axp192 instead of the esp32, so there needs to be some way for the display functions to reset the display via the axp192.

This is an annoyance with Core2. However the hard reset does not necessarily need be in the display functions. You can do it while initialising the board and then later do only soft reset in the display functions. This is not optimal but atleast there is no need to add axp192 dependency to the display functions.

I do believe the obstacle is the path, and the obstacle is adding in support for the AXP192 modules, so it can interface with other modules. We shouldn't be trying to add in code for the AXP192 across loads of modules, rather modules should be able to invoke the AXP192 module to achieve their respective ends.

[granvillebarker]

I do believe the obstacle is the path, and the obstacle is adding in support for the AXP192 modules, so it can interface with other modules. We shouldn't be trying to add in code for the AXP192 across loads of modules, rather modules should be able to invoke the AXP192 module to achieve their respective ends.

I've seen where an axp192 module is in the works by one of the devs, but I don't think that has anything to do with the display issues. The ili9341 driver works for me, if you power the module off and back on, but not if the soft reboots or the reset button is pressed, example on my github. Other projects like openhasp work, so it's gotta be something simple.

[martydingo]

I do believe the obstacle is the path, and the obstacle is adding in support for the AXP192 modules, so it can interface with other modules. We shouldn't be trying to add in code for the AXP192 across loads of modules, rather modules should be able to invoke the AXP192 module to achieve their respective ends.

I've seen where an axp192 module is in the works by one of the devs, but I don't think that has anything to do with the display issues. The ili9341 driver works for me, if you power the module off and back on, but not if the soft reboots or the reset button is pressed, example on my github. Other projects like openhasp work, so it's gotta be something simple.

AXP192 is a power management device. You are seeing issues with power management. Interfacing with the display may work using the ILI9341 driver, as after all, it is the driver. However, if the display is not in a state where the AXP192 needs to be communicated with to then interact with the ILI9341, then it won't work, the AXP192 will need initializing to then communicate with the ILI9341, as far as I understand.

This has been the case on every M5 device I've used with ESPHome with an AXP192. I do believe interfacing with an AXP192 if one exists, before proceeding with any initialisation of the ILI9341, is what's required.

[DarkBeardRUS]

+1

[kpurintun]

ESP is awesome right up until you want to put one in the Wife's living areas and she think's its dumb looking. these don't look bad at all. especially the stack. definitely excited for movement on this.

[codedmind]

I cannot help... but found this https://github.com/m5stack/M5Unified Maybe can push the integration into esphome?

Thanks

[ultimateguy]

+1 here... bought this M5stack development kit not realizing it doesn't work with esphome :(

[granvillebarker]

Check out Openhasp, it's one way to integrate the M5Core2 with Home Assistant until support is added.

[codedmind]

I can't help integrate it into Esphome, but if someone can development tasmota version already have an auto configuration option for m5stack tough that works

[RamEliC]

Still trying to get this to work without much luck. Please add support for M5 Stack core 2!!

[nagyrobi]

https://github.com/esphome/feature-requests/issues/1721

[KTibow]

Does anyone have this partially working?

[rasclatt-dot-com]

+1 from me. As per the feedback this is a bigger issue, a lot of the M5 devices include a high density of really useful sensors and features and are well packaged, however most of these features can only be enabled via the axp192 power managment chip, (screen, touch, microphone, amplifier, speaker, etc. Also some of these are only accessiable via a p192 GPIO pins which can’t be referenced without the axp192 component.

I have tried a number of custom components for my M5core2 and have managed to get some components to work, however there are always unexpected results that make the solution unworkable, (the solution in the feed above allows speakers and less to work but switches on a constant vibration module).

There is real potential to use the M5Core2 as a couscous assistant (i2s microphone, built in speaker media players for genie/ acorn - combined with screen, sensors and built in leds) but until the power management is fixed these can’t be accessed)

[martydingo]

+1 from me. As per the feedback this is a bigger issue, a lot of the M5 devices include a high density of really useful sensors and features and are well packaged, however most of these features can only be enabled via the axp192 power managment chip, (screen, touch, microphone, amplifier, speaker, etc. Also some of these are only accessiable via a p192 GPIO pins which can’t be referenced without the axp192 component.

I have tried a number of custom components for my M5core2 and have managed to get some components to work, however there are always unexpected results that make the solution unworkable, (the solution in the feed above allows speakers and less to work but switches on a constant vibration module).

There is real potential to use the M5Core2 as a couscous assistant (i2s microphone, built in speaker media players for genie/ acorn - combined with screen, sensors and built in leds) but until the power management is fixed these can’t be accessed)

I have gotten this to work with the display now, without that horrendous vibration.

In axp192.cpp, on line 10, there is the following:

void AXP192Component::setup() 
{
  begin(false, false, false, false, false);
}

Each false corresponds to a disableLDO variable. The vibration motor is on LDO2 on the Core2, so you can disable the motor by updating that line to the following:

void AXP192Component::setup() 
{
  begin(false, true, false, false, false);
}

My configuration is as follows:

esphome:
  name: m5stack-core2
  platform: ESP32
  board: m5stack-core-esp32

  includes:
   - /config/custom_components/axp192/axp192.h

wifi:
  ssid: "xxx"
  password: "xxx"

  # Enable fallback hotspot (captive portal) in case wifi connection fails
  ap:
    ssid: "M5Stack-Core2 Fallback Hotspot"
    password: "x"

substitutions:
  devicename: m5core2
  upper_devicename: M5Core2 

captive_portal:

# Enable logging
logger:

# Enable Home Assistant API
api:

ota:

web_server:

# AXP192 power management - must be present to initialize TFT power on
sensor:
  - platform: axp192
    address: 0x34
    i2c_id: bus_a
    update_interval: 30s
    battery_level:
      name: "M5Core2 Battery Level"
      id: "m5core2_batterylevel"

  - platform: wifi_signal
    name: ${upper_devicename} WiFi Signal
    id: wifi_dbm
  - platform: uptime
    name: ${upper_devicename} Uptime

spi:
  clk_pin: GPIO18
  mosi_pin: GPIO23
  miso_pin: GPIO38

i2c:
   - id: bus_a
     sda: GPIO21
     scl: GPIO22
     scan: True

font:
  - file: 'fonts/arial.ttf'
    id: font1
    size: 8

# # builtin 80x160 TFT
display:
  - platform: ili9341
    model: M5STACK
    cs_pin: 5
    dc_pin: 15
    lambda: |-
      it.print(80, 0, id(font1), TextAlign::TOP_CENTER, "M5Stick Test");

And it works!

[cmet7]

And it works!

Just tried this and it's still not working after reboot.

[martydingo]

And it works!

Just tried this and it's still not working after reboot.

I've just ran into the issue after posting, following modifications to the original library to add model support.

I've fixed the issue, it should compile however the issue is to do with the backlight pin not getting any voltage, since the M5Sick and the Core2 have different pins for their backlights.

I'm about to commit the code and I'll update soon.

[martydingo]

Please let me know if there any issues with the code. I am seeing issues with the LCD on the M5Stick-C, but the Core2 works perfectly with the configuration within sample-config.

Note to update the wifi & AP details as you see fit :)

https://github.com/martydingo/esphome-axp192

[cmet7]

the Core2 works perfectly with the configuration within sample-config.

The sample config for core 2 is empty.

[martydingo]

the Core2 works perfectly with the configuration within sample-config.

The sample config for core 2 is empty.

Okay, that's embarrassing, fixed now.

[clowrey]

Now we just need touchscreen driver for the FT6336U IC :) I don't have a core 2 but the WT32-SC01 which I have also uses this touch IC..

[spali]

BTW for others: The M5GO IoT Starter Kit v2.6 has a ILI9342C and Pwr Mgmt IP5306. It works with following settings:

external_components:
  - source:
      type: git
      url: https://github.com/ssieb/custom_components
    components: [ip5306]
ip5306:
  battery_level: # sensor
    name: ${upper_devicename} Battery Level
    entity_category: diagnostic
  charger_connected: # binary_sensor
    name: ${upper_devicename} Charger Connected
    entity_category: diagnostic
  charge_full: # binary_sensor
    name: ${upper_devicename} fully charged
    entity_category: diagnostic
display:
  - platform: ili9341
    model: M5STACK
    #model: TFT_2.4R (mirrors and inverts the display)
    cs_pin: GPIO14
    dc_pin: GPIO27
    reset_pin: GPIO33
    led_pin: GPIO32
    rotation: 0

I don't know the technical details behind display, and power mgmt and if they are related (which is different regarding the normal Core2). But it doesn't work with commented out TFT_2.4R setting.

[cmet7]

the Core2 works perfectly with the configuration within sample-config.

The sample config for core 2 is empty.

Okay, that's embarrassing, fixed now.

@martydingo I haven't been able to get this working. I am seeing this error: Platform not found: 'sensor.axp192'.

I'm using your sample config for the Core 2.

[cmet7]

For what it's worth I got this working by cloning the git repo referenced above and moving the axp192 directory under /custom_components. I'm running ESP Home in a docker container and the include seems not to work.

I can confirm that this is working on M5 Stack Core2 and the display continues working even after a reset.

[landonr]

you can include the axp192 component from gitlab like this. this works for m5stick-c

external_components:
  - source:
      type: git
      url: https://gitlab.com/geiseri/esphome_extras.git
    refresh: 0s
    components: [axp192]

axp192:
  id: axp
  address: 0x34
  i2c_id: bus_a
  update_interval: 60s

sensor:
    # AXP192 power management - must be present to initialize TFT power on
  - platform: axp192
    axp192_id: axp
    id: batteryPercent

light:
  - platform: axp192
    id: axpbacklight
    axp192_id: axp
    restore_mode: ALWAYS_ON
    name: Backlight

binary_sensor:
  - platform: axp192
    axp192_id: axp
    type: charging
    id: axp_charger
    name: Charger

[cmet7]

@martydingo this is working well with the exception of brightness. Core 2 uses DC-DC3 for brightness control which doesn't work the same way that LDO2 works. DC-DC3 is controlled by the 7 least significant bits in the 0x27 register; the most significant bit is reserved. As a result the brightness value shifts left 3 places rather than 4. In order to set the register I read the entire byte, logical AND with 0x80 to clear all bits except the reserved bit, logical OR with the shifted brightness value.

I've opened a pull request against your repo: https://github.com/martydingo/esphome-axp192/pull/1

[dereisele]

I've got a M5Stack Core Gray with the same display. Here is my first not working try: https://github.com/dereisele/esphome_components

The Display shows a white bar on the right side

[martydingo]

@cmet7 thanks very much for that, I've merged the PR after taking a gander.

Apologies for the delay on that!

[martydingo]

I've got a M5Stack Core Gray with the same display. Here is my first not working try: https://github.com/dereisele/esphome_components

The Display shows a white bar on the right side

Please supply all code, not only the custom component but your ESPHome YAML too please. :)

[nielsnl68]

could you try my changes to the ili9341 component at https://github.com/esphome/esphome/pull/3795

this should fix it i belief.

[dereisele]

@martydingo Here is my config

esphome:
  name: m5stack

external_components:
#  - source:
#      type: git
#      url: https://github.com/dereisele/esphome_components
#    components: [ ili9341 ]
  - source:
      type: "local"
      path: "../../esphome_components/components"
    components:
      - ili9341

esp32:
  board: m5stack-grey
  framework:
    type: arduino

# Enable logging
logger:

mqtt:
  broker: !secret mqtt_host
  discovery: true
  username: !secret mqtt_user
  password: !secret mqtt_password

# Enable Home Assistant API
api:
  encryption:
    key: "xxxx"

ota:
  password: "xxx"

wifi:
  ssid: !secret wifi_ssid
  password: !secret wifi_password

  # Enable fallback hotspot (captive portal) in case wifi connection fails
  ap:
    ssid: "M5Stack Fallback Hotspot"
    password: "xxx"

captive_portal:

spi:
  clk_pin: 18
  mosi_pin: 23
  miso_pin: 19

font:
  - file: "fonts/Roboto-Medium.ttf"
    id: font_roboto_medium22
    size: 22
    glyphs: '!"%()+,-_.:°0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ abcdefghijklmnopqrstuvwxyz/³µ'

display:
  - platform: ili9xxx
    id: m5stack_display
    model: M5STACKGREY
    cs_pin: 14
    dc_pin: 27
    backlight_pin: 32
    led_pin: 33
    rotation: 0
    lambda: |-
      Color RED(1,0,0);
      Color BLUE(0,0,1);
      Color WHITE(1,1,1);
      it.rectangle(0,  0, it.get_width(), it.get_height(), BLUE);
      it.rectangle(0, 22, it.get_width(), it.get_height(), RED);

# Button to toggle the display backlight
binary_sensor:
  - platform: gpio
    id: M5_BtnA
    pin:
      number: 39
      inverted: true
  - platform: gpio
    id: M5_BtnB
    pin:
      number: 38
      inverted: true
  - platform: gpio
    id: M5_BtnC
    pin:
      number: 37
      inverted: true
    on_click:
      then:
        - switch.toggle: backlight

# GPIO pin of the display backlight
switch:
  - platform: gpio
    pin: 32
    name: "Backlight"
    id: backlight
    restore_mode: ALWAYS_ON

[dereisele]

could you try my changes to the ili9341 component at esphome/esphome#3795

this should fix it i belief.

With that config I get a complete white screen (ili9342 model config)

[nielsnl68]

@dereisele do you mean you get ONLY the white screen or do you also get the colored rectangles?

[dereisele]

@dereisele do you mean you get ONLY the white screen or do you also get the colored rectangles?

No, just a complete white screen

[leoedin]

Edit: I updated ESPHome and my changes don't work - and martydingo's do. So ignore this!

[dereisele]

@leoedin I got my M5Stack Gray working with your changes! Thank you very much!!!

esphome:
  name: m5stack

external_components:
  - source:
      type: git
      url: 'https://github.com/leoedin/esphome-axp192'
    components: [axp192]

i2c:
  - id: bus_a
    sda: GPIO21
    scl: GPIO22

sensor:
  - platform: axp192
    model: M5CORE2
    address: 0x34
    i2c_id: bus_a
    update_interval: 30s
    brightness: 75%
    battery_level:
      name: "Device Battery Level"
      id: "device_batterylevel"

esp32:
  board: m5stack-grey
  framework:
    type: arduino

# Enable logging
logger:

mqtt:
  broker: !secret mqtt_host
  discovery: true
  username: !secret mqtt_user
  password: !secret mqtt_password

# Enable Home Assistant API
api:
  encryption:
    key: "xxx"

ota:
  password: "xxx"

wifi:
  ssid: !secret wifi_ssid
  password: !secret wifi_password

  # Enable fallback hotspot (captive portal) in case wifi connection fails
  ap:
    ssid: "M5Stack Fallback Hotspot"
    password: "xxx"

captive_portal:

spi:
  clk_pin: 18
  mosi_pin: 23
  miso_pin: 19

font:
  - file: "gfonts://Roboto"
    id: font_roboto_20
    size: 20

# ILI9342C
display:
  - platform: ili9341
    model: M5STACK
    cs_pin: 14
    dc_pin: 27
    led_pin: 33
    lambda: |-
      it.print(80, 0, id(font_roboto_20), TextAlign::TOP_CENTER, "M5Core Test");

# Button to toggle the display backlight
binary_sensor:
  - platform: gpio
    id: M5_BtnA
    pin:
      number: 39
      inverted: true
  - platform: gpio
    id: M5_BtnB
    pin:
      number: 38
      inverted: true
  - platform: gpio
    id: M5_BtnC
    pin:
      number: 37
      inverted: true
    on_click:
      then:
        - switch.toggle: backlight

# GPIO pin of the display backlight
switch:
  - platform: gpio
    pin: 32
    name: "Backlight"
    id: backlight
    restore_mode: ALWAYS_ON