search

nickolay / esphome-lilygo-t547plus

Use Lilygo T5-4.7 inch ESP32-S3 (aka "plus"/V2.3) e-paper module with ESPHome
Other
27 stars 21 forks source link

Rename DisplayBufferRef to DisplayRef #5

Closed drrllchn closed 1 year ago

drrllchn commented 1 year ago

What

Renames DisplayBufferRef to DisplayRef in display.py

Why

See https://github.com/esphome/esphome/pull/5002 for breaking change in esphome.

nickolay commented 1 year ago

Thanks for the heads up!

Do I understand correctly that with this change this repo would only be compatible with newer ESPHome versions? What can users who are not ready for an upgrade do if I apply this?

drrllchn commented 1 year ago

No worries, thanks for getting this display working in the first place!

It looks like this breaking change went in to ESPHome 2023.7.0. I would assume this would be a breaking change as well for those using this external component on older versions of ESPHome as DisplayRef wouldn't exist in previous versions of the ESPHome display component.

It also looks like all the display components that were already part of ESPHome were also updated with this same change as part of the same PR, but that makes sense because it would come with the new ESPHome version as well.

I think the best solution here is to upstream this T547 display component into ESPHome directly (the component has been working great for me), but that's quite a bigger push and I don't have enough knowledge to move it forward myself as I'm a designer and not an engineer by trade. Maybe something you could do if you had the time?

In lieu of that, another alternative is to merge this change into a separate branch so that those running older versions of ESPHome can continue using this branch while having a separate branch for 2023.7.0+. The downside of this is that branches aren't easy to discover unless documented somewhere.

Yet another alternative is to update the README with instructions for those still on older versions of ESPHome. Something like this that points to a release tag of the last working commit:

# for those using 2023.7.0 and later
external_components:
  - source: github://nickolay/esphome-lilygo-t547plus
    components: [t547]

# for those using 2023.6.5 and earlier
external_components:
  - source: github://nickolay/esphome-lilygo-t547plus@2023.6.5
    components: [t547]
nickolay commented 1 year ago

Thanks a lot and sorry it took too long to get this merged!

I took your advice and created a branch for older ESPHome versions, mentioning the branch in the README.

I'm not sure myself what's the requirements for contributing the component back to the mainline esphome, which is why I made this an external component...