Skip to content
New issue

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

#

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

Already on GitHub? # to your account

Jump to bottom

Restore Arduino Client API #10776

Merged
merged 1 commit into from
Jan 7, 2025
Merged

Restore Arduino Client API #10776

merged 1 commit into from
Jan 7, 2025

Conversation

pennam
Copy link
Contributor

@pennam pennam commented Dec 23, 2024 •
edited
Loading

Should fix #2755 (comment)

@CLAassistant
Copy link

CLAassistant commented Dec 23, 2024 •
edited
Loading

CLA assistant check
All committers have signed the CLA.

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Dec 23, 2024 •
edited
Loading

Messages
📖 🎉 Good Job! All checks are passing!

👋 Hello pennam, we appreciate your contribution to 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 d8bb0b7

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Dec 23, 2024 •
edited
Loading

Test Results

 62 files   62 suites   5m 43s ⏱️
 21 tests  21 ✅ 0 💤 0 ❌
154 runs  154 ✅ 0 💤 0 ❌

Results for commit d8bb0b7.

♻️ This comment has been updated with latest results.

@github-actions GitHub Actions
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
ESP32P4000.000.00000.000.00
ESP32S3💚 -24‼️ +5K0.00⚠️ +0.500⚠️ +4960.00⚠️ +0.83
ESP32S2💚 -32‼️ +4K0.00⚠️ +0.410⚠️ +360.00⚠️ +0.06
ESP32C3000.000.00000.000.00
ESP32C6000.000.00000.000.00
ESP32H2000.000.00000.000.00
ESP32💚 -28‼️ +12K0.00‼️ +1.230⚠️ +760.00⚠️ +0.12
Click to expand the detailed deltas report [usage change in BYTES]
TargetESP32P4ESP32S3ESP32S2ESP32C3ESP32C6ESP32H2ESP32
ExampleFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAM
ArduinoOTA/examples/BasicOTA00💚 -120💚 -1600000--00
AsyncUDP/examples/AsyncUDPClient0000000000--00
AsyncUDP/examples/AsyncUDPMulticastServer0000000000--00
AsyncUDP/examples/AsyncUDPServer0000000000--00
DNSServer/examples/CaptivePortal00💚 -120💚 -1600000--00
EEPROM/examples/eeprom_class00000000000000
EEPROM/examples/eeprom_extra00000000000000
EEPROM/examples/eeprom_write00000000000000
ESP32/examples/AnalogOut/LEDCFade00000000000000
ESP32/examples/AnalogOut/LEDCSingleChannel00000000000000
ESP32/examples/AnalogOut/LEDCSoftwareFade00000000000000
ESP32/examples/AnalogOut/SigmaDelta00000000000000
ESP32/examples/AnalogOut/ledcFrequency00000000000000
ESP32/examples/AnalogOut/ledcWrite_RGB00000000000000
ESP32/examples/AnalogRead00000000000000
ESP32/examples/AnalogReadContinuous00000000000000
ESP32/examples/ArduinoStackSize00000000000000
ESP32/examples/CI/CIBoardsTest00000000000000
ESP32/examples/ChipID/GetChipID00000000000000
ESP32/examples/DeepSleep/TimerWakeUp0000000000--00
ESP32/examples/DeepSleep/TouchWakeUp000000------00
ESP32/examples/FreeRTOS/BasicMultiThreading00000000000000
ESP32/examples/FreeRTOS/Mutex00000000000000
ESP32/examples/FreeRTOS/Queue00000000000000
ESP32/examples/FreeRTOS/Semaphore00000000000000
ESP32/examples/GPIO/BlinkRGB00000000000000
ESP32/examples/GPIO/FunctionalInterrupt00000000000000
ESP32/examples/GPIO/FunctionalInterruptStruct00000000000000
ESP32/examples/GPIO/GPIOInterrupt00000000000000
ESP32/examples/HWCDC_Events0000--000000--
ESP32/examples/MacAddress/GetMacAddress00000000000000
ESP32/examples/RMT/Legacy_RMT_Driver_Compatible00000000000000
ESP32/examples/RMT/RMTCallback00000000000000
ESP32/examples/RMT/RMTLoopback00000000000000
ESP32/examples/RMT/RMTReadXJT00000000000000
ESP32/examples/RMT/RMTWrite_RGB_LED00000000000000
ESP32/examples/RMT/RMT_CPUFreq_Test00000000000000
ESP32/examples/RMT/RMT_EndOfTransmissionState00000000000000
ESP32/examples/RMT/RMT_LED_Blink00000000000000
ESP32/examples/ResetReason/ResetReason00000000000000
ESP32/examples/ResetReason/ResetReason200000000000000
ESP32/examples/Serial/BaudRateDetect_Demo00000000000000
ESP32/examples/Serial/OnReceiveError_BREAK_Demo00000000000000
ESP32/examples/Serial/OnReceive_Demo00000000000000
ESP32/examples/Serial/RS485_Echo_Demo00000000000000
ESP32/examples/Serial/RxFIFOFull_Demo00000000000000
ESP32/examples/Serial/RxTimeout_Demo00000000000000
ESP32/examples/Serial/Serial_All_CPU_Freqs00000000000000
ESP32/examples/Serial/Serial_STD_Func_OnReceive00000000000000
ESP32/examples/Serial/onReceiveExample00000000000000
ESP32/examples/TWAI/TWAIreceive00000000000000
ESP32/examples/TWAI/TWAItransmit00000000000000
ESP32/examples/Template/ExampleTemplate00000000000000
ESP32/examples/Time/SimpleTime0000000000--00
ESP32/examples/Timer/RepeatTimer00000000000000
ESP32/examples/Timer/WatchdogTimer00000000000000
ESP32/examples/Touch/TouchInterrupt000000------00
ESP32/examples/Touch/TouchRead000000------00
ESP32/examples/Utilities/HEXBuilder00000000000000
ESP32/examples/Utilities/MD5Builder00000000000000
ESP32/examples/Utilities/SHA1Builder00000000000000
ESP_I2S/examples/ES8388_loopback00000000000000
ESP_I2S/examples/Record_to_WAV0000--------00
ESP_I2S/examples/Simple_tone00000000000000
ESPmDNS/examples/mDNS-SD_Extended0000000000--00
ESPmDNS/examples/mDNS_Web_Server00💚 -120💚 -1600000--00
Ethernet/examples/ETH_TLK11000----------💚 -120
Ethernet/examples/ETH_W5500_Arduino_SPI00💚 -120💚 -160000000💚 -120
Ethernet/examples/ETH_W5500_IDF_SPI00💚 -120💚 -160000000💚 -120
Ethernet/examples/ETH_WIFI_BRIDGE0000000000--00
FFat/examples/FFat_Test00000000000000
FFat/examples/FFat_time0000000000--00
HTTPClient/examples/Authorization00💚 -200💚 -2400000--💚 -240
HTTPClient/examples/BasicHttpClient00💚 -200💚 -2400000--💚 -240
HTTPClient/examples/BasicHttpsClient00💚 -200💚 -2400000--💚 -240
HTTPClient/examples/ReuseConnection00💚 -200💚 -2400000--💚 -240
HTTPClient/examples/StreamHttpClient00💚 -200💚 -2400000--💚 -280
HTTPUpdate/examples/httpUpdate00💚 -120💚 -1600000--💚 -120
HTTPUpdate/examples/httpUpdateSPIFFS00💚 -120💚 -1600000--💚 -120
HTTPUpdate/examples/httpUpdateSecure00💚 -240💚 -2400000--💚 -240
HTTPUpdateServer/examples/WebUpdater00💚 -120💚 -1600000--00
LittleFS/examples/LITTLEFS_test00000000000000
LittleFS/examples/LITTLEFS_time0000000000--00
NetBIOS/examples/ESP_NBNST0000000000--00
NetworkClientSecure/examples/WiFiClientInsecure00💚 -240💚 -2400000--💚 -200
NetworkClientSecure/examples/WiFiClientPSK00💚 -200💚 -3200000--💚 -200
NetworkClientSecure/examples/WiFiClientSecure00💚 -200💚 -2400000--💚 -200
NetworkClientSecure/examples/WiFiClientSecureProtocolUpgrade00💚 -240💚 -3200000--💚 -240
NetworkClientSecure/examples/WiFiClientShowPeerCredentials00💚 -200💚 -2400000--💚 -240
NetworkClientSecure/examples/WiFiClientTrustOnFirstUse00💚 -200💚 -2400000--💚 -200
PPP/examples/PPP_Basic00💚 -120💚 -16000000000
PPP/examples/PPP_WIFI_BRIDGE0000000000--00
Preferences/examples/Prefs2Struct00000000000000
Preferences/examples/StartCounter00000000000000
SD/examples/SD_Test00000000000000
SD/examples/SD_time0000000000--00
SD_MMC/examples/SD2USBMSC0000----------
SD_MMC/examples/SDMMC_Test0000--------00
SD_MMC/examples/SDMMC_time0000--------00
SPI/examples/SPI_Multiple_Buses00000000000000
SPIFFS/examples/SPIFFS_Test00000000000000
SPIFFS/examples/SPIFFS_time0000000000--00
TFLiteMicro/examples/hello_world00000000000000
Ticker/examples/Blinker00000000000000
Ticker/examples/TickerBasic00000000000000
Ticker/examples/TickerParameter00000000000000
USB/examples/CompositeDevice000000--------
USB/examples/ConsumerControl000000--------
USB/examples/CustomHIDDevice000000--------
USB/examples/FirmwareMSC000000--------
USB/examples/Gamepad000000--------
USB/examples/HIDVendor000000--------
USB/examples/Keyboard/KeyboardLogout000000--------
USB/examples/Keyboard/KeyboardMessage000000--------
USB/examples/Keyboard/KeyboardReprogram000000--------
USB/examples/Keyboard/KeyboardSerial000000--------
USB/examples/KeyboardAndMouseControl000000--------
USB/examples/MIDI/MidiController000000--------
USB/examples/MIDI/MidiInterface000000--------
USB/examples/MIDI/MidiMusicBox000000--------
USB/examples/MIDI/ReceiveMidi000000--------
USB/examples/Mouse/ButtonMouseControl000000--------
USB/examples/SystemControl000000--------
USB/examples/USBMSC000000--------
USB/examples/USBSerial000000--------
USB/examples/USBVendor000000--------
Update/examples/AWS_S3_OTA_Update00💚 -120💚 -1600000--00
Update/examples/HTTPS_OTA_Update0000000000--00
Update/examples/HTTP_Client_AES_OTA_Update00💚 -120💚 -1200000--💚 -120
Update/examples/HTTP_Server_AES_OTA_Update00💚 -120💚 -1600000--00
Update/examples/OTAWebUpdater00💚 -120💚 -1200000--00
Update/examples/SD_Update00000000000000
WebServer/examples/AdvancedWebServer00💚 -160💚 -1600000--00
WebServer/examples/FSBrowser00💚 -120💚 -1600000--00
WebServer/examples/Filters00💚 -120💚 -1600000--00
WebServer/examples/HelloServer00💚 -120💚 -1600000--00
WebServer/examples/HttpAdvancedAuth00💚 -160💚 -1600000--00
WebServer/examples/HttpAuthCallback00💚 -120💚 -1600000--00
WebServer/examples/HttpAuthCallbackInline00💚 -120💚 -1600000--00
WebServer/examples/HttpBasicAuth00💚 -120💚 -1600000--00
WebServer/examples/HttpBasicAuthSHA100💚 -120💚 -1600000--00
WebServer/examples/HttpBasicAuthSHA1orBearerToken00💚 -120💚 -1600000--00
WebServer/examples/MultiHomedServers00💚 -120💚 -2000000--00
WebServer/examples/PathArgServer00💚 -120💚 -2000000--00
WebServer/examples/SDWebServer00💚 -120💚 -2000000--00
WebServer/examples/SimpleAuthentification00💚 -120⚠️ +2400000--00
WebServer/examples/UploadHugeFile00💚 -120💚 -1600000--00
WebServer/examples/WebServer00💚 -120💚 -1600000--00
WebServer/examples/WebUpdate00💚 -120💚 -1600000--00
WiFi/examples/FTM/FTM_Initiator0000000000--00
WiFi/examples/FTM/FTM_Responder0000000000--00
WiFi/examples/SimpleWiFiServer00💚 -120💚 -1600000--00
WiFi/examples/WiFiAccessPoint00💚 -120💚 -1600000--00
WiFi/examples/WiFiClient00💚 -120💚 -1600000--💚 -120
WiFi/examples/WiFiClientBasic00💚 -160💚 -1600000--00
WiFi/examples/WiFiClientConnect0000000000--00
WiFi/examples/WiFiClientEvents0000000000--00
WiFi/examples/WiFiClientStaticIP00💚 -120000000--00
WiFi/examples/WiFiExtender0000000000--00
WiFi/examples/WiFiIPv60000000000--00
WiFi/examples/WiFiMulti0000000000--00
WiFi/examples/WiFiMultiAdvanced00💚 -200💚 -2400000--💚 -240
WiFi/examples/WiFiScan0000000000--00
WiFi/examples/WiFiScanAsync0000000000--00
WiFi/examples/WiFiScanDualAntenna0000000000--00
WiFi/examples/WiFiScanTime0000000000--00
WiFi/examples/WiFiTelnetToSerial00💚 -120💚 -1600000--00
WiFi/examples/WiFiUDPClient0000000000--00
Wire/examples/WireMaster00000000000000
Wire/examples/WireScan00000000000000
Wire/examples/WireSlave00000000000000
BLE/examples/BLE5_extended_scan--00--000000--
BLE/examples/BLE5_multi_advertising--00--000000--
BLE/examples/BLE5_periodic_advertising--00--000000--
BLE/examples/BLE5_periodic_sync--00--000000--
BLE/examples/Beacon_Scanner--00--00000000
BLE/examples/Client--00--00000000
BLE/examples/EddystoneTLM_Beacon--00--00000000
BLE/examples/EddystoneURL_Beacon--00--00000000
BLE/examples/Notify--00--00000000
BLE/examples/Scan--00--00000000
BLE/examples/Server--00--00000000
BLE/examples/Server_multiconnect--00--00000000
BLE/examples/UART--00--00000000
BLE/examples/Write--00--00000000
BLE/examples/iBeacon--00--00000000
ESP32/examples/Camera/CameraWebServer--‼️ +5K⚠️ +496‼️ +4K⚠️ +36------‼️ +12K⚠️ +76
ESP32/examples/DeepSleep/ExternalWakeUp--0000------00
ESP_NOW/examples/ESP_NOW_Broadcast_Master--00000000--00
ESP_NOW/examples/ESP_NOW_Broadcast_Slave--00000000--00
ESP_NOW/examples/ESP_NOW_Network--00000000--00
ESP_NOW/examples/ESP_NOW_Serial--00000000--00
ESP_SR/examples/Basic--00----------
HTTPClient/examples/HTTPClientEnterprise--💚 -200💚 -2400000--💚 -240
Insights/examples/DiagnosticsSmokeTest--00000000--00
Insights/examples/MinimalDiagnostics--00000000--00
Matter/examples/MatterColorLight--00000000--00
Matter/examples/MatterCommissionTest--00000000--00
Matter/examples/MatterComposedLights--00000000--00
Matter/examples/MatterContactSensor--00000000--00
Matter/examples/MatterDimmableLight--00000000--00
Matter/examples/MatterEnhancedColorLight--00000000--00
Matter/examples/MatterFan--00000000--00
Matter/examples/MatterHumiditySensor--00000000--00
Matter/examples/MatterMinimum--00000000--00
Matter/examples/MatterOccupancySensor--00000000--00
Matter/examples/MatterOnIdentify--00000000--00
Matter/examples/MatterOnOffLight--00000000--00
Matter/examples/MatterOnOffPlugin--00000000--00
Matter/examples/MatterPressureSensor--00000000--00
Matter/examples/MatterSmartButon--00000000--00
Matter/examples/MatterTemperatureLight--00000000--00
Matter/examples/MatterTemperatureSensor--00000000--⚠️ +160
Matter/examples/WiFiProvWithinMatter--00000000--00
NetworkClientSecure/examples/WiFiClientSecureEnterprise--💚 -200💚 -2400000--💚 -200
RainMaker/examples/RMakerCustom--00000000--00
RainMaker/examples/RMakerCustomAirCooler--00000000--00
RainMaker/examples/RMakerSonoffDualR3--00000000--00
RainMaker/examples/RMakerSwitch--00000000--00
SimpleBLE/examples/SimpleBleDevice--00--00000000
WiFi/examples/WPS--00000000--00
WiFi/examples/WiFiBlueToothSwitch--00--0000--00
WiFi/examples/WiFiClientEnterprise--💚 -120💚 -1600000--00
WiFi/examples/WiFiSmartConfig--00000000--💚 -160
WiFiProv/examples/WiFiProv--00000000--00
OpenThread/examples/COAP/coap_lamp--------0000--
OpenThread/examples/COAP/coap_switch--------0000--
OpenThread/examples/SimpleCLI--------0000--
OpenThread/examples/SimpleNode--------0000--
OpenThread/examples/SimpleThreadNetwork/ExtendedRouterNode--------0000--
OpenThread/examples/SimpleThreadNetwork/LeaderNode--------0000--
OpenThread/examples/SimpleThreadNetwork/RouterNode--------0000--
OpenThread/examples/ThreadScan--------0000--
OpenThread/examples/onReceive--------0000--
Zigbee/examples/Zigbee_CarbonDioxide_Sensor--------0000--
Zigbee/examples/Zigbee_Color_Dimmable_Light--------0000--
Zigbee/examples/Zigbee_Color_Dimmer_Switch--------0000--
Zigbee/examples/Zigbee_Dimmable_Light--------0000--
Zigbee/examples/Zigbee_Occupancy_Sensor--------0000--
Zigbee/examples/Zigbee_On_Off_Light--------0000--
Zigbee/examples/Zigbee_On_Off_Switch--------0000--
Zigbee/examples/Zigbee_Pressure_Flow_Sensor--------0000--
Zigbee/examples/Zigbee_Scan_Networks--------0000--
Zigbee/examples/Zigbee_Temp_Hum_Sensor_Sleepy--------0000--
Zigbee/examples/Zigbee_Temperature_Sensor--------0000--
Zigbee/examples/Zigbee_Thermostat--------0000--
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------------💚 -120

@JAndrassy
Copy link
Contributor

JAndrassy commented Dec 23, 2024 •
edited
Loading

ESP32/examples/Camera/CameraWebServer memory consumption increased extremely for xtensa toolchain, but that example doesn't use classes modified in this PR

This was referenced Dec 24, 2024
Open
Open
Closed
Closed
@me-no-dev me-no-dev added the Status: Pending Merge Pull Request is ready to be merged label Jan 6, 2025
@pennam pennam mentioned this pull request Jan 7, 2025
Closed
@me-no-dev me-no-dev merged commit 5f44c4e into espressif:master Jan 7, 2025
72 checks passed
@mnltake mnltake mentioned this pull request Jan 8, 2025
Open
@brentru brentru mentioned this pull request Jan 9, 2025
Closed
@lasselukkari lasselukkari mentioned this pull request Jan 12, 2025
Closed
mhaberler pushed a commit to mhaberler/PicoMQTT that referenced this pull request Jan 15, 2025
fix Arduino Client API, again
ead2369 
Espressif reverted the changes done to 3.1.0 in 3.1.1, see espressif/arduino-esp32#10776

so assuming going forward this API will be kept, make this an exception for 3.1.0
mhaberler pushed a commit to mhaberler/PicoMQTT that referenced this pull request Mar 9, 2025
fix Arduino Client API, again
52df371 
Espressif reverted the changes done to 3.1.0 in 3.1.1, see espressif/arduino-esp32#10776

so assuming going forward this API will be kept, make this an exception for 3.1.0
# for free to join this conversation on GitHub. Already have an account? # to comment
Reviewers

@me-no-dev me-no-dev me-no-dev approved these changes

Assignees
No one assigned
Labels
Status: Pending Merge Pull Request is ready to be merged
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Virtual functions in client.h are out of line with standard Arduino API
4 participants
@pennam @CLAassistant @JAndrassy @me-no-dev