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

Replace box-emu-hal (non-component) with actual box-emu component and use esp-box component from espp #73

Merged
merged 14 commits into from
Jul 4, 2024

Conversation

finger563
Copy link
Contributor

@finger563 finger563 commented Jul 3, 2024

Description

  • Remove box-emu-hal component which was just a collection of static functions in a namespace (and not very well designed)
  • Update espp submodule to have newest EspBox component which automatically detects and configures touch, display, and audio for both ESP32-S3-BOX and ESP32-S3-BOX-3 - no longer requiring a recompile / menuconfig to select box version! 🎉
  • Add new box-emu component which leverages EspBox component and provides a nicer interface
  • Update sd card configuration to use 16k allocation unit size for better performance instead of the default 512b.

Motivation and Context

Related espp PR: esp-cpp/espp#264

This PR enables the box-emu code to run on all versions of the box-emu as well as all versions of the esp-box, without needing to recompile. Previously, you would have to recompile if you wanted to target different versions of the esp-box (but not if you wanted to target different versions of the box-emu).

Finally, this helps clean up the code and remove code that's a little more esp-box related, now that it has an actual component class for the BoxEmu and it uses the espp::EspBox component as well.

Additionally, this code also speeds up file access by increasing the allocation unit size configured for the sd card.

How has this been tested?

  • Building and running box-emu/example on Box-3 (V1)
  • Building and running box-emu/example on Box (V1)
  • Building and running box-emu/example on Box (V0)

Building and running main on Box-3 (V1) and testing all the emulators :)

Screenshots (if appropriate, e.g. schematic, board, console logs, lab pictures):

Box-3 V1:
CleanShot 2024-07-03 at 08 07 46

Box V1:
CleanShot 2024-07-03 at 08 10 53

Box V0:
CleanShot 2024-07-03 at 08 23 05

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation Update
  • Hardware (schematic, board, system design) change
  • Software change

Checklist:

  • My change requires a change to the documentation.
  • I have added / updated the documentation related to this change via either README or WIKI

Software

  • I have added tests to cover my changes.
  • I have updated the .github/workflows/build.yml file to add my new test to the automated cloud build github action.
  • All new and existing tests passed.
  • My code follows the code style of this project.

@finger563 finger563 marked this pull request as draft July 3, 2024 02:27
@finger563 finger563 self-assigned this Jul 3, 2024
Copy link

github-actions bot commented Jul 3, 2024

✅Static analysis result - no issues found! ✅

@finger563 finger563 added enhancement New feature or request esp32-s3-box esp32-s3-box-3 hal hardware abstraction layer labels Jul 3, 2024
@finger563 finger563 changed the title Feature/espp update and esp box component Replace box-emu-hal (non-component) with actual box-emu component and use esp-box component from espp Jul 4, 2024
@finger563 finger563 marked this pull request as ready for review July 4, 2024 03:01
@finger563 finger563 merged commit fc6e4ae into main Jul 4, 2024
4 checks passed
@finger563 finger563 deleted the feature/espp-update-and-esp-box-component branch July 4, 2024 03:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request esp32-s3-box esp32-s3-box-3 hal hardware abstraction layer
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant