Skip to content

Conversation

me-no-dev
Copy link
Member

This pull request adds support for custom input formats in the ESP_SR speech recognition library, allowing users to specify the channel layout for microphone and playback data. It also introduces a new partition scheme for ESP_SR models, updates the example and CI configuration to use these changes, and refines the build conditions for ESP_SR to use model storage options instead of wake word/multinet flags.

Speech Recognition Input Format Support:

  • Added an input_format parameter to the ESP_SR_Class::begin method and the underlying sr_start function, allowing users to specify the channel layout for speech recognition (e.g., "MMNR" for two microphones, one unused, one playback channel). This is reflected in both the header and implementation files (ESP_SR.h, ESP_SR.cpp, esp32-hal-sr.h, esp32-hal-sr.c). [1] [2] [3] [4] [5]
  • Updated the Basic example (Basic.ino) to use the new SR_INPUT_FORMAT define and to pass it to ESP_SR.begin. Added documentation for the input format. [1] [2]

Partition Scheme and CI Improvements:

  • Added a new partition scheme esp_sr_16 for ESP32P4 boards, supporting 3MB APP, 7MB SPIFFS, and 2.9MB MODEL, with corresponding upload size and flags in boards.txt.
  • Updated CI configuration (ci.json) to test ESP_SR on ESP32P4 boards with the new partition scheme. [1] [2]

Build Condition Refinements:

  • Changed conditional compilation flags throughout ESP_SR source files to use CONFIG_MODEL_IN_FLASH or CONFIG_MODEL_IN_SDCARD instead of CONFIG_USE_WAKENET or CONFIG_USE_MULTINET, ensuring the code is built only when model storage is available. [1] [2] [3] [4]

Copy link
Contributor

github-actions bot commented Sep 4, 2025

Messages
📖 🎉 Good Job! All checks are passing!

👋 Hello me-no-dev, we appreciate your contribution to this project!


📘 Please review the project's Contributions Guide for key guidelines on code, documentation, testing, and more.

🖊️ Please also make sure you have read and signed the Contributor License Agreement for this project.

Click to see more instructions ...


This automated output is generated by the PR linter DangerJS, which checks if your Pull Request meets the project's requirements and helps you fix potential issues.

DangerJS is triggered with each push event to a Pull Request and modify the contents of this comment.

Please consider the following:
- Danger mainly focuses on the PR structure and formatting and can't understand the meaning behind your code or changes.
- Danger is not a substitute for human code reviews; it's still important to request a code review from your colleagues.
- To manually retry these Danger checks, please navigate to the Actions tab and re-run last Danger workflow.

Review and merge process you can expect ...


We do welcome contributions in the form of bug reports, feature requests and pull requests.

1. An internal issue has been created for the PR, we assign it to the relevant engineer.
2. They review the PR and either approve it or ask you for changes or clarifications.
3. Once the GitHub PR is approved we do the final review, collect approvals from core owners and make sure all the automated tests are passing.
- At this point we may do some adjustments to the proposed change, or extend it by adding tests or documentation.
4. If the change is approved and passes the tests it is merged into the default branch.

Generated by 🚫 dangerJS against 7781d7b

Copy link
Contributor

github-actions bot commented Sep 4, 2025

Memory usage test (comparing PR against master branch)

The table below shows the summary of memory usage change (decrease - increase) in bytes and percentage for each target.

MemoryFLASH [bytes]FLASH [%]RAM [bytes]RAM [%]
TargetDECINCDECINCDECINCDECINC
ESP32P4000.000.00000.000.00
ESP32S30‼️ +137K0.00‼️ +20.660⚠️ +19840.00‼️ +6.35
Click to expand the detailed deltas report [usage change in BYTES]
TargetESP32P4ESP32S3
ExampleFLASHRAMFLASHRAM
libraries/ESP_SR/examples/Basic--‼️ +137K⚠️ +1984

@me-no-dev me-no-dev added the Status: Pending Merge Pull Request is ready to be merged label Sep 4, 2025
Copy link
Contributor

github-actions bot commented Sep 4, 2025

Test Results

 76 files   76 suites   13m 12s ⏱️
 38 tests  38 ✅ 0 💤 0 ❌
241 runs  241 ✅ 0 💤 0 ❌

Results for commit 7781d7b.

@me-no-dev me-no-dev merged commit d10bc28 into idf-release/v5.5 Sep 4, 2025
42 checks passed
@me-no-dev me-no-dev deleted the bugfix/esp_sr_example branch September 4, 2025 10:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Pending Merge Pull Request is ready to be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant