[ { "path": ".github/workflows/clean_workflow.yml", "content": "name: Clean Workflow Logs\non:\n workflow_dispatch:\n inputs:\n keep_minimum_runs:\n description: \"Numero di workflow recenti da mantenere\"\n default: \"5\"\n required: false\njobs:\n clean-logs:\n runs-on: ubuntu-latest\n permissions:\n actions: write\n steps:\n - name: Delete workflow runs\n uses: Mattraks/delete-workflow-runs@v2\n with:\n token: ${{ secrets.GITHUB_TOKEN }}\n repository: ${{ github.repository }}\n retain_days: 0 # Imposta a 0 per ignorare la data e considerare solo keep_minimum_runs\n keep_minimum_runs: ${{ github.event.inputs.keep_minimum_runs }}\n" }, { "path": ".github/workflows/cli-build-esp32-dev.yml", "content": "# yaml-language-server: $schema=https://json.schemastore.org/github-workflow.json\n\nname: (ESP32) Build dev with Arduino CLI\n\non:\n workflow_dispatch:\n push:\n branches:\n - dev\n \n pull_request:\n\nconcurrency:\n group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}\n cancel-in-progress: true\n\njobs:\n arduino-esp32:\n name: ESP32 (arduino-cli) (shard=${{ matrix.shard }})\n if: github.event_name == 'workflow_dispatch' || vars.ENABLE_BUILDS == 'true'\n runs-on: ubuntu-latest\n strategy:\n fail-fast: false\n matrix:\n shard: [1, 2, 3, 4]\n steps:\n - name: Checkout\n uses: actions/checkout@v4\n\n - name: Install arduino-cli\n run: curl -fsSL https://raw.githubusercontent.com/arduino/arduino-cli/master/install.sh | BINDIR=/usr/local/bin sh\n\n - name: Cache Arduino CLI data\n uses: actions/cache@v4\n with:\n key: ${{ runner.os }}-arduino-esp32-${{ hashFiles('.github/workflows/cli-build-esp32-dev.yml') }}-${{ github.run_id }}-${{ matrix.shard }}\n restore-keys: |\n ${{ runner.os }}-arduino-esp32-${{ hashFiles('.github/workflows/cli-build-esp32-dev.yml') }}-\n ${{ runner.os }}-arduino-esp32-\n path: |\n ~/.arduino15\n ~/Arduino\n ~/.cache/arduino-cli\n\n - name: Update core index\n run: arduino-cli core update-index --additional-urls https://espressif.github.io/arduino-esp32/package_esp32_index.json\n\n - name: Install core\n run: arduino-cli core install --additional-urls https://espressif.github.io/arduino-esp32/package_esp32_index.json esp32:esp32\n\n - name: Install ArduinoJson\n run: arduino-cli lib install ArduinoJson\n\n - name: Install Arduino-MySQL\n run: ARDUINO_LIBRARY_ENABLE_UNSAFE_INSTALL=true arduino-cli lib install --git-url https://github.com/cotestatnt/Arduino-MySQL\n\n - name: Install Arduino_MFRC522v2\n run: ARDUINO_LIBRARY_ENABLE_UNSAFE_INSTALL=true arduino-cli lib install --git-url https://github.com/OSSLibraries/Arduino_MFRC522v2\n\n - name: Install PubSubClient\n run: ARDUINO_LIBRARY_ENABLE_UNSAFE_INSTALL=true arduino-cli lib install --git-url https://github.com/knolleary/pubsubclient \n\n - name: Build Examples\n run: |\n set -uo pipefail\n\n total_shards=4\n shard=\"${{ matrix.shard }}\"\n\n report_file=\"build-report-esp32-arduino-cli-shard${{ matrix.shard }}.txt\"\n : > \"$report_file\"\n\n failures=0\n total=0\n index=0\n\n for dir in examples/*; do\n if [[ ! -d \"$dir\" ]]; then\n continue\n fi\n\n example=\"$(basename \"$dir\")\"\n\n # Split examples across shards for faster CI.\n index=$((index + 1))\n example_shard=$(( (index - 1) % total_shards + 1 ))\n if [[ \"$example_shard\" != \"$shard\" ]]; then\n continue\n fi\n\n sketch=\"examples/${example}/${example}.ino\"\n total=$((total + 1))\n\n echo \"=============================================================\"\n echo \"Building ${sketch}...\"\n echo \"=============================================================\"\n\n if [[ ! -f \"$sketch\" ]]; then\n failures=$((failures + 1))\n printf '%-25s : FAIL (missing %s)\\n' \"${example}\" \"${sketch}\" >> \"$report_file\"\n continue\n fi\n\n echo \"::group::arduino-cli compile - ${example}\"\n set +e\n arduino-cli compile \\\n --library . \\\n --warnings none \\\n --build-cache-path \"$HOME/.cache/arduino-cli\" \\\n -b esp32:esp32:esp32 \\\n \"$sketch\"\n rc=$?\n set -e\n echo \"::endgroup::\"\n\n if [[ $rc -eq 0 ]]; then\n printf '%-25s : OK\\n' \"${example}\" >> \"$report_file\"\n else\n failures=$((failures + 1))\n printf '%-25s : FAIL (exit=%s)\\n' \"${example}\" \"$rc\" >> \"$report_file\"\n fi\n done\n\n echo \"\"\n echo \"==================== Build report (arduino-cli) ====================\"\n cat \"$report_file\"\n echo \"===================================================================\"\n echo \"Total attempted: ${total} | Failures: ${failures}\"\n\n # Do not fail the job here: the final report job will decide.\n\n - name: Upload build report\n if: always()\n uses: actions/upload-artifact@v4\n with:\n name: arduino-cli-esp32-report-shard${{ matrix.shard }}\n path: build-report-esp32-arduino-cli-shard${{ matrix.shard }}.txt\n\n report:\n name: ESP32 (arduino-cli) - Final report\n runs-on: ubuntu-latest\n needs: arduino-esp32\n if: always() && needs.arduino-esp32.result != 'skipped'\n steps:\n - name: Download all reports\n uses: actions/download-artifact@v4\n with:\n pattern: arduino-cli-esp32-report-*\n merge-multiple: true\n path: reports\n\n - name: Print final report and set status\n run: |\n set -uo pipefail\n echo \"==================== Final build report (ESP32/arduino-cli) ====================\"\n failures=0\n files=0\n shopt -s nullglob\n for f in reports/*.txt; do\n files=$((files + 1))\n echo \"--- ${f} ---\"\n cat \"$f\"\n if grep -q \" : FAIL\" \"$f\"; then\n failures=$((failures + 1))\n fi\n done\n if [[ $files -eq 0 ]]; then\n echo \"No report files found (artifact download failed?)\"\n exit 1\n fi\n echo \"===========================================================================\"\n if [[ $failures -gt 0 ]]; then\n echo \"One or more shards reported FAIL.\"\n exit 1\n fi\n\n" }, { "path": ".github/workflows/cli-build-esp8266.yml", "content": "# yaml-language-server: $schema=https://json.schemastore.org/github-workflow.json\n\nname: (ESP8266) Build with Arduino CLI\n\non:\n workflow_dispatch:\n push:\n branches:\n - dev\n pull_request:\n\nconcurrency:\n group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}\n cancel-in-progress: true\n\njobs:\n arduino-esp8266:\n name: ESP8266 (arduino-cli) (shard=${{ matrix.shard }})\n if: github.event_name == 'workflow_dispatch' || vars.ENABLE_BUILDS == 'true'\n runs-on: ubuntu-latest\n strategy:\n fail-fast: false\n matrix:\n shard: [1, 2, 3, 4]\n steps:\n - name: Checkout\n uses: actions/checkout@v4\n\n - name: Install arduino-cli\n run: curl -fsSL https://raw.githubusercontent.com/arduino/arduino-cli/master/install.sh | BINDIR=/usr/local/bin sh\n\n - name: Cache Arduino CLI data\n uses: actions/cache@v4\n with:\n key: ${{ runner.os }}-arduino-esp8266-${{ hashFiles('.github/workflows/cli-build-esp8266.yml') }}-${{ github.run_id }}-${{ matrix.shard }}\n restore-keys: |\n ${{ runner.os }}-arduino-esp8266-${{ hashFiles('.github/workflows/cli-build-esp8266.yml') }}-\n ${{ runner.os }}-arduino-esp8266-\n path: |\n ~/.arduino15\n ~/Arduino\n ~/.cache/arduino-cli\n\n - name: Update core index\n run: arduino-cli core update-index --additional-urls https://arduino.esp8266.com/stable/package_esp8266com_index.json\n\n - name: Install core\n run: arduino-cli core install --additional-urls https://arduino.esp8266.com/stable/package_esp8266com_index.json esp8266:esp8266\n\n - name: Install ArduinoJson\n run: arduino-cli lib install ArduinoJson\n\n - name: Build Examples\n run: |\n set -uo pipefail\n\n total_shards=4\n shard=\"${{ matrix.shard }}\"\n\n # Examples not intended for ESP8266 / this job\n EXCLUDE_EXAMPLES=(\n esp32-cam\n binaryWebSocket\n csvLoggerSD\n localRFID\n mysqlRFID\n mqtt_webserver\n )\n\n report_file=\"build-report-esp8266-arduino-cli-shard${{ matrix.shard }}.txt\"\n : > \"$report_file\"\n\n failures=0\n total=0\n index=0\n\n for dir in examples/*; do\n if [[ ! -d \"$dir\" ]]; then\n continue\n fi\n\n example=\"$(basename \"$dir\")\"\n\n if [[ \" ${EXCLUDE_EXAMPLES[*]} \" == *\" ${example} \"* ]]; then\n echo \"Skipping: ${example}\"\n printf '%-25s : SKIP\\n' \"${example}\" >> \"$report_file\"\n continue\n fi\n\n # Split examples across shards for faster CI.\n index=$((index + 1))\n example_shard=$(( (index - 1) % total_shards + 1 ))\n if [[ \"$example_shard\" != \"$shard\" ]]; then\n continue\n fi\n\n sketch=\"examples/${example}/${example}.ino\"\n total=$((total + 1))\n\n echo \"=============================================================\"\n echo \"Building ${sketch}...\"\n echo \"=============================================================\"\n\n if [[ ! -f \"$sketch\" ]]; then\n failures=$((failures + 1))\n printf '%-25s : FAIL (missing %s)\\n' \"${example}\" \"${sketch}\" >> \"$report_file\"\n continue\n fi\n\n echo \"::group::arduino-cli compile - ${example}\"\n set +e\n arduino-cli compile \\\n --library . \\\n --warnings none \\\n --build-cache-path \"$HOME/.cache/arduino-cli\" \\\n -b esp8266:esp8266:huzzah \\\n \"$sketch\"\n rc=$?\n set -e\n echo \"::endgroup::\"\n\n if [[ $rc -eq 0 ]]; then\n printf '%-25s : OK\\n' \"${example}\" >> \"$report_file\"\n else\n failures=$((failures + 1))\n printf '%-25s : FAIL (exit=%s)\\n' \"${example}\" \"$rc\" >> \"$report_file\"\n fi\n done\n\n echo \"\"\n echo \"==================== Build report (esp8266/arduino-cli) ====================\"\n cat \"$report_file\"\n echo \"=============================================================================\"\n echo \"Total attempted: ${total} | Failures: ${failures}\"\n\n # Do not fail the job here: the final report job will decide.\n\n - name: Upload build report\n if: always()\n uses: actions/upload-artifact@v4\n with:\n name: arduino-cli-esp8266-report-shard${{ matrix.shard }}\n path: build-report-esp8266-arduino-cli-shard${{ matrix.shard }}.txt\n\n report:\n name: ESP8266 (arduino-cli) - Final report\n runs-on: ubuntu-latest\n needs: arduino-esp8266\n if: always() && needs.arduino-esp8266.result != 'skipped'\n steps:\n - name: Download all reports\n uses: actions/download-artifact@v4\n with:\n pattern: arduino-cli-esp8266-report-*\n merge-multiple: true\n path: reports\n\n - name: Print final report and set status\n run: |\n set -uo pipefail\n echo \"==================== Final build report (ESP8266/arduino-cli) ====================\"\n failures=0\n files=0\n shopt -s nullglob\n for f in reports/*.txt; do\n files=$((files + 1))\n echo \"--- ${f} ---\"\n cat \"$f\"\n if grep -q \" : FAIL\" \"$f\"; then\n failures=$((failures + 1))\n fi\n done\n if [[ $files -eq 0 ]]; then\n echo \"No report files found (artifact download failed?)\"\n exit 1\n fi\n echo \"===========================================================================\"\n if [[ $failures -gt 0 ]]; then\n echo \"One or more shards reported FAIL.\"\n exit 1\n fi\n" }, { "path": ".github/workflows/pio-build-esp32-dev.yml", "content": "# yaml-language-server: $schema=https://json.schemastore.org/github-workflow.json\n\nname: (ESP32) Build dev with PlatformIO\n\non:\n workflow_dispatch:\n push:\n branches:\n - dev\n \n pull_request:\n\nconcurrency:\n group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}\n cancel-in-progress: true\n\njobs:\n # Build with PlatformIO - ESP32 Arduino Latest\n\n platformio-esp32-arduino-latest:\n name: ESP32 (pio) - Arduino Latest (board=${{ matrix.board }}, shard=${{ matrix.shard }})\n if: github.event_name == 'workflow_dispatch' || vars.ENABLE_BUILDS == 'true'\n runs-on: ubuntu-latest\n strategy:\n fail-fast: false\n matrix:\n board:\n - esp32dev\n - esp32-s3-devkitc-1\n shard: [1, 2, 3, 4]\n\n steps:\n - name: Checkout\n uses: actions/checkout@v4\n\n - name: Cache PlatformIO\n uses: actions/cache@v4\n with:\n key: ${{ runner.os }}-pio\n path: |\n ~/.cache/pip\n ~/.platformio\n\n - name: Python\n uses: actions/setup-python@v5\n with:\n python-version: \"3.13\"\n\n - name: Install PIO\n run: |\n python -m pip install --upgrade pip\n pip install --upgrade platformio\n\n - name: Build Examples\n run: |\n set -uo pipefail\n\n total_shards=4\n shard=\"${{ matrix.shard }}\"\n\n report_file=\"build-report-${{ matrix.board }}-shard${{ matrix.shard }}.txt\"\n : > \"$report_file\"\n\n failures=0\n total=0\n index=0\n\n for dir in examples/*; do\n if [[ ! -d \"$dir\" ]]; then\n continue\n fi\n\n example=\"$(basename \"$dir\")\"\n board_to_use=\"${{ matrix.board }}\"\n\n # Split examples across shards for faster CI.\n index=$((index + 1))\n example_shard=$(( (index - 1) % total_shards + 1 ))\n if [[ \"$example_shard\" != \"$shard\" ]]; then\n continue\n fi\n\n # Avoid duplicating esp32-cam across the board matrix.\n if [[ \"$example\" == \"esp32-cam\" && \"${{ matrix.board }}\" != \"esp32dev\" ]]; then\n printf '%-25s : SKIP (board-specific)\\n' \"${example}\" >> \"$report_file\"\n continue\n fi\n\n # Some examples are board-specific\n if [[ \"$example\" == \"esp32-cam\" ]]; then\n board_to_use=\"esp32cam\"\n fi\n\n total=$((total + 1))\n\n echo \"=============================================================\"\n echo \"Building examples/${example} (board=${board_to_use})...\"\n echo \"=============================================================\"\n\n echo \"::group::pio run - examples/${example}\"\n set +e\n # Use a per-example build directory to avoid cross-example artefacts.\n PLATFORMIO_BUILD_DIR=\".pio/build-${board_to_use}-${example}\" \\\n PLATFORMIO_SRC_DIR=\"examples/${example}\" PIO_BOARD=\"${board_to_use}\" \\\n pio run -e ci-arduino-3-latest\n rc=$?\n set -e\n echo \"::endgroup::\"\n\n if [[ $rc -eq 0 ]]; then\n printf '%-25s : OK\\n' \"${example}\" >> \"$report_file\"\n else\n failures=$((failures + 1))\n printf '%-25s : FAIL (exit=%s)\\n' \"${example}\" \"$rc\" >> \"$report_file\"\n fi\n done\n\n echo \"\"\n echo \"==================== Build report (board=${{ matrix.board }}) ====================\"\n cat \"$report_file\"\n echo \"=============================================================================\"\n echo \"Total attempted: ${total} | Failures: ${failures}\"\n\n # Do not fail the job here: the final report job will decide.\n\n - name: Upload build report\n if: always()\n uses: actions/upload-artifact@v4\n with:\n name: pio-esp32-report-${{ matrix.board }}-shard${{ matrix.shard }}\n path: build-report-${{ matrix.board }}-shard${{ matrix.shard }}.txt\n\n report:\n name: ESP32 (pio) - Final report\n runs-on: ubuntu-latest\n needs: platformio-esp32-arduino-latest\n if: always() && needs.platformio-esp32-arduino-latest.result != 'skipped'\n steps:\n - name: Download all reports\n uses: actions/download-artifact@v4\n with:\n pattern: pio-esp32-report-*\n merge-multiple: true\n path: reports\n\n - name: Print final report and set status\n run: |\n set -uo pipefail\n echo \"==================== Final build report (ESP32/pio) ====================\"\n failures=0\n files=0\n shopt -s nullglob\n for f in reports/*.txt; do\n files=$((files + 1))\n echo \"--- ${f} ---\"\n cat \"$f\"\n if grep -q \" : FAIL\" \"$f\"; then\n failures=$((failures + 1))\n fi\n done\n if [[ $files -eq 0 ]]; then\n echo \"No report files found (artifact download failed?)\"\n exit 1\n fi\n echo \"=======================================================================\"\n if [[ $failures -gt 0 ]]; then\n echo \"One or more shards reported FAIL.\"\n exit 1\n fi\n\n" }, { "path": ".github/workflows/pio-build-esp8266.yml", "content": "# yaml-language-server: $schema=https://json.schemastore.org/github-workflow.json\n\nname: (ESP8266) Build with PlatformIO\n\non:\n workflow_dispatch:\n push:\n branches:\n - dev\n pull_request:\n\nconcurrency:\n group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}\n cancel-in-progress: true\n\njobs:\n platformio-esp8266:\n name: ESP8266 (pio) (board=${{ matrix.board }}, shard=${{ matrix.shard }})\n if: github.event_name == 'workflow_dispatch' || vars.ENABLE_BUILDS == 'true'\n runs-on: ubuntu-latest\n strategy:\n fail-fast: false\n matrix:\n board:\n - d1_mini\n shard: [1, 2, 3, 4]\n\n steps:\n - name: Checkout\n uses: actions/checkout@v4\n\n - name: Cache PlatformIO\n uses: actions/cache@v4\n with:\n key: ${{ runner.os }}-pio\n path: |\n ~/.cache/pip\n ~/.platformio\n\n - name: Python\n uses: actions/setup-python@v5\n with:\n python-version: \"3.x\"\n\n - name: Install PIO\n run: |\n python -m pip install --upgrade pip\n pip install --upgrade platformio\n\n - name: Build Examples\n run: |\n set -uo pipefail\n\n total_shards=4\n shard=\"${{ matrix.shard }}\"\n\n # Examples not intended for ESP8266 / this job\n EXCLUDE_EXAMPLES=(\n esp32-cam\n binaryWebSocket\n csvLoggerSD\n localRFID\n mysqlRFID\n mqtt_webserver\n )\n\n report_file=\"build-report-esp8266-pio-${{ matrix.board }}-shard${{ matrix.shard }}.txt\"\n : > \"$report_file\"\n\n failures=0\n total=0\n index=0\n\n for dir in examples/*; do\n if [[ ! -d \"$dir\" ]]; then\n continue\n fi\n\n example=\"$(basename \"$dir\")\"\n\n if [[ \" ${EXCLUDE_EXAMPLES[*]} \" == *\" ${example} \"* ]]; then\n echo \"Skipping: ${example}\"\n printf '%-25s : SKIP\\n' \"${example}\" >> \"$report_file\"\n continue\n fi\n\n # Split examples across shards for faster CI.\n index=$((index + 1))\n example_shard=$(( (index - 1) % total_shards + 1 ))\n if [[ \"$example_shard\" != \"$shard\" ]]; then\n continue\n fi\n\n total=$((total + 1))\n\n echo \"=============================================================\"\n echo \"Building examples/${example} (board=${{ matrix.board }}, shard=${shard})...\"\n echo \"=============================================================\"\n\n echo \"::group::pio run - examples/${example}\"\n set +e\n # Use a per-example build directory to avoid cross-example artefacts.\n PLATFORMIO_BUILD_DIR=\".pio/build-${{ matrix.board }}-${example}\" \\\n PLATFORMIO_SRC_DIR=\"examples/${example}\" PIO_BOARD=\"${{ matrix.board }}\" \\\n pio run -e ci-esp8266\n rc=$?\n set -e\n echo \"::endgroup::\"\n\n if [[ $rc -eq 0 ]]; then\n printf '%-25s : OK\\n' \"${example}\" >> \"$report_file\"\n else\n failures=$((failures + 1))\n printf '%-25s : FAIL (exit=%s)\\n' \"${example}\" \"$rc\" >> \"$report_file\"\n fi\n done\n\n echo \"\"\n echo \"==================== Build report (esp8266/pio, board=${{ matrix.board }}, shard=${{ matrix.shard }}) ====================\"\n cat \"$report_file\"\n echo \"===============================================================================================\"\n echo \"Total attempted: ${total} | Failures: ${failures}\"\n\n # Do not fail the job here: the final report job will decide.\n\n - name: Upload build report\n if: always()\n uses: actions/upload-artifact@v4\n with:\n name: pio-esp8266-report-${{ matrix.board }}-shard${{ matrix.shard }}\n path: build-report-esp8266-pio-${{ matrix.board }}-shard${{ matrix.shard }}.txt\n\n report:\n name: ESP8266 (pio) - Final report\n runs-on: ubuntu-latest\n needs: platformio-esp8266\n if: always() && needs.platformio-esp8266.result != 'skipped'\n steps:\n - name: Download all reports\n uses: actions/download-artifact@v4\n with:\n pattern: pio-esp8266-report-*\n merge-multiple: true\n path: reports\n\n - name: Print final report and set status\n run: |\n set -uo pipefail\n echo \"==================== Final build report (ESP8266/pio) ====================\"\n failures=0\n files=0\n shopt -s nullglob\n for f in reports/*.txt; do\n files=$((files + 1))\n echo \"--- ${f} ---\"\n cat \"$f\"\n if grep -q \" : FAIL\" \"$f\"; then\n failures=$((failures + 1))\n fi\n done\n if [[ $files -eq 0 ]]; then\n echo \"No report files found (artifact download failed?)\"\n exit 1\n fi\n echo \"===========================================================================\"\n if [[ $failures -gt 0 ]]; then\n echo \"One or more shards reported FAIL.\"\n exit 1\n fi\n\n" }, { "path": ".gitignore", "content": "# Prerequisites\n*.d\n\n# Compiled Object files\n*.slo\n*.lo\n*.o\n*.obj\n\n# Precompiled Headers\n*.gch\n*.pch\n\n# Compiled Dynamic libraries\n*.so\n*.dylib\n*.dll\n\n# Fortran module files\n*.mod\n*.smod\n\n# Compiled Static libraries\n*.lai\n*.la\n*.a\n*.lib\n\n# Executables\n*.exe\n*.out\n*.app\n\n# PlatformIO in VScode\n.pio/\n.vscode/\n*.lnk\n*.bak\n/build\n/built-in-webpages/setup/build_setup/node_modules\n/examples/customHTML/build\n/pio_examples/temp\n/pio_examples/simpleServer/setup/build_setup/node_modules\n/built-in-webpages/edit/build_edit/node_modules\n" }, { "path": "LICENSE", "content": " Apache License\n Version 2.0, January 2004\n http://www.apache.org/licenses/\n\n TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\n\n 1. Definitions.\n\n \"License\" shall mean the terms and conditions for use, reproduction,\n and distribution as defined by Sections 1 through 9 of this document.\n\n \"Licensor\" shall mean the copyright owner or entity authorized by\n the copyright owner that is granting the License.\n\n \"Legal Entity\" shall mean the union of the acting entity and all\n other entities that control, are controlled by, or are under common\n control with that entity. For the purposes of this definition,\n \"control\" means (i) the power, direct or indirect, to cause the\n direction or management of such entity, whether by contract or\n otherwise, or (ii) ownership of fifty percent (50%) or more of the\n outstanding shares, or (iii) beneficial ownership of such entity.\n\n \"You\" (or \"Your\") shall mean an individual or Legal Entity\n exercising permissions granted by this License.\n\n \"Source\" form shall mean the preferred form for making modifications,\n including but not limited to software source code, documentation\n source, and configuration files.\n\n \"Object\" form shall mean any form resulting from mechanical\n transformation or translation of a Source form, including but\n not limited to compiled object code, generated documentation,\n and conversions to other media types.\n\n \"Work\" shall mean the work of authorship, whether in Source or\n Object form, made available under the License, as indicated by a\n copyright notice that is included in or attached to the work\n (an example is provided in the Appendix below).\n\n \"Derivative Works\" shall mean any work, whether in Source or Object\n form, that is based on (or derived from) the Work and for which the\n editorial revisions, annotations, elaborations, or other modifications\n represent, as a whole, an original work of authorship. For the purposes\n of this License, Derivative Works shall not include works that remain\n separable from, or merely link (or bind by name) to the interfaces of,\n the Work and Derivative Works thereof.\n\n \"Contribution\" shall mean any work of authorship, including\n the original version of the Work and any modifications or additions\n to that Work or Derivative Works thereof, that is intentionally\n submitted to Licensor for inclusion in the Work by the copyright owner\n or by an individual or Legal Entity authorized to submit on behalf of\n the copyright owner. For the purposes of this definition, \"submitted\"\n means any form of electronic, verbal, or written communication sent\n to the Licensor or its representatives, including but not limited to\n communication on electronic mailing lists, source code control systems,\n and issue tracking systems that are managed by, or on behalf of, the\n Licensor for the purpose of discussing and improving the Work, but\n excluding communication that is conspicuously marked or otherwise\n designated in writing by the copyright owner as \"Not a Contribution.\"\n\n \"Contributor\" shall mean Licensor and any individual or Legal Entity\n on behalf of whom a Contribution has been received by Licensor and\n subsequently incorporated within the Work.\n\n 2. Grant of Copyright License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n copyright license to reproduce, prepare Derivative Works of,\n publicly display, publicly perform, sublicense, and distribute the\n Work and such Derivative Works in Source or Object form.\n\n 3. Grant of Patent License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n (except as stated in this section) patent license to make, have made,\n use, offer to sell, sell, import, and otherwise transfer the Work,\n where such license applies only to those patent claims licensable\n by such Contributor that are necessarily infringed by their\n Contribution(s) alone or by combination of their Contribution(s)\n with the Work to which such Contribution(s) was submitted. If You\n institute patent litigation against any entity (including a\n cross-claim or counterclaim in a lawsuit) alleging that the Work\n or a Contribution incorporated within the Work constitutes direct\n or contributory patent infringement, then any patent licenses\n granted to You under this License for that Work shall terminate\n as of the date such litigation is filed.\n\n 4. Redistribution. You may reproduce and distribute copies of the\n Work or Derivative Works thereof in any medium, with or without\n modifications, and in Source or Object form, provided that You\n meet the following conditions:\n\n (a) You must give any other recipients of the Work or\n Derivative Works a copy of this License; and\n\n (b) You must cause any modified files to carry prominent notices\n stating that You changed the files; and\n\n (c) You must retain, in the Source form of any Derivative Works\n that You distribute, all copyright, patent, trademark, and\n attribution notices from the Source form of the Work,\n excluding those notices that do not pertain to any part of\n the Derivative Works; and\n\n (d) If the Work includes a \"NOTICE\" text file as part of its\n distribution, then any Derivative Works that You distribute must\n include a readable copy of the attribution notices contained\n within such NOTICE file, excluding those notices that do not\n pertain to any part of the Derivative Works, in at least one\n of the following places: within a NOTICE text file distributed\n as part of the Derivative Works; within the Source form or\n documentation, if provided along with the Derivative Works; or,\n within a display generated by the Derivative Works, if and\n wherever such third-party notices normally appear. The contents\n of the NOTICE file are for informational purposes only and\n do not modify the License. You may add Your own attribution\n notices within Derivative Works that You distribute, alongside\n or as an addendum to the NOTICE text from the Work, provided\n that such additional attribution notices cannot be construed\n as modifying the License.\n\n You may add Your own copyright statement to Your modifications and\n may provide additional or different license terms and conditions\n for use, reproduction, or distribution of Your modifications, or\n for any such Derivative Works as a whole, provided Your use,\n reproduction, and distribution of the Work otherwise complies with\n the conditions stated in this License.\n\n 5. Submission of Contributions. Unless You explicitly state otherwise,\n any Contribution intentionally submitted for inclusion in the Work\n by You to the Licensor shall be under the terms and conditions of\n this License, without any additional terms or conditions.\n Notwithstanding the above, nothing herein shall supersede or modify\n the terms of any separate license agreement you may have executed\n with Licensor regarding such Contributions.\n\n 6. Trademarks. This License does not grant permission to use the trade\n names, trademarks, service marks, or product names of the Licensor,\n except as required for reasonable and customary use in describing the\n origin of the Work and reproducing the content of the NOTICE file.\n\n 7. Disclaimer of Warranty. Unless required by applicable law or\n agreed to in writing, Licensor provides the Work (and each\n Contributor provides its Contributions) on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\n implied, including, without limitation, any warranties or conditions\n of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A\n PARTICULAR PURPOSE. You are solely responsible for determining the\n appropriateness of using or redistributing the Work and assume any\n risks associated with Your exercise of permissions under this License.\n\n 8. Limitation of Liability. In no event and under no legal theory,\n whether in tort (including negligence), contract, or otherwise,\n unless required by applicable law (such as deliberate and grossly\n negligent acts) or agreed to in writing, shall any Contributor be\n liable to You for damages, including any direct, indirect, special,\n incidental, or consequential damages of any character arising as a\n result of this License or out of the use or inability to use the\n Work (including but not limited to damages for loss of goodwill,\n work stoppage, computer failure or malfunction, or any and all\n other commercial damages or losses), even if such Contributor\n has been advised of the possibility of such damages.\n\n 9. Accepting Warranty or Additional Liability. While redistributing\n the Work or Derivative Works thereof, You may choose to offer,\n and charge a fee for, acceptance of support, warranty, indemnity,\n or other liability obligations and/or rights consistent with this\n License. However, in accepting such obligations, You may act only\n on Your own behalf and on Your sole responsibility, not on behalf\n of any other Contributor, and only if You agree to indemnify,\n defend, and hold each Contributor harmless for any liability\n incurred by, or claims asserted against, such Contributor by reason\n of your accepting any such warranty or additional liability.\n\n END OF TERMS AND CONDITIONS\n\n APPENDIX: How to apply the Apache License to your work.\n\n To apply the Apache License to your work, attach the following\n boilerplate notice, with the fields enclosed by brackets \"[]\"\n replaced with your own identifying information. (Don't include\n the brackets!) The text should be enclosed in the appropriate\n comment syntax for the file format. We also recommend that a\n file or class name and description of purpose be included on the\n same \"printed page\" as the copyright notice for easier\n identification within third-party archives.\n\n Copyright [yyyy] [name of copyright owner]\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use this file except in compliance with the License.\n You may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\n Unless required by applicable law or agreed to in writing, software\n distributed under the License is distributed on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n See the License for the specific language governing permissions and\n limitations under the License.\n" }, { "path": "README.md", "content": "# ESP-FS-WebServer\n\nA library for ESP8266/ESP32 that provides a web server with an integrated file system browser, WiFi configuration manager, and support for WebSockets. This library is based on the synchronous `WebServer` class.\n\n![WiFi Manager](docs/wifi_manager.png)\n\n## Features\n\n- **Dynamic WiFi Configuration**: An integrated setup page (`/setup`) allows you to scan for WiFi networks and connect the ESP to your local network. Passwords are stored using AES-256-CBC encryption (hardware on ESP32 platform) with multiple SSIDs manager (up to 5 different WiFi credentials).\n- **Powerful & Customizable UI**:\n - Easily add your own configuration parameters (text boxes, checkboxes, sliders, dropdown lists) to the setup page.\n - Inject custom **HTML, CSS, and JavaScript** snippets into the setup page to create rich, dynamic user interfaces for your specific project needs.\n- **Over-the-Air (OTA) Updates**: Update your device's firmware securely and conveniently through the web interface. You can easily upload also your entire web project's `data` folder to the ESP's filesystem.\n- **WebSocket Support**: Built-in support for real-time, two-way communication between the web client and the ESP.\n- **Advanced File Management**: An embedded file manager (`/edit`) allows you to browse, view, upload, and delete files and folders.\n\nBuilt-in `/setup` and `/edit` page sources are shared with the async library and are maintained in `C:\\Cloud\\fs-webserver-shared-pages`. Regenerate the embedded headers from that repository instead of editing generated files in `src/assets` directly.\n\n## Documentation\n\nFor more detailed information, please refer to the documentation in the `docs` folder:\n\n- **[API Reference](docs/API.md)** – Detailed overview of the public methods.\n- **[Setup and WiFi](docs/SetupAndWiFi.md)** – Guide to `startWiFi()`, captive portal, and the `/setup` page.\n- **[Filesystem and Editor](docs/FileEditorAndFS.md)** – How to serve static files and use the `/edit` page.\n- **[WebSocket](docs/WebSocket.md)** – Information on using the WebSocket server.\n- **[Password Encryption](docs/pwd_encrypt.md)** – Information on how passwords are managed.\n\n## Dependencies\n\n- ESP8266/ESP32 Core for Arduino\n\n## Basic Usage\n\n```cpp\n#include \n#include \n#if defined(ESP8266)\n#include \n#else\n#include \n#endif\n#include \"FSWebServer.h\"\n\n// Use LittleFS\nfs::FS& filesystem = LittleFS;\n\nFSWebServer server(80, filesystem, \"esphost\");\n\nvoid setup() {\n Serial.begin(115200);\n\n // Initialize Filesystem\n if (!filesystem.begin()) {\n Serial.println(\"Error mounting file system.\");\n return;\n }\n\n // Start WiFi (or captive portal if no credentials)\n server.startWiFi(10000);\n\n // Add a handler for the root page\n server.on(\"/\", []() {\n server.send(200, \"text/html\", \"

Hello from FSWebServer!

\");\n });\n\n // Start the server\n server.begin();\n Serial.println(\"HTTP server started.\");\n}\n\nvoid loop() {\n server.run();\n}\n\n```\n\n## WiFi Management Enhancements\n\n### Dedicated WiFiService class\n- `WiFiService` centralizes scanning, connections, captive portal setup, MDNS, and watchdog handling so the sketch can stay focused on application logic.\n- When `startWiFi()` runs it loads credentials from `CredentialManager`, picks the SSID with the strongest RSSI (optionally honoring static IP data saved per credential), and reports a `WiFiStartResult` that tells `FSWebServer` whether to stay in STA or fall back to the captive portal.\n- `doWifiConnection()` now persists updated credentials before calling `WiFiService::connectWithParams()`, which feeds the long-timeout watchdog, reuses stored passwords when the form leaves the password blank, and advertises `http://.local` through `startMDNSOnly()` as soon as the STA link is up. `FSWebServer` logs when mDNS becomes reachable so you can verify the hostname was published.\n\n### Setup page reconnection experience\n- The `/getStatus` handler exposes firmware version, active mode, hostname, IP, and the configuration file path so the UI knows where to direct the user after a network change.\n- After `/connect` begins switching SSIDs the browser starts polling `http://.local/getStatus` (falling back to the captured AP when necessary) until the ESP reappears on the new network, automatically updates the credential list, and surfaces a timeout message only after several failed polls.\n- This polling loop keeps the loader visible, shows a modal once the device is reachable again, and points users to either the new `http://.local` URL or the IP reported by the ESP without forcing them to refresh manually.\n\n\n### Custom application \"options manager\"\n![options](docs/options_manager.png)\n\n### OTA update and `data` folder upload\n![OTA](docs/ota_data.png)\n\n### Custom 'code snippets'\n![snippet](docs/custom_html.png)\n\n### ACE file editor\n![File Manager](docs/file_manager.png)\n" }, { "path": "built-in-webpages/readme.md", "content": "The canonical built-in page sources are no longer maintained in this folder.\n\nUse the shared repository at `C:\\Cloud\\fs-webserver-shared-pages` as the single source of truth for both **AsyncFsWebServer** and **FSWebServer** built-in pages.\n\nCurrent workflow:\n* edit `/setup` sources in `C:\\Cloud\\fs-webserver-shared-pages\\setup`\n* edit `/edit` sources in `C:\\Cloud\\fs-webserver-shared-pages\\edit`\n* open a terminal in `C:\\Cloud\\fs-webserver-shared-pages`\n* run `npm install` once\n* run `npm run build` to regenerate `setup_htm.h`, `logo_svg.h`, and `edit_htm.h` in both library `src/assets` folders\n\nTarget resolution order in the shared repo:\n* `--target ` CLI arguments\n* `targets.json`\n* autodiscovery of the Arduino sketchbook `libraries` folder\n\nThis folder is kept only as historical reference and should not be used as the primary build entrypoint anymore." }, { "path": "docs/API.md", "content": "# FSWebServer – API (overview)\n\nThis page summarizes the main methods exposed by `FSWebServer` and when to use them.\n\n> Note: some APIs are available only when the related features are enabled via macros (e.g. `ESP_FS_WS_SETUP`, `ESP_FS_WS_EDIT`).\n\n## Constructor\n\n```cpp\nFSWebServer(uint16_t port, fs::FS &fs, const char* hostname = \"\");\n```\n\n- `port`: HTTP port (typically `80`)\n- `fs`: filesystem (`LittleFS`, `SPIFFS`, `FFat`, …)\n- `hostname`: optional (also used for mDNS)\n\n## Server start\n\n```cpp\nvoid begin(WebSocketsServer::WebSocketServerEvent wsEventHandler = nullptr);\n```\n\n- Registers built-in handlers (setup/edit if enabled), static file serving, and notFound.\n- If `wsEventHandler != nullptr`, creates and starts a websocket server.\n- Starts the webserver.\n\n## Runtime info\n\n```cpp\nIPAddress getServerIP();\nbool isAccessPointMode() const;\n```\n\n## Authentication (/setup page)\n\n```cpp\nvoid setAuthentication(const char* user, const char* pswd);\n```\n\nWhen set, the `/setup` page requires basic-auth.\n\n## Filesystem listing\n\n```cpp\nvoid printFileList(fs::FS &fs, const char * dirname, uint8_t levels);\nvoid printFileList(fs::FS &fs, const char * dirname, uint8_t levels, Print& out);\n```\n\n- The `Print& out` overload lets you send output to streams other than `Serial`.\n\nExample:\n\n```cpp\nserver.printFileList(FILESYSTEM, \"/\", 1); // default -> Serial\nserver.printFileList(FILESYSTEM, \"/\", 1, Serial); // explicit\n```\n\n## WiFi + captive portal\n\n```cpp\nbool startWiFi(uint32_t timeout, CallbackF fn = nullptr);\nbool startCaptivePortal(const char* ssid, const char* pass, const char* redirectTargetURL);\n```\n\n- `startWiFi()` tries to connect using already-saved credentials.\n- If it fails, you typically start `startCaptivePortal()` and use `/setup` to configure.\n\n## WebSocket (runtime)\n\n```cpp\nWebSocketsServer* getWebSocketServer();\nbool broadcastWebSocket(const String &payload);\nbool broadcastWebSocket(const uint8_t *payload, size_t length);\nbool sendWebSocket(uint8_t num, const String &payload);\n```\n\n## Setup page (only if `ESP_FS_WS_SETUP`)\n\nConfig file and callback:\n\n```cpp\nFile getConfigFile(const char* mode);\nconst char* getConfiFileName();\nbool clearConfigFile();\nvoid setConfigSavedCallback(ConfigSavedCallbackF callback);\n```\n\nOptions and setup UI:\n\n```cpp\nvoid setSetupPageTitle(const char* title);\nvoid addOptionBox(const char* title);\n\n// attach a comment string to an existing option element\n// For most controls the comment is rendered in a separate line under the input.\n// Boolean (checkbox) fields use a so the text stays on the same line.\nvoid addComment(const char *lbl, const char *comment);\n\n// boolean option: grouped by default, pass fourth argument false to keep declaration order\n// the third parameter specifies `hidden` exactly like the generic template\nvoid addOption(const char *lbl, bool val, bool hidden = false, bool grouped = true);\n\n// boolean overload that accepts a comment\nvoid addOption(const char *lbl, bool val, const char *comment,\n bool hidden = false, bool grouped = true);\n\n// generic templated version (bool excluded via SFINAE below)\ntemplate \nvoid addOption(const char *lbl, T val, bool hidden=false, double min=MIN_F, double max=MAX_F, double st=1.0);\n\n// convenience comment overload for non-bool types\n// use the bool-specific variant to add a comment to a checkbox\ntemplate ::value, int>::type = 0>\nvoid addOption(const char *lbl, T val, const char *comment);\n\ntemplate \nvoid addOption(const char *lbl, T val, bool hidden=false, double min=MIN_F, double max=MAX_F, double st=1.0);\n\ntemplate \nbool getOptionValue(const char *lbl, T &var);\n\ntemplate \nbool saveOptionValue(const char *lbl, T val);\n```\n\nBoolean options are now controlled per-option; the third parameter (or the `grouped` argument) determines whether the switch/check is collected with other booleans or left inline. Hidden behaviour still works via `hidden` argument.\n\nDropdown/Slider:\n\n```cpp\nusing DropdownList = FSWebServer::DropdownList;\nusing Slider = FSWebServer::Slider;\n\nvoid addDropdownList(DropdownList &def);\nvoid addSlider(Slider &def);\nbool getDropdownSelection(DropdownList &def);\nbool getSliderValue(Slider &def);\n```\n\n## Web file editor (only if `ESP_FS_WS_EDIT`)\n\n```cpp\nvoid enableFsCodeEditor(FsInfoCallbackF fsCallback = nullptr);\nvoid setFsInfoCallback(FsInfoCallbackF fsCallback);\n```\n\nSee also: `SetupAndWiFi.md`, `FileEditorAndFS.md`, `WebSocket.md`.\n" }, { "path": "docs/FileEditorAndFS.md", "content": "# Filesystem + Web File Editor (/edit)\n\nThe library serves static files from the filesystem and, optionally, includes a web editor (ACE) to manage files directly from the browser.\n\n## Static file serving\n\nBy default, files are served from the filesystem with:\n\n- root URL `/` -> filesystem path `/`\n- default file: `index.htm`\n\nIn code (internally):\n\n- `serveStatic(\"/\", fs, \"/\").setDefaultFile(\"index.htm\")`\n\n## Stampa contenuto filesystem (debug)\n## Print filesystem contents (debug)\n\n```cpp\nserver.printFileList(FILESYSTEM, \"/\", 1); // default -> Serial\nserver.printFileList(FILESYSTEM, \"/\", 1, Serial); // or to a chosen stream\n```\n\nThe `Print&` overload is useful to log to streams other than `Serial`.\n\n## Enable /edit\n\n```cpp\nserver.enableFsCodeEditor();\n```\n\nMain endpoints:\n- `GET /edit` editor page\n- `GET /list?dir=/` directory listing\n- `POST /edit` upload\n- `PUT /edit` create/rename\n- `DELETE /edit` delete\n\n## Provide filesystem info (recommended on ESP32)\n\nOn ESP32, to show correct “total/used bytes” in the UI:\n\n```cpp\nserver.setFsInfoCallback([](fsInfo_t* fsInfo) {\n fsInfo->fsName = \"LittleFS\";\n fsInfo->totalBytes = LittleFS.totalBytes();\n fsInfo->usedBytes = LittleFS.usedBytes();\n});\n```\n" }, { "path": "docs/SetupAndWiFi.md", "content": "# Setup + WiFi (startWiFi / captive portal / config)\n\nThis library can:\n- try to connect to a previously saved WiFi network (STA)\n- if it fails, start an Access Point + captive portal and serve `/setup`\n- persist **application options** into `config.json` on the filesystem \n (WiFi credentials are now handled separately by `CredentialManager` and **never** stored in `config.json`)\n\n## Typical flow\n\n```cpp\nif (!server.startWiFi(10000)) {\n server.startCaptivePortal(\"ESP_AP\", \"123456789\", \"/setup\"); \n}\nserver.init(onWsEvent);\n```\n\n1. `startWiFi(timeout)` attempts to connect using saved credentials.\n2. If it fails, `startCaptivePortal(ssid, pass, \"/setup\")` switches the ESP to AP mode and redirects requests to `/setup` (or a custom endpoint)\n3. On `/setup` the user selects the WiFi network (managed by `CredentialManager`) and any extra application options; \n the library saves **only the application options** to `config.json` and stores WiFi credentials in encrypted form via `CredentialManager`.\n\nIt's possible also change the setting of IP address and mask for the captive portal passing a `WiFiConnectParams` structs to `startCaptivePortal()` method.\n```cpp\nif (!server.startWiFi(10000)) {\n Serial.println(\"\\nWiFi not connected! Starting AP mode...\");\n WiFiConnectParams params (\"ESP_AP\", \"123456789\"); \n params.config.local_ip = IPAddress(192, 168, 1, 1);\n params.config.gateway = IPAddress(192, 168, 1, 1);\n params.config.subnet = IPAddress(255, 255, 255, 0); \n server.startCaptivePortal(params, \"/setup\");\n}\n```\n## Application options on /setup\n\nExample (see also `withWebSocket.ino`):\n\n```cpp\nserver.addOptionBox(\"My Options\");\nserver.addOption(\"LED Pin\", ledPin);\nserver.addOption(\"Option 1\", option1.c_str());\nserver.addOption(\"Option 2\", option2);\n// you can also add a comment for a control that will appear beneath it\nserver.addComment(\"Option 2\", \"Explanation or hint text goes here\");\n```\n\nRead your application options at boot (from `config.json`, WiFi excluded):\n\n```cpp\nuint32_t option2;\nserver.getOptionValue(\"Option 2\", option2);\n```\n\n## Config file: read/write\n\n- Full path: `server.getConfiFileName()`\n- File access: `server.getConfigFile(\"r\")` / `server.getConfigFile(\"w\")`\n- Reset config: `server.clearConfigFile()`\n\n“Config saved” callback (useful when saving via `/edit` or upload):\n\n```cpp\nserver.setConfigSavedCallback([](const char* filename){\n Serial.printf(\"Config saved: %s\\n\", filename);\n});\n```\n\n## WiFi credentials storage (CredentialManager)\n\n- WiFi SSID, password, DHCP/static IP and related data are **not** stored in `config.json`.\n- They are managed and stored (encrypted) by the internal `CredentialManager`:\n - ESP32: NVS\n - ESP8266: filesystem (e.g. LittleFS)\n- The `/setup` page talks directly with the WiFi APIs (`/wifi/credentials`, `/connect`, etc.), \n so your sketch usually does **not** need to read or write WiFi data manually.\n\nSee also: `pwd_encrypt.md` for a deeper overview of `CredentialManager` and encrypted WiFi storage.\n\n## Protect /setup with basic-auth\n\n```cpp\nserver.setAuthentication(\"admin\", \"admin\");\n```\n\nWhen set, the `/setup` page requires authentication.\n" }, { "path": "docs/WebSocket.md", "content": "# WebSocket Support\n\nThe library includes and uses [WebSockets](https://github.com/Links2004/arduino-WebSockets) by Markus Sattler for bidirectional communication with web clients.\n\nSupport is enabled by default via the `ESP_FS_WS_WEBSOCKET` macro.\n\n## 1. Create the Event Handler\n\nFirst, you need to define a function that will handle WebSocket events. This function must match the `WebSocketServerEvent` signature.\n\n```cpp\n// WebSocket event handler\nvoid webSocketEvent(uint8_t num, WStype_t type, uint8_t * payload, size_t length) {\n switch (type) {\n case WStype_DISCONNECTED:\n Serial.printf(\"[%u] Disconnected!\\n\", num);\n break;\n case WStype_CONNECTED:\n {\n IPAddress ip = server.getWebSocketServer()->remoteIP(num);\n Serial.printf(\"[%u] Connected from %d.%d.%d.%d url: %s\\n\", num, ip[0], ip[1], ip[2], ip[3], payload);\n\n // Send a welcome message to the newly connected client\n server.getWebSocketServer()->sendTXT(num, \"Hello from FSWebServer!\");\n }\n break;\n case WStype_TEXT:\n Serial.printf(\"[%u] Received text: %s\\n\", num, payload);\n\n // Echo the message back to the client\n server.getWebSocketServer()->sendTXT(num, payload);\n break;\n case WStype_BIN:\n Serial.printf(\"[%u] Received binary data of length %u\\n\", num, length);\n // hexdump(payload, length); // Example for printing binary data\n break;\n default:\n Serial.printf(\"Unhandled event type: %d\\n\", type);\n break;\n }\n}\n```\n- `num`: The client ID (an integer from 0 up to the maximum number of clients).\n- `type`: The type of event (e.g., `WStype_CONNECTED`, `WStype_DISCONNECTED`, `WStype_TEXT`).\n- `payload`: A pointer to the received data.\n- `length`: The length of the received data.\n\n## 2. Start the Server with the Handler\n\nPass your event handler function to the `server.begin()` method. This will automatically start the WebSocket server.\n\n```cpp\nvoid setup() {\n // ... other setup code ...\n\n // Start the web server and enable WebSockets\n server.begin(webSocketEvent);\n}\n```\n\n## 3. Sending Messages from the ESP\n\nYou have two ways to send messages to clients.\n\n### Simple Broadcast (Recommended)\n\nUse the helper methods built into `FSWebServer` to easily broadcast messages to all connected clients.\n\n```cpp\n// Broadcast a text message\nserver.broadcastWebSocket(\"This is a message for everyone.\");\n\n// Broadcast binary data\nuint8_t binaryPayload[] = {0xDE, 0xAD, 0xBE, 0xEF};\nserver.broadcastWebSocket(binaryPayload, sizeof(binaryPayload));\n```\n\n### Advanced Control\n\nFor more advanced scenarios, like sending a message to a specific client, you can get a pointer to the underlying `WebSocketsServer` object.\n\n```cpp\n// Get the WebSocket server instance\nWebSocketsServer* ws = server.getWebSocketServer();\n\nif (ws) {\n // Send a text message to client number 2\n ws->sendTXT(2, \"This is a private message for you.\");\n\n // Disconnect client number 3\n ws->disconnect(3);\n}\n```\nThis gives you full access to the underlying WebSocket library's API.\n" }, { "path": "docs/pwd_encrypt.md", "content": "# FSWebServer CredentialManager Integration \n\n✅ **Encrypted Password Storage** - AES-256-CBC encryption\n✅ **Automatic Persistence** - NVS (ESP32) or Filesystem (ESP8266) \n✅ **Multi-SSID Support** - Store up to 5 WiFi networks (configurable)\n✅ **FIFO Management** - Automatically remove oldest when full\n✅ **RSSI-Based Selection** - Connect to strongest signal\n✅ **Zero Configuration** - Works transparently with FSWebServer\n✅ **Cross-Platform** - ESP32 and ESP8266 compatible\n\n\n## Quick Start\n\n### Set Encryption Key\n```cpp\n// In CredentialManager.h, change this:\n#define CREDENTIAL_MANAGER_ENCRYPTION_KEY \"YOUR_SECRET_KEY_16_CHARS!\"\n// To something like:\n#define CREDENTIAL_MANAGER_ENCRYPTION_KEY \"MyCompany2024Key!\"\n```\n\nThen:\n1. Open `/setup` to add WiFi credentials\n2. Reboot device\n3. Check serial logs for RSSI-based connection\n\n---\n\n## Architecture Overview\n\n```\n┌─────────────────────────────────────────────────────┐\n│ User's Arduino Sketch │\n│ │\n│ - Calls: server.begin() │\n│ - Calls: server.run() │\n│ - No credential management code needed │\n└─────────────────────────┬───────────────────────────┘\n │\n ▼\n┌─────────────────────────────────────────────────────┐\n│ Modified FSWebServer Library │\n│ │\n│ • Constructor: Load credentials from storage │\n│ • startWiFi(): RSSI-based WiFi selection │\n│ • doWifiConnection(): FIFO credential mgmt │ \n└─────────────────────────┬───────────────────────────┘\n │\n ▼\n┌─────────────────────────────────────────────────────┐\n│ CredentialManager (New Class) │\n│ │\n│ • AES-256-CBC encryption/decryption │\n│ • NVS persistence (ESP32) │\n│ • Filesystem persistence (ESP8266) │\n│ • Credential list management │\n│ • FIFO removal when full │\n└─────────────────────────┬───────────────────────────┘\n │\n ┌─────────────┴─────────────┐\n ▼ ▼\n ┌──────────────┐ ┌──────────────────┐\n │ NVS Flash │ │ Filesystem │\n │ (ESP32) │ │ (ESP8266/ESP32) │\n │ Encrypted │ │ Encrypted │\n │ Passwords │ │ Passwords │\n └──────────────┘ └──────────────────┘\n```\n\n---\n\n## Key Features Explained\n\n### 1. Transparent Credential Management\n- User adds credentials via `/setup` web page\n- Credentials automatically saved to encrypted storage\n- No code changes needed in user sketch\n- Credentials persist across power cycles\n\n### 2. FIFO (First In, First Out) Management\n```\nWhen list is full (5 credentials):\nAdd new credential → Automatically remove oldest → Keep 5 total\n```\n\n### 3. RSSI-Based WiFi Selection\n```\nOn startup:\n1. Scan available networks\n2. Find stored credentials that match\n3. Select the one with best (highest) signal strength\n4. Connect to that network\n```\n\n**Example**:\n- HomeWiFi: -65 dBm (good)\n- OfficeWiFi: -42 dBm (excellent) \n→ Connect to OfficeWiFi (higher value = better signal)\n\n### 4. Encryption\n```\nUser input: \"MyPassword123\"\n ↓ (AES-256-CBC encrypt)\nStored: \"aX7k3jQ9pL2nM8vX...\"\n ↓ (AES-256-CBC decrypt)\nRetrieved: \"MyPassword123\"\n```\n\n### 5. Cross-Platform Support\n```\nESP32: Uses NVS (secure, encrypted by hardware)\nESP8266: Uses LittleFS/SPIFFS (plaintext storage file)\nBoth: Passwords encrypted by CredentialManager\n```\n\n## Security Considerations\n\n### Password Encryption\n- **Algorithm**: AES-256-CBC (256-bit encryption)\n- **Padding**: PKCS7 (standard padding)\n- **Mode**: Cipher Block Chaining (secure against pattern attacks)\n\n### Encryption Key Storage\n- **ESP32**: Ideally in eFuse BLOCK_KEY0 (hardware protected)\n ```bash\n # Generate and set key:\n espefuse.py key_set BLOCK_KEY0 <32-byte-hex-key>\n ```\n\n- **ESP8266**: Compile-time constant (less secure)\n ```cpp\n #define CREDENTIAL_MANAGER_ENCRYPTION_KEY \"MySecretKey12345\"\n ```\n\n### Additional Security Measures\n- Use **Secure Boot** to prevent firmware tampering\n- Use **eFuse** to lock down critical settings\n- Keep encryption key confidential and consistent\n- Change key only if you can re-encrypt stored credentials\n\n### Threat Model\n- **Protected Against**: Flash dump reading (passwords encrypted)\n- **Protected Against**: Casual inspection of storage\n- **Not Protected Against**: Brute-force attacks on weak keys\n- **Not Protected Against**: Side-channel attacks (e.g., timing)\n\n---\n\n## Customization Options\n\n### Change Maximum Credentials\nIn FSWebServer.h:\n```cpp\nstatic constexpr uint8_t MAX_CREDENTIALS = 5; // Change to 10 for more\n```\n\n### Change Encryption Key\nIn CredentialManager.h:\n```cpp\n#define CREDENTIAL_MANAGER_ENCRYPTION_KEY \"YourCustomKey12!\"\n```\n\n---\n\n## Performance\n\n### Startup Time Impact\n- WiFi scan: 500-2000ms (depends on RF environment)\n- Credential matching: 10-50ms\n- Connection: 2-5 seconds\n- **Total**: ~3-7 seconds (typical)\n\n### Memory Usage\n- CredentialManager class: ~500 bytes\n- Per credential: ~100 bytes\n- Vector overhead: ~20 bytes\n- **Total for 5 credentials**: ~1.2 KB\n\n### Storage Usage\n- Per credential in NVS/FS: ~60 bytes encrypted\n- For 5 credentials: ~300 bytes\n- **Impact**: Negligible on ESP32 (512KB NVS)\n\n---\n\n" }, { "path": "docs/readme.md", "content": "# Documentation\n\n- [API](API.md) – available methods and what they do\n- [Setup + WiFi](SetupAndWiFi.md) – `startWiFi()`, captive portal, `/setup`, config\n- [Filesystem + Editor](FileEditorAndFS.md) – static file serving, `/edit`, FS info\n- [WebSocket](WebSocket.md) – enablement, handler, broadcast\n" }, { "path": "examples/csvLogger/.gitignore", "content": ".pio\n.vscode/.browse.c_cpp.db*\n.vscode/c_cpp_properties.json\n.vscode/launch.json\n.vscode/ipch\n" }, { "path": "examples/csvLogger/csvLogger.ino", "content": "#include \n#include \n#include \n#include \n\nFSWebServer server(LittleFS, 80, \"esphost\");\n\n// Timezone definition to get properly time from NTP server\n#define MYTZ \"CET-1CEST,M3.5.0,M10.5.0/3\"\n#include \n\nstruct tm ntpTime;\nconst char* basePath = \"/csv\";\n\n//////////////////////////////// Filesystem\n////////////////////////////////////////////\nbool startFilesystem() {\n if (LittleFS.begin()) {\n server.printFileList(LittleFS, \"/\", 2, Serial);\n return true;\n } else {\n Serial.println(\"ERROR on mounting filesystem. It will be formmatted!\");\n LittleFS.format();\n ESP.restart();\n }\n return false;\n}\n\n//////////////////////////// Append a row to csv file\n//////////////////////////////////////\nbool appenRow() {\n getLocalTime(&ntpTime, 10);\n\n char filename[32];\n snprintf(filename, sizeof(filename), \"%s/%04d_%02d_%02d.csv\", basePath,\n ntpTime.tm_year + 1900, ntpTime.tm_mon + 1, ntpTime.tm_mday);\n\n File file;\n if (LittleFS.exists(filename)) {\n file = LittleFS.open(filename, \"a\"); // Append to existing file\n } else {\n file = LittleFS.open(filename, \"w\"); // Create a new file\n file.println(\"timestamp, free heap, largest free block, connected, wifi strength\");\n }\n\n if (file) {\n char timestamp[25];\n strftime(timestamp, sizeof(timestamp), \"%c\", &ntpTime);\n\n char row[64];\n#ifdef ESP32\n snprintf(row, sizeof(row), \"%s, %d, %d, %s, %d\", timestamp,\n heap_caps_get_free_size(0), heap_caps_get_largest_free_block(0),\n (WiFi.status() == WL_CONNECTED) ? \"true\" : \"false\", WiFi.RSSI());\n#elif defined(ESP8266)\n uint32_t free;\n uint32_t max;\n ESP.getHeapStats(&free, &max, nullptr);\n snprintf(row, sizeof(row), \"%s, %d, %d, %s, %d\", timestamp, free, max,\n (WiFi.status() == WL_CONNECTED) ? \"true\" : \"false\", WiFi.RSSI());\n#endif\n Serial.println(row);\n file.println(row);\n file.close();\n return true;\n }\n\n return false;\n}\n\nvoid setup() {\n Serial.begin(115200);\n delay(1000);\n startFilesystem();\n\n // Try to connect to WiFi (will start AP if not connected after timeout)\n if (!server.startWiFi(10000)) {\n Serial.println(\"\\nWiFi not connected! Starting AP mode...\");\n server.startCaptivePortal(\"ESP32_LOGGER\", \"123456789\", \"/setup\");\n }\n\n // Enable ACE FS file web editor and add FS info callback fucntion\n server.enableFsCodeEditor();\n\n // Start server\n server.begin();\n Serial.print(F(\"Async ESP Web Server started on IP Address: \"));\n Serial.println(server.getServerIP());\n Serial.println(\n F(\"This is \\\"scvLogger.ino\\\" example.\\n\"\n \"Open /setup page to configure optional parameters.\\n\"\n \"Open /edit page to view, edit or upload example or your custom \"\n \"webserver source files.\"));\n\n// Set NTP servers\n#ifdef ESP8266\n configTime(MYTZ, \"time.google.com\", \"time.windows.com\", \"pool.ntp.org\");\n#elif defined(ESP32)\n configTzTime(MYTZ, \"time.google.com\", \"time.windows.com\", \"pool.ntp.org\");\n#endif\n // Wait for NTP sync (with timeout)\n getLocalTime(&ntpTime, 5000);\n\n // Create csv logs folder if not exists\n if (!LittleFS.exists(basePath)) {\n LittleFS.mkdir(basePath);\n }\n Serial.println(\"Setup completed.\");\n}\n\nvoid loop() {\n server.handleClient();\n if (server.isAccessPointMode()) server.updateDNS();\n\n static uint32_t updateTime;\n if (millis() - updateTime > 30000) {\n updateTime = millis();\n appenRow();\n }\n}\n" }, { "path": "examples/csvLogger/data/assets/css/index.css", "content": "/* Misc */\nhtml, body {\n font-family: \"Helvetica\",\"Arial\",sans-serif;\n font-size: 14px;\n font-weight: 400;\n line-height: 20px;\n}\nbody {\n margin: 0;\n font-family: -apple-system,BlinkMacSystemFont,\"Segoe UI\",Roboto,\"Helvetica Neue\",Arial,\"Noto Sans\",sans-serif,\"Apple Color Emoji\",\"Segoe UI Emoji\",\"Segoe UI Symbol\",\"Noto Color Emoji\";\n font-size: 1rem;\n font-weight: 400;\n line-height: 1.5;\n color: #212529;\n text-align: left;\n background-color: #fff;\n}\n\nh1 {\n margin: 5px;\n text-align: center;\n}\n\np {\n font-size: 0.9rem;\n margin: 0.5rem 0 1.5rem 0;\n}\n\na,\na:visited {\n color: #08C;\n text-decoration: none;\n}\n\na:hover,\na:focus {\n color: #69c773;\n cursor: pointer;\n}\n\na.delete-file,\na.delete-file:visited {\n color: #CC0000;\n margin-left: 0.5rem;\n vertical-align: middle;\n}\n\nbutton {\n display: inline-block;\n border-radius: 3px;\n border: none;\n font-size: 0.9rem;\n padding: 0.5rem 1em;\n background: #86b32d;\n border-bottom: 1px solid #5d7d1f;\n color: white;\n margin: 5px 0;\n text-align: center;\n}\n\nbutton:hover {\n opacity: 0.75;\n cursor: pointer;\n}\n\n#page-wrapper {\n width: 95%;\n background: #FFF;\n padding: 1.25rem;\n margin: 1rem auto;\n min-height: 800px;\n border-top: 5px solid #69c773;\n box-shadow: 0 2px 10px rgba(0,0,0,0.8);\n}\n\n#content {\n width: 85%;\n overflow: auto;\n height: 86vh;\n}\n\n#files {\n width: 15%;\n}\n\n#files ul {\n margin: 20px 0;\n padding: 0.5rem 1rem;\n overflow-y: auto;\n list-style: square;\n background: #F7F7F7;\n border: 1px solid #D9D9D9;\n border-radius: 5px;\n box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.1);\n max-height: 75vh;\n}\n\n#files li {\n margin-left: 8px;\n font-size: 14px;\n display: flex;\n justify-content: space-between;\n align-items: center;\n}\n\n.container {\n display: flex;\n flex-direction: row;\n align-content: flex-start;\n justify-content: space-between;\n align-items: flex-start;\n column-gap: 10px;\n height: 86vh;\n}\n\n.delete {\n font-size: 24px;\n transition: 0.3s;\n margin-top:5px;\n}\n\n.delete-all{\n color: #f44336;\n font-size: 12px;\n background-color: transparent;\n background-repeat: no-repeat;\n border: none;\n cursor: pointer;\n overflow: hidden;\n}\n\n/* Tables */\n.table-holder {\n margin-top: 20px;\n border: 1px solid lightgray;\n border-radius: 5px;\n border-bottom: 0px;\n border-bottom-left-radius: 0px;\n border-bottom-right-radius: 0px;\n}\n\n.tables {\n margin-bottom: 50px;\n}\n\ntable {\n width: 100%;\n border-bottom: 0px;\n}\n\ntable, th, td {\n border: 1px solid lightgrey;\n border-collapse: collapse;\n padding-left: 5px;\n}\n\ntable tr:nth-child(even) {\n background-color: white;\n}\n\ntable tr:nth-child(odd) {\n background-color: #f2f2f2;\n}\n\ntable th {\n background-color: #e1e1e1;\n color: black;\n}\n\n/* Sections */\n\n.section {\n box-shadow: 10px 10px 10px 10px;\n background-color: #e5e5e5;\n padding: 10px;\n padding-top: 20px;\n font-size: 18px;\n}\n\n.section-lightgrey {\n background-color: #f9f9f9;\n}\n\n/* 100% Image Width on Smaller Screens */\n@media only screen and (max-width: 700px){\n .modal-content {\n width: 100%;\n }\n}\n" }, { "path": "examples/csvLogger/data/assets/css/style.css", "content": "/* Misc */\nhtml, body {\n font-family: \"Helvetica\",\"Arial\",sans-serif;\n font-size: 14px;\n font-weight: 400;\n line-height: 20px;\n}\nbody {\n margin: 0;\n font-family: -apple-system,BlinkMacSystemFont,\"Segoe UI\",Roboto,\"Helvetica Neue\",Arial,\"Noto Sans\",sans-serif,\"Apple Color Emoji\",\"Segoe UI Emoji\",\"Segoe UI Symbol\",\"Noto Color Emoji\";\n font-size: 1rem;\n font-weight: 400;\n line-height: 1.5;\n color: #212529;\n text-align: left;\n background-color: #fff;\n}\n\nh1 {\n margin: 5px;\n text-align: center;\n}\n\np {\n font-size: 0.9rem;\n margin: 0.5rem 0 1.5rem 0;\n}\n\na,\na:visited {\n color: #08C;\n text-decoration: none;\n}\n\na:hover,\na:focus {\n color: #69c773;\n cursor: pointer;\n}\n\na.delete-file,\na.delete-file:visited {\n color: #CC0000;\n margin-left: 0.5rem;\n vertical-align: middle;\n}\n\nbutton {\n display: inline-block;\n border-radius: 3px;\n border: none;\n font-size: 0.9rem;\n padding: 0.5rem 1em;\n background: #86b32d;\n border-bottom: 1px solid #5d7d1f;\n color: white;\n margin: 5px 0;\n text-align: center;\n}\n\nbutton:hover {\n opacity: 0.75;\n cursor: pointer;\n}\n\n#page-wrapper {\n width: 95%;\n background: #FFF;\n padding: 1.25rem;\n margin: 1rem auto;\n min-height: 800px;\n border-top: 5px solid #69c773;\n box-shadow: 0 2px 10px rgba(0,0,0,0.8);\n}\n\n#content {\n width: 85%;\n overflow: auto;\n height: 86vh;\n}\n\n#files {\n width: 15%;\n line-height: 1;\n}\n\n#files ul {\n margin: 20px 0;\n padding: 0.5rem 1rem;\n overflow-y: auto;\n list-style: square;\n background: #F7F7F7;\n border: 1px solid #D9D9D9;\n border-radius: 5px;\n box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.1);\n max-height: 75vh;\n}\n\n#files li {\n font-size: 14px;\n display: flex;\n justify-content: space-between;\n align-items: center;\n}\n\n.container {\n display: flex;\n flex-direction: row;\n align-content: flex-start;\n justify-content: space-between;\n align-items: flex-start;\n column-gap: 10px;\n height: 86vh;\n}\n\n.delete {\n font-size: 24px;\n transition: 0.3s;\n margin-top:5px;\n}\n\n.delete-all{\n color: #f44336;\n font-size: 12px;\n background-color: transparent;\n background-repeat: no-repeat;\n border: none;\n cursor: pointer;\n overflow: hidden;\n}\n\n/* Tables */\n.table-holder {\n margin-top: 20px;\n border: 1px solid lightgray;\n border-radius: 5px;\n border-bottom: 0px;\n border-bottom-left-radius: 0px;\n border-bottom-right-radius: 0px;\n}\n\n.tables {\n margin-bottom: 50px;\n}\n\ntable {\n width: 100%;\n border-bottom: 0px;\n}\n\ntable, th, td {\n border: 1px solid lightgrey;\n border-collapse: collapse;\n padding-left: 5px;\n}\n\ntable tr:nth-child(even) {\n background-color: white;\n}\n\ntable tr:nth-child(odd) {\n background-color: #f2f2f2;\n}\n\ntable th {\n background-color: #e1e1e1;\n color: black;\n}\n\n/* Sections */\n\n.section {\n box-shadow: 10px 10px 10px 10px;\n background-color: #e5e5e5;\n padding: 10px;\n padding-top: 20px;\n font-size: 18px;\n}\n\n.section-lightgrey {\n background-color: #f9f9f9;\n}\n\n/* 100% Image Width on Smaller Screens */\n@media only screen and (max-width: 700px){\n .modal-content {\n width: 100%;\n }\n}\n" }, { "path": "examples/csvLogger/data/assets/js/csv.js", "content": "\n// Default file to be loaded with no parameter in url\nvar filename = '';\n\n// JQuery-like selector\nvar $ = function(el) {\n\treturn document.getElementById(el);\n};\n\n\n/**\n * @returns {getUserInput.userInput} an object\n * containing all the user input at the time \n * of the method call.\n */\nfunction getUserInput() {\n var userInput = {};\n userInput.fileName = filename;\n userInput.maxRows = \"0\";\n userInput.encoding = 'UTF-8';\n userInput.columnSeparator = ',';\n userInput.useQuotes = true;\n userInput.firstRowHeaders = true;\n userInput.firstRowInlcude = false;\n return userInput;\n}\n\n/* Tables */\n\nvar tableCount = 1;\n\n/**\n * Creates a table holder with the \n * given table in it.\n * \n * @param {type} title\n * @param {type} tableHtml\n * @returns {String|getTableUnit.tableHolder}\n */\n\nfunction getTableUnit(title, tableHtml){\n var id = \"table-\" + tableCount;\n var tableHolder = \"
{@name}{@table}
\";\n tableHolder = tableHolder.replace(\"{@name}\", title);\n tableHolder = tableHolder.replace(\"{@table}\", tableHtml);\n tableCount++;\n return tableHolder;\n}\n\n/**\n * Clears all tables from the page.\n */\nfunction clearTables(){\n tableCount = 1;\n $('csv-table').innerHTML = '';\n}\n\n/**\n * Adds (appends) a table holder to the page.\n * \n * @param {type} unit\n * @returns {undefined}\n */\nfunction addTableUnit(unit){\n $('csv-table').innerHTML = unit ;\n}\n\n\nfunction saveTable(filename, text) {\n var myblob = new Blob([text]);\n var formData = new FormData();\n formData.append(\"data\", myblob, filename);\n\n // POST data using the Fetch API\n fetch('/edit', {\n method: 'POST',\n headers: {\n 'Access-Control-Allow-Origin': '*',\n 'Access-Control-Max-Age': '600',\n 'Access-Control-Allow-Methods': 'PUT,POST,GET,OPTIONS',\n 'Access-Control-Allow-Headers': '*',\n 'filename': filename\n },\n body: formData\n })\n // Handle the server response\n .then(response => response.text())\n .then(text => {\n console.log(text);\n });\n}\n\n\n/* Table downloading */\n\n/**\n * Download the specified table to \n * the users computer.\n * \n * @param {type} table table number\n * @param {save} save file to host memory\n * @returns {undefined}\n */\n\nfunction downloadTable(table, save = false) {\n var tableId = \"table-\" + table;\n \n\tvar csvArray = [];\n\tvar rows = document.querySelectorAll(\"#\" + tableId + \" > table tr\");\n\t\t\t\n\tfor (var i = 0; i < rows.length; i++) {\n\t\tvar row = [], cols = rows[i].querySelectorAll(\"td, th\");\n\t\tfor (var j = 0; j < cols.length; j++) {\n\t\t \n\t\t var value = cols[j].innerText;\n\t\t \n\t\t if(customParseFloat(value) ) {\n row.push(value);\n\t\t }\n\t\t else {\n\t\t row.push('\"' + value +'\"');\n\t\t }\n }\n\t\tcsvArray.push(row.join(\",\")); \t\t\n\t\tcsvArray.push(\"\\n\");\n\t}\n\n var csvString = csvArray.join(\"\");\n if (save === false)\n download(filename, csvString);\n else {\n saveTable(filename, csvString);\n }\n}\n\n\n/**\n * Creates and downloads a file to the users computer.\n * \n * @param {type} filename\n * @param {type} text\n * @returns {undefined}\n */\nfunction download(filename, text) {\n var element = document.createElement('a');\n element.setAttribute('href', 'data:text/plain;charset=utf-8,' + encodeURIComponent(text));\n element.setAttribute('download', filename);\n\n element.style.display = 'none';\n document.body.appendChild(element);\n element.click();\n document.body.removeChild(element);\n}\n\n/**\n * Gets the users input and creates\n * a set of tables from it.\n */\nfunction populate(csv){\n var ui = getUserInput();\n addTableUnit(\n getTableUnit(\n ui.fileName,\n getTable(\n csvTo2DArray(\n csv,\n ui.columnSeparator,\n ui.useQuotes,\n ui.maxRows\n ),\n ui.firstRowHeaders, \n ui.firstRowInlcude\n )\n )\n );\n\n // Prevents to ad a new line inside cell\n var cells = document.querySelectorAll('td');\n \n cells.forEach(item => {\n item.addEventListener('keypress', event => {\n if ( event.keyCode === 13 ){\n if (window.event) {\n window.event.returnValue = false;\n }\n }\n });\n });\n}\n\n/**\n * Load the csv from webserver location and fit table with data\n*/\nfunction loadCsv(path) {\n clearTables();\n filename = path;\n \n fetch(path)\n .then(response => response.text()) \n .then(textString => {\n populate(textString);\n });\n}\n\n\n/**\n * Standard parseFloat don't handle properly \"0\", \"0.0\", \"0.00\" etc strings\n * @param {strNumber} the string representing a number to be parsed\n * @returns {float number} or NaN\n*/\nfunction customParseFloat(strNumber){\n if (isNaN(parseFloat(strNumber)) === false){\n let toFixedLength = 0;\n\n let arr = strNumber.split('.');\n if (arr.length === 2 ){\n toFixedLength = arr[1].length;\n }\n return parseFloat(strNumber).toFixed(toFixedLength);\n }\n return NaN; // Not a number\n}\n\n/**\n * Creates an unstyled, bare-bones html table\n * from the provided 2D(Multidimentional Array).\n * \n * @param {type} tableArray the 2D array.\n * @param {type} useHeaders will make the first row\n * in the table bold if true.\n * @param {type} dupeHeaders will duplicate the first row\n * in the table if true and useHeaders is true.\n * @param {type} tableId HTML ID for the table.\n * @returns {String} the constructed html table as text.\n */\nfunction getTable(tableArray, useHeaders, dupeHeaders, tableId){\n var tableOpen = \"\";\n var tableClose = \"
\";\n \n var headerCell = \"{@val}\";\n var cell = \"{@val}\";\n \n var rowOpen = \"\";\n var rowClose = \"\";\n \n var table = tableOpen;\n \n for(i = 0; i < tableArray.length; i++){\n //Row\n if(i === 1 && useHeaders && dupeHeaders){\n i = 0;\n useHeaders = false;\n dupeHeaders = false;\n }\n \n table += rowOpen;\n for(j = 0; j < tableArray[i].length; j++){\n //Cell\n if(i === 0 && useHeaders){\n table += headerCell.replace(\"{@val}\", tableArray[i][j]);\n } else {\n table += cell.replace(\"{@val}\", tableArray[i][j]);\n }\n }\n \n table += rowClose;\n }\n \n return table + tableClose;\n}\n\n/**\n * Creates a 2D (Multidimentional) array from\n * CSV data in string form.\n * \n * @param {type} csv the CSV data.\n * @param {type} separator the character used\n * to separate the columns/cells.\n * @param {type} quotes ignores the separator\n * in quoted text.\n * @param {type} maxRows the maximum rows\n * to scan.\n * @returns {Array|csvTo2DArray.table} the CSV data\n * as a 2D (Multidimentional) array.\n */\nfunction csvTo2DArray(csv, separator, quotes, maxRows){\n var table = [];\n var rows = 0;\n \n csv.split(\"\\n\").map(function(row){\n if(maxRows !== \"0\")\n if(rows >= maxRows)\n return;\n \n var tableRow = getRow(row, separator, quotes);\n \n if(tableRow === null)\n return table;\n \n table.push(tableRow);\n rows++;\n });\n \n return table;\n}\n\n/**\n * Creates an array from a CSV row (line)\n * \n * @param {type} row the CSV row.\n * @param {type} separator character used to separate\n * cells/columns\n * @param {type} quotes ignores the separator\n * in quoted text.\n * @returns {Array|getRow.trow} the CSV row as an array.\n */\nfunction getRow(row, separator, quotes){\n if(row.length === 0)\n return null;\n \n isQuoted = false;\n var trow = [];\n var cell = \"\";\n \n for(var i = 0; i < row.length; i++){\n var char = row.charAt(i);\n \n if(quotes){\n if(char === '\\\"' || char === '\\''){\n isQuoted = !isQuoted;\n continue;\n }\n }\n \n if(char === separator && !isQuoted){\n trow.push(cell);\n cell = \"\";\n continue;\n }\n \n cell += char;\n }\n \n trow.push(cell);\n return trow;\n}" }, { "path": "examples/csvLogger/data/assets/js/index.js", "content": "var dataFolder = document.getElementById(\"csv-path\").value;\nvar fileList = document.getElementById('file-list');\nvar currentFile = \"\";\n\n// Fetch the list of files and fill the filelist\nfunction listFiles() {\n var url = '/list?dir=' + dataFolder;\n if (url.charAt(url.length - 1) === '/')\n url = url.slice(0, -1); // Remove the last character\n fetch(url) // Do the request\n .then(response => response.json()) // Parse the response\n .then(obj => { // DO something with response\n fileList.innerHTML = '';\n obj.forEach(function(entry, i) {\n addEntry(entry.name);\n });\n // Load last file\n loadCsv(dataFolder + obj[obj.length -1].name); \n });\n}\n\n// Load selected image inside the preview content\nfunction loadFile(filename) {\n loadCsv(filename);\n}\n\n// Delete selected file in SD\nasync function deleteFile(filename) {\n var isExecuted = confirm(\"Are you sure to delete \"+ filename + \"?\");\n if(isExecuted){\n const data = new URLSearchParams();\n data.append('path', filename);\n fetch('/edit', {\n method: 'DELETE',\n body: data\n });\n // Update the file browser.\n listFiles();\n }\n}\n\nasync function deleteAll() {\n var isExecuted = confirm(\"Are you sure to delete all files in \"+ dataFolder + \" folder?\");\n if(isExecuted){\n var ul = document.getElementById(\"file-list\");\n var items = ul.getElementsByClassName(\"edit-file\");\n for (var i=0; i\n\n\n \n ESP32 CSV List\n \n \n\n \n
\n
\n

CSV list web interface

\n
\n
\n
    \n
    \n \n

    \n \n \n
    \n
    \n \n
    \n
    \n
    \n
    \n
    \n
    \n
    \n
    \n \n \n \n" }, { "path": "examples/csvLogger/partitions.csv", "content": "# Name, Type, SubType, Offset, Size, Flags\nnvs, data, nvs, 0x9000, 0x5000,\notadata, data, ota, 0xe000, 0x2000,\napp0, app, ota_0, 0x10000, 0x140000,\napp1, app, ota_1, 0x150000,0x140000,\nspiffs, data, spiffs, 0x290000,0x160000,\ncoredump, data, coredump,0x3F0000,0x10000,\n" }, { "path": "examples/csvLogger/platformio.ini", "content": "; PlatformIO Project Configuration File\n;\n; Build options: build flags, source filter\n; Upload options: custom upload port, speed and extra flags\n; Library options: dependencies, extra library storages\n; Advanced options: extra scripting\n;\n; Please visit documentation for the other options and examples\n; https://docs.platformio.org/page/projectconf.html\n\n[platformio]\nsrc_dir = .\n\n[env:esp32-s3-devkitc1-n4r2]\nplatform = https://github.com/pioarduino/platform-espressif32/releases/download/stable/platform-espressif32.zip\nboard = esp32-s3-devkitc1-n4r2\nframework = arduino\nupload_speed = 921600\nmonitor_speed = 115200\nboard_build.partitions = partitions.csv\nlib_extra_dirs = ../../\nlib_ignore = pio_examples\n\n[env:esp32dev]\nplatform = https://github.com/pioarduino/platform-espressif32/releases/download/stable/platform-espressif32.zip\nboard = esp32dev\nframework = arduino\nupload_speed = 921600\nmonitor_speed = 115200\nboard_build.partitions = partitions.csv\nlib_extra_dirs = ../../\nlib_ignore = pio_examples\n\n[env:esp8266-nodemcuv2]\nplatform = espressif8266\nboard = nodemcuv2\nframework = arduino\nupload_speed = 921600\nmonitor_speed = 115200\nboard_build.partitions = partitions.csv\nlib_extra_dirs = ../../\nlib_ignore = pio_examples\n" }, { "path": "examples/csvLogger/readme.md", "content": "An example for logging to a CSV file and viewing the content with the browser.\nIt is also possible to modify or download the file.\n\n![image](https://github.com/cotestatnt/esp-fs-webserver/assets/27758688/a776a217-f634-480c-873c-8914e82f87e3)" }, { "path": "examples/csvLoggerSD/csvLoggerSD.ino", "content": "#include \n#include \n\n// Timezone definition to get properly time from NTP server\n#define MYTZ \"CET-1CEST,M3.5.0,M10.5.0/3\"\n#include \n\n#define PIN_CS 14\n#define PIN_SCK 13\n#define PIN_MOSI 12\n#define PIN_MISO 11\n\n\nFSWebServer server(SD, 80, \"myServer\");\nbool captiveRun = false;\nstruct tm ntpTime;\nconst char* basePath = \"/csv\";\n\n//////////////////////////////// NTP Time /////////////////////////////////////////\nvoid getUpdatedtime(const uint32_t timeout) {\n uint32_t start = millis();\n do {\n time_t now = time(nullptr);\n ntpTime = *localtime(&now);\n delay(1);\n } while (millis() - start < timeout && ntpTime.tm_year <= (1970 - 1900));\n}\n\n\n//////////////////////////////// Filesystem /////////////////////////////////////////\nbool startFilesystem(){\n if (SD.begin(PIN_CS)){\n server.printFileList(SD, \"/\", 2);\n return true;\n }\n else {\n Serial.println(\"ERROR on mounting filesystem. It will be formmatted!\");\n ESP.restart();\n }\n return false;\n}\n\n//////////////////////////// Append a row to csv file ///////////////////////////////////\nbool appenRow() {\n getUpdatedtime(10);\n\n char filename[24];\n snprintf(filename, sizeof(filename),\n \"%s/%04d_%02d_%02d.csv\",\n basePath,\n ntpTime.tm_year + 1900,\n ntpTime.tm_mon + 1,\n ntpTime.tm_mday\n );\n\n File file;\n if (SD.exists(filename)) {\n file = SD.open(filename, \"a\"); // Append to existing file\n }\n else {\n file = SD.open(filename, \"w\"); // Create a new file\n file.println(\"timestamp, free heap, largest free block, connected, wifi strength\");\n }\n\n if (file) {\n char timestamp[25];\n strftime(timestamp, sizeof(timestamp), \"%c\", &ntpTime);\n\n char row[64];\n #ifdef ESP32\n snprintf(row, sizeof(row), \"%s, %d, %d, %s, %d\",\n timestamp,\n heap_caps_get_free_size(0),\n heap_caps_get_largest_free_block(0),\n (WiFi.status() == WL_CONNECTED) ? \"true\" : \"false\",\n WiFi.RSSI()\n );\n #elif defined(ESP8266)\n uint32_t free;\n uint16_t max;\n ESP.getHeapStats(&free, &max, nullptr);\n snprintf(row, sizeof(row),\n \"%s, %d, %d, %s, %d\",\n timestamp, free, max,\n (WiFi.status() == WL_CONNECTED) ? \"true\" : \"false\",\n WiFi.RSSI()\n );\n #endif\n Serial.println(row);\n file.println(row);\n file.close();\n return true;\n }\n\n return false;\n}\n\n\nvoid setup() {\n SPI.begin(PIN_SCK, PIN_MISO, PIN_MOSI, PIN_CS);\n Serial.begin(115200);\n \n delay(1000);\n startFilesystem();\n\n // Create csv logs folder if not exists\n if (!SD.exists(basePath)) {\n SD.mkdir(basePath);\n }\n\n // Try to connect to WiFi (will start AP if not connected after timeout)\n if (!server.startWiFi(10000)) {\n Serial.println(\"\\nWiFi not connected! Starting AP mode...\");\n server.startCaptivePortal(\"ESP_AP\", \"123456789\", \"/setup\");\n captiveRun = true;\n }\n\n // Enable ACE FS file web editor and add FS info callback fucntion\n server.enableFsCodeEditor();\n #ifdef ESP32\n server.setFsInfoCallback([](fsInfo_t* fsInfo) {\n fsInfo->totalBytes = SD.totalBytes();\n fsInfo->usedBytes = SD.usedBytes();\n fsInfo->fsName = \"SD\";\n });\n #endif\n\n // Start server\n server.begin();\n Serial.print(F(\"\\nAsync ESP Web Server started on IP Address: \"));\n Serial.println(server.getServerIP());\n Serial.println(F(\n \"This is \\\"scvLoggerSdFat.ino\\\" example.\\n\"\n \"Open /setup page to configure optional parameters.\\n\"\n \"Open /edit page to view, edit or upload example or your custom webserver source files.\"\n ));\n\n // Set NTP servers\n #ifdef ESP8266\n configTime(MYTZ, \"time.google.com\", \"time.windows.com\", \"pool.ntp.org\");\n #elif defined(ESP32)\n configTzTime(MYTZ, \"time.google.com\", \"time.windows.com\", \"pool.ntp.org\");\n #endif\n\n // Wait for NTP sync (with timeout)\n getUpdatedtime(5000);\n\n appenRow();\n}\n\nvoid loop() {\n server.handleClient();\n if (captiveRun)\n server.updateDNS();\n\n static uint32_t updateTime;\n if (millis()- updateTime > 30000) {\n updateTime = millis();\n appenRow();\n }\n}\n" }, { "path": "examples/csvLoggerSD/data/assets/css/index.css", "content": "/* Misc */\nhtml, body {\n font-family: \"Helvetica\",\"Arial\",sans-serif;\n font-size: 14px;\n font-weight: 400;\n line-height: 20px;\n}\nbody {\n margin: 0;\n font-family: -apple-system,BlinkMacSystemFont,\"Segoe UI\",Roboto,\"Helvetica Neue\",Arial,\"Noto Sans\",sans-serif,\"Apple Color Emoji\",\"Segoe UI Emoji\",\"Segoe UI Symbol\",\"Noto Color Emoji\";\n font-size: 1rem;\n font-weight: 400;\n line-height: 1.5;\n color: #212529;\n text-align: left;\n background-color: #fff;\n}\n\nh1 {\n margin: 5px;\n text-align: center;\n}\n\np {\n font-size: 0.9rem;\n margin: 0.5rem 0 1.5rem 0;\n}\n\na,\na:visited {\n color: #08C;\n text-decoration: none;\n}\n\na:hover,\na:focus {\n color: #69c773;\n cursor: pointer;\n}\n\na.delete-file,\na.delete-file:visited {\n color: #CC0000;\n margin-left: 0.5rem;\n vertical-align: middle;\n}\n\nbutton {\n display: inline-block;\n border-radius: 3px;\n border: none;\n font-size: 0.9rem;\n padding: 0.5rem 1em;\n background: #86b32d;\n border-bottom: 1px solid #5d7d1f;\n color: white;\n margin: 5px 0;\n text-align: center;\n}\n\nbutton:hover {\n opacity: 0.75;\n cursor: pointer;\n}\n\n#page-wrapper {\n width: 95%;\n background: #FFF;\n padding: 1.25rem;\n margin: 1rem auto;\n min-height: 800px;\n border-top: 5px solid #69c773;\n box-shadow: 0 2px 10px rgba(0,0,0,0.8);\n}\n\n#content {\n width: 85%;\n overflow: auto;\n height: 86vh;\n}\n\n#files {\n width: 15%;\n}\n\n#files ul {\n margin: 20px 0;\n padding: 0.5rem 1rem;\n overflow-y: auto;\n list-style: square;\n background: #F7F7F7;\n border: 1px solid #D9D9D9;\n border-radius: 5px;\n box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.1);\n max-height: 75vh;\n}\n\n#files li {\n margin-left: 8px;\n font-size: 14px;\n display: flex;\n justify-content: space-between;\n align-items: center;\n}\n\n.container {\n display: flex;\n flex-direction: row;\n align-content: flex-start;\n justify-content: space-between;\n align-items: flex-start;\n column-gap: 10px;\n height: 86vh;\n}\n\n.delete {\n font-size: 24px;\n transition: 0.3s;\n margin-top:5px;\n}\n\n.delete-all{\n color: #f44336;\n font-size: 12px;\n background-color: transparent;\n background-repeat: no-repeat;\n border: none;\n cursor: pointer;\n overflow: hidden;\n}\n\n/* Tables */\n.table-holder {\n margin-top: 20px;\n border: 1px solid lightgray;\n border-radius: 5px;\n border-bottom: 0px;\n border-bottom-left-radius: 0px;\n border-bottom-right-radius: 0px;\n}\n\n.tables {\n margin-bottom: 50px;\n}\n\ntable {\n width: 100%;\n border-bottom: 0px;\n}\n\ntable, th, td {\n border: 1px solid lightgrey;\n border-collapse: collapse;\n padding-left: 5px;\n}\n\ntable tr:nth-child(even) {\n background-color: white;\n}\n\ntable tr:nth-child(odd) {\n background-color: #f2f2f2;\n}\n\ntable th {\n background-color: #e1e1e1;\n color: black;\n}\n\n/* Sections */\n\n.section {\n box-shadow: 10px 10px 10px 10px;\n background-color: #e5e5e5;\n padding: 10px;\n padding-top: 20px;\n font-size: 18px;\n}\n\n.section-lightgrey {\n background-color: #f9f9f9;\n}\n\n/* 100% Image Width on Smaller Screens */\n@media only screen and (max-width: 700px){\n .modal-content {\n width: 100%;\n }\n}\n" }, { "path": "examples/csvLoggerSD/data/assets/css/style.css", "content": "/* Misc */\nhtml, body {\n font-family: \"Helvetica\",\"Arial\",sans-serif;\n font-size: 14px;\n font-weight: 400;\n line-height: 20px;\n}\nbody {\n margin: 0;\n font-family: -apple-system,BlinkMacSystemFont,\"Segoe UI\",Roboto,\"Helvetica Neue\",Arial,\"Noto Sans\",sans-serif,\"Apple Color Emoji\",\"Segoe UI Emoji\",\"Segoe UI Symbol\",\"Noto Color Emoji\";\n font-size: 1rem;\n font-weight: 400;\n line-height: 1.5;\n color: #212529;\n text-align: left;\n background-color: #fff;\n}\n\nh1 {\n margin: 5px;\n text-align: center;\n}\n\np {\n font-size: 0.9rem;\n margin: 0.5rem 0 1.5rem 0;\n}\n\na,\na:visited {\n color: #08C;\n text-decoration: none;\n}\n\na:hover,\na:focus {\n color: #69c773;\n cursor: pointer;\n}\n\na.delete-file,\na.delete-file:visited {\n color: #CC0000;\n margin-left: 0.5rem;\n vertical-align: middle;\n}\n\nbutton {\n display: inline-block;\n border-radius: 3px;\n border: none;\n font-size: 0.9rem;\n padding: 0.5rem 1em;\n background: #86b32d;\n border-bottom: 1px solid #5d7d1f;\n color: white;\n margin: 5px 0;\n text-align: center;\n}\n\nbutton:hover {\n opacity: 0.75;\n cursor: pointer;\n}\n\n#page-wrapper {\n width: 95%;\n background: #FFF;\n padding: 1.25rem;\n margin: 1rem auto;\n min-height: 800px;\n border-top: 5px solid #69c773;\n box-shadow: 0 2px 10px rgba(0,0,0,0.8);\n}\n\n#content {\n width: 85%;\n overflow: auto;\n height: 86vh;\n}\n\n#files {\n width: 15%;\n line-height: 1;\n}\n\n#files ul {\n margin: 20px 0;\n padding: 0.5rem 1rem;\n overflow-y: auto;\n list-style: square;\n background: #F7F7F7;\n border: 1px solid #D9D9D9;\n border-radius: 5px;\n box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.1);\n max-height: 75vh;\n}\n\n#files li {\n font-size: 14px;\n display: flex;\n justify-content: space-between;\n align-items: center;\n}\n\n.container {\n display: flex;\n flex-direction: row;\n align-content: flex-start;\n justify-content: space-between;\n align-items: flex-start;\n column-gap: 10px;\n height: 86vh;\n}\n\n.delete {\n font-size: 24px;\n transition: 0.3s;\n margin-top:5px;\n}\n\n.delete-all{\n color: #f44336;\n font-size: 12px;\n background-color: transparent;\n background-repeat: no-repeat;\n border: none;\n cursor: pointer;\n overflow: hidden;\n}\n\n/* Tables */\n.table-holder {\n margin-top: 20px;\n border: 1px solid lightgray;\n border-radius: 5px;\n border-bottom: 0px;\n border-bottom-left-radius: 0px;\n border-bottom-right-radius: 0px;\n}\n\n.tables {\n margin-bottom: 50px;\n}\n\ntable {\n width: 100%;\n border-bottom: 0px;\n}\n\ntable, th, td {\n border: 1px solid lightgrey;\n border-collapse: collapse;\n padding-left: 5px;\n}\n\ntable tr:nth-child(even) {\n background-color: white;\n}\n\ntable tr:nth-child(odd) {\n background-color: #f2f2f2;\n}\n\ntable th {\n background-color: #e1e1e1;\n color: black;\n}\n\n/* Sections */\n\n.section {\n box-shadow: 10px 10px 10px 10px;\n background-color: #e5e5e5;\n padding: 10px;\n padding-top: 20px;\n font-size: 18px;\n}\n\n.section-lightgrey {\n background-color: #f9f9f9;\n}\n\n/* 100% Image Width on Smaller Screens */\n@media only screen and (max-width: 700px){\n .modal-content {\n width: 100%;\n }\n}\n" }, { "path": "examples/csvLoggerSD/data/assets/js/csv.js", "content": "\n// Default file to be loaded with no parameter in url\nvar filename = '';\n\n// JQuery-like selector\nvar $ = function(el) {\n\treturn document.getElementById(el);\n};\n\n\n/**\n * @returns {getUserInput.userInput} an object\n * containing all the user input at the time \n * of the method call.\n */\nfunction getUserInput() {\n var userInput = {};\n userInput.fileName = filename;\n userInput.maxRows = \"0\";\n userInput.encoding = 'UTF-8';\n userInput.columnSeparator = ',';\n userInput.useQuotes = true;\n userInput.firstRowHeaders = true;\n userInput.firstRowInlcude = false;\n return userInput;\n}\n\n/* Tables */\n\nvar tableCount = 1;\n\n/**\n * Creates a table holder with the \n * given table in it.\n * \n * @param {type} title\n * @param {type} tableHtml\n * @returns {String|getTableUnit.tableHolder}\n */\n\nfunction getTableUnit(title, tableHtml){\n var id = \"table-\" + tableCount;\n var tableHolder = \"
    {@name}{@table}
    \";\n tableHolder = tableHolder.replace(\"{@name}\", title);\n tableHolder = tableHolder.replace(\"{@table}\", tableHtml);\n tableCount++;\n return tableHolder;\n}\n\n/**\n * Clears all tables from the page.\n */\nfunction clearTables(){\n tableCount = 1;\n $('csv-table').innerHTML = '';\n}\n\n/**\n * Adds (appends) a table holder to the page.\n * \n * @param {type} unit\n * @returns {undefined}\n */\nfunction addTableUnit(unit){\n $('csv-table').innerHTML = unit ;\n}\n\n\nfunction saveTable(filename, text) {\n var myblob = new Blob([text]);\n var formData = new FormData();\n formData.append(\"data\", myblob, filename);\n\n // POST data using the Fetch API\n fetch('/edit', {\n method: 'POST',\n headers: {\n 'Access-Control-Allow-Origin': '*',\n 'Access-Control-Max-Age': '600',\n 'Access-Control-Allow-Methods': 'PUT,POST,GET,OPTIONS',\n 'Access-Control-Allow-Headers': '*',\n 'filename': filename\n },\n body: formData\n })\n // Handle the server response\n .then(response => response.text())\n .then(text => {\n console.log(text);\n });\n}\n\n\n/* Table downloading */\n\n/**\n * Download the specified table to \n * the users computer.\n * \n * @param {type} table table number\n * @param {save} save file to host memory\n * @returns {undefined}\n */\n\nfunction downloadTable(table, save = false) {\n var tableId = \"table-\" + table;\n \n\tvar csvArray = [];\n\tvar rows = document.querySelectorAll(\"#\" + tableId + \" > table tr\");\n\t\t\t\n\tfor (var i = 0; i < rows.length; i++) {\n\t\tvar row = [], cols = rows[i].querySelectorAll(\"td, th\");\n\t\tfor (var j = 0; j < cols.length; j++) {\n\t\t \n\t\t var value = cols[j].innerText;\n\t\t \n\t\t if(customParseFloat(value) ) {\n row.push(value);\n\t\t }\n\t\t else {\n\t\t row.push('\"' + value +'\"');\n\t\t }\n }\n\t\tcsvArray.push(row.join(\",\")); \t\t\n\t\tcsvArray.push(\"\\n\");\n\t}\n\n var csvString = csvArray.join(\"\");\n if (save === false)\n download(filename, csvString);\n else {\n saveTable(filename, csvString);\n }\n}\n\n\n/**\n * Creates and downloads a file to the users computer.\n * \n * @param {type} filename\n * @param {type} text\n * @returns {undefined}\n */\nfunction download(filename, text) {\n var element = document.createElement('a');\n element.setAttribute('href', 'data:text/plain;charset=utf-8,' + encodeURIComponent(text));\n element.setAttribute('download', filename);\n\n element.style.display = 'none';\n document.body.appendChild(element);\n element.click();\n document.body.removeChild(element);\n}\n\n/**\n * Gets the users input and creates\n * a set of tables from it.\n */\nfunction populate(csv){\n var ui = getUserInput();\n addTableUnit(\n getTableUnit(\n ui.fileName,\n getTable(\n csvTo2DArray(\n csv,\n ui.columnSeparator,\n ui.useQuotes,\n ui.maxRows\n ),\n ui.firstRowHeaders, \n ui.firstRowInlcude\n )\n )\n );\n\n // Prevents to ad a new line inside cell\n var cells = document.querySelectorAll('td');\n \n cells.forEach(item => {\n item.addEventListener('keypress', event => {\n if ( event.keyCode === 13 ){\n if (window.event) {\n window.event.returnValue = false;\n }\n }\n });\n });\n}\n\n/**\n * Load the csv from webserver location and fit table with data\n*/\nfunction loadCsv(path) {\n clearTables();\n filename = path;\n \n fetch(path)\n .then(response => response.text()) \n .then(textString => {\n populate(textString);\n });\n}\n\n\n/**\n * Standard parseFloat don't handle properly \"0\", \"0.0\", \"0.00\" etc strings\n * @param {strNumber} the string representing a number to be parsed\n * @returns {float number} or NaN\n*/\nfunction customParseFloat(strNumber){\n if (isNaN(parseFloat(strNumber)) === false){\n let toFixedLength = 0;\n\n let arr = strNumber.split('.');\n if (arr.length === 2 ){\n toFixedLength = arr[1].length;\n }\n return parseFloat(strNumber).toFixed(toFixedLength);\n }\n return NaN; // Not a number\n}\n\n/**\n * Creates an unstyled, bare-bones html table\n * from the provided 2D(Multidimentional Array).\n * \n * @param {type} tableArray the 2D array.\n * @param {type} useHeaders will make the first row\n * in the table bold if true.\n * @param {type} dupeHeaders will duplicate the first row\n * in the table if true and useHeaders is true.\n * @param {type} tableId HTML ID for the table.\n * @returns {String} the constructed html table as text.\n */\nfunction getTable(tableArray, useHeaders, dupeHeaders, tableId){\n var tableOpen = \"\";\n var tableClose = \"
    \";\n \n var headerCell = \"{@val}\";\n var cell = \"{@val}\";\n \n var rowOpen = \"\";\n var rowClose = \"\";\n \n var table = tableOpen;\n \n for(i = 0; i < tableArray.length; i++){\n //Row\n if(i === 1 && useHeaders && dupeHeaders){\n i = 0;\n useHeaders = false;\n dupeHeaders = false;\n }\n \n table += rowOpen;\n for(j = 0; j < tableArray[i].length; j++){\n //Cell\n if(i === 0 && useHeaders){\n table += headerCell.replace(\"{@val}\", tableArray[i][j]);\n } else {\n table += cell.replace(\"{@val}\", tableArray[i][j]);\n }\n }\n \n table += rowClose;\n }\n \n return table + tableClose;\n}\n\n/**\n * Creates a 2D (Multidimentional) array from\n * CSV data in string form.\n * \n * @param {type} csv the CSV data.\n * @param {type} separator the character used\n * to separate the columns/cells.\n * @param {type} quotes ignores the separator\n * in quoted text.\n * @param {type} maxRows the maximum rows\n * to scan.\n * @returns {Array|csvTo2DArray.table} the CSV data\n * as a 2D (Multidimentional) array.\n */\nfunction csvTo2DArray(csv, separator, quotes, maxRows){\n var table = [];\n var rows = 0;\n \n csv.split(\"\\n\").map(function(row){\n if(maxRows !== \"0\")\n if(rows >= maxRows)\n return;\n \n var tableRow = getRow(row, separator, quotes);\n \n if(tableRow === null)\n return table;\n \n table.push(tableRow);\n rows++;\n });\n \n return table;\n}\n\n/**\n * Creates an array from a CSV row (line)\n * \n * @param {type} row the CSV row.\n * @param {type} separator character used to separate\n * cells/columns\n * @param {type} quotes ignores the separator\n * in quoted text.\n * @returns {Array|getRow.trow} the CSV row as an array.\n */\nfunction getRow(row, separator, quotes){\n if(row.length === 0)\n return null;\n \n isQuoted = false;\n var trow = [];\n var cell = \"\";\n \n for(var i = 0; i < row.length; i++){\n var char = row.charAt(i);\n \n if(quotes){\n if(char === '\\\"' || char === '\\''){\n isQuoted = !isQuoted;\n continue;\n }\n }\n \n if(char === separator && !isQuoted){\n trow.push(cell);\n cell = \"\";\n continue;\n }\n \n cell += char;\n }\n \n trow.push(cell);\n return trow;\n}" }, { "path": "examples/csvLoggerSD/data/assets/js/index.js", "content": "var dataFolder = document.getElementById(\"csv-path\").value;\nvar fileList = document.getElementById('file-list');\nvar currentFile = \"\";\n\n// Fetch the list of files and fill the filelist\nfunction listFiles() {\n var url = '/list?dir=' + dataFolder;\n if (url.charAt(url.length - 1) === '/')\n url = url.slice(0, -1); // Remove the last character\n fetch(url) // Do the request\n .then(response => response.json()) // Parse the response\n .then(obj => { // DO something with response\n fileList.innerHTML = '';\n obj.forEach(function(entry, i) {\n addEntry(entry.name);\n });\n // Load last file\n loadCsv(dataFolder + obj[obj.length -1].name); \n });\n}\n\n// Load selected image inside the preview content\nfunction loadFile(filename) {\n loadCsv(filename);\n}\n\n// Delete selected file in SD\nasync function deleteFile(filename) {\n var isExecuted = confirm(\"Are you sure to delete \"+ filename + \"?\");\n if(isExecuted){\n const data = new URLSearchParams();\n data.append('path', filename);\n fetch('/edit', {\n method: 'DELETE',\n body: data\n });\n // Update the file browser.\n listFiles();\n }\n}\n\nasync function deleteAll() {\n var isExecuted = confirm(\"Are you sure to delete all files in \"+ dataFolder + \" folder?\");\n if(isExecuted){\n var ul = document.getElementById(\"file-list\");\n var items = ul.getElementsByClassName(\"edit-file\");\n for (var i=0; i\n\n\n \n ESP32 CSV List\n \n \n\n \n
    \n
    \n

    CSV list web interface

    \n
    \n
    \n
      \n
      \n \n

      \n \n \n
      \n
      \n \n
      \n
      \n
      \n
      \n
      \n
      \n
      \n
      \n \n \n \n" }, { "path": "examples/csvLoggerSD/partitions.csv", "content": "# Name, Type, SubType, Offset, Size, Flags\nnvs, data, nvs, 0x9000, 0x5000,\notadata, data, ota, 0xe000, 0x2000,\napp0, app, ota_0, 0x10000, 0x140000,\napp1, app, ota_1, 0x150000,0x140000,\nspiffs, data, spiffs, 0x290000,0x160000,\ncoredump, data, coredump,0x3F0000,0x10000,\n" }, { "path": "examples/csvLoggerSD/platformio.ini", "content": "; PlatformIO Project Configuration File\n;\n; Build options: build flags, source filter\n; Upload options: custom upload port, speed and extra flags\n; Library options: dependencies, extra library storages\n; Advanced options: extra scripting\n;\n; Please visit documentation for the other options and examples\n; https://docs.platformio.org/page/projectconf.html\n\n[platformio]\nsrc_dir = .\n\n[env:esp32-s3-devkitc1-n4r2]\nplatform = https://github.com/pioarduino/platform-espressif32/releases/download/stable/platform-espressif32.zip\nboard = esp32-s3-devkitc1-n4r2\nframework = arduino\nupload_speed = 921600\nboard_build.partitions = partitions.csv\nlib_extra_dirs = ../../\nlib_ignore = pio_examples\n\n[env:esp32dev]\nplatform = https://github.com/pioarduino/platform-espressif32/releases/download/stable/platform-espressif32.zip\nboard = esp32dev\nframework = arduino\nupload_speed = 921600\nboard_build.partitions = partitions.csv\nlib_extra_dirs = ../../\nlib_ignore = pio_examples\n\n[env:esp8266-nodemcuv2]\nplatform = espressif8266\nboard = nodemcuv2\nframework = arduino\nupload_speed = 921600\nboard_build.partitions = partitions.csv\nlib_extra_dirs = ../../\nlib_ignore = pio_examples\n" }, { "path": "examples/csvLoggerSD/readme.md", "content": "An example for logging to a CSV file and viewing the content with the browser.\nIt is also possible to modify or download the file.\n\n![image](https://github.com/cotestatnt/esp-fs-webserver/assets/27758688/a776a217-f634-480c-873c-8914e82f87e3)" }, { "path": "examples/customHTML/customElements.h", "content": "#pragma once\n#include \n\n\n/*\n* This HTML code will be injected in /setup webpage using a
      element as parent\n* The parent element will have the HTML id properties equal to 'raw-html-'\n* where the id value will be equal to the id parameter passed to the function addHTML(html_code, id).\n*/\ninline const char custom_html[] PROGMEM = R\"EOF(\n\n\n
      \n
      \n \n
      \n \n \n \n Fecth url\n \n
      \n
      \n)EOF\";\n\n\n/*\n* In this example, a style sections is added in order to render properly the new\n* \n            \n          \n        \n    \n        
      \n          
      Select image
      \n          
        \n            \n        
        \n        \n        \n      \n    \n    \n    \n    \n  \n"
  },
  {
    "path": "examples/esp32-cam/data/www/styles.css",
    "content": "*, *:before, *:after {\n  -moz-box-sizing: border-box;\n  -webkit-box-sizing: border-box;\n  box-sizing: border-box;\n}\n\nhtml {\n  font-family: Helvetica, Arial, sans-serif;\n  font-size: 100%;\n  background: #333;\n  color: #33383D;\n  -webkit-font-smoothing: antialiased;\n}\n\n#page-wrapper {\n  width: 960px;\n  background: #FFF;\n  padding: 1.25rem;\n  margin: 1rem auto;\n  min-height: 300px;\n  border-top: 5px solid #69c773;\n  box-shadow: 0 2px 10px rgba(0,0,0,0.8);\n}\n\n\nh2 {\n  margin-top: 0;\n  font-size: 0.9rem;\n  letter-spacing: 1px;\n  color: #999;\n}\n\np {\n  font-size: 0.9rem;\n  margin: 0.5rem 0 1.5rem 0;\n}\n\na,\na:visited {\n  color: #08C;\n  text-decoration: none;\n}\n\na:hover,\na:focus {\n  color: #69c773;\n  cursor: pointer;\n}\n\na.delete-file,\na.delete-file:visited {\n  color: #CC0000;\n  margin-left: 0.5rem;\n  vertical-align: middle;\n}\n\n\n\n.field {\n  margin-bottom: 1rem;\n}\n\nbutton {\n  width: 150px;\n  display: inline-block;\n  border-radius: 3px;\n  border: none;\n  font-size: 0.9rem;\n  padding: 0.6rem 1em;\n  background: #86b32d;\n  border-bottom: 1px solid #5d7d1f;\n  color: white;\n  margin: 0 0.25rem;\n  text-align: center;\n}\n\nbutton:hover {\n  opacity: 0.75;\n  cursor: pointer;\n}\n\n#file-form {\n  width: 75%;\n  float: left;\n}\n\n#files {\n  width: 23%;\n  float: right;\n}\n\n#files ul {\n  margin: 0;\n  padding: 0.5rem 1rem;\n  max-height: 600px;\n  overflow-y: auto;\n  list-style: square;\n  background: #F7F7F7;\n  border: 1px solid #D9D9D9;\n  border-radius: 3px;\n  box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.1);\n}\n\n#files li {\n  margin-left: 8px;\n  font-size: 14px;\n}\n\n\n/* Clearfix Utils */\n\n.clearfix {\n  *zoom: 1;\n}\n\n.clearfix:before,\n.clearfix:after {\n  display: table;\n  line-height: 0;\n  content: \"\";\n}\n\n.clearfix:after {\n  clear: both;\n}\n\n#image-content {\n  border-radius: 5px;\n  cursor: pointer;\n  transition: 0.3s;\n}\n\n#image-content:hover {opacity: 0.7;}\n\n/* The Modal (background) */\n.modal {\n  display: none; /* Hidden by default */\n  position: fixed; /* Stay in place */\n  z-index: 1; /* Sit on top */\n  padding-top: 100px; /* Location of the box */\n  left: 0;\n  top: 0;\n  width: 100%; /* Full width */\n  height: 100%; /* Full height */\n  overflow: auto; /* Enable scroll if needed */\n  background-color: rgb(0,0,0); /* Fallback color */\n  background-color: rgba(0,0,0,0.9); /* Black w/ opacity */\n}\n\n\n/* Modal Content (image) */\n.modal-content {\n  margin: auto;\n  display: block;\n  width: 90%;\n}\n\n/* Caption of Modal Image */\n#caption {\n  margin: auto;\n  display: block;\n  text-align: center;\n  color: #ccc;\n  padding: 10px 0;\n}\n\n/* Add Animation */\n.modal-content, #caption {  \n  -webkit-animation-name: zoom;\n  -webkit-animation-duration: 0.6s;\n  animation-name: zoom;\n  animation-duration: 0.6s;\n}\n\n@-webkit-keyframes zoom {\n  from {-webkit-transform:scale(0)} \n  to {-webkit-transform:scale(1)}\n}\n\n@keyframes zoom {\n  from {transform:scale(0)} \n  to {transform:scale(1)}\n}\n\n/* The Close Button */\n.close {\n  position: absolute;\n  top: 15px;\n  right: 35px;\n  color: #f1f1f1;\n  font-size: 40px;\n  font-weight: bold;\n  transition: 0.3s;\n}\n\n.close:hover,\n.close:focus {\n  color: #bbb;\n  text-decoration: none;\n  cursor: pointer;\n}\n\n.delete {\n  font-size: 30px;\n  font-weight: bold;\n  transition: 0.3s;\n}\n\n.delete-all{\n  color: #f44336;\n  font-size: 12px;\n  background-color: transparent;\n  background-repeat: no-repeat;\n  border: none;\n  cursor: pointer;\n  overflow: hidden;\n  outline: none;\n}\n/* 100% Image Width on Smaller Screens */\n@media only screen and (max-width: 700px){\n  .modal-content {\n    width: 100%;\n  }\n}\n"
  },
  {
    "path": "examples/esp32-cam/esp32-cam.ino",
    "content": "\n#include \n#include \n#include \n#include    // https://github.com/cotestatnt/esp-fs-webserver/\n#include \"esp_camera.h\"\n#include \"soc/soc.h\"          // Brownout error fix\n#include \"soc/rtc_cntl_reg.h\" // Brownout error fix\n#if ESP_ARDUINO_VERSION_MAJOR >= 3\n  #include \"soc/soc_caps.h\"\n#endif\n// Local include files with camera pin definition and configuration\n#include \"camera_pins.h\"\n// Timezone definition to get properly time from NTP server\n#define MYTZ \"CET-1CEST,M3.5.0,M10.5.0/3\" \n\n// Set default file system type\n#define USE_LITTLEFS          1\n#define USE_SDMMC             2\n#define FILESYSTEM_TYPE       USE_LITTLEFS\n\n#if (FILESYSTEM_TYPE == USE_SDMMC)\n  #define FILESYSTEM SD_MMC\n#elif (FILESYSTEM_TYPE == USE_LITTLEFS)\n  #define FILESYSTEM LittleFS\n#endif\n\nFSWebServer server(FILESYSTEM, 80, \"esp32cam\");\n\n// Functions prototype\nvoid setInterval();\nvoid getPicture();\n\n// Struct for saving time datas (needed for time-naming the image files)\nstruct tm tInfo;\nuint16_t grabInterval = 0;  // Grab a picture every x seconds\nuint32_t lastGrabTime = 0;\nconst char* getFolder = \"/img\";\n\n///////////////////////////////////  SETUP  ///////////////////////////////////////\nvoid setup() {\n  WRITE_PERI_REG(RTC_CNTL_BROWN_OUT_REG, 0); // disable brownout detect\n\n  // Flash LED setup\n    pinMode(LAMP_PIN, OUTPUT); // set the lamp pin as output\n  #if ESP_ARDUINO_VERSION_MAJOR >= 3\n    // Nuova API: ledcAttach(pin, freq, resolution)\n    ledcAttach(LAMP_PIN, pwmfreq, pwmresolution);\n  #else\n    ledcSetup(lampChannel, pwmfreq, pwmresolution); // configure LED PWM channel\n    ledcAttachPin(LAMP_PIN, lampChannel);\n  #endif\n    setLamp(0); // set default value\n\n  Serial.begin(115200);\n  Serial.println();\n\n  // Try to connect to WiFi (will start AP if not connected after timeout)\n  if (!server.startWiFi(10000)) {\n    Serial.println(\"\\nWiFi not connected! Starting AP mode...\");\n    server.startCaptivePortal(\"ESP32CAM_AP\", \"123456789\", \"/setup\");\n  }\n\n  // Sync time with NTP\n  configTzTime(MYTZ, \"time.google.com\", \"time.windows.com\", \"pool.ntp.org\");\n\n\n#if (FILESYSTEM_TYPE == USE_SDMMC)\n  /*\n   Init onboard SD filesystem (format if necessary)\n   SD_MMC.begin(const char * mountpoint, bool mode1bit, bool format_if_mount_failed, int sdmmc_frequency, uint8_t maxOpenFiles)\n   To avoid led glowing, set mode1bit = true (SD HS_DATA1 is tied to GPIO4, the same of on-board flash led)\n  */\n  if (!SD_MMC.begin(\"/sdcard\", true, true, SDMMC_FREQ_HIGHSPEED, 5)) {\n    Serial.println(\"\\nSD Mount Failed.\\n\");\n  }\n  else if (!SD_MMC.exists(getFolder)) {\n    if(SD_MMC.mkdir(getFolder))\n      Serial.println(\"Dir created\");\n    else\n      Serial.println(\"mkdir failed\");\n  }\n#elif (FILESYSTEM_TYPE == USE_LITTLEFS)\n  if (!LittleFS.begin()) {\n    Serial.println(\"ERROR on mounting LittleFS. It will be formmatted!\");\n    LittleFS.format();\n    ESP.restart();\n  }\n  else if (!LittleFS.exists(getFolder)) {\n    if(LittleFS.mkdir(getFolder))\n      Serial.println(\"Dir created\");\n    else\n      Serial.println(\"mkdir failed\");     \n  }\n  Serial.println(\"LittleFS mounted successfully\");\n#endif\n  \n  // List all files stored in filesystem\n  server.printFileList(FILESYSTEM, \"/\", 1, Serial);\n\n  // Enable ACE FS file web editor and add FS info callback function\n  server.enableFsCodeEditor();\n\n  // Add custom handlers to webserver\n  server.on(\"/getPicture\", getPicture);\n  server.on(\"/setInterval\", setInterval);\n\n  // Start server with built-in websocket event handler\n  server.begin();\n  Serial.print(F(\"\\nESP Web Server started on IP Address: \"));\n  Serial.println(server.getServerIP());\n  Serial.println(F(\n    \"This is \\\"remoteOTA.ino\\\" example.\\n\"\n    \"Open /setup page to configure optional parameters.\\n\"\n    \"Open /edit page to view, edit or upload example or your custom webserver source files.\"\n  ));\n\n  // Init the camera module (according the camera_config_t defined)\n  init_camera();\n}\n\n///////////////////////////////////  LOOP  ///////////////////////////////////////\nvoid loop() {\n  server.run();\n\n  if (grabInterval) {\n    if (millis() - lastGrabTime > grabInterval *1000) {\n      lastGrabTime = millis();\n      getPicture();\n    }\n  }\n}\n\n//////////////////////////////////  FUNCTIONS//////////////////////////////////////\nvoid setInterval() {\n  if (server.hasArg(\"val\")) {\n    grabInterval = server.arg(\"val\").toInt();\n    Serial.printf(\"Set grab interval every %d seconds\\n\", grabInterval);\n  }\n  server.send(200, \"text/plain\", \"OK\");\n}\n\n// Lamp Control\nvoid setLamp(int newVal) {\n  if (newVal < 0) return;\n  // Apply exponential scaling to have a better visual effect\n  int brightness = round((pow(2, (1 + (newVal * 0.02))) - 2) / 6 * pwmMax);\n#if ESP_ARDUINO_VERSION_MAJOR >= 3\n  // ledcWrite(pin, value) with new API\n  ledcWrite(LAMP_PIN, brightness);\n#else\n  ledcWrite(lampChannel, brightness);\n#endif\n  Serial.print(\"Lamp: \");\n  Serial.print(newVal);\n  Serial.print(\"%, pwm = \");\n  Serial.println(brightness);\n}\n\n// Send a picture taken from CAM to a Telegram chat\nvoid getPicture() {\n\n  // Take Picture with Camera;\n  Serial.println(\"Camera capture requested\");\n\n  // Take Picture with Camera and store in ram buffer fb\n  setLamp(100);\n  delay(100);\n  camera_fb_t *fb = esp_camera_fb_get();\n  setLamp(0);\n\n  if (!fb) {\n    Serial.println(\"Camera capture failed\");    \n    server.send(500, \"text/plain\", \"ERROR. Image grab failed\");\n    return;\n  }\n\n  // Keep files on SD memory, filename is time based (YYYYMMDD_HHMMSS.jpg)\n  // Embedded filesystem is too small to keep all images, overwrite the same file\n  char filename[20];\n  time_t now = time(nullptr);\n  tInfo = *localtime(&now);\n  strftime(filename, sizeof(filename), \"%Y%m%d_%H%M%S.jpg\", &tInfo);\n\n  char filePath[30];\n  strcpy(filePath, getFolder);\n  strcat(filePath, \"/\");\n  strcat(filePath, filename);\n  File file = FILESYSTEM.open(filePath, \"w\");\n  if (!file) {\n    Serial.println(\"Failed to open file in writing mode\");\n    server.send(500, \"text/plain\", \"ERROR. Image grab failed\");\n    return;\n  }\n  // size_t _jpg_buf_len = 0;\n  // uint8_t *_jpg_buf = NULL;\n  // bool jpeg_converted = frame2jpg(fb, 80, &_jpg_buf, &_jpg_buf_len);\n  file.write(fb->buf, fb->len);\n  file.close();\n  Serial.printf(\"Saved file to path: %s - %zu bytes\\n\", filePath, fb->len);\n\n  // Clear buffer\n  esp_camera_fb_return(fb);\n  server.send(200, \"text/plain\", filename);\n}\n\n\n"
  },
  {
    "path": "examples/esp32-cam/partitions.csv",
    "content": "# Name,   Type, SubType, Offset,  Size, Flags\nnvs,      data, nvs,     0x9000,  0x5000,\notadata,  data, ota,     0xe000,  0x2000,\napp0,     app,  ota_0,   0x10000, 0x140000,\napp1,     app,  ota_1,   0x150000,0x140000,\nspiffs,   data, spiffs,  0x290000,0x160000,\ncoredump, data, coredump,0x3F0000,0x10000,\n"
  },
  {
    "path": "examples/esp32-cam/platformio.ini",
    "content": "; PlatformIO Project Configuration File\n;\n;   Build options: build flags, source filter\n;   Upload options: custom upload port, speed and extra flags\n;   Library options: dependencies, extra library storages\n;   Advanced options: extra scripting\n;\n; Please visit documentation for the other options and examples\n; https://docs.platformio.org/page/projectconf.html\n\n[platformio]\nsrc_dir = .\n\n\n# Questo esempio è compatibile solo con schede ESP32 dotate di CAM (ad es. AI Thinker, ESP32-CAM, TTGO T-Journal, ecc.)\n# Scegli la board corretta e decommenta la sezione corrispondente, oppure aggiungi la tua board compatibile.\n\n[env:esp32cam]\nplatform = espressif32\nboard = esp32cam\nframework = arduino\nupload_speed = 921600\nboard_build.partitions = partitions.csv\nlib_extra_dirs = ../../\nlib_ignore = pio_examples\n\n# Esempio per AI Thinker (decommenta se necessario)\n# [env:esp32cam-ai-thinker]\n# platform = espressif32\n# board = esp32cam\n# framework = arduino\n# upload_speed = 921600\n# board_build.partitions = partitions.csv\n# lib_extra_dirs = ../../\n# lib_ignore = pio_examples\n"
  },
  {
    "path": "examples/gpio_list/.gitignore",
    "content": ".pio\n.vscode/.browse.c_cpp.db*\n.vscode/c_cpp_properties.json\n.vscode/launch.json\n.vscode/ipch\n"
  },
  {
    "path": "examples/gpio_list/data/index.htm",
    "content": "\r\n\r\n  \r\n    \r\n    ESP GPIO dinamic list\r\n    \r\n    \r\n    \r\n  \r\n  \r\n    
        \r\n      
        \r\n        \r\n        \r\n          \r\n            \r\n            \r\n            \r\n          \r\n        \r\n\r\n        
        GPIO status list
        \r\n        
        \r\n          \r\n            \r\n              \r\n                \r\n                \r\n                \r\n                \r\n              \r\n            \r\n            \r\n            \r\n            \r\n          
        Pin NamePin numberTypeLevel
        \r\n        
        \r\n      
        \r\n    
        \r\n    \r\n  \r\n\r\n"
  },
  {
    "path": "examples/gpio_list/data/script.js",
    "content": "const svgLightOn = '' ;\nconst svgLightOff = '';\n\n/**\n* Custom selector \"JQuery style\", but in plain \"Vanilla JS\"\n*/\nvar $ = function(el) {\n\treturn document.getElementById(el);\n};\n\n/**\n* Start a websocket client and set event callback functions\n*/\nfunction ws_connect() {\n  var ws = new WebSocket('ws://' + location.hostname + ':81/');\n  ws.onopen = function() {\n    ws.send('Connected - ' + new Date());\n    getGpioList();\n  };\n  ws.onmessage = function(e) {\n    parseMessage(e.data);\n  };\n  ws.onclose = function(e) {\n    setTimeout(function() {\n    ws_connect();\n    }, 1000);\n  };\n  ws.onerror = function(err) {\n    ws.close();\n  };\n  return ws;\n}\n\n/**\n* Send data \"cmds\" to ESP\n*/\nfunction sendCommand(cmd, pin, level) {\n  var data = {\n    cmd: cmd,\n    pin: parseInt(pin),\n    level: level\n  };\n  console.log(data);\n  connection.send(JSON.stringify(data));\n}\n\n/**\n* Parse messages receveid via websocket\n*/\nfunction parseMessage(msg) {\n  const obj = JSON.parse(msg);\n  if (typeof obj === 'object' && obj !== null) {\n    if (obj.esptime !== null) {\n      var date = new Date(0); // The 0 sets the date to epoch\n      if( date.setUTCSeconds(obj.esptime))\n        document.getElementById(\"esp-time\").innerHTML = date;\n    }\n    updateGpiosList(obj);\n  }\n}\n\n/**\n* Read GPIO list status\n*/\nfunction getGpioList() {\n  fetch('/getGpioList')                 // Do the request\n  .then(response => response.json())    // Parse the response\n  .then(obj => {                        // DO something with response\n    updateGpiosList(obj);\n  });\n}\n\n\n/**\n* Iterate to the gpio list passed as parameter anc create DOMs dinamically\n*/\nfunction updateGpiosList(elems) {\n\n  // Get reference to gpio-list element and clear content\n  const list = document.querySelector('#gpio-list');\n  list.innerHTML = \"\";\n\n  // Draw all input rows\n  const inputs = Object.entries(elems).filter((item) => item[1].type === 'input');\n\n  inputs.forEach(el => {\n    const obj = el[1];\n    var lbl = obj.level ? `${svgLightOn} HIGH` : `${svgLightOff}  LOW`;\n    // Create a single row with all columns\n    var row = document.createElement('tr');\n\t  row.innerHTML  = '' + obj.label + '';\n    row.innerHTML += '' + obj.pin + '';\n    row.innerHTML += '' + obj.type + '';\n    row.innerHTML += `` ;\n    // Append this row to list\n    list.appendChild(row);\n  });\n\n  // Draw all output rows\n  const outputs = Object.entries(elems).filter((item) => item[1].type === 'output');\n\n  outputs.forEach(el => {\n    const obj = el[1];\n    var lbl = obj.level ? ` checked>Turn OFF` : `>Turn ON`;\n    // Create a single row with all columns\n    var row = document.createElement('tr');\n\t  row.innerHTML  = '' + obj.label + '';\n    row.innerHTML += '' + obj.pin + '';\n    row.innerHTML += '' + obj.type + '';\n    row.innerHTML += `