Skip to content

feat(rmt): adds new function to send specific number of loops #11748

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

Draft
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

SuGlider
Copy link
Collaborator

@SuGlider SuGlider commented Aug 20, 2025

Description of Change

Adds a new function rmtWriteLoopingCount() to send a specific number of times, repeating the same RMT Symbols.

Adds:
bool rmtWriteLoopingCount(int pin, rmt_data_t *data, size_t num_rmt_symbols, uint32_t loop_count)

It will send a pattern defined by *data RMT Symbols for loop_count times (repeated).
This is different from rmtWriteLooping(), which will repeat it for ever (endless looping).

Test Scenarios

To-Do:

  • add example
  • test it, specially when RMT channel is already sending something and it changes the loop mode/count.

Related links

Closes #11731

Adds a new function `rmtWriteLoopingCount()` to send a specific number of times, repeating the same RMT Symbols.
@SuGlider SuGlider added this to the 3.3.0 milestone Aug 20, 2025
@SuGlider SuGlider self-assigned this Aug 20, 2025
@SuGlider SuGlider requested a review from a team as a code owner August 20, 2025 14:25
@SuGlider SuGlider added the Area: Peripherals API Relates to peripheral's APIs. label Aug 20, 2025
Copy link
Contributor

github-actions bot commented Aug 20, 2025

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "feat(rmt): adds new function to send specific number of loops":
    • body's lines must not be longer than 100 characters

Please fix these commit messages - here are some basic tips:

  • follow Conventional Commits style
  • correct format of commit message should be: <type/action>(<scope/component>): <summary>, for example fix(esp32): Fixed startup timeout issue
  • allowed types are: change,ci,docs,feat,fix,refactor,remove,revert,test
  • sufficiently descriptive message summary should be between 10 to 72 characters and start with upper case letter
  • avoid Jira references in commit messages (unavailable/irrelevant for our customers)

TIP: Install pre-commit hooks and run this check when committing (uses the Conventional Precommit Linter).

👋 Hello SuGlider, 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.
- Resolve all warnings (⚠️ ) before requesting a review from human reviewers - they will appreciate it.
- 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 5413697

Adds:
bool rmtWriteLoopingCount(int pin, rmt_data_t *data, size_t num_rmt_symbols, uint32_t loop_count)

It will send a pattern defined by `*data` RMT Symbols for `loop_count` times (repeated).

This is different from `rmtWriteLooping()`, which will repeat it for ever (endless looping).
@SuGlider SuGlider moved this from Todo to In Progress in Arduino ESP32 Core Project Roadmap Aug 20, 2025
@SuGlider SuGlider marked this pull request as draft August 20, 2025 14:37
Copy link
Contributor

Test Results

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

Results for commit 5413697.

Copy link
Contributor

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
ESP32C5000.000.00000.000.00
ESP32P4000.000.00000.000.00
ESP32S3💚 -16⚠️ +40.000.00000.000.00
ESP32S2💚 -1200.000.00000.000.00
ESP32C3000.000.00000.000.00
ESP32C60⚠️ +100.000.00000.000.00
ESP32H2000.000.00000.000.00
ESP32💚 -400.000.00000.000.00
Click to expand the detailed deltas report [usage change in BYTES]
TargetESP32C5ESP32P4ESP32S3ESP32S2ESP32C3ESP32C6ESP32H2ESP32
ExampleFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAM
ArduinoOTA/examples/BasicOTA000000💚 -400000--00
AsyncUDP/examples/AsyncUDPClient000000000000--00
AsyncUDP/examples/AsyncUDPMulticastServer000000000000--00
AsyncUDP/examples/AsyncUDPServer000000000000--00
BLE/examples/Beacon_Scanner00--00--00000000
BLE/examples/Client00--00--00000000
BLE/examples/EddystoneTLM_Beacon00--00--00000000
BLE/examples/EddystoneURL_Beacon00--00--00000000
BLE/examples/Notify00--00--00000000
BLE/examples/Scan00--00--00000000
BLE/examples/Server00--00--00000000
BLE/examples/Server_multiconnect00--00--00000000
BLE/examples/UART00--00--00000000
BLE/examples/Write00--00--00000000
BLE/examples/iBeacon00--00--00000000
DNSServer/examples/CaptivePortal000000000000--00
EEPROM/examples/eeprom_class0000000000000000
EEPROM/examples/eeprom_extra0000000000000000
EEPROM/examples/eeprom_write0000000000000000
ESP32/examples/AnalogOut/LEDCFade0000000000000000
ESP32/examples/AnalogOut/LEDCGammaFade0000------0000--
ESP32/examples/AnalogOut/LEDCSingleChannel0000000000000000
ESP32/examples/AnalogOut/LEDCSoftwareFade0000000000000000
ESP32/examples/AnalogOut/SigmaDelta0000000000000000
ESP32/examples/AnalogOut/ledcFrequency0000000000000000
ESP32/examples/AnalogOut/ledcWrite_RGB0000000000000000
ESP32/examples/AnalogRead0000000000000000
ESP32/examples/AnalogReadContinuous0000000000000000
ESP32/examples/ArduinoStackSize0000000000000000
ESP32/examples/CI/CIBoardsTest000000💚 -4000000000
ESP32/examples/ChipID/GetChipID0000000000000000
ESP32/examples/DeepSleep/TimerWakeUp000000000000--00
ESP32/examples/FreeRTOS/BasicMultiThreading000000💚 -4000000000
ESP32/examples/FreeRTOS/Mutex0000000000000000
ESP32/examples/FreeRTOS/Queue0000000000000000
ESP32/examples/FreeRTOS/Semaphore0000000000000000
ESP32/examples/GPIO/BlinkRGB000000💚 -4000000000
ESP32/examples/GPIO/FunctionalInterrupt0000000000000000
ESP32/examples/GPIO/FunctionalInterruptLambda000000💚 -4000⚠️ +1000000
ESP32/examples/GPIO/FunctionalInterruptStruct0000000000000000
ESP32/examples/GPIO/GPIOInterrupt0000000000000000
ESP32/examples/HWCDC_Events000000--000000--
ESP32/examples/MacAddress/GetMacAddress0000000000000000
ESP32/examples/RMT/Legacy_RMT_Driver_Compatible0000000000000000
ESP32/examples/RMT/RMTCallback000000💚 -40000000💚 -40
ESP32/examples/RMT/RMTLoopback000000💚 -40000000💚 -40
ESP32/examples/RMT/RMTReadXJT000000💚 -40000000💚 -40
ESP32/examples/RMT/RMTWrite_RGB_LED000000💚 -40000000💚 -40
ESP32/examples/RMT/RMT_CPUFreq_Test000000💚 -40000000💚 -40
ESP32/examples/RMT/RMT_EndOfTransmissionState000000💚 -40000000💚 -40
ESP32/examples/RMT/RMT_LED_Blink000000💚 -40000000💚 -40
ESP32/examples/ResetReason/ResetReason0000000000000000
ESP32/examples/ResetReason/ResetReason20000000000000000
ESP32/examples/Serial/BaudRateDetect_Demo0000000000000000
ESP32/examples/Serial/OnReceiveError_BREAK_Demo0000000000000000
ESP32/examples/Serial/OnReceive_Demo0000000000000000
ESP32/examples/Serial/RS485_Echo_Demo0000000000000000
ESP32/examples/Serial/RxFIFOFull_Demo0000000000000000
ESP32/examples/Serial/RxTimeout_Demo0000000000000000
ESP32/examples/Serial/Serial_All_CPU_Freqs0000000000000000
ESP32/examples/Serial/Serial_STD_Func_OnReceive0000000000000000
ESP32/examples/Serial/onReceiveExample0000000000000000
ESP32/examples/Template/ExampleTemplate0000000000000000
ESP32/examples/Time/SimpleTime000000000000--00
ESP32/examples/Timer/RepeatTimer0000000000000000
ESP32/examples/Timer/WatchdogTimer0000000000000000
ESP32/examples/Utilities/HEXBuilder0000000000000000
ESP32/examples/Utilities/MD5Builder0000000000000000
ESP32/examples/Utilities/SHA1Builder0000000000000000
ESP_I2S/examples/ES8388_loopback000000💚 -4000000000
ESP_I2S/examples/Simple_tone0000000000000000
ESP_NOW/examples/ESP_NOW_Broadcast_Master00--00000000--00
ESP_NOW/examples/ESP_NOW_Broadcast_Slave00--00000000--00
ESP_NOW/examples/ESP_NOW_Network00--00000000--00
ESP_NOW/examples/ESP_NOW_Serial00--00000000--00
ESPmDNS/examples/mDNS-SD_Extended000000000000--00
ESPmDNS/examples/mDNS_Web_Server000000000000--00
Ethernet/examples/ETH_W5500_Arduino_SPI000000💚 -4000000000
Ethernet/examples/ETH_W5500_IDF_SPI000000💚 -4000000000
Ethernet/examples/ETH_WIFI_BRIDGE000000💚 -400000--00
FFat/examples/FFat_Test0000000000000000
FFat/examples/FFat_time000000000000--00
HTTPClient/examples/Authorization000000000000--00
HTTPClient/examples/BasicHttpClient000000000000--00
HTTPClient/examples/BasicHttpsClient000000000000--00
HTTPClient/examples/HTTPClientEnterprise00--00000000--00
HTTPClient/examples/ReuseConnection000000000000--00
HTTPClient/examples/StreamHttpClient000000000000--00
HTTPUpdate/examples/httpUpdate000000💚 -400000--00
HTTPUpdate/examples/httpUpdateSPIFFS000000💚 -400000--00
HTTPUpdate/examples/httpUpdateSecure000000💚 -400000--00
HTTPUpdateServer/examples/WebUpdater000000💚 -400000--00
Insights/examples/DiagnosticsSmokeTest00--00000000--00
Insights/examples/MinimalDiagnostics00--00000000--00
LittleFS/examples/LITTLEFS_test0000000000000000
LittleFS/examples/LITTLEFS_time000000000000--00
Matter/examples/MatterColorLight00--00💚 -4000000000
Matter/examples/MatterCommissionTest00--000000000000
Matter/examples/MatterComposedLights00--000000000000
Matter/examples/MatterContactSensor00--00💚 -4000000000
Matter/examples/MatterDimmableLight00--00💚 -4000000000
Matter/examples/MatterEnhancedColorLight00--00💚 -4000000000
Matter/examples/MatterEvents00--000000000000
Matter/examples/MatterFan00--00💚 -4000000000
Matter/examples/MatterHumiditySensor00--000000000000
Matter/examples/MatterLambdaSingleCallbackManyEPs00--000000000000
Matter/examples/MatterMinimum00--00💚 -4000000000
Matter/examples/MatterOccupancySensor00--000000000000
Matter/examples/MatterOnIdentify00--00💚 -4000000000
Matter/examples/MatterOnOffLight00--00💚 -4000000000
Matter/examples/MatterOnOffPlugin00--00💚 -4000000000
Matter/examples/MatterPressureSensor00--000000000000
Matter/examples/MatterSmartButon00--000000000000
Matter/examples/MatterTemperatureLight00--00💚 -4000000000
Matter/examples/MatterTemperatureSensor00--000000000000
Matter/examples/MatterThermostat00--000000000000
NetBIOS/examples/ESP_NBNST000000000000--00
NetworkClientSecure/examples/WiFiClientInsecure000000000000--00
NetworkClientSecure/examples/WiFiClientPSK000000000000--00
NetworkClientSecure/examples/WiFiClientSecure000000000000--00
NetworkClientSecure/examples/WiFiClientSecureEnterprise00--00000000--00
NetworkClientSecure/examples/WiFiClientSecureProtocolUpgrade000000000000--00
NetworkClientSecure/examples/WiFiClientShowPeerCredentials000000000000--00
NetworkClientSecure/examples/WiFiClientTrustOnFirstUse000000000000--00
OpenThread/examples/CLI/COAP/coap_lamp00--------0000--
OpenThread/examples/CLI/COAP/coap_switch00--------0000--
OpenThread/examples/CLI/SimpleCLI00--------0000--
OpenThread/examples/CLI/SimpleNode00--------0000--
OpenThread/examples/CLI/SimpleThreadNetwork/ExtendedRouterNode00--------0000--
OpenThread/examples/CLI/SimpleThreadNetwork/LeaderNode00--------0000--
OpenThread/examples/CLI/SimpleThreadNetwork/RouterNode00--------0000--
OpenThread/examples/CLI/ThreadScan00--------0000--
OpenThread/examples/CLI/onReceive00--------0000--
OpenThread/examples/Native/SimpleThreadNetwork/LeaderNode00--------0000--
OpenThread/examples/Native/SimpleThreadNetwork/RouterNode00--------0000--
PPP/examples/PPP_Basic000000💚 -4000000000
PPP/examples/PPP_WIFI_BRIDGE000000💚 -400000--00
Preferences/examples/Prefs2Struct0000000000000000
Preferences/examples/StartCounter0000000000000000
RainMaker/examples/RMakerCustom00--00💚 -400000----
RainMaker/examples/RMakerCustomAirCooler00--00💚 -400000----
RainMaker/examples/RMakerSonoffDualR300--00💚 -400000----
RainMaker/examples/RMakerSwitch00--00💚 -400000----
SD/examples/SD_Test000000💚 -4000000000
SD/examples/SD_time0000⚠️ +40💚 -400000--00
SPI/examples/SPI_Multiple_Buses000000💚 -4000000000
SPIFFS/examples/SPIFFS_Test0000000000000000
SPIFFS/examples/SPIFFS_time000000000000--00
TFLiteMicro/examples/hello_world0000000000000000
Ticker/examples/Blinker000000💚 -4000000000
Ticker/examples/TickerBasic000000💚 -4000000000
Ticker/examples/TickerParameter000000💚 -4000000000
Update/examples/AWS_S3_OTA_Update000000000000--00
Update/examples/HTTPS_OTA_Update000000000000--00
Update/examples/HTTP_Client_AES_OTA_Update000000💚 -400000--00
Update/examples/HTTP_Server_AES_OTA_Update000000💚 -400000--00
Update/examples/OTAWebUpdater000000💚 -400000--00
Update/examples/SD_Update000000💚 -4000000000
WebServer/examples/AdvancedWebServer000000💚 -400000--00
WebServer/examples/FSBrowser000000000000--00
WebServer/examples/Filters000000💚 -400000--00
WebServer/examples/HelloServer000000💚 -400000--00
WebServer/examples/HttpAdvancedAuth000000💚 -400000--00
WebServer/examples/HttpAuthCallback000000💚 -400000--00
WebServer/examples/HttpAuthCallbackInline000000💚 -400000--00
WebServer/examples/HttpBasicAuth000000💚 -400000--00
WebServer/examples/HttpBasicAuthSHA1000000💚 -400000--00
WebServer/examples/HttpBasicAuthSHA1orBearerToken000000💚 -400000--00
WebServer/examples/Middleware00--00000000--00
WebServer/examples/MultiHomedServers000000💚 -400000--00
WebServer/examples/PathArgServer000000000000--00
WebServer/examples/SDWebServer000000000000--00
WebServer/examples/SimpleAuthentification000000000000--00
WebServer/examples/UploadHugeFile000000💚 -1200000--00
WebServer/examples/WebServer000000000000--00
WebServer/examples/WebUpdate000000💚 -400000--00
WiFi/examples/FTM/FTM_Initiator000000000000--00
WiFi/examples/FTM/FTM_Responder000000000000--00
WiFi/examples/SimpleWiFiServer0000💚 -40💚 -400000--00
WiFi/examples/WPS00--00000000--00
WiFi/examples/WiFiAccessPoint000000💚 -400000--00
WiFi/examples/WiFiBlueToothSwitch00--00--0000--00
WiFi/examples/WiFiClient000000000000--00
WiFi/examples/WiFiClientBasic000000000000--00
WiFi/examples/WiFiClientConnect000000000000--00
WiFi/examples/WiFiClientEnterprise00--00000000--00
WiFi/examples/WiFiClientEvents000000000000--00
WiFi/examples/WiFiClientStaticIP000000000000--00
WiFi/examples/WiFiExtender000000000000--00
WiFi/examples/WiFiIPv6000000000000--00
WiFi/examples/WiFiMulti000000000000--00
WiFi/examples/WiFiMultiAdvanced000000000000--00
WiFi/examples/WiFiScan000000000000--00
WiFi/examples/WiFiScanAsync000000000000--00
WiFi/examples/WiFiScanDualAntenna000000000000--00
WiFi/examples/WiFiScanTime0000💚 -160000000--00
WiFi/examples/WiFiSmartConfig00--00000000--00
WiFi/examples/WiFiTelnetToSerial000000000000--00
WiFi/examples/WiFiUDPClient000000000000--00
WiFiProv/examples/WiFiProv00--00000000--00
Wire/examples/WireMaster0000000000000000
Wire/examples/WireScan0000000000000000
Wire/examples/WireSlave0000000000000000
Wire/examples/WireSlaveFunctionalCallback0000000000000000
Zigbee/examples/Zigbee_Analog_Input_Output00--000000000000
Zigbee/examples/Zigbee_Binary_Input00--------0000--
Zigbee/examples/Zigbee_CarbonDioxide_Sensor00--------0000--
Zigbee/examples/Zigbee_Color_Dimmable_Light00--------0000--
Zigbee/examples/Zigbee_Color_Dimmer_Switch00--000000000000
Zigbee/examples/Zigbee_Contact_Switch00--------0000--
Zigbee/examples/Zigbee_Dimmable_Light00--------0000--
Zigbee/examples/Zigbee_Electrical_AC_Sensor00--000000000000
Zigbee/examples/Zigbee_Electrical_AC_Sensor_MultiPhase00--000000000000
Zigbee/examples/Zigbee_Electrical_DC_Sensor00--------0000--
Zigbee/examples/Zigbee_Fan_Control00--00💚 -40000000💚 -40
Zigbee/examples/Zigbee_Gateway00--000000----00
Zigbee/examples/Zigbee_Illuminance_Sensor00--------0000--
Zigbee/examples/Zigbee_OTA_Client00--------0000--
Zigbee/examples/Zigbee_Occupancy_Sensor00--------0000--
Zigbee/examples/Zigbee_On_Off_Light00--------0000--
Zigbee/examples/Zigbee_On_Off_MultiSwitch00--000000000000
Zigbee/examples/Zigbee_On_Off_Switch00--000000000000
Zigbee/examples/Zigbee_PM25_Sensor00--------0000--
Zigbee/examples/Zigbee_Power_Outlet00--00💚 -4000000000
Zigbee/examples/Zigbee_Pressure_Flow_Sensor00--------0000--
Zigbee/examples/Zigbee_Range_Extender00--00💚 -4000000000
Zigbee/examples/Zigbee_Scan_Networks00--------0000--
Zigbee/examples/Zigbee_Temp_Hum_Sensor_Sleepy00--------0000--
Zigbee/examples/Zigbee_Temperature_Sensor00--------0000--
Zigbee/examples/Zigbee_Thermostat00--000000000000
Zigbee/examples/Zigbee_Vibration_Sensor00--------0000--
Zigbee/examples/Zigbee_Wind_Speed_Sensor00--------0000--
Zigbee/examples/Zigbee_Window_Covering00--------0000--
ESP32/examples/DeepSleep/TouchWakeUp--000000------00
ESP32/examples/TWAI/TWAIreceive--00000000000000
ESP32/examples/TWAI/TWAItransmit--00000000000000
ESP32/examples/Touch/TouchInterrupt--000000------00
ESP32/examples/Touch/TouchRead--000000------00
ESP_I2S/examples/Record_to_WAV--0000--------00
Ethernet/examples/ETH_TLK110--00----------00
SD_MMC/examples/SD2USBMSC--0000----------
SD_MMC/examples/SDMMC_Test--0000--------00
SD_MMC/examples/SDMMC_time--0000--------00
USB/examples/CompositeDevice--000000--------
USB/examples/ConsumerControl--000000--------
USB/examples/CustomHIDDevice--000000--------
USB/examples/FirmwareMSC--000000--------
USB/examples/Gamepad--000000--------
USB/examples/HIDVendor--000000--------
USB/examples/Keyboard/KeyboardLogout--000000--------
USB/examples/Keyboard/KeyboardMessage--000000--------
USB/examples/Keyboard/KeyboardReprogram--000000--------
USB/examples/Keyboard/KeyboardSerial--000000--------
USB/examples/KeyboardAndMouseControl--000000--------
USB/examples/MIDI/MidiController--000000--------
USB/examples/MIDI/MidiInterface--000000--------
USB/examples/MIDI/MidiMusicBox--000000--------
USB/examples/MIDI/ReceiveMidi--000000--------
USB/examples/Mouse/ButtonMouseControl--000000--------
USB/examples/SystemControl--000000--------
USB/examples/USBMSC--000000--------
USB/examples/USBSerial--000000--------
USB/examples/USBVendor--000000--------
ESP32/examples/Camera/CameraWebServer (1)----0000------00
ESP32/examples/Camera/CameraWebServer (2)----0000------00
ESP32/examples/Camera/CameraWebServer (3)----00----------
ESP32/examples/DeepSleep/ExternalWakeUp----0000------00
ESP_SR/examples/Basic----00----------
BluetoothSerial/examples/DiscoverConnect--------------00
BluetoothSerial/examples/GetLocalMAC--------------00
BluetoothSerial/examples/SerialToSerialBT--------------00
BluetoothSerial/examples/SerialToSerialBTM--------------00
BluetoothSerial/examples/SerialToSerialBT_Legacy--------------00
BluetoothSerial/examples/SerialToSerialBT_SSP--------------00
BluetoothSerial/examples/bt_classic_device_discovery--------------00
BluetoothSerial/examples/bt_remove_paired_devices--------------00
ESP32/examples/DeepSleep/SmoothBlink_ULP_Code--------------00
Ethernet/examples/ETH_LAN8720--------------00
SimpleBLE/examples/SimpleBleDevice--------------00

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Peripherals API Relates to peripheral's APIs.
Projects
Status: In Progress
Development

Successfully merging this pull request may close these issues.

Add rmtWriteLoopingCount function to set loop count
1 participant