Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

adding simpletest for esp32s2 tft #8457

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

FoamyGuy
Copy link
Collaborator

@FoamyGuy FoamyGuy commented Oct 2, 2023

As discussed in the weeds a few weeks back, a board specific simpletest script.

I did the Feather ESP32-S2 TFT and made the script illustrate the usage of:

  • displayio
  • wifi / requests
  • LED blink
  • Neopixel rainbow cycle
  • Button input

I'm interested if anyone has ideas about what else should (or shouldn't) be included in the simpletest script. I wanted to try to feature the built-in hardware as best as possible without making the script overly complex.

One idea I had but didn't do was having it do an I2C bus scan and putting any addresses it finds on the display as well. If that sounds like a good addition let me know and I can add it with another commit.

I believe this is the first one of these, so there may be actions adjustments needed if there are tools that aren't expecting to find the .py files in this directory, or perhaps pylint / black configuration may need to be altered.

@anecdata
Copy link
Member

anecdata commented Oct 3, 2023

This should be suitable for forward and reverse display versions of the ESP32-S2 and ESP32-S3 TFT. We may want to list the targeted boards explicitly somewhere. But if it lives in the board directory, then we'll have duplicates or aliases?

@tannewt
Copy link
Member

tannewt commented Oct 3, 2023

I think @dglaude was interested in this too.

@FoamyGuy
Copy link
Collaborator Author

FoamyGuy commented Oct 3, 2023

I had imagined there being duplicates in cases where the hardware is similar enough to use the exact same script. I don't know how many cases like that there are, I'm open to other ideas on how handle them.

Is it possible in a git repo to check in symbolic links? so this file could exist in one place and then be linked to elsewhere to have a sort of "shadow copy" exist there?

@dglaude
Copy link

dglaude commented Oct 3, 2023

I did not anticipate that the same simpletest would fit many board, and that simpletest proposal would start to appear so fast.
One think I wanted was to have the first few simpletest "perfect" to be used as template for other, and I was thinking that maybe some automatic generation would be possible to avoid copy/modify/paste human activities.

@FoamyGuy
Copy link
Collaborator Author

FoamyGuy commented Oct 3, 2023

I did hope that this one could be a good starting point as inspiration for others. I'm open to any feedback on it. I do think the built-in hardware on a given device will factor in heavily to it's simpletest so there will be some parts that aren't as re-usable between different devices.

Some kind of automated generation would be neat, but I'm not opposed to sourcing some of it it from human activity. It gives us the opportunity for some new "good first issue" type things that people with less experience can tackle to get involved with the project or as contributions for hacktoberfest.

@tannewt
Copy link
Member

tannewt commented Oct 4, 2023

s it possible in a git repo to check in symbolic links? so this file could exist in one place and then be linked to elsewhere to have a sort of "shadow copy" exist there?

I think you can but I'd rather just have one script per board. That'd ensure that editing one doesn't impact another.

@dhalbert dhalbert marked this pull request as draft November 15, 2023 14:09
@dhalbert
Copy link
Collaborator

I'm converting this to draft because I think the best alternatives are still being discussed.

@jepler
Copy link
Member

jepler commented Jul 12, 2024

Any plans to get back to this @FoamyGuy ?

@FoamyGuy
Copy link
Collaborator Author

I missed this ping back in July.

I'd be happy to get back to this, I do still think this "device simpletest" scripts can be quite useful personally.

I'm open to any feedback regarding the test script in the PR, or anything meta like where it's stored etc... It sounds like from the comments above we prefer to have 1 per device so that changes can only impact a single one, that is good with me.

I'm happy to make any changes that would necessary to get this one into an acceptable shape for merging.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants