diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 69b147b..3d3c4b4 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -3,85 +3,142 @@ name: Arduino Library CI on: push: paths-ignore: - - '**/**.md' - - '/keywords.txt' - - '/library.json' - - '/library.properties' - - '/ui' - - '/docs' + - "**/**.md" + - "/keywords.txt" + - "/library.json" + - "/library.properties" + - "/vue-frontend" + - "/docs" pull_request: paths-ignore: - - '**/**.md' - - '/keywords.txt' - - '/library.json' - - '/library.properties' - - '/ui' - - '/docs' + - "**/**.md" + - "/keywords.txt" + - "/library.json" + - "/library.properties" + - "/vue-frontend" + - "/docs" jobs: - Async_CI: + arduino: + name: arduino ${{ matrix.name }} runs-on: ubuntu-latest + strategy: + fail-fast: false + matrix: + include: + - name: package_esp32_index.json + core: esp32:esp32 + board: esp32:esp32:esp32 + index_url: https://espressif.github.io/arduino-esp32/package_esp32_index.json + - name: package_esp32_dev_index.json + core: esp32:esp32 + board: esp32:esp32:esp32 + index_url: https://espressif.github.io/arduino-esp32/package_esp32_dev_index.json + - name: package_esp8266com_index.json + core: esp8266:esp8266 + board: esp8266:esp8266:huzzah + index_url: https://arduino.esp8266.com/stable/package_esp8266com_index.json + - name: package_rp2040_index.json + core: rp2040:rp2040 + board: rp2040:rp2040:rpipicow + index_url: https://github.com/earlephilhower/arduino-pico/releases/download/global/package_rp2040_index.json + steps: - - uses: actions/setup-python@v1 + - name: Checkout + uses: actions/checkout@v4 + + - name: Arduino Lint + uses: arduino/arduino-lint-action@v1 with: - python-version: '3.x' + library-manager: update - - uses: actions/checkout@v2 + - name: Install arduino-cli + run: curl -fsSL https://raw.githubusercontent.com/arduino/arduino-cli/master/install.sh | BINDIR=/usr/local/bin sh - - uses: actions/checkout@v2 - with: - repository: ayushsharma82/ci-arduino - path: ci + - name: Update core index + run: arduino-cli core update-index --additional-urls "${{ matrix.index_url }}" - - name: pre-install - run: bash ci/actions_install.sh + - name: Install core + run: arduino-cli core install --additional-urls "${{ matrix.index_url }}" ${{ matrix.core }} - - name: Set configuration - run: arduino-cli config set library.enable_unsafe_install true + - name: Install AsyncTCP (ESP32) + if: ${{ matrix.core == 'esp32:esp32' }} + run: ARDUINO_LIBRARY_ENABLE_UNSAFE_INSTALL=true arduino-cli lib install --git-url https://github.com/mathieucarbou/AsyncTCP#v3.1.4 - - name: Install test dependencies - run: arduino-cli lib install --git-url https://github.com/me-no-dev/ESPAsyncWebServer --git-url https://github.com/me-no-dev/ESPAsyncTCP --git-url https://github.com/me-no-dev/AsyncTCP + - name: Install AsyncTCP (RP2040) + if: ${{ matrix.core == 'rp2040:rp2040' }} + run: ARDUINO_LIBRARY_ENABLE_UNSAFE_INSTALL=true arduino-cli lib install --git-url https://github.com/khoih-prog/AsyncTCP_RP2040W#v1.2.0 - - name: Skip SyncDemo Example - run: | - cd examples - cd Demo - touch .esp32.test.skip - touch .esp8266.test.skip - touch .picow_rp2040.test.skip + - name: Install ESPAsyncTCP (ESP8266) + if: ${{ matrix.core == 'esp8266:esp8266' }} + run: ARDUINO_LIBRARY_ENABLE_UNSAFE_INSTALL=true arduino-cli lib install --git-url https://github.com/mathieucarbou/esphome-ESPAsyncTCP#v2.0.0 + + - name: Install ESPAsyncWebServer (ESP32/ESP8266) + if: ${{ matrix.core == 'esp32:esp32' || matrix.core == 'esp8266:esp8266' || matrix.core == 'rp2040:rp2040' }} + run: ARDUINO_LIBRARY_ENABLE_UNSAFE_INSTALL=true arduino-cli lib install --git-url https://github.com/mathieucarbou/ESPAsyncWebServer#v2.10.8 + + - name: Build Demo + run: arduino-cli compile --library . --warnings none -b ${{ matrix.board }} "examples/Demo/Demo.ino" - - name: Configure ElegantOTA to Async Mode + - name: Configure Async Mode run: | cd src sed -i 's/ELEGANTOTA_USE_ASYNC_WEBSERVER 0/ELEGANTOTA_USE_ASYNC_WEBSERVER 1/' ElegantOTA.h - - name: Test Async Demo - run: python3 ci/build_platform.py esp8266 esp32 + - name: Build Async Demo + run: arduino-cli compile --library . --warnings none -b ${{ matrix.board }} "examples/AsyncDemo/AsyncDemo.ino" - Sync_CI: + platformio: + name: pio ${{ matrix.name }} runs-on: ubuntu-latest + strategy: + fail-fast: false + matrix: + include: + - name: esp32dev|arduino + board: esp32dev + platform: espressif32 + opts: + - name: esp32dev|arduino-2 + board: esp32dev + platform: espressif32@6.7.0 + opts: + - name: esp32dev|arduino-3 + board: esp32dev + platform: espressif32 + opts: "--project-option 'platform_packages=platformio/framework-arduinoespressif32 @ https://github.com/espressif/arduino-esp32.git#3.0.1, platform_packages=platformio/framework-arduinoespressif32-libs @ https://github.com/espressif/arduino-esp32/releases/download/3.0.1/esp32-arduino-libs-3.0.1.zip'" + - name: esp32-s3-devkitc-1|arduino + board: esp32-s3-devkitc-1 + platform: espressif32 + opts: + - name: esp32-s3-devkitc-1|arduino-2 + board: esp32-s3-devkitc-1 + platform: espressif32@6.7.0 + opts: + - name: esp32-s3-devkitc-1|arduino-3 + board: esp32-s3-devkitc-1 + platform: espressif32 + opts: "--project-option 'platform_packages=platformio/framework-arduinoespressif32 @ https://github.com/espressif/arduino-esp32.git#3.0.1, platform_packages=platformio/framework-arduinoespressif32-libs @ https://github.com/espressif/arduino-esp32/releases/download/3.0.1/esp32-arduino-libs-3.0.1.zip'" + - name: huzzah|espressif8266 + board: huzzah + platform: espressif8266 + opts: steps: - - uses: actions/setup-python@v1 + - uses: actions/checkout@v4 + - name: Set up cache + uses: actions/cache@v4 with: - python-version: '3.x' - - - uses: actions/checkout@v2 - - - uses: actions/checkout@v2 + path: | + ~/.platformio + ~/.cache/pip + key: ${{ matrix.name }} + - uses: actions/setup-python@v5 with: - repository: adafruit/ci-arduino - path: ci - - - name: pre-install - run: bash ci/actions_install.sh - - - name: Skip AsyncDemo Example - run: | - cd examples - cd AsyncDemo - touch .esp32.test.skip - touch .esp8266.test.skip - touch .picow_rp2040.test.skip - - - name: Test Sync Demo - run: python3 ci/build_platform.py esp8266 esp32 picow_rp2040 + python-version: "3.x" + - name: Install PlatformIO + run: pip install platformio + - name: Install Platform + run: platformio platform install ${{ matrix.platform }} + + - run: platformio ci "examples/Demo/Demo.ino" -l '.' -b ${{ matrix.board }} ${{ matrix.opts }} + - run: PLATFORMIO_BUILD_FLAGS="-DELEGANTOTA_USE_ASYNC_WEBSERVER=1" platformio ci "examples/AsyncDemo/AsyncDemo.ino" -l '.' -b ${{ matrix.board }} ${{ matrix.opts }} diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml new file mode 100644 index 0000000..4279cc6 --- /dev/null +++ b/.github/workflows/stale.yml @@ -0,0 +1,17 @@ +name: 'Close stale issues and PR' +on: + schedule: + - cron: '30 6 * * *' + +jobs: + stale: + runs-on: ubuntu-latest + steps: + - uses: actions/stale@v9 + with: + stale-issue-message: 'This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days.' + stale-pr-message: 'This PR is marked as stale because it has been open 45 days with no activity. You can remove stale label or comment if this PR is still valid.' + close-issue-message: 'This issue was closed because it has been stalled for 5 days with no activity.' + days-before-stale: 30 + days-before-close: 5 + days-before-pr-close: -1 diff --git a/.gitignore b/.gitignore index 78a7633..e1a65ae 100644 --- a/.gitignore +++ b/.gitignore @@ -36,4 +36,5 @@ node_modules .DS_Store .vscode /build -/portal \ No newline at end of file +/portal +.pio diff --git a/library.json b/library.json index 01d5cd4..c3198a8 100644 --- a/library.json +++ b/library.json @@ -15,21 +15,15 @@ "maintainer": true } ], - "dependencies": - [ - { - "owner": "esphome", - "name": "ESPAsyncWebServer-esphome", - "version": "^3.0.0", - "platforms": ["espressif8266", "espressif32"] - }, + "dependencies": [ { - "name": "ESPAsyncWebServer", - "version": "https://github.com/doomhammer/ESPAsyncWebServer#more-rp2040-fixes", - "platforms": ["raspberrypi"] + "owner": "mathieucarbou", + "name": "ESP Async WebServer", + "version": "^2.10.4", + "platforms": ["espressif8266", "espressif32", "raspberrypi"] } ], - "version": "3.1.1", + "version": "3.1.2", "frameworks": "arduino", "platforms": ["espressif8266", "espressif32", "raspberrypi"] } diff --git a/library.properties b/library.properties index 5a4010a..e5342ff 100644 --- a/library.properties +++ b/library.properties @@ -1,5 +1,5 @@ name=ElegantOTA -version=3.1.1 +version=3.1.2 author=Ayush Sharma category=Communication maintainer=Ayush Sharma diff --git a/platformio.ini b/platformio.ini new file mode 100644 index 0000000..79ce2aa --- /dev/null +++ b/platformio.ini @@ -0,0 +1,46 @@ +[env] +framework = arduino +build_flags = + -Wall -Wextra + -D CONFIG_ARDUHAL_LOG_COLORS + -D CORE_DEBUG_LEVEL=ARDUHAL_LOG_LEVEL_DEBUG + -D ELEGANTOTA_USE_ASYNC_WEBSERVER=1 +lib_deps = + mathieucarbou/Async TCP @ ^3.1.4 + mathieucarbou/ESP Async WebServer @ 2.10.4 +upload_protocol = esptool +monitor_speed = 115200 +monitor_filters = esp32_exception_decoder, log2file + +[platformio] +lib_dir = . +; src_dir = examples/Demo +src_dir = examples/AsyncDemo + +[env:arduino] +platform = espressif32 +board = esp32-s3-devkitc-1 + +[env:arduino-2] +platform = espressif32@6.7.0 +board = esp32-s3-devkitc-1 + +[env:arduino-3] +platform = espressif32 +platform_packages= + platformio/framework-arduinoespressif32 @ https://github.com/espressif/arduino-esp32.git#3.0.1 + platformio/framework-arduinoespressif32-libs @ https://github.com/espressif/arduino-esp32/releases/download/3.0.1/esp32-arduino-libs-3.0.1.zip +board = esp32-s3-devkitc-1 + +[env:esp8266] +platform = espressif8266 +board = huzzah +lib_deps = + mathieucarbou/ESP Async WebServer @ 2.10.4 + esphome/ESPAsyncTCP-esphome @ 2.0.0 + +[env:pico] +platform = https://github.com/maxgerhardt/platform-raspberrypi.git +board = pico +framework = arduino +board_build.core = earlephilhower \ No newline at end of file diff --git a/src/ElegantOTA.cpp b/src/ElegantOTA.cpp index 4bf7bfa..af979ed 100644 --- a/src/ElegantOTA.cpp +++ b/src/ElegantOTA.cpp @@ -16,7 +16,7 @@ void ElegantOTAClass::begin(ELEGANTOTA_WEBSERVER *server, const char * username, #if ELEGANTOTA_USE_ASYNC_WEBSERVER == 1 _server->on("/update", HTTP_GET, [&](AsyncWebServerRequest *request){ - if(_authenticate && !request->authenticate(_username, _password)){ + if(_authenticate && !request->authenticate(_username.c_str(), _password.c_str())){ return request->requestAuthentication(); } AsyncWebServerResponse *response = request->beginResponse_P(200, "text/html", ELEGANT_HTML, sizeof(ELEGANT_HTML)); @@ -25,7 +25,7 @@ void ElegantOTAClass::begin(ELEGANTOTA_WEBSERVER *server, const char * username, }); #else _server->on("/update", HTTP_GET, [&](){ - if (_authenticate && !_server->authenticate(_username, _password)) { + if (_authenticate && !_server->authenticate(_username.c_str(), _password.c_str())) { return _server->requestAuthentication(); } _server->sendHeader("Content-Encoding", "gzip"); @@ -35,7 +35,7 @@ void ElegantOTAClass::begin(ELEGANTOTA_WEBSERVER *server, const char * username, #if ELEGANTOTA_USE_ASYNC_WEBSERVER == 1 _server->on("/ota/start", HTTP_GET, [&](AsyncWebServerRequest *request) { - if (_authenticate && !request->authenticate(_username, _password)) { + if (_authenticate && !request->authenticate(_username.c_str(), _password.c_str())) { return request->requestAuthentication(); } @@ -84,7 +84,7 @@ void ElegantOTAClass::begin(ELEGANTOTA_WEBSERVER *server, const char * username, StreamString str; Update.printError(str); _update_error_str = str.c_str(); - _update_error_str += "\n"; + _update_error_str.concat("\n"); ELEGANTOTA_DEBUG_MSG(_update_error_str.c_str()); } #elif defined(ESP32) @@ -94,7 +94,7 @@ void ElegantOTAClass::begin(ELEGANTOTA_WEBSERVER *server, const char * username, StreamString str; Update.printError(str); _update_error_str = str.c_str(); - _update_error_str += "\n"; + _update_error_str.concat("\n"); ELEGANTOTA_DEBUG_MSG(_update_error_str.c_str()); } #endif @@ -103,7 +103,7 @@ void ElegantOTAClass::begin(ELEGANTOTA_WEBSERVER *server, const char * username, }); #else _server->on("/ota/start", HTTP_GET, [&]() { - if (_authenticate && !_server->authenticate(_username, _password)) { + if (_authenticate && !_server->authenticate(_username.c_str(), _password.c_str())) { return _server->requestAuthentication(); } @@ -152,7 +152,7 @@ void ElegantOTAClass::begin(ELEGANTOTA_WEBSERVER *server, const char * username, StreamString str; Update.printError(str); _update_error_str = str.c_str(); - _update_error_str += "\n"; + _update_error_str.concat("\n"); ELEGANTOTA_DEBUG_MSG(_update_error_str.c_str()); } #elif defined(ESP32) @@ -162,7 +162,7 @@ void ElegantOTAClass::begin(ELEGANTOTA_WEBSERVER *server, const char * username, StreamString str; Update.printError(str); _update_error_str = str.c_str(); - _update_error_str += "\n"; + _update_error_str.concat("\n"); ELEGANTOTA_DEBUG_MSG(_update_error_str.c_str()); } #elif defined(TARGET_RP2040) @@ -191,7 +191,7 @@ void ElegantOTAClass::begin(ELEGANTOTA_WEBSERVER *server, const char * username, #if ELEGANTOTA_USE_ASYNC_WEBSERVER == 1 _server->on("/ota/upload", HTTP_POST, [&](AsyncWebServerRequest *request) { - if(_authenticate && !request->authenticate(_username, _password)){ + if(_authenticate && !request->authenticate(_username.c_str(), _password.c_str())){ return request->requestAuthentication(); } // Post-OTA update callback @@ -210,7 +210,7 @@ void ElegantOTAClass::begin(ELEGANTOTA_WEBSERVER *server, const char * username, }, [&](AsyncWebServerRequest *request, String filename, size_t index, uint8_t *data, size_t len, bool final) { //Upload handler chunks in data if(_authenticate){ - if(!request->authenticate(_username, _password)){ + if(!request->authenticate(_username.c_str(), _password.c_str())){ return request->requestAuthentication(); } } @@ -236,7 +236,7 @@ void ElegantOTAClass::begin(ELEGANTOTA_WEBSERVER *server, const char * username, StreamString str; Update.printError(str); _update_error_str = str.c_str(); - _update_error_str += "\n"; + _update_error_str.concat("\n"); ELEGANTOTA_DEBUG_MSG(_update_error_str.c_str()); } }else{ @@ -245,7 +245,7 @@ void ElegantOTAClass::begin(ELEGANTOTA_WEBSERVER *server, const char * username, }); #else _server->on("/ota/upload", HTTP_POST, [&](){ - if (_authenticate && !_server->authenticate(_username, _password)) { + if (_authenticate && !_server->authenticate(_username.c_str(), _password.c_str())) { return _server->requestAuthentication(); } // Post-OTA update callback @@ -264,7 +264,7 @@ void ElegantOTAClass::begin(ELEGANTOTA_WEBSERVER *server, const char * username, HTTPUpload& upload = _server->upload(); if (upload.status == UPLOAD_FILE_START) { // Check authentication - if (_authenticate && !_server->authenticate(_username, _password)) { + if (_authenticate && !_server->authenticate(_username.c_str(), _password.c_str())) { ELEGANTOTA_DEBUG_MSG("Authentication Failed on UPLOAD_FILE_START\n"); return; } @@ -289,7 +289,7 @@ void ElegantOTAClass::begin(ELEGANTOTA_WEBSERVER *server, const char * username, StreamString str; Update.printError(str); _update_error_str = str.c_str(); - _update_error_str += "\n"; + _update_error_str.concat("\n"); ELEGANTOTA_DEBUG_MSG(_update_error_str.c_str()); } @@ -304,11 +304,9 @@ void ElegantOTAClass::begin(ELEGANTOTA_WEBSERVER *server, const char * username, } void ElegantOTAClass::setAuth(const char * username, const char * password){ - if (strlen(username) > 0 && strlen(password) > 0) { - strlcpy(_username, username, sizeof(_username)); - strlcpy(_password, password, sizeof(_password)); - _authenticate = true; - } + _username = username; + _password = password; + _authenticate = _username.length() && _password.length(); } void ElegantOTAClass::clearAuth(){ diff --git a/src/ElegantOTA.h b/src/ElegantOTA.h index ac33e79..5ad77f2 100644 --- a/src/ElegantOTA.h +++ b/src/ElegantOTA.h @@ -121,8 +121,8 @@ class ElegantOTAClass{ ELEGANTOTA_WEBSERVER *_server; bool _authenticate; - char _username[64]; - char _password[64]; + String _username; + String _password; bool _auto_reboot = true; bool _reboot = false;