Arduino Core 3 (#407)
* Add and remove libs and components for Arduino Core 3 * Arduino Core 3 * Add back Solo1 * Change ESP32-S3 to 4MB build * Update README.md * Fix retain and number of retries * Fix rolling log * Fix defaults * Fix BleScanner on Solo1 * Export settings * Import settings * Fix HA Battery voltage * Change submodule * Update espMqttClient and AsyncTCP * Webserial and MQTT/Network reconnecting * Update nuki_ble --------- Co-authored-by: iranl <iranl@github.com>
This commit is contained in:
12
.github/workflows/build.yml
vendored
12
.github/workflows/build.yml
vendored
@@ -19,7 +19,7 @@ jobs:
|
|||||||
strategy:
|
strategy:
|
||||||
fail-fast: false
|
fail-fast: false
|
||||||
matrix:
|
matrix:
|
||||||
board: [esp32dev, esp32-s3, esp32-c3, esp32solo1]
|
board: [esp32dev, esp32-s3, esp32-c3, esp32-c6, esp32solo1]
|
||||||
build: [release, debug]
|
build: [release, debug]
|
||||||
env:
|
env:
|
||||||
BOARD: ${{ matrix.board }}
|
BOARD: ${{ matrix.board }}
|
||||||
@@ -62,20 +62,20 @@ jobs:
|
|||||||
BOARD="${BOARD}_dbg"
|
BOARD="${BOARD}_dbg"
|
||||||
fi
|
fi
|
||||||
echo "::group::Building with PlatformIO"
|
echo "::group::Building with PlatformIO"
|
||||||
|
if [ "$BUILD" = "release" ]; then
|
||||||
|
make updater_${BOARD}
|
||||||
|
fi
|
||||||
make $BOARD
|
make $BOARD
|
||||||
echo "::endgroup::"
|
echo "::endgroup::"
|
||||||
|
|
||||||
- name: Add flash script
|
- name: Add flash script
|
||||||
env:
|
env:
|
||||||
DOC: how-to-flash.txt
|
DOC: resources/how-to-flash.txt
|
||||||
FILES: ${{ format('{0}/{1}', env.BUILD, env.VARIANT) }}
|
FILES: ${{ format('{0}/{1}', env.BUILD, env.VARIANT) }}
|
||||||
run: |
|
run: |
|
||||||
BOARD=`echo $BOARD | tr '[:lower:]' '[:upper:]'`
|
BOARD=`echo $BOARD | tr '[:lower:]' '[:upper:]'`
|
||||||
|
|
||||||
# fix for docs
|
# fix for docs
|
||||||
if [ "$BOARD" = "ESP32SOLO1" ]; then
|
if [ "$BOARD" = "ESP32DEV" ]; then
|
||||||
BOARD="ESP32Solo1"
|
|
||||||
elif [ "$BOARD" = "ESP32DEV" ]; then
|
|
||||||
BOARD="ESP32"
|
BOARD="ESP32"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
|||||||
4
.github/workflows/stale-actions.yml
vendored
4
.github/workflows/stale-actions.yml
vendored
@@ -1,12 +1,12 @@
|
|||||||
name: "Mark or close stale issues and PRs"
|
name: "Mark or close stale issues and PRs"
|
||||||
on:
|
on:
|
||||||
schedule:
|
schedule:
|
||||||
- cron: "30 * * * *"
|
- cron: "30 7 * * *"
|
||||||
jobs:
|
jobs:
|
||||||
stale:
|
stale:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/stale@v6.0.1
|
- uses: actions/stale@v9.0.0
|
||||||
with:
|
with:
|
||||||
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
days-before-stale: 45
|
days-before-stale: 45
|
||||||
|
|||||||
11
.gitignore
vendored
11
.gitignore
vendored
@@ -11,8 +11,15 @@ webflash/*.bin
|
|||||||
.pio
|
.pio
|
||||||
.vscode
|
.vscode
|
||||||
.project
|
.project
|
||||||
|
managed_components
|
||||||
|
dependencies.lock
|
||||||
|
sdkconfig.esp32*
|
||||||
|
sdkconfig.updater_esp32*
|
||||||
|
updater/src/*.cpp
|
||||||
|
updater/src/*.h
|
||||||
|
updater/src/networkDevices/*.cpp
|
||||||
|
updater/src/networkDevices/*.h
|
||||||
# Python venv
|
# Python venv
|
||||||
/pyvenv.cfg
|
/pyvenv.cfg
|
||||||
/lib64
|
/lib64
|
||||||
/lib/python3*
|
/lib/python3*
|
||||||
2
.gitmodules
vendored
2
.gitmodules
vendored
@@ -1,3 +1,3 @@
|
|||||||
[submodule "lib/nuki_ble"]
|
[submodule "lib/nuki_ble"]
|
||||||
path = lib/nuki_ble
|
path = lib/nuki_ble
|
||||||
url = https://github.com/technyon/nuki_ble.git
|
url = https://github.com/I-Connect/NukiBleEsp32
|
||||||
|
|||||||
150
CMakeLists.txt
150
CMakeLists.txt
@@ -1,147 +1,3 @@
|
|||||||
cmake_minimum_required(VERSION 3.0.0)
|
cmake_minimum_required(VERSION 3.16.0)
|
||||||
|
include($ENV{IDF_PATH}/tools/cmake/project.cmake)
|
||||||
if(NOT ARDUINO_BOARD)
|
project(nukihub)
|
||||||
set(ARDUINO_BOARD "ESP32 Dev Module [esp32.esp32]")
|
|
||||||
endif()
|
|
||||||
|
|
||||||
project(nuki_hub CXX)
|
|
||||||
|
|
||||||
# ARDUHAL_LOG_LEVEL_NONE, define ARDUHAL_LOG_LEVEL_ERROR, define ARDUHAL_LOG_LEVEL_WARN, define ARDUHAL_LOG_LEVEL_INFO,
|
|
||||||
# define ARDUHAL_LOG_LEVEL_DEBUG, define ARDUHAL_LOG_LEVEL_VERBOSE
|
|
||||||
|
|
||||||
set(LOG_LEVEL ARDUHAL_LOG_LEVEL_NONE)
|
|
||||||
|
|
||||||
#add_compile_definitions(DEBUG_SENSE_NUKI)
|
|
||||||
#add_compile_definitions(DEBUG_NUKI_COMMAND)
|
|
||||||
#add_compile_definitions(DEBUG_NUKI_CONNECT)
|
|
||||||
#add_compile_definitions(DEBUG_NUKI_COMMUNICATION)
|
|
||||||
#add_compile_definitions(DEBUG_NUKI_HEX_DATA)
|
|
||||||
#add_compile_definitions(DEBUG_NUKI_READABLE_DATA)
|
|
||||||
|
|
||||||
# Length of char arrays to store certificates for MQTTS
|
|
||||||
add_compile_definitions(TLS_CA_MAX_SIZE=2200)
|
|
||||||
add_compile_definitions(TLS_CERT_MAX_SIZE=1500)
|
|
||||||
add_compile_definitions(TLS_KEY_MAX_SIZE=1800)
|
|
||||||
add_compile_definitions(ESP_PLATFORM)
|
|
||||||
add_compile_definitions(ESP32)
|
|
||||||
add_compile_definitions(ARDUINO_ARCH_ESP32)
|
|
||||||
# add_compile_definitions(CONFIG_BT_NIMBLE_PINNED_TO_CORE=1)
|
|
||||||
|
|
||||||
include_directories(${PROJECT_NAME}
|
|
||||||
PRIVATE
|
|
||||||
lib/Crc16
|
|
||||||
resources/NimBLE-Arduino/src
|
|
||||||
lib/BleScanner/src
|
|
||||||
lib/nuki_ble/src
|
|
||||||
lib/WiFiManager
|
|
||||||
lib/WebServer/src
|
|
||||||
lib/Ethernet/src
|
|
||||||
lib/MqttLogger/src
|
|
||||||
lib/espMqttClient/src
|
|
||||||
lib/AsyncTCP/src
|
|
||||||
lib/ArduinoJson/src
|
|
||||||
)
|
|
||||||
|
|
||||||
set(SRCFILES
|
|
||||||
src/Config.h
|
|
||||||
src/NukiDeviceId.cpp
|
|
||||||
src/CharBuffer.cpp
|
|
||||||
src/Network.cpp
|
|
||||||
src/MqttReceiver.h
|
|
||||||
src/NetworkLock.cpp
|
|
||||||
src/NetworkOpener.cpp
|
|
||||||
src/networkDevices/NetworkDevice.h
|
|
||||||
src/networkDevices/NetworkDevice.cpp
|
|
||||||
src/networkDevices/WifiDevice.cpp
|
|
||||||
src/networkDevices/W5500Device.cpp
|
|
||||||
src/networkDevices/EthLan8720Device.cpp
|
|
||||||
src/networkDevices/ClientSyncW5500.cpp
|
|
||||||
src/networkDevices/espMqttClientW5500.cpp
|
|
||||||
src/networkDevices/IPConfiguration.cpp
|
|
||||||
src/LockActionResult.h
|
|
||||||
src/QueryCommand.h
|
|
||||||
src/NukiWrapper.cpp
|
|
||||||
src/NukiOpenerWrapper.cpp
|
|
||||||
src/MqttTopics.h
|
|
||||||
src/Ota.cpp
|
|
||||||
src/WebCfgServerConstants.h
|
|
||||||
src/WebCfgServer.cpp
|
|
||||||
src/PresenceDetection.cpp
|
|
||||||
src/PreferencesKeys.h
|
|
||||||
src/Gpio.cpp
|
|
||||||
src/Logger.cpp
|
|
||||||
src/RestartReason.h
|
|
||||||
# include/RTOS.h
|
|
||||||
lib/WiFiManager/WiFiManager.cpp
|
|
||||||
lib/WiFiManager/wm_consts_en.h
|
|
||||||
lib/WiFiManager/wm_strings_en.h
|
|
||||||
lib/Crc16/Crc16.h
|
|
||||||
lib/nuki_ble/src/NukiBle.cpp
|
|
||||||
lib/nuki_ble/src/NukiBle.hpp
|
|
||||||
lib/nuki_ble/src/NukiLock.cpp
|
|
||||||
lib/nuki_ble/src/NukiOpener.cpp
|
|
||||||
lib/nuki_ble/src/NukiConstants.h
|
|
||||||
lib/nuki_ble/src/NukiOpenerConstants.h
|
|
||||||
lib/nuki_ble/src/NukiLockConstants.h
|
|
||||||
lib/nuki_ble/src/NukiDataTypes.h
|
|
||||||
lib/nuki_ble/src/NukiUtils.cpp
|
|
||||||
lib/nuki_ble/src/NukiLockUtils.cpp
|
|
||||||
lib/nuki_ble/src/NukiOpenerUtils.cpp
|
|
||||||
lib/gpio2go/src/Gpio2Go.cpp
|
|
||||||
lib/gpio2go/src/InterruptMode.h
|
|
||||||
lib/gpio2go/src/PinMode.h
|
|
||||||
lib/BleScanner/src/BleInterfaces.h
|
|
||||||
lib/BleScanner/src/BleScanner.cpp
|
|
||||||
lib/MqttLogger/src/MqttLogger.cpp
|
|
||||||
lib/AsyncTCP/src/AsyncTCP.cpp
|
|
||||||
)
|
|
||||||
|
|
||||||
file(GLOB_RECURSE SRCFILESREC
|
|
||||||
resources/NimBLE-Arduino/src/*.c
|
|
||||||
resources/NimBLE-Arduino/src/*.cpp
|
|
||||||
resources/NimBLE-Arduino/src/*.h
|
|
||||||
lib/WebServer/src/*.cpp
|
|
||||||
lib/WebServer/src/*.h
|
|
||||||
lib/Ethernet/src/*.cpp
|
|
||||||
lib/Ethernet/src/*.h
|
|
||||||
lib/espMqttClient/src/*.cpp
|
|
||||||
lib/espMqttClient/src/*.h
|
|
||||||
lib/espMqttClient/src/Packets/*.cpp
|
|
||||||
lib/espMqttClient/src/Packets/*.h
|
|
||||||
lib/espMqttClient/src/Transport/*.cpp
|
|
||||||
lib/espMqttClient/src/Transport/*.h
|
|
||||||
lib/ArduinoJson/src/*.h
|
|
||||||
lib/ArduinoJson/src/*.hpp
|
|
||||||
)
|
|
||||||
|
|
||||||
add_executable(${PROJECT_NAME}
|
|
||||||
src/main.cpp
|
|
||||||
${SRCFILES}
|
|
||||||
${SRCFILESREC}
|
|
||||||
)
|
|
||||||
|
|
||||||
target_compile_definitions(${PROJECT_NAME}
|
|
||||||
PRIVATE
|
|
||||||
ARDUHAL_LOG_LEVEL=${LOG_LEVEL}
|
|
||||||
CORE_DEBUG_LEVEL=${LOG_LEVEL}
|
|
||||||
CONFIG_NIMBLE_CPP_LOG_LEVEL=0
|
|
||||||
)
|
|
||||||
|
|
||||||
target_link_arduino_libraries(${PROJECT_NAME}
|
|
||||||
PRIVATE
|
|
||||||
core
|
|
||||||
BLE
|
|
||||||
WiFi
|
|
||||||
WiFiClientSecure
|
|
||||||
Update
|
|
||||||
DNSServer
|
|
||||||
Preferences
|
|
||||||
Ethernet
|
|
||||||
SPI
|
|
||||||
)
|
|
||||||
|
|
||||||
target_link_arduino_libraries(DNSServer PUBLIC WiFi)
|
|
||||||
|
|
||||||
# This is needed for the generation of HEX binary and uploading it
|
|
||||||
target_enable_arduino_upload(${PROJECT_NAME})
|
|
||||||
|
|
||||||
@@ -1,45 +0,0 @@
|
|||||||
FROM eclipse-temurin:11-jdk-jammy AS builder
|
|
||||||
|
|
||||||
RUN set -ex && \
|
|
||||||
apt-get update && \
|
|
||||||
apt-get install -y git cmake xz-utils python3 python3-serial ninja-build
|
|
||||||
|
|
||||||
RUN curl -L "https://downloads.arduino.cc/arduino-1.8.19-linux64.tar.xz" -o /tmp/arduino-ide.tar.xz
|
|
||||||
RUN tar -xf /tmp/arduino-ide.tar.xz --directory ~/
|
|
||||||
|
|
||||||
RUN cd ~/arduino* && \
|
|
||||||
./install.sh && \
|
|
||||||
./arduino --pref "boardsmanager.additional.urls=https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json" --save-prefs && \
|
|
||||||
./arduino --install-boards esp32:esp32:2.0.17
|
|
||||||
|
|
||||||
RUN git clone --recurse-submodules https://github.com/technyon/Arduino-CMake-Toolchain.git ~/Arduino-CMake-Toolchain
|
|
||||||
|
|
||||||
COPY src /usr/src/nuki_hub/src
|
|
||||||
COPY lib /usr/src/nuki_hub/lib
|
|
||||||
COPY include /usr/src/nuki_hub/include
|
|
||||||
COPY CMakeLists.txt /usr/src/nuki_hub
|
|
||||||
|
|
||||||
RUN mkdir -p /usr/src/nuki_hub/build
|
|
||||||
|
|
||||||
RUN cd /usr/src/nuki_hub/build && \
|
|
||||||
echo "# Espressif ESP32 Partition Table" > partitions.csv && \
|
|
||||||
echo "# Name, Type, SubType, Offset, Size, Flags" >> partitions.csv && \
|
|
||||||
echo "nvs, data, nvs, 0x9000, 0x5000," >> partitions.csv && \
|
|
||||||
echo "otadata, data, ota, 0xe000, 0x2000," >> partitions.csv && \
|
|
||||||
echo "app0, app, ota_0, 0x10000, 0x1E0000," >> partitions.csv && \
|
|
||||||
echo "app1, app, ota_1, 0x1F0000,0x1E0000," >> partitions.csv && \
|
|
||||||
echo "spiffs, data, spiffs, 0x3D0000,0x30000," >> partitions.csv
|
|
||||||
|
|
||||||
RUN set -ex && \
|
|
||||||
cd /usr/src/nuki_hub/build && \
|
|
||||||
touch file_opts && \
|
|
||||||
cmake -G Ninja -D CMAKE_TOOLCHAIN_FILE=~/Arduino-CMake-Toolchain/Arduino-toolchain.cmake .. && \
|
|
||||||
ninja
|
|
||||||
|
|
||||||
FROM builder AS runtime
|
|
||||||
|
|
||||||
COPY --from=builder /usr/src/nuki_hub/build/nuki_hub.bin /usr/src/nuki_hub/build/release/nuki_hub.bin
|
|
||||||
COPY --from=builder /usr/src/nuki_hub/build/nuki_hub.partitions.bin /usr/src/nuki_hub/build/release/nuki_hub.partitions.bin
|
|
||||||
COPY --from=builder /root/.arduino15/packages/esp32/hardware/esp32/2.0.17/tools/partitions/boot_app0.bin /usr/src/nuki_hub/build/release/boot_app0.bin
|
|
||||||
|
|
||||||
CMD ["/bin/bash"]
|
|
||||||
@@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
You can build this project using Docker. Just run the following commands in the console:
|
You can build this project using Docker. Just run the following commands in the console:
|
||||||
|
|
||||||
## Build with PlatformIO (will build for the ESP32, ESP32-S3, ESP32-C3 and ESP32-solo1)
|
## Build with PlatformIO (will build for the ESP32, ESP32-S3, ESP32-C3 and ESP32-C6)
|
||||||
```console
|
```console
|
||||||
git clone https://github.com/technyon/nuki_hub --recursive
|
git clone https://github.com/technyon/nuki_hub --recursive
|
||||||
cd nuki_hub/Docker
|
cd nuki_hub/Docker
|
||||||
@@ -10,12 +10,3 @@ cd nuki_hub/Docker
|
|||||||
```
|
```
|
||||||
|
|
||||||
once the script is complete you will find the nuki_hub binaries in the `nuki_hub/release` folder.
|
once the script is complete you will find the nuki_hub binaries in the `nuki_hub/release` folder.
|
||||||
|
|
||||||
## Build with CMake (will only build for the ESP32)
|
|
||||||
```console
|
|
||||||
git clone https://github.com/technyon/nuki_hub --recursive
|
|
||||||
cd nuki_hub/Docker
|
|
||||||
./build_with_docker_cmake.sh
|
|
||||||
```
|
|
||||||
|
|
||||||
once the script is complete you will find the nuki_hub binary in the `nuki_hub/build_cmake` folder.
|
|
||||||
|
|||||||
@@ -1,6 +0,0 @@
|
|||||||
set -ex
|
|
||||||
docker build -f ./Dockerfile_cmake -t nuki_hub_cmake ..
|
|
||||||
docker create --name nuki_hub_cmake nuki_hub_cmake
|
|
||||||
rm -rf ../build_cmake
|
|
||||||
docker cp nuki_hub_cmake:/usr/src/nuki_hub/build/ ../build_cmake
|
|
||||||
docker rm -f nuki_hub_cmake
|
|
||||||
14
Makefile
14
Makefile
@@ -10,12 +10,15 @@ default: esp32
|
|||||||
.PHONY: release
|
.PHONY: release
|
||||||
release: $(BOARDS)
|
release: $(BOARDS)
|
||||||
|
|
||||||
|
.PHONY: updater
|
||||||
|
release: updater_$(BOARDS)
|
||||||
|
|
||||||
.PHONY: debug
|
.PHONY: debug
|
||||||
debug: $(DEBUG_BOARDS)
|
debug: $(DEBUG_BOARDS)
|
||||||
|
|
||||||
# Target to build all boards in both release and debug modes
|
# Target to build all boards in release, updater and debug modes
|
||||||
.PHONY: all
|
.PHONY: all
|
||||||
all: release debug
|
all: release updater debug
|
||||||
|
|
||||||
# Alias
|
# Alias
|
||||||
.PHONY: esp32
|
.PHONY: esp32
|
||||||
@@ -25,6 +28,10 @@ esp%:
|
|||||||
@echo "Building $@"
|
@echo "Building $@"
|
||||||
pio run --environment $@
|
pio run --environment $@
|
||||||
|
|
||||||
|
updater_esp%:
|
||||||
|
@echo "Building $@"
|
||||||
|
pio run -d updater --environment $@
|
||||||
|
|
||||||
# Help target to display available build targets
|
# Help target to display available build targets
|
||||||
.PHONY: help
|
.PHONY: help
|
||||||
help:
|
help:
|
||||||
@@ -36,13 +43,14 @@ help:
|
|||||||
@$(foreach board,$(DEBUG_BOARDS),echo " make $(board) - Build $(board) in debug mode";)
|
@$(foreach board,$(DEBUG_BOARDS),echo " make $(board) - Build $(board) in debug mode";)
|
||||||
@echo "Available boards:"
|
@echo "Available boards:"
|
||||||
@echo " $(BOARDS)"
|
@echo " $(BOARDS)"
|
||||||
|
@echo " updater_$(BOARDS)"
|
||||||
@echo " $(DEBUG_BOARDS)"
|
@echo " $(DEBUG_BOARDS)"
|
||||||
|
|
||||||
# Utility target to clean build artifacts
|
# Utility target to clean build artifacts
|
||||||
.PHONY: clean
|
.PHONY: clean
|
||||||
clean:
|
clean:
|
||||||
@echo "Cleaning build artifacts..."
|
@echo "Cleaning build artifacts..."
|
||||||
@-rm -rf release debug .pio/build
|
@-rm -rf release debug .pio/build updater/.pio/build
|
||||||
|
|
||||||
# Install dependencies
|
# Install dependencies
|
||||||
.PHONY: deps
|
.PHONY: deps
|
||||||
|
|||||||
123
README.md
123
README.md
@@ -15,12 +15,14 @@ Feel free to join us on Discord: https://discord.gg/9nPq85bP4p
|
|||||||
## Supported devices
|
## Supported devices
|
||||||
|
|
||||||
<b>Supported ESP32 devices:</b>
|
<b>Supported ESP32 devices:</b>
|
||||||
- All ESP32 models with WIFI and BLE which are supported by Arduino Core 2.0.17 should work. Tested builds are provided for the ESP32, ESP32-S3 and ESP32-C3.
|
- Nuki Hub is compiled against all ESP32 models with Wi-Fi and Bluetooh Low Energy (BLE) which are supported by ESP-IDF 5.1.4 and Arduino Core 3.0.1.
|
||||||
- Untested builds are provided for the ESP32-Solo1.
|
- Tested stable builds are provided for the ESP32, ESP32-S3 and ESP32-C3.
|
||||||
|
- Support for the ESP32-C6 is ***HIGHLY*** experimental. Expect frequent crashes, especially when running Nuki Hub paired as an app (when not using in Hybrid mode). Pairing is also not supported yet and needs to be done manually on the /advanced page of the web configurator.
|
||||||
|
- The ESP32-Solo1 is not supported by ESP-IDF 5.1 and as such can't be build using Arduino Core 3 and ESP-IDF 5.1. Untested build against Arduino Core 2.0.14 and ESP-IDF 4.4 are provided.
|
||||||
|
|
||||||
<b>Not supported ESP32 devices:</b>
|
<b>Not supported ESP32 devices:</b>
|
||||||
- The ESP32-S2 has no BLE and as such can't run Nuki Hub.
|
- The ESP32-S2 has no BLE and as such can't run Nuki Hub.
|
||||||
- The ESP32-C6 and ESP32-H2 are not supported by Arduino Core 2.0.17 and as such Nuki Hub is not compiled against these targets (at this time).
|
- The ESP32-H2 has no Wi-FI and Nuki Hub is not compiled against this target because of this (at this time).
|
||||||
|
|
||||||
<b>Supported Nuki devices:</b>
|
<b>Supported Nuki devices:</b>
|
||||||
- Nuki Smart Lock 1.0
|
- Nuki Smart Lock 1.0
|
||||||
@@ -43,8 +45,14 @@ As an alternative to Wi-Fi (which is available on any supported ESP32), the foll
|
|||||||
- [LilyGO-T-ETH-POE](https://github.com/Xinyuan-LilyGO/LilyGO-T-ETH-POE)
|
- [LilyGO-T-ETH-POE](https://github.com/Xinyuan-LilyGO/LilyGO-T-ETH-POE)
|
||||||
- [GL-S10 (Revisions 2.1, 2.3 / 1.0 is not supported)](https://www.gl-inet.com/products/gl-s10/)
|
- [GL-S10 (Revisions 2.1, 2.3 / 1.0 is not supported)](https://www.gl-inet.com/products/gl-s10/)
|
||||||
|
|
||||||
<b>Note for users upgrading from Nuki Hub 8.21 or lower:</b><br>
|
## Support Nuki Hub development
|
||||||
Please go to "MQTT and Network Configuration" and select "Wi-Fi only" as the network device (unless you use other network hardware).
|
|
||||||
|
If you haven't ordered your Nuki product yet, you can support me by using my referrer code when placing your order:<br>
|
||||||
|
REF2P8WSFGJCN<br>
|
||||||
|
This will also give you a 10% discount on your order.<br>
|
||||||
|
<br>
|
||||||
|
This project is free to use for everyone. However if you feel like donating, you can buy me a coffee at ko-fi.com:<br>
|
||||||
|
[](https://ko-fi.com/C0C1IDUBV)
|
||||||
|
|
||||||
## First time installation
|
## First time installation
|
||||||
|
|
||||||
@@ -54,8 +62,6 @@ NOTE: Webflash is not available for the ESP32-Solo1<br>
|
|||||||
<br>
|
<br>
|
||||||
Alternatively download the latest release for your ESP32 model from https://github.com/technyon/nuki_hub/releases<br>
|
Alternatively download the latest release for your ESP32 model from https://github.com/technyon/nuki_hub/releases<br>
|
||||||
Unpack the zip archive and read the included how-to-flash.txt for installation instructions for either "Espressif Flash Download Tools" or "esptool".<br>
|
Unpack the zip archive and read the included how-to-flash.txt for installation instructions for either "Espressif Flash Download Tools" or "esptool".<br>
|
||||||
<br>
|
|
||||||
Updates can be installed using the Nuki Hub web configurator
|
|
||||||
|
|
||||||
## Initial setup (Network and MQTT)
|
## Initial setup (Network and MQTT)
|
||||||
|
|
||||||
@@ -65,7 +71,7 @@ Use the web interface to connect the ESP to your preferred Wi-Fi network.<br>
|
|||||||
<br>
|
<br>
|
||||||
After configuring Wi-Fi, the ESP should automatically connect to your network.<br>
|
After configuring Wi-Fi, the ESP should automatically connect to your network.<br>
|
||||||
<br>
|
<br>
|
||||||
To configure the connection to the MQTT broker first connect your client device to the same Wi-Fi network the ESP32 is connected to.<br>
|
To configure the connection to the MQTT broker, first connect your client device to the same Wi-Fi network the ESP32 is connected to.<br>
|
||||||
In a browser navigate to the IP address assigned to the ESP32 via DHCP (often found in the web interface of your internet router).<br><br>
|
In a browser navigate to the IP address assigned to the ESP32 via DHCP (often found in the web interface of your internet router).<br><br>
|
||||||
Next click on "Edit" below "MQTT and Network Configuration" and enter the address and port (usually 1883) of your MQTT broker and a username and a password if required by your MQTT broker.<br>
|
Next click on "Edit" below "MQTT and Network Configuration" and enter the address and port (usually 1883) of your MQTT broker and a username and a password if required by your MQTT broker.<br>
|
||||||
<br>
|
<br>
|
||||||
@@ -77,7 +83,7 @@ In that case leave all fields starting with "MQTT SSL" blank. Otherwise see the
|
|||||||
Enable pairing mode on the Nuki Lock or Opener (press the button on the Nuki device for a few seconds) and power on the ESP32.<br>
|
Enable pairing mode on the Nuki Lock or Opener (press the button on the Nuki device for a few seconds) and power on the ESP32.<br>
|
||||||
Pairing should be automatic.<br>
|
Pairing should be automatic.<br>
|
||||||
<br>
|
<br>
|
||||||
When pairing is successful, the web interface should show "Paired: Yes" (it might be necessary to reload the page in your browser).<br>
|
When pairing is successful, the web interface should show "Paired: Yes".<br>
|
||||||
MQTT nodes like lock state and battery level should now reflect the reported values from the lock.<br>
|
MQTT nodes like lock state and battery level should now reflect the reported values from the lock.<br>
|
||||||
<br>
|
<br>
|
||||||
<b>Note: It is possible to run Nuki Hub alongside a Nuki Bridge.
|
<b>Note: It is possible to run Nuki Hub alongside a Nuki Bridge.
|
||||||
@@ -89,15 +95,6 @@ Enable "Register as app" before pairing to allow this. Otherwise the Bridge will
|
|||||||
Hybrid mode allows you to use the official Nuki MQTT implemenation on a Nuki Lock 3.0 Pro, Nuki Lock 4.0 or Nuki Lock 4.0 Pro in conjunction with Nuki Hub.<br>
|
Hybrid mode allows you to use the official Nuki MQTT implemenation on a Nuki Lock 3.0 Pro, Nuki Lock 4.0 or Nuki Lock 4.0 Pro in conjunction with Nuki Hub.<br>
|
||||||
See [hybrid mode](/HYBRID.md) for more information.
|
See [hybrid mode](/HYBRID.md) for more information.
|
||||||
|
|
||||||
## Support
|
|
||||||
|
|
||||||
If you haven't ordered your Nuki product yet, you can support me by using my referrer code when placing your order:<br>
|
|
||||||
REF2P8WSFGJCN<br>
|
|
||||||
This will also give you a 10% discount on your order.<br>
|
|
||||||
<br>
|
|
||||||
This project is free to use for everyone. However if you feel like donating, you can buy me a coffee at ko-fi.com:<br>
|
|
||||||
[](https://ko-fi.com/C0C1IDUBV)
|
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
In a browser navigate to the IP address assigned to the ESP32.
|
In a browser navigate to the IP address assigned to the ESP32.
|
||||||
@@ -124,13 +121,14 @@ In a browser navigate to the IP address assigned to the ESP32.
|
|||||||
- Disable fallback to Wi-Fi / Wi-Fi config portal: By default the Nuki Hub will fallback to Wi-Fi and open the Wi-Fi configuration portal when the network connection fails. Enable this setting to disable this fallback.
|
- Disable fallback to Wi-Fi / Wi-Fi config portal: By default the Nuki Hub will fallback to Wi-Fi and open the Wi-Fi configuration portal when the network connection fails. Enable this setting to disable this fallback.
|
||||||
- Connect to AP with the best signal in an environment with multiple APs with the same SSID: Enable to perform a scan for the Access Point with the best signal strenght for the specified SSID in a multi AP/Mesh environment.
|
- Connect to AP with the best signal in an environment with multiple APs with the same SSID: Enable to perform a scan for the Access Point with the best signal strenght for the specified SSID in a multi AP/Mesh environment.
|
||||||
- RSSI Publish interval: Set to a positive integer to set the amount of seconds between updates to the maintenance/wifiRssi MQTT topic with the current Wi-Fi RSSI, set to -1 to disable, default 60.
|
- RSSI Publish interval: Set to a positive integer to set the amount of seconds between updates to the maintenance/wifiRssi MQTT topic with the current Wi-Fi RSSI, set to -1 to disable, default 60.
|
||||||
- Network Timeout until restart: Set to a positive integer to restart the Nuki Hub after the set amount of seconds has passed without an active connection to the MQTT broker, set to -1 to disable, default 60.
|
- MQTT Timeout until restart: Set to a positive integer to restart the Nuki Hub after the set amount of seconds has passed without an active connection to the MQTT broker, set to -1 to disable, default 60.
|
||||||
- Restart on disconnect: Enable to restart the Nuki Hub after 60 seconds without a connection to a network.
|
- Restart on disconnect: Enable to restart the Nuki Hub when disconnected from the network.
|
||||||
- Enable MQTT logging: Enable to fill the maintenance/log MQTT topic with debug log information.
|
- Enable MQTT logging: Enable to fill the maintenance/log MQTT topic with debug log information.
|
||||||
- Check for Firmware Updates every 24h: Enable to allow the Nuki Hub to check the latest release of the Nuki Hub firmware on boot and every 24 hours. Requires the Nuki Hub to be able to connect to github.com. The latest version will be published to MQTT and will be visible on the main page of the Web Configurator.
|
- Check for Firmware Updates every 24h: Enable to allow the Nuki Hub to check the latest release of the Nuki Hub firmware on boot and every 24 hours. Requires the Nuki Hub to be able to connect to github.com. The latest version will be published to MQTT and will be visible on the main page of the Web Configurator.
|
||||||
|
- Allow updating using MQTT: Enable to allow starting the Nuki Hub update process using MQTT. Will also enable the Home Assistant update functionality if auto discovery is enabled.
|
||||||
- Disable some extraneous non-JSON topics: Enable to not publish non-JSON keypad and config MQTT topics.
|
- Disable some extraneous non-JSON topics: Enable to not publish non-JSON keypad and config MQTT topics.
|
||||||
- Enable hybrid official MQTT and Nuki Hub setup: Enable to combine the official MQTT over Thread/WiFi with BLE. Improves speed of state changes. Needs the official MQTT to be setup first. Also requires Nuki Hub to be paired as app and unregistered as a bridge using the Nuki app. See [hybrid mode](/HYBRID.md)
|
- Enable hybrid official MQTT and Nuki Hub setup: Enable to combine the official MQTT over Thread/Wi-Fi with BLE. Improves speed of state changes. Needs the official MQTT to be setup first. Also requires Nuki Hub to be paired as app and unregistered as a bridge using the Nuki app. See [hybrid mode](/HYBRID.md)
|
||||||
- Enable sending actions through official MQTT: Enable to sent lock actions through the official MQTT topics (e.g. over Thread/WiFi) instead of using BLE. Needs "Enable hybrid official MQTT and Nuki Hub setup" to be enabled. See [hybrid mode](/HYBRID.md)
|
- Enable sending actions through official MQTT: Enable to sent lock actions through the official MQTT topics (e.g. over Thread/Wi-Fi) instead of using BLE. Needs "Enable hybrid official MQTT and Nuki Hub setup" to be enabled. See [hybrid mode](/HYBRID.md)
|
||||||
- Time between status updates when official MQTT is offline (seconds): Set to a positive integer to set the maximum amount of seconds between actively querying the Nuki lock for the current lock state when the official MQTT is offline, default 600.
|
- Time between status updates when official MQTT is offline (seconds): Set to a positive integer to set the maximum amount of seconds between actively querying the Nuki lock for the current lock state when the official MQTT is offline, default 600.
|
||||||
|
|
||||||
#### IP Address assignment
|
#### IP Address assignment
|
||||||
@@ -158,9 +156,9 @@ In a browser navigate to the IP address assigned to the ESP32.
|
|||||||
- Query interval keypad (Only available when a Keypad is detected): Set to a positive integer to set the maximum amount of seconds between actively querying the Nuki device for the current keypad state, default 1800.
|
- Query interval keypad (Only available when a Keypad is detected): Set to a positive integer to set the maximum amount of seconds between actively querying the Nuki device for the current keypad state, default 1800.
|
||||||
- Number of retries if command failed: Set to a positive integer to define the amount of times the Nuki Hub retries sending commands to the Nuki Lock or Opener when commands are not acknowledged by the device, default 3.
|
- Number of retries if command failed: Set to a positive integer to define the amount of times the Nuki Hub retries sending commands to the Nuki Lock or Opener when commands are not acknowledged by the device, default 3.
|
||||||
- Delay between retries: Set to the amount of milliseconds the Nuki Hub waits between resending not acknowledged commands, default 100.
|
- Delay between retries: Set to the amount of milliseconds the Nuki Hub waits between resending not acknowledged commands, default 100.
|
||||||
- Lock: Nuki Bridge is running alongside Nuki Hub: Enable to allow Nuki Hub to co-exist with a Nuki Bridge by registering Nuki Hub as an (smartphone) app instead of a bridge. Changing this setting will require re-pairing. Enabling this setting is strongly discouraged as described in the "[Pairing with a Nuki Lock or Opener](#pairing-with-a-nuki-lock-or-opener)" section of this README, ***unless when used in [Hybrid mode](/HYBRID.md)e (Official MQTT / Nuki Hub co-existance)***
|
- Lock: Nuki Bridge is running alongside Nuki Hub: Enable to allow Nuki Hub to co-exist with a Nuki Bridge by registering Nuki Hub as an (smartphone) app instead of a bridge. Changing this setting will require re-pairing. Enabling this setting is strongly discouraged as described in the "[Pairing with a Nuki Lock or Opener](#pairing-with-a-nuki-lock-or-opener)" section of this README, ***unless when used in [Hybrid mode](/HYBRID.md) (Official MQTT / Nuki Hub co-existance)***
|
||||||
- Opener: Nuki Bridge is running alongside Nuki Hub: Enable to allow Nuki Hub to co-exist with a Nuki Bridge by registering Nuki Hub as an (smartphone) app instead of a bridge. Changing this setting will require re-pairing. Enabling this setting is strongly discouraged as described in the "[Pairing with a Nuki Lock or Opener](#pairing-with-a-nuki-lock-or-opener)" section of this README
|
- Opener: Nuki Bridge is running alongside Nuki Hub: Enable to allow Nuki Hub to co-exist with a Nuki Bridge by registering Nuki Hub as an (smartphone) app instead of a bridge. Changing this setting will require re-pairing. Enabling this setting is strongly discouraged as described in the "[Pairing with a Nuki Lock or Opener](#pairing-with-a-nuki-lock-or-opener)" section of this README
|
||||||
- Presence detection timeout: Set to a positive integer to set the amount of seconds between updates to the presence/devices MQTT topic with the list of detected bluetooth devices, set to -1 to disable presence detection, default 60.
|
- Presence detection timeout: Set to a positive integer to set the amount of seconds between updates to the presence/devices MQTT topic with the list of detected bluetooth devices, set to -1 to disable presence detection, default -1.
|
||||||
- Restart if bluetooth beacons not received: Set to a positive integer to restart the Nuki Hub after the set amount of seconds has passed without receiving a bluetooth beacon from the Nuki device, set to -1 to disable, default 60. Because the bluetooth stack of the ESP32 can silently fail it is not recommended to disable this setting.
|
- Restart if bluetooth beacons not received: Set to a positive integer to restart the Nuki Hub after the set amount of seconds has passed without receiving a bluetooth beacon from the Nuki device, set to -1 to disable, default 60. Because the bluetooth stack of the ESP32 can silently fail it is not recommended to disable this setting.
|
||||||
|
|
||||||
### Access Level Configuration
|
### Access Level Configuration
|
||||||
@@ -198,7 +196,7 @@ In a browser navigate to the IP address assigned to the ESP32.
|
|||||||
|
|
||||||
#### Factory reset Nuki Hub
|
#### Factory reset Nuki Hub
|
||||||
|
|
||||||
- Type [4 DIGIT CODE] to confirm factory reset: Set to the shown randomly generated code to reset all Nuki Hub settings to default and unpair Nuki Lock and/or Opener. Optionally also reset WiFi settings to default by enabling the checkbox.
|
- Type [4 DIGIT CODE] to confirm factory reset: Set to the shown randomly generated code to reset all Nuki Hub settings to default and unpair Nuki Lock and/or Opener. Optionally also reset Wi-Fi settings to default (and reopen the Wi-Fi configurator) by enabling the checkbox.
|
||||||
|
|
||||||
### GPIO Configuration
|
### GPIO Configuration
|
||||||
|
|
||||||
@@ -303,8 +301,9 @@ In a browser navigate to the IP address assigned to the ESP32.
|
|||||||
|
|
||||||
### Maintanence
|
### Maintanence
|
||||||
|
|
||||||
- maintenance/networkDevice: Set to the name of the network device that is used by the ESP. When using Wi-Fi will be set to "Built-in Wi-Fi". If using Ethernet will be set to "Wiznet W5500", "Olimex (LAN8720)", "WT32-ETH01", "M5STACK PoESP32 Unit" or "LilyGO T-ETH-POE".
|
- maintenance/networkDevice: Set to the name of the network device that is used by the ESP. When using Wi-Fi will be set to "Built-in Wi-Fi". If using Ethernet will be set to "Wiznet W5500", "Olimex (LAN8720)", "WT32-ETH01", "M5STACK PoESP32 Unit", "LilyGO T-ETH-POE" or "GL-S10".
|
||||||
- maintenance/reset: Set to 1 to trigger a reboot of the ESP. Auto-resets to 0.
|
- maintenance/reset: Set to 1 to trigger a reboot of the ESP. Auto-resets to 0.
|
||||||
|
- maintenance/update: Set to 1 to auto update Nuki Hub to the latest version from GitHub. Requires the setting "Allow updating using MQTT" to be enabled. Auto-resets to 0.
|
||||||
- maintenance/mqttConnectionState: Last Will and Testament (LWT) topic. "online" when Nuki Hub is connected to the MQTT broker, "offline" if Nuki Hub is not connected to the MQTT broker.
|
- maintenance/mqttConnectionState: Last Will and Testament (LWT) topic. "online" when Nuki Hub is connected to the MQTT broker, "offline" if Nuki Hub is not connected to the MQTT broker.
|
||||||
- maintenance/uptime: Uptime in minutes.
|
- maintenance/uptime: Uptime in minutes.
|
||||||
- maintenance/wifiRssi: The Wi-Fi signal strength of the Wi-Fi Access Point as measured by the ESP32 and expressed by the RSSI Value in dBm.
|
- maintenance/wifiRssi: The Wi-Fi signal strength of the Wi-Fi Access Point as measured by the ESP32 and expressed by the RSSI Value in dBm.
|
||||||
@@ -315,7 +314,7 @@ In a browser navigate to the IP address assigned to the ESP32.
|
|||||||
|
|
||||||
### Misc
|
### Misc
|
||||||
|
|
||||||
- presence/devices: List of detected bluetooth devices as CSV. Can be used for presence detection.
|
- presence/devices: List of detected bluetooth devices as CSV, which be used for presence detection (by a third party application, Nuki Hub has no mechanism in place to act on the presence of absence of device). Because Nuki Hub uses passive scanning (which has no impact on battery life of nearby devices) only device MAC addresses and RSSI values are available and not device names or other information about the devices.
|
||||||
|
|
||||||
## Changing Nuki Lock/Opener Configuration
|
## Changing Nuki Lock/Opener Configuration
|
||||||
|
|
||||||
@@ -423,12 +422,27 @@ Example:
|
|||||||
|
|
||||||
If Home Assistant discovery is enabled (see the [Home Assistant Discovery](#home-assistant-discovery-optional) section of this README) Nuki Hub will create entities for almost all of the above settings.
|
If Home Assistant discovery is enabled (see the [Home Assistant Discovery](#home-assistant-discovery-optional) section of this README) Nuki Hub will create entities for almost all of the above settings.
|
||||||
|
|
||||||
## Over-the-air Update (OTA)
|
## Upgrading using Over-the-air Update (OTA)
|
||||||
|
|
||||||
After the initial installation of the Nuki Hub firmware via serial connection, further updates can be deployed via OTA update from a browser.<br>
|
After the initial installation of the Nuki Hub firmware via serial connection, further updates can be deployed via OTA update from a browser.<br>
|
||||||
In the configuration portal, scroll down to "Firmware update" and click "Open".<br>
|
In the configuration portal, select "Firmware update" from the main page.<br>
|
||||||
Then Click "Browse" and select the new "nuki_hub.bin" file and select "Upload file".<br>
|
<br>
|
||||||
After about a minute the new firmware should be installed afterwhich the ESP will reboot automatically.
|
The easiest way to upgrade Nuki Hub, if Nuki Hub is connected to the internet, is to select "Auto Update".<br>
|
||||||
|
This will download the latest Nuki Hub and Nuki Hub updater and automatically upgrade both applications.<br>
|
||||||
|
Nuki Hub will reboot 3 times during this process, which will take about 5 minutes.<br>
|
||||||
|
If you have enabled "Allow updating using MQTT" you can also use the Home Assistant updater or write "1" to the `nukihub/maintanance/reset` topic to start the update process.<br>
|
||||||
|
<br>
|
||||||
|
Alternatively you can select a binary file from your file system to update Nuki Hub or the Nuki Hub updator manually<br>
|
||||||
|
You can only update Nuki Hub from the Nuki Hub updater and update the updater only from Nuki Hub<br>
|
||||||
|
You can reboot from Nuki Hub to the updater and vice versa by selecting the reboot option from the "Firware update" page<br>
|
||||||
|
When you are on the right application you can upload the new binary by clicking on "Browse" and select the new "nuki_hub\[board\].bin" or "nuki_hub_updater\[board\].bin" file and select "Upload file".<br>
|
||||||
|
After about a minute the new firmware should be installed afterwhich the ESP will reboot automatically to the updated binary.<br>
|
||||||
|
Selecting the wrong binary will lead to an unsuccessfull update<br>
|
||||||
|
<br>
|
||||||
|
<b> Note for users upgrading from Nuki Hub 8.35 or lower:</b><br>
|
||||||
|
Updating to version 8.36 requires a change to the partition table of the ESP32.<br>
|
||||||
|
Please follow the instructions for the [First time installation](#first-time-installation) once when updating to Nuki Hub 8.36 from an earlier version.<br>
|
||||||
|
Your settings will not be affected when updating using the above instructions (do not select erase device when updating using Webflash).<br>
|
||||||
|
|
||||||
## MQTT Encryption (optional; Wi-Fi and LAN8720 only)
|
## MQTT Encryption (optional; Wi-Fi and LAN8720 only)
|
||||||
|
|
||||||
@@ -594,8 +608,6 @@ To enable GPIO control, go the the "GPIO Configuration" page where each GPIO can
|
|||||||
- General input (pull-up): The pin is configured in pull-up configuration and its state is published to the "gpio/pin_x/state" topic
|
- General input (pull-up): The pin is configured in pull-up configuration and its state is published to the "gpio/pin_x/state" topic
|
||||||
- Genral output: The pin is set to high or low depending on the "gpio/pin_x/state" topic
|
- Genral output: The pin is set to high or low depending on the "gpio/pin_x/state" topic
|
||||||
|
|
||||||
Note: The old setting "Enable control via GPIO" is removed. If you had enabled this setting before upgrading to 8.22, the PINs are automatically configured to be compatible with the previously hard-coded PINs.
|
|
||||||
|
|
||||||
## Connecting via Ethernet (Optional)
|
## Connecting via Ethernet (Optional)
|
||||||
|
|
||||||
If you prefer to connect to the MQTT Broker via Ethernet instead of Wi-Fi, you either use one of the supported ESP32 modules (see about section above),
|
If you prefer to connect to the MQTT Broker via Ethernet instead of Wi-Fi, you either use one of the supported ESP32 modules (see about section above),
|
||||||
@@ -617,6 +629,7 @@ If the W5500 hwardware isn't detected, Wi-Fi is used as a fallback.<br>
|
|||||||
<br>
|
<br>
|
||||||
Note: Encrypted MQTT is only available for Wi-Fi and LAN8720 modules, W5x00 modules don't support encryption<br>
|
Note: Encrypted MQTT is only available for Wi-Fi and LAN8720 modules, W5x00 modules don't support encryption<br>
|
||||||
(that leaves Olimex, WT32-ETH01 and M5Stack PoESP32 Unit if encryption is desired).<br>
|
(that leaves Olimex, WT32-ETH01 and M5Stack PoESP32 Unit if encryption is desired).<br>
|
||||||
|
Note: LAN8720 modules are only supported on the ESP32, not on the ESP32-S3, ESP32-C3 or ESP-C6<br>
|
||||||
<br>
|
<br>
|
||||||
If encryption is needed, Olimex is the easiest option, since it has USB for flashing onboard.
|
If encryption is needed, Olimex is the easiest option, since it has USB for flashing onboard.
|
||||||
|
|
||||||
@@ -636,22 +649,13 @@ It will restart the ESP after a configured amount of time.
|
|||||||
First, make sure the firmware version of the Nuki device is up-to-date, older versions have issues pairing.<br>
|
First, make sure the firmware version of the Nuki device is up-to-date, older versions have issues pairing.<br>
|
||||||
Next, try erasing the ESP32 flash and then (re-)flash the firmware.<br>
|
Next, try erasing the ESP32 flash and then (re-)flash the firmware.<br>
|
||||||
To erase the flash, use the espressif download tool and click the "Erase" button.<br>
|
To erase the flash, use the espressif download tool and click the "Erase" button.<br>
|
||||||
Afterwards flash the firmware as described in the readme within the 7z file.<br>
|
Afterwards flash the firmware as described in the "how-to-flash.txt" file or using Webflash.<br>
|
||||||
<br>
|
<br>
|
||||||
|
|
||||||
Also, there are reports that the ESP32 "DEVKIT1" module doesn't work and pairing is not possible. The reason is unknown, but if you use such a module, try a different one.<br>
|
Also, check that pairing is allowed. In the Nuki smartphone app, go to "Settings" --> "Features & Configuration" --> "Button & LED" and make sure "Bluetooh Pairing" is enabled.<br>
|
||||||
<br>
|
Next press the button for several seconds untill the LED light remains lit.
|
||||||
Reported as working are:
|
|
||||||
- [M5Stack ATOM Lite](https://shop.m5stack.com/products/atom-lite-esp32-development-kit)
|
|
||||||
- ESP32-WROOM-32D (DEVKIT V4)
|
|
||||||
- ESP32-WROOM-32E
|
|
||||||
- ESP32-S3-WROOM-1
|
|
||||||
|
|
||||||
For more information check the related issue: https://github.com/technyon/nuki_hub/issues/39
|
A note about the [M5Stack PoESP32 Unit](https://docs.m5stack.com/en/unit/poesp32). Here the initial Bluetooth reception is very poor (range less than one meter). The reason is that the module does not have an antenna on the PCB, but only an IPEX connector. By retrofitting an external SMA antenna (IPEX, or other names U.FL, IPAX, IPX, AMC, MHF, UMCC), Bluetooth/Wi-Fi works over several meters.
|
||||||
|
|
||||||
Also, check that pairing is allowed. In the Nuki smartphone app, go to "Settings" --> "Features & Configuration" --> "Button & LED" and make sure "Bluetooh Pairing" is enabled.
|
|
||||||
|
|
||||||
A note about the [M5Stack PoESP32 Unit](https://docs.m5stack.com/en/unit/poesp32). Here the initial Bluetooth reception is very poor (range less than one meter). The reason is that the module does not have an antenna on the PCB, but only an IPEX connector. By retrofitting an external SMA antenna (IPEX, or other names U.FL, IPAX, IPX, AMC, MHF, UMCC), bluetooth/Wifi works over several meters.
|
|
||||||
|
|
||||||
### In Home Assistant, the lock/opener is shown as unavailable
|
### In Home Assistant, the lock/opener is shown as unavailable
|
||||||
|
|
||||||
@@ -661,17 +665,19 @@ This unfortunately means that older versions of Home Assistant are not supported
|
|||||||
|
|
||||||
## FAQ
|
## FAQ
|
||||||
|
|
||||||
### Nuki Hub doesn't work when Wi-Fi on a Nuki Smartlock Pro (3.0 / 4.0) is turned on.
|
### Nuki Hub in bridge mode doesn't work when Wi-Fi on a Nuki Smartlock Pro (3.0 / 4.0) is turned on.
|
||||||
|
|
||||||
According to Nuki this is by design and part of the specification of the Pro lock.<br>
|
According to Nuki this is by design and part of the specification of the Pro lock.<br>
|
||||||
You can use either the built-in Wi-Fi or a Bridge (which Nuki Hub registers as).<br>
|
You can use either the built-in Wi-Fi or a Bridge (which Nuki Hub registers as).<br>
|
||||||
|
Or use Nuki Hub in Hybrid mode using Wi-Fi or Thread, see [hybrid mode](/HYBRID.md)<br>
|
||||||
Using both at the same time is not supported.
|
Using both at the same time is not supported.
|
||||||
|
|
||||||
### Certain functionality doesn't work (e. g. changing configuration, setting keypad codes)
|
### Certain functionality doesn't work (e. g. changing configuration, setting keypad codes)
|
||||||
|
|
||||||
Some functionality is restricted by the Lock (or Opener) firmware and is only accessible when the PIN is provided.<br>
|
Some functionality is restricted by the Lock (or Opener) firmware and is only accessible when the PIN is provided.<br>
|
||||||
When setting up the lock (or opener), you have to set a PIN in the Nuki smartphone app.<br>
|
When setting up the lock (or opener), you have to set a PIN in the Nuki smartphone app.<br>
|
||||||
Navigate to the Nuki Hub Credentials page, enter this PIN and click save.
|
Navigate to the Nuki Hub Credentials page, enter this PIN and click save.<br>
|
||||||
|
Check the main page of the configurator to see if the entered PIN is valid
|
||||||
|
|
||||||
### Authorization data isn't published
|
### Authorization data isn't published
|
||||||
|
|
||||||
@@ -717,28 +723,9 @@ cd nuki_hub
|
|||||||
make deps
|
make deps
|
||||||
|
|
||||||
# build all binary boards
|
# build all binary boards
|
||||||
|
make updater
|
||||||
make release
|
make release
|
||||||
```
|
```
|
||||||
<br>
|
|
||||||
<b>VMWare image (Not preferred, not using the latest Arduino ESP32 release at this time)</b><br>
|
|
||||||
A virtual machine (VMWare image) that is setup to compile Nuki Hub is available for download at:<br>
|
|
||||||
https://drive.google.com/file/d/1fUVYHDtxXAZOAfQ321iRNIwkqFwuDsBp/view?usp=share_link<br>
|
|
||||||
<br>
|
|
||||||
User and password for the VM are both "nuki" and "nuki".<br>
|
|
||||||
The source is checked out at ~/projects/nuki_hub, the cmake build directory is build.<br>
|
|
||||||
<br>
|
|
||||||
To compile, run the following commands:
|
|
||||||
```
|
|
||||||
cd projects/nuki_hub/build
|
|
||||||
ninja
|
|
||||||
```
|
|
||||||
|
|
||||||
To upload the image via serial port, run:
|
|
||||||
```
|
|
||||||
ninja upload-nuki_hub
|
|
||||||
```
|
|
||||||
|
|
||||||
The serial device is defined in ~/.bashrc (Environment variable SERIAL_PORT), which you'll eventually have to adopt to your device.
|
|
||||||
|
|
||||||
## Disclaimer
|
## Disclaimer
|
||||||
|
|
||||||
|
|||||||
31
lib/AsyncTCP-esphome/.github/stale.yml
vendored
31
lib/AsyncTCP-esphome/.github/stale.yml
vendored
@@ -1,31 +0,0 @@
|
|||||||
# Configuration for probot-stale - https://github.com/probot/stale
|
|
||||||
|
|
||||||
daysUntilStale: 60
|
|
||||||
daysUntilClose: 14
|
|
||||||
limitPerRun: 30
|
|
||||||
staleLabel: stale
|
|
||||||
exemptLabels:
|
|
||||||
- pinned
|
|
||||||
- security
|
|
||||||
- "to be implemented"
|
|
||||||
- "for reference"
|
|
||||||
- "move to PR"
|
|
||||||
- "enhancement"
|
|
||||||
|
|
||||||
only: issues
|
|
||||||
onlyLabels: []
|
|
||||||
exemptProjects: false
|
|
||||||
exemptMilestones: false
|
|
||||||
exemptAssignees: false
|
|
||||||
|
|
||||||
markComment: >
|
|
||||||
[STALE_SET] This issue has been automatically marked as stale because it has not had
|
|
||||||
recent activity. It will be closed in 14 days if no further activity occurs. Thank you
|
|
||||||
for your contributions.
|
|
||||||
|
|
||||||
unmarkComment: >
|
|
||||||
[STALE_CLR] This issue has been removed from the stale queue. Please ensure activity to keep it openin the future.
|
|
||||||
|
|
||||||
closeComment: >
|
|
||||||
[STALE_DEL] This stale issue has been automatically closed. Thank you for your contributions.
|
|
||||||
|
|
||||||
29
lib/AsyncTCP-esphome/.github/workflows/push.yml
vendored
29
lib/AsyncTCP-esphome/.github/workflows/push.yml
vendored
@@ -1,29 +0,0 @@
|
|||||||
name: Async TCP CI
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
pull_request:
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
|
|
||||||
build-arduino:
|
|
||||||
name: Arduino on ${{ matrix.os }}
|
|
||||||
runs-on: ${{ matrix.os }}
|
|
||||||
strategy:
|
|
||||||
matrix:
|
|
||||||
os: [ubuntu-latest]
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v3
|
|
||||||
- uses: arduino/setup-arduino-cli@v1
|
|
||||||
- name: Download board
|
|
||||||
run: |
|
|
||||||
arduino-cli --config-file arduino-cli.yaml core update-index
|
|
||||||
arduino-cli --config-file arduino-cli.yaml board listall
|
|
||||||
arduino-cli --config-file arduino-cli.yaml core install esp32:esp32@2.0.2
|
|
||||||
- name: Compile Sketch
|
|
||||||
run: arduino-cli --config-file arduino-cli.yaml --library ./src/ compile --fqbn esp32:esp32:esp32 ./examples/ClientServer/Client/Client.ino
|
|
||||||
- name: Compile Sketch with IPv6
|
|
||||||
env:
|
|
||||||
LWIP_IPV6: true
|
|
||||||
run: arduino-cli --config-file arduino-cli.yaml --library ./src/ compile --fqbn esp32:esp32:esp32 ./examples/ClientServer/Client/Client.ino
|
|
||||||
2
lib/AsyncTCP-esphome/.gitignore
vendored
2
lib/AsyncTCP-esphome/.gitignore
vendored
@@ -1,2 +0,0 @@
|
|||||||
|
|
||||||
.DS_Store
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
{"type": "library", "name": "AsyncTCP-esphome", "version": "2.1.3", "spec": {"owner": "esphome", "id": 12172, "name": "AsyncTCP-esphome", "requirements": null, "uri": null}}
|
|
||||||
@@ -1,34 +0,0 @@
|
|||||||
sudo: false
|
|
||||||
language: python
|
|
||||||
os:
|
|
||||||
- linux
|
|
||||||
|
|
||||||
git:
|
|
||||||
depth: false
|
|
||||||
|
|
||||||
stages:
|
|
||||||
- build
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
include:
|
|
||||||
|
|
||||||
- name: "Arduino Build"
|
|
||||||
if: tag IS blank AND (type = pull_request OR (type = push AND branch = master))
|
|
||||||
stage: build
|
|
||||||
script: bash $TRAVIS_BUILD_DIR/.github/scripts/on-push.sh
|
|
||||||
|
|
||||||
- name: "PlatformIO Build"
|
|
||||||
if: tag IS blank AND (type = pull_request OR (type = push AND branch = master))
|
|
||||||
stage: build
|
|
||||||
script: bash $TRAVIS_BUILD_DIR/.github/scripts/on-push.sh 1 1
|
|
||||||
|
|
||||||
notifications:
|
|
||||||
email:
|
|
||||||
on_success: change
|
|
||||||
on_failure: change
|
|
||||||
webhooks:
|
|
||||||
urls:
|
|
||||||
- https://webhooks.gitter.im/e/60e65d0c78ea0a920347
|
|
||||||
on_success: change # options: [always|never|change] default: always
|
|
||||||
on_failure: always # options: [always|never|change] default: always
|
|
||||||
on_start: false # default: false
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
set(COMPONENT_SRCDIRS
|
|
||||||
"src"
|
|
||||||
)
|
|
||||||
|
|
||||||
set(COMPONENT_ADD_INCLUDEDIRS
|
|
||||||
"src"
|
|
||||||
)
|
|
||||||
|
|
||||||
set(COMPONENT_REQUIRES
|
|
||||||
"arduino-esp32"
|
|
||||||
)
|
|
||||||
|
|
||||||
register_component()
|
|
||||||
|
|
||||||
target_compile_options(${COMPONENT_TARGET} PRIVATE -fno-rtti)
|
|
||||||
@@ -1,30 +0,0 @@
|
|||||||
menu "AsyncTCP Configuration"
|
|
||||||
|
|
||||||
choice ASYNC_TCP_RUNNING_CORE
|
|
||||||
bool "Core on which AsyncTCP's thread is running"
|
|
||||||
default ASYNC_TCP_RUN_CORE1
|
|
||||||
help
|
|
||||||
Select on which core AsyncTCP is running
|
|
||||||
|
|
||||||
config ASYNC_TCP_RUN_CORE0
|
|
||||||
bool "CORE 0"
|
|
||||||
config ASYNC_TCP_RUN_CORE1
|
|
||||||
bool "CORE 1"
|
|
||||||
config ASYNC_TCP_RUN_NO_AFFINITY
|
|
||||||
bool "BOTH"
|
|
||||||
|
|
||||||
endchoice
|
|
||||||
|
|
||||||
config ASYNC_TCP_RUNNING_CORE
|
|
||||||
int
|
|
||||||
default 0 if ASYNC_TCP_RUN_CORE0
|
|
||||||
default 1 if ASYNC_TCP_RUN_CORE1
|
|
||||||
default -1 if ASYNC_TCP_RUN_NO_AFFINITY
|
|
||||||
|
|
||||||
config ASYNC_TCP_USE_WDT
|
|
||||||
bool "Enable WDT for the AsyncTCP task"
|
|
||||||
default "y"
|
|
||||||
help
|
|
||||||
Enable WDT for the AsyncTCP task, so it will trigger if a handler is locking the thread.
|
|
||||||
|
|
||||||
endmenu
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
# AsyncTCP
|
|
||||||

|
|
||||||
A fork of the [AsyncTCP](https://github.com/me-no-dev/AsyncTCP) library by [@me-no-dev](https://github.com/me-no-dev) for [ESPHome](https://esphome.io).
|
|
||||||
|
|
||||||
### Async TCP Library for ESP32 Arduino
|
|
||||||
|
|
||||||
This is a fully asynchronous TCP library, aimed at enabling trouble-free, multi-connection network environment for Espressif's ESP32 MCUs.
|
|
||||||
|
|
||||||
This library is the base for [ESPAsyncWebServer](https://github.com/me-no-dev/ESPAsyncWebServer)
|
|
||||||
|
|
||||||
## AsyncClient and AsyncServer
|
|
||||||
The base classes on which everything else is built. They expose all possible scenarios, but are really raw and require more skills to use.
|
|
||||||
@@ -1,3 +0,0 @@
|
|||||||
COMPONENT_ADD_INCLUDEDIRS := src
|
|
||||||
COMPONENT_SRCDIRS := src
|
|
||||||
CXXFLAGS += -fno-rtti
|
|
||||||
@@ -1,23 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "AsyncTCP-esphome",
|
|
||||||
"description": "Asynchronous TCP Library for ESP32",
|
|
||||||
"keywords": "async,tcp",
|
|
||||||
"authors": {
|
|
||||||
"name": "Hristo Gochkov",
|
|
||||||
"maintainer": true
|
|
||||||
},
|
|
||||||
"repository": {
|
|
||||||
"type": "git",
|
|
||||||
"url": "https://github.com/esphome/AsyncTCP.git"
|
|
||||||
},
|
|
||||||
"version": "2.1.3",
|
|
||||||
"license": "LGPL-3.0",
|
|
||||||
"frameworks": "arduino",
|
|
||||||
"platforms": [
|
|
||||||
"espressif32",
|
|
||||||
"libretiny"
|
|
||||||
],
|
|
||||||
"build": {
|
|
||||||
"libCompatMode": 2
|
|
||||||
}
|
|
||||||
}
|
|
||||||
File diff suppressed because it is too large
Load Diff
@@ -1,247 +0,0 @@
|
|||||||
/*
|
|
||||||
Asynchronous TCP library for Espressif MCUs
|
|
||||||
|
|
||||||
Copyright (c) 2016 Hristo Gochkov. All rights reserved.
|
|
||||||
This file is part of the esp8266 core for Arduino environment.
|
|
||||||
|
|
||||||
This library is free software; you can redistribute it and/or
|
|
||||||
modify it under the terms of the GNU Lesser General Public
|
|
||||||
License as published by the Free Software Foundation; either
|
|
||||||
version 2.1 of the License, or (at your option) any later version.
|
|
||||||
|
|
||||||
This library is distributed in the hope that it will be useful,
|
|
||||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
||||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
||||||
Lesser General Public License for more details.
|
|
||||||
|
|
||||||
You should have received a copy of the GNU Lesser General Public
|
|
||||||
License along with this library; if not, write to the Free Software
|
|
||||||
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
|
|
||||||
*/
|
|
||||||
|
|
||||||
#ifndef ASYNCTCP_H_
|
|
||||||
#define ASYNCTCP_H_
|
|
||||||
|
|
||||||
#include "IPAddress.h"
|
|
||||||
#include "IPv6Address.h"
|
|
||||||
#include <functional>
|
|
||||||
#include "lwip/ip_addr.h"
|
|
||||||
#include "lwip/ip6_addr.h"
|
|
||||||
|
|
||||||
#ifndef LIBRETINY
|
|
||||||
#include "sdkconfig.h"
|
|
||||||
extern "C" {
|
|
||||||
#include "freertos/semphr.h"
|
|
||||||
#include "lwip/pbuf.h"
|
|
||||||
}
|
|
||||||
#else
|
|
||||||
extern "C" {
|
|
||||||
#include <semphr.h>
|
|
||||||
#include <lwip/pbuf.h>
|
|
||||||
}
|
|
||||||
#define CONFIG_ASYNC_TCP_RUNNING_CORE -1 //any available core
|
|
||||||
#define CONFIG_ASYNC_TCP_USE_WDT 0
|
|
||||||
#endif
|
|
||||||
|
|
||||||
//If core is not defined, then we are running in Arduino or PIO
|
|
||||||
#ifndef CONFIG_ASYNC_TCP_RUNNING_CORE
|
|
||||||
#define CONFIG_ASYNC_TCP_RUNNING_CORE -1 //any available core
|
|
||||||
#define CONFIG_ASYNC_TCP_USE_WDT 1 //if enabled, adds between 33us and 200us per event
|
|
||||||
#endif
|
|
||||||
|
|
||||||
#ifndef CONFIG_ASYNC_TCP_STACK_SIZE
|
|
||||||
#define CONFIG_ASYNC_TCP_STACK_SIZE 8192 * 2
|
|
||||||
#endif
|
|
||||||
|
|
||||||
class AsyncClient;
|
|
||||||
|
|
||||||
#define ASYNC_MAX_ACK_TIME 5000
|
|
||||||
#define ASYNC_WRITE_FLAG_COPY 0x01 //will allocate new buffer to hold the data while sending (else will hold reference to the data given)
|
|
||||||
#define ASYNC_WRITE_FLAG_MORE 0x02 //will not send PSH flag, meaning that there should be more data to be sent before the application should react.
|
|
||||||
|
|
||||||
typedef std::function<void(void*, AsyncClient*)> AcConnectHandler;
|
|
||||||
typedef std::function<void(void*, AsyncClient*, size_t len, uint32_t time)> AcAckHandler;
|
|
||||||
typedef std::function<void(void*, AsyncClient*, int8_t error)> AcErrorHandler;
|
|
||||||
typedef std::function<void(void*, AsyncClient*, void *data, size_t len)> AcDataHandler;
|
|
||||||
typedef std::function<void(void*, AsyncClient*, struct pbuf *pb)> AcPacketHandler;
|
|
||||||
typedef std::function<void(void*, AsyncClient*, uint32_t time)> AcTimeoutHandler;
|
|
||||||
|
|
||||||
struct tcp_pcb;
|
|
||||||
struct ip_addr;
|
|
||||||
|
|
||||||
class AsyncClient {
|
|
||||||
public:
|
|
||||||
AsyncClient(tcp_pcb* pcb = 0);
|
|
||||||
~AsyncClient();
|
|
||||||
|
|
||||||
AsyncClient & operator=(const AsyncClient &other);
|
|
||||||
AsyncClient & operator+=(const AsyncClient &other);
|
|
||||||
|
|
||||||
bool operator==(const AsyncClient &other);
|
|
||||||
|
|
||||||
bool operator!=(const AsyncClient &other) {
|
|
||||||
return !(*this == other);
|
|
||||||
}
|
|
||||||
bool connect(IPAddress ip, uint16_t port);
|
|
||||||
bool connect(IPv6Address ip, uint16_t port);
|
|
||||||
bool connect(const char *host, uint16_t port);
|
|
||||||
void close(bool now = false);
|
|
||||||
void stop();
|
|
||||||
int8_t abort();
|
|
||||||
bool free();
|
|
||||||
|
|
||||||
bool canSend();//ack is not pending
|
|
||||||
size_t space();//space available in the TCP window
|
|
||||||
size_t add(const char* data, size_t size, uint8_t apiflags=ASYNC_WRITE_FLAG_COPY);//add for sending
|
|
||||||
bool send();//send all data added with the method above
|
|
||||||
|
|
||||||
//write equals add()+send()
|
|
||||||
size_t write(const char* data);
|
|
||||||
size_t write(const char* data, size_t size, uint8_t apiflags=ASYNC_WRITE_FLAG_COPY); //only when canSend() == true
|
|
||||||
|
|
||||||
uint8_t state();
|
|
||||||
bool connecting();
|
|
||||||
bool connected();
|
|
||||||
bool disconnecting();
|
|
||||||
bool disconnected();
|
|
||||||
bool freeable();//disconnected or disconnecting
|
|
||||||
|
|
||||||
uint16_t getMss();
|
|
||||||
|
|
||||||
uint32_t getRxTimeout();
|
|
||||||
void setRxTimeout(uint32_t timeout);//no RX data timeout for the connection in seconds
|
|
||||||
|
|
||||||
uint32_t getAckTimeout();
|
|
||||||
void setAckTimeout(uint32_t timeout);//no ACK timeout for the last sent packet in milliseconds
|
|
||||||
|
|
||||||
void setNoDelay(bool nodelay);
|
|
||||||
bool getNoDelay();
|
|
||||||
|
|
||||||
uint32_t getRemoteAddress();
|
|
||||||
uint16_t getRemotePort();
|
|
||||||
uint32_t getLocalAddress();
|
|
||||||
uint16_t getLocalPort();
|
|
||||||
#if LWIP_IPV6
|
|
||||||
ip6_addr_t getRemoteAddress6();
|
|
||||||
ip6_addr_t getLocalAddress6();
|
|
||||||
IPv6Address remoteIP6();
|
|
||||||
IPv6Address localIP6();
|
|
||||||
#endif
|
|
||||||
|
|
||||||
//compatibility
|
|
||||||
IPAddress remoteIP();
|
|
||||||
uint16_t remotePort();
|
|
||||||
IPAddress localIP();
|
|
||||||
uint16_t localPort();
|
|
||||||
|
|
||||||
void onConnect(AcConnectHandler cb, void* arg = 0); //on successful connect
|
|
||||||
void onDisconnect(AcConnectHandler cb, void* arg = 0); //disconnected
|
|
||||||
void onAck(AcAckHandler cb, void* arg = 0); //ack received
|
|
||||||
void onError(AcErrorHandler cb, void* arg = 0); //unsuccessful connect or error
|
|
||||||
void onData(AcDataHandler cb, void* arg = 0); //data received (called if onPacket is not used)
|
|
||||||
void onPacket(AcPacketHandler cb, void* arg = 0); //data received
|
|
||||||
void onTimeout(AcTimeoutHandler cb, void* arg = 0); //ack timeout
|
|
||||||
void onPoll(AcConnectHandler cb, void* arg = 0); //every 125ms when connected
|
|
||||||
|
|
||||||
void ackPacket(struct pbuf * pb);//ack pbuf from onPacket
|
|
||||||
size_t ack(size_t len); //ack data that you have not acked using the method below
|
|
||||||
void ackLater(){ _ack_pcb = false; } //will not ack the current packet. Call from onData
|
|
||||||
|
|
||||||
const char * errorToString(int8_t error);
|
|
||||||
const char * stateToString();
|
|
||||||
|
|
||||||
//Do not use any of the functions below!
|
|
||||||
static int8_t _s_poll(void *arg, struct tcp_pcb *tpcb);
|
|
||||||
static int8_t _s_recv(void *arg, struct tcp_pcb *tpcb, struct pbuf *pb, int8_t err);
|
|
||||||
static int8_t _s_fin(void *arg, struct tcp_pcb *tpcb, int8_t err);
|
|
||||||
static int8_t _s_lwip_fin(void *arg, struct tcp_pcb *tpcb, int8_t err);
|
|
||||||
static void _s_error(void *arg, int8_t err);
|
|
||||||
static int8_t _s_sent(void *arg, struct tcp_pcb *tpcb, uint16_t len);
|
|
||||||
static int8_t _s_connected(void* arg, void* tpcb, int8_t err);
|
|
||||||
static void _s_dns_found(const char *name, struct ip_addr *ipaddr, void *arg);
|
|
||||||
|
|
||||||
int8_t _recv(tcp_pcb* pcb, pbuf* pb, int8_t err);
|
|
||||||
tcp_pcb * pcb(){ return _pcb; }
|
|
||||||
|
|
||||||
protected:
|
|
||||||
bool _connect(ip_addr_t addr, uint16_t port);
|
|
||||||
|
|
||||||
tcp_pcb* _pcb;
|
|
||||||
int8_t _closed_slot;
|
|
||||||
|
|
||||||
AcConnectHandler _connect_cb;
|
|
||||||
void* _connect_cb_arg;
|
|
||||||
AcConnectHandler _discard_cb;
|
|
||||||
void* _discard_cb_arg;
|
|
||||||
AcAckHandler _sent_cb;
|
|
||||||
void* _sent_cb_arg;
|
|
||||||
AcErrorHandler _error_cb;
|
|
||||||
void* _error_cb_arg;
|
|
||||||
AcDataHandler _recv_cb;
|
|
||||||
void* _recv_cb_arg;
|
|
||||||
AcPacketHandler _pb_cb;
|
|
||||||
void* _pb_cb_arg;
|
|
||||||
AcTimeoutHandler _timeout_cb;
|
|
||||||
void* _timeout_cb_arg;
|
|
||||||
AcConnectHandler _poll_cb;
|
|
||||||
void* _poll_cb_arg;
|
|
||||||
|
|
||||||
bool _ack_pcb;
|
|
||||||
uint32_t _tx_last_packet;
|
|
||||||
uint32_t _rx_ack_len;
|
|
||||||
uint32_t _rx_last_packet;
|
|
||||||
uint32_t _rx_timeout;
|
|
||||||
uint32_t _rx_last_ack;
|
|
||||||
uint32_t _ack_timeout;
|
|
||||||
uint16_t _connect_port;
|
|
||||||
|
|
||||||
int8_t _close();
|
|
||||||
void _free_closed_slot();
|
|
||||||
void _allocate_closed_slot();
|
|
||||||
int8_t _connected(void* pcb, int8_t err);
|
|
||||||
void _error(int8_t err);
|
|
||||||
int8_t _poll(tcp_pcb* pcb);
|
|
||||||
int8_t _sent(tcp_pcb* pcb, uint16_t len);
|
|
||||||
int8_t _fin(tcp_pcb* pcb, int8_t err);
|
|
||||||
int8_t _lwip_fin(tcp_pcb* pcb, int8_t err);
|
|
||||||
void _dns_found(struct ip_addr *ipaddr);
|
|
||||||
|
|
||||||
public:
|
|
||||||
AsyncClient* prev;
|
|
||||||
AsyncClient* next;
|
|
||||||
};
|
|
||||||
|
|
||||||
class AsyncServer {
|
|
||||||
public:
|
|
||||||
AsyncServer(IPAddress addr, uint16_t port);
|
|
||||||
AsyncServer(IPv6Address addr, uint16_t port);
|
|
||||||
AsyncServer(uint16_t port);
|
|
||||||
~AsyncServer();
|
|
||||||
void onClient(AcConnectHandler cb, void* arg);
|
|
||||||
void begin();
|
|
||||||
void end();
|
|
||||||
void setNoDelay(bool nodelay);
|
|
||||||
bool getNoDelay();
|
|
||||||
uint8_t status();
|
|
||||||
|
|
||||||
//Do not use any of the functions below!
|
|
||||||
static int8_t _s_accept(void *arg, tcp_pcb* newpcb, int8_t err);
|
|
||||||
static int8_t _s_accepted(void *arg, AsyncClient* client);
|
|
||||||
|
|
||||||
protected:
|
|
||||||
uint16_t _port;
|
|
||||||
bool _bind4 = false;
|
|
||||||
bool _bind6 = false;
|
|
||||||
IPAddress _addr;
|
|
||||||
IPv6Address _addr6;
|
|
||||||
bool _noDelay;
|
|
||||||
tcp_pcb* _pcb;
|
|
||||||
AcConnectHandler _connect_cb;
|
|
||||||
void* _connect_cb_arg;
|
|
||||||
|
|
||||||
int8_t _accept(tcp_pcb* newpcb, int8_t err);
|
|
||||||
int8_t _accepted(AsyncClient* client);
|
|
||||||
};
|
|
||||||
|
|
||||||
|
|
||||||
#endif /* ASYNCTCP_H_ */
|
|
||||||
35
lib/AsyncTCP/.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
35
lib/AsyncTCP/.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
@@ -0,0 +1,35 @@
|
|||||||
|
---
|
||||||
|
name: Bug report
|
||||||
|
about: Create a report to help us improve
|
||||||
|
title: "[BUG]"
|
||||||
|
labels: bug
|
||||||
|
assignees: ''
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Please make sure to go through the recommendations before opening a bug report:**
|
||||||
|
|
||||||
|
[https://github.com/mathieucarbou/AsyncTCP?tab=readme-ov-file#important-recommendations](https://github.com/mathieucarbou/AsyncTCP?tab=readme-ov-file#important-recommendations)
|
||||||
|
|
||||||
|
**Description**
|
||||||
|
|
||||||
|
A clear and concise description of what the bug is.
|
||||||
|
|
||||||
|
**Board**
|
||||||
|
|
||||||
|
esp32dev, esp32s3, etc
|
||||||
|
|
||||||
|
**Ethernet adapter used ?**
|
||||||
|
|
||||||
|
If yes, please specify which one
|
||||||
|
|
||||||
|
**Stack trace**
|
||||||
|
|
||||||
|
Please provide the stack trace here taken with `monitor_filters = esp32_exception_decoder`.
|
||||||
|
**Any issue opened with a non readable stack trace will be ignored because not helpful at all.**
|
||||||
|
|
||||||
|
As an alternative, you can use [https://maximeborges.github.io/esp-stacktrace-decoder/](https://maximeborges.github.io/esp-stacktrace-decoder/).
|
||||||
|
|
||||||
|
**Additional notes**
|
||||||
|
|
||||||
|
Add any other context about the problem here.
|
||||||
10
lib/AsyncTCP/.github/ISSUE_TEMPLATE/question.md
vendored
Normal file
10
lib/AsyncTCP/.github/ISSUE_TEMPLATE/question.md
vendored
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
---
|
||||||
|
name: Question
|
||||||
|
about: Describe your question
|
||||||
|
title: "[Q]"
|
||||||
|
labels: question
|
||||||
|
assignees: ''
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
|
||||||
@@ -1,36 +0,0 @@
|
|||||||
#!/bin/bash
|
|
||||||
|
|
||||||
export ARDUINO_ESP32_PATH="$ARDUINO_USR_PATH/hardware/espressif/esp32"
|
|
||||||
if [ ! -d "$ARDUINO_ESP32_PATH" ]; then
|
|
||||||
echo "Installing ESP32 Arduino Core ..."
|
|
||||||
script_init_path="$PWD"
|
|
||||||
mkdir -p "$ARDUINO_USR_PATH/hardware/espressif"
|
|
||||||
cd "$ARDUINO_USR_PATH/hardware/espressif"
|
|
||||||
|
|
||||||
echo "Installing Python Serial ..."
|
|
||||||
pip install pyserial > /dev/null
|
|
||||||
|
|
||||||
if [ "$OS_IS_WINDOWS" == "1" ]; then
|
|
||||||
echo "Installing Python Requests ..."
|
|
||||||
pip install requests > /dev/null
|
|
||||||
fi
|
|
||||||
|
|
||||||
if [ "$GITHUB_REPOSITORY" == "espressif/arduino-esp32" ]; then
|
|
||||||
echo "Linking Core..."
|
|
||||||
ln -s $GITHUB_WORKSPACE esp32
|
|
||||||
else
|
|
||||||
echo "Cloning Core Repository..."
|
|
||||||
git clone https://github.com/espressif/arduino-esp32.git esp32 > /dev/null 2>&1
|
|
||||||
fi
|
|
||||||
|
|
||||||
echo "Updating Submodules ..."
|
|
||||||
cd esp32
|
|
||||||
git submodule update --init --recursive > /dev/null 2>&1
|
|
||||||
|
|
||||||
echo "Installing Platform Tools ..."
|
|
||||||
cd tools && python get.py
|
|
||||||
cd $script_init_path
|
|
||||||
|
|
||||||
echo "ESP32 Arduino has been installed in '$ARDUINO_ESP32_PATH'"
|
|
||||||
echo ""
|
|
||||||
fi
|
|
||||||
220
lib/AsyncTCP/.github/scripts/install-arduino-ide.sh
vendored
220
lib/AsyncTCP/.github/scripts/install-arduino-ide.sh
vendored
@@ -1,220 +0,0 @@
|
|||||||
#!/bin/bash
|
|
||||||
|
|
||||||
#OSTYPE: 'linux-gnu', ARCH: 'x86_64' => linux64
|
|
||||||
#OSTYPE: 'msys', ARCH: 'x86_64' => win32
|
|
||||||
#OSTYPE: 'darwin18', ARCH: 'i386' => macos
|
|
||||||
|
|
||||||
OSBITS=`arch`
|
|
||||||
if [[ "$OSTYPE" == "linux"* ]]; then
|
|
||||||
export OS_IS_LINUX="1"
|
|
||||||
ARCHIVE_FORMAT="tar.xz"
|
|
||||||
if [[ "$OSBITS" == "i686" ]]; then
|
|
||||||
OS_NAME="linux32"
|
|
||||||
elif [[ "$OSBITS" == "x86_64" ]]; then
|
|
||||||
OS_NAME="linux64"
|
|
||||||
elif [[ "$OSBITS" == "armv7l" || "$OSBITS" == "aarch64" ]]; then
|
|
||||||
OS_NAME="linuxarm"
|
|
||||||
else
|
|
||||||
OS_NAME="$OSTYPE-$OSBITS"
|
|
||||||
echo "Unknown OS '$OS_NAME'"
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
elif [[ "$OSTYPE" == "darwin"* ]]; then
|
|
||||||
export OS_IS_MACOS="1"
|
|
||||||
ARCHIVE_FORMAT="zip"
|
|
||||||
OS_NAME="macosx"
|
|
||||||
elif [[ "$OSTYPE" == "cygwin" ]] || [[ "$OSTYPE" == "msys" ]] || [[ "$OSTYPE" == "win32" ]]; then
|
|
||||||
export OS_IS_WINDOWS="1"
|
|
||||||
ARCHIVE_FORMAT="zip"
|
|
||||||
OS_NAME="windows"
|
|
||||||
else
|
|
||||||
OS_NAME="$OSTYPE-$OSBITS"
|
|
||||||
echo "Unknown OS '$OS_NAME'"
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
export OS_NAME
|
|
||||||
|
|
||||||
ARDUINO_BUILD_DIR="$HOME/.arduino/build.tmp"
|
|
||||||
ARDUINO_CACHE_DIR="$HOME/.arduino/cache.tmp"
|
|
||||||
|
|
||||||
if [ "$OS_IS_MACOS" == "1" ]; then
|
|
||||||
export ARDUINO_IDE_PATH="/Applications/Arduino.app/Contents/Java"
|
|
||||||
export ARDUINO_USR_PATH="$HOME/Documents/Arduino"
|
|
||||||
elif [ "$OS_IS_WINDOWS" == "1" ]; then
|
|
||||||
export ARDUINO_IDE_PATH="$HOME/arduino_ide"
|
|
||||||
export ARDUINO_USR_PATH="$HOME/Documents/Arduino"
|
|
||||||
else
|
|
||||||
export ARDUINO_IDE_PATH="$HOME/arduino_ide"
|
|
||||||
export ARDUINO_USR_PATH="$HOME/Arduino"
|
|
||||||
fi
|
|
||||||
|
|
||||||
if [ ! -d "$ARDUINO_IDE_PATH" ]; then
|
|
||||||
echo "Installing Arduino IDE on $OS_NAME ..."
|
|
||||||
echo "Downloading 'arduino-nightly-$OS_NAME.$ARCHIVE_FORMAT' to 'arduino.$ARCHIVE_FORMAT' ..."
|
|
||||||
if [ "$OS_IS_LINUX" == "1" ]; then
|
|
||||||
wget -O "arduino.$ARCHIVE_FORMAT" "https://www.arduino.cc/download.php?f=/arduino-nightly-$OS_NAME.$ARCHIVE_FORMAT" > /dev/null 2>&1
|
|
||||||
echo "Extracting 'arduino.$ARCHIVE_FORMAT' ..."
|
|
||||||
tar xf "arduino.$ARCHIVE_FORMAT" > /dev/null
|
|
||||||
mv arduino-nightly "$ARDUINO_IDE_PATH"
|
|
||||||
else
|
|
||||||
curl -o "arduino.$ARCHIVE_FORMAT" -L "https://www.arduino.cc/download.php?f=/arduino-nightly-$OS_NAME.$ARCHIVE_FORMAT" > /dev/null 2>&1
|
|
||||||
echo "Extracting 'arduino.$ARCHIVE_FORMAT' ..."
|
|
||||||
unzip "arduino.$ARCHIVE_FORMAT" > /dev/null
|
|
||||||
if [ "$OS_IS_MACOS" == "1" ]; then
|
|
||||||
mv "Arduino.app" "/Applications/Arduino.app"
|
|
||||||
else
|
|
||||||
mv arduino-nightly "$ARDUINO_IDE_PATH"
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
rm -rf "arduino.$ARCHIVE_FORMAT"
|
|
||||||
|
|
||||||
mkdir -p "$ARDUINO_USR_PATH/libraries"
|
|
||||||
mkdir -p "$ARDUINO_USR_PATH/hardware"
|
|
||||||
|
|
||||||
echo "Arduino IDE Installed in '$ARDUINO_IDE_PATH'"
|
|
||||||
echo ""
|
|
||||||
fi
|
|
||||||
|
|
||||||
function build_sketch(){ # build_sketch <fqbn> <path-to-ino> [extra-options]
|
|
||||||
if [ "$#" -lt 2 ]; then
|
|
||||||
echo "ERROR: Illegal number of parameters"
|
|
||||||
echo "USAGE: build_sketch <fqbn> <path-to-ino> [extra-options]"
|
|
||||||
return 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
local fqbn="$1"
|
|
||||||
local sketch="$2"
|
|
||||||
local xtra_opts="$3"
|
|
||||||
local win_opts=""
|
|
||||||
if [ "$OS_IS_WINDOWS" == "1" ]; then
|
|
||||||
local ctags_version=`ls "$ARDUINO_IDE_PATH/tools-builder/ctags/"`
|
|
||||||
local preprocessor_version=`ls "$ARDUINO_IDE_PATH/tools-builder/arduino-preprocessor/"`
|
|
||||||
win_opts="-prefs=runtime.tools.ctags.path=$ARDUINO_IDE_PATH/tools-builder/ctags/$ctags_version -prefs=runtime.tools.arduino-preprocessor.path=$ARDUINO_IDE_PATH/tools-builder/arduino-preprocessor/$preprocessor_version"
|
|
||||||
fi
|
|
||||||
|
|
||||||
echo ""
|
|
||||||
echo "Compiling '"$(basename "$sketch")"' ..."
|
|
||||||
mkdir -p "$ARDUINO_BUILD_DIR"
|
|
||||||
mkdir -p "$ARDUINO_CACHE_DIR"
|
|
||||||
$ARDUINO_IDE_PATH/arduino-builder -compile -logger=human -core-api-version=10810 \
|
|
||||||
-fqbn=$fqbn \
|
|
||||||
-warnings="all" \
|
|
||||||
-tools "$ARDUINO_IDE_PATH/tools-builder" \
|
|
||||||
-tools "$ARDUINO_IDE_PATH/tools" \
|
|
||||||
-built-in-libraries "$ARDUINO_IDE_PATH/libraries" \
|
|
||||||
-hardware "$ARDUINO_IDE_PATH/hardware" \
|
|
||||||
-hardware "$ARDUINO_USR_PATH/hardware" \
|
|
||||||
-libraries "$ARDUINO_USR_PATH/libraries" \
|
|
||||||
-build-cache "$ARDUINO_CACHE_DIR" \
|
|
||||||
-build-path "$ARDUINO_BUILD_DIR" \
|
|
||||||
$win_opts $xtra_opts "$sketch"
|
|
||||||
}
|
|
||||||
|
|
||||||
function count_sketches() # count_sketches <examples-path>
|
|
||||||
{
|
|
||||||
local examples="$1"
|
|
||||||
rm -rf sketches.txt
|
|
||||||
if [ ! -d "$examples" ]; then
|
|
||||||
touch sketches.txt
|
|
||||||
return 0
|
|
||||||
fi
|
|
||||||
local sketches=$(find $examples -name *.ino)
|
|
||||||
local sketchnum=0
|
|
||||||
for sketch in $sketches; do
|
|
||||||
local sketchdir=$(dirname $sketch)
|
|
||||||
local sketchdirname=$(basename $sketchdir)
|
|
||||||
local sketchname=$(basename $sketch)
|
|
||||||
if [[ "${sketchdirname}.ino" != "$sketchname" ]]; then
|
|
||||||
continue
|
|
||||||
fi;
|
|
||||||
if [[ -f "$sketchdir/.test.skip" ]]; then
|
|
||||||
continue
|
|
||||||
fi
|
|
||||||
echo $sketch >> sketches.txt
|
|
||||||
sketchnum=$(($sketchnum + 1))
|
|
||||||
done
|
|
||||||
return $sketchnum
|
|
||||||
}
|
|
||||||
|
|
||||||
function build_sketches() # build_sketches <fqbn> <examples-path> <chunk> <total-chunks> [extra-options]
|
|
||||||
{
|
|
||||||
local fqbn=$1
|
|
||||||
local examples=$2
|
|
||||||
local chunk_idex=$3
|
|
||||||
local chunks_num=$4
|
|
||||||
local xtra_opts=$5
|
|
||||||
|
|
||||||
if [ "$#" -lt 2 ]; then
|
|
||||||
echo "ERROR: Illegal number of parameters"
|
|
||||||
echo "USAGE: build_sketches <fqbn> <examples-path> [<chunk> <total-chunks>] [extra-options]"
|
|
||||||
return 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
if [ "$#" -lt 4 ]; then
|
|
||||||
chunk_idex="0"
|
|
||||||
chunks_num="1"
|
|
||||||
xtra_opts=$3
|
|
||||||
fi
|
|
||||||
|
|
||||||
if [ "$chunks_num" -le 0 ]; then
|
|
||||||
echo "ERROR: Chunks count must be positive number"
|
|
||||||
return 1
|
|
||||||
fi
|
|
||||||
if [ "$chunk_idex" -ge "$chunks_num" ]; then
|
|
||||||
echo "ERROR: Chunk index must be less than chunks count"
|
|
||||||
return 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
set +e
|
|
||||||
count_sketches "$examples"
|
|
||||||
local sketchcount=$?
|
|
||||||
set -e
|
|
||||||
local sketches=$(cat sketches.txt)
|
|
||||||
rm -rf sketches.txt
|
|
||||||
|
|
||||||
local chunk_size=$(( $sketchcount / $chunks_num ))
|
|
||||||
local all_chunks=$(( $chunks_num * $chunk_size ))
|
|
||||||
if [ "$all_chunks" -lt "$sketchcount" ]; then
|
|
||||||
chunk_size=$(( $chunk_size + 1 ))
|
|
||||||
fi
|
|
||||||
|
|
||||||
local start_index=$(( $chunk_idex * $chunk_size ))
|
|
||||||
if [ "$sketchcount" -le "$start_index" ]; then
|
|
||||||
echo "Skipping job"
|
|
||||||
return 0
|
|
||||||
fi
|
|
||||||
|
|
||||||
local end_index=$(( $(( $chunk_idex + 1 )) * $chunk_size ))
|
|
||||||
if [ "$end_index" -gt "$sketchcount" ]; then
|
|
||||||
end_index=$sketchcount
|
|
||||||
fi
|
|
||||||
|
|
||||||
local start_num=$(( $start_index + 1 ))
|
|
||||||
echo "Found $sketchcount Sketches";
|
|
||||||
echo "Chunk Count : $chunks_num"
|
|
||||||
echo "Chunk Size : $chunk_size"
|
|
||||||
echo "Start Sketch: $start_num"
|
|
||||||
echo "End Sketch : $end_index"
|
|
||||||
|
|
||||||
local sketchnum=0
|
|
||||||
for sketch in $sketches; do
|
|
||||||
local sketchdir=$(dirname $sketch)
|
|
||||||
local sketchdirname=$(basename $sketchdir)
|
|
||||||
local sketchname=$(basename $sketch)
|
|
||||||
if [ "${sketchdirname}.ino" != "$sketchname" ] \
|
|
||||||
|| [ -f "$sketchdir/.test.skip" ]; then
|
|
||||||
continue
|
|
||||||
fi
|
|
||||||
sketchnum=$(($sketchnum + 1))
|
|
||||||
if [ "$sketchnum" -le "$start_index" ] \
|
|
||||||
|| [ "$sketchnum" -gt "$end_index" ]; then
|
|
||||||
continue
|
|
||||||
fi
|
|
||||||
build_sketch "$fqbn" "$sketch" "$xtra_opts"
|
|
||||||
local result=$?
|
|
||||||
if [ $result -ne 0 ]; then
|
|
||||||
return $result
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
return 0
|
|
||||||
}
|
|
||||||
133
lib/AsyncTCP/.github/scripts/install-platformio.sh
vendored
133
lib/AsyncTCP/.github/scripts/install-platformio.sh
vendored
@@ -1,133 +0,0 @@
|
|||||||
#!/bin/bash
|
|
||||||
|
|
||||||
echo "Installing Python Wheel ..."
|
|
||||||
pip install wheel > /dev/null 2>&1
|
|
||||||
|
|
||||||
echo "Installing PlatformIO ..."
|
|
||||||
pip install -U platformio > /dev/null 2>&1
|
|
||||||
|
|
||||||
echo "PlatformIO has been installed"
|
|
||||||
echo ""
|
|
||||||
|
|
||||||
|
|
||||||
function build_pio_sketch(){ # build_pio_sketch <board> <path-to-ino>
|
|
||||||
if [ "$#" -lt 2 ]; then
|
|
||||||
echo "ERROR: Illegal number of parameters"
|
|
||||||
echo "USAGE: build_pio_sketch <board> <path-to-ino>"
|
|
||||||
return 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
local board="$1"
|
|
||||||
local sketch="$2"
|
|
||||||
local sketch_dir=$(dirname "$sketch")
|
|
||||||
echo ""
|
|
||||||
echo "Compiling '"$(basename "$sketch")"' ..."
|
|
||||||
python -m platformio ci -l '.' --board "$board" "$sketch_dir" --project-option="board_build.partitions = huge_app.csv"
|
|
||||||
}
|
|
||||||
|
|
||||||
function count_sketches() # count_sketches <examples-path>
|
|
||||||
{
|
|
||||||
local examples="$1"
|
|
||||||
rm -rf sketches.txt
|
|
||||||
if [ ! -d "$examples" ]; then
|
|
||||||
touch sketches.txt
|
|
||||||
return 0
|
|
||||||
fi
|
|
||||||
local sketches=$(find $examples -name *.ino)
|
|
||||||
local sketchnum=0
|
|
||||||
for sketch in $sketches; do
|
|
||||||
local sketchdir=$(dirname $sketch)
|
|
||||||
local sketchdirname=$(basename $sketchdir)
|
|
||||||
local sketchname=$(basename $sketch)
|
|
||||||
if [[ "${sketchdirname}.ino" != "$sketchname" ]]; then
|
|
||||||
continue
|
|
||||||
fi;
|
|
||||||
if [[ -f "$sketchdir/.test.skip" ]]; then
|
|
||||||
continue
|
|
||||||
fi
|
|
||||||
echo $sketch >> sketches.txt
|
|
||||||
sketchnum=$(($sketchnum + 1))
|
|
||||||
done
|
|
||||||
return $sketchnum
|
|
||||||
}
|
|
||||||
|
|
||||||
function build_pio_sketches() # build_pio_sketches <board> <examples-path> <chunk> <total-chunks>
|
|
||||||
{
|
|
||||||
if [ "$#" -lt 2 ]; then
|
|
||||||
echo "ERROR: Illegal number of parameters"
|
|
||||||
echo "USAGE: build_pio_sketches <board> <examples-path> [<chunk> <total-chunks>]"
|
|
||||||
return 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
local board=$1
|
|
||||||
local examples=$2
|
|
||||||
local chunk_idex=$3
|
|
||||||
local chunks_num=$4
|
|
||||||
|
|
||||||
if [ "$#" -lt 4 ]; then
|
|
||||||
chunk_idex="0"
|
|
||||||
chunks_num="1"
|
|
||||||
fi
|
|
||||||
|
|
||||||
if [ "$chunks_num" -le 0 ]; then
|
|
||||||
echo "ERROR: Chunks count must be positive number"
|
|
||||||
return 1
|
|
||||||
fi
|
|
||||||
if [ "$chunk_idex" -ge "$chunks_num" ]; then
|
|
||||||
echo "ERROR: Chunk index must be less than chunks count"
|
|
||||||
return 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
set +e
|
|
||||||
count_sketches "$examples"
|
|
||||||
local sketchcount=$?
|
|
||||||
set -e
|
|
||||||
local sketches=$(cat sketches.txt)
|
|
||||||
rm -rf sketches.txt
|
|
||||||
|
|
||||||
local chunk_size=$(( $sketchcount / $chunks_num ))
|
|
||||||
local all_chunks=$(( $chunks_num * $chunk_size ))
|
|
||||||
if [ "$all_chunks" -lt "$sketchcount" ]; then
|
|
||||||
chunk_size=$(( $chunk_size + 1 ))
|
|
||||||
fi
|
|
||||||
|
|
||||||
local start_index=$(( $chunk_idex * $chunk_size ))
|
|
||||||
if [ "$sketchcount" -le "$start_index" ]; then
|
|
||||||
echo "Skipping job"
|
|
||||||
return 0
|
|
||||||
fi
|
|
||||||
|
|
||||||
local end_index=$(( $(( $chunk_idex + 1 )) * $chunk_size ))
|
|
||||||
if [ "$end_index" -gt "$sketchcount" ]; then
|
|
||||||
end_index=$sketchcount
|
|
||||||
fi
|
|
||||||
|
|
||||||
local start_num=$(( $start_index + 1 ))
|
|
||||||
echo "Found $sketchcount Sketches";
|
|
||||||
echo "Chunk Count : $chunks_num"
|
|
||||||
echo "Chunk Size : $chunk_size"
|
|
||||||
echo "Start Sketch: $start_num"
|
|
||||||
echo "End Sketch : $end_index"
|
|
||||||
|
|
||||||
local sketchnum=0
|
|
||||||
for sketch in $sketches; do
|
|
||||||
local sketchdir=$(dirname $sketch)
|
|
||||||
local sketchdirname=$(basename $sketchdir)
|
|
||||||
local sketchname=$(basename $sketch)
|
|
||||||
if [ "${sketchdirname}.ino" != "$sketchname" ] \
|
|
||||||
|| [ -f "$sketchdir/.test.skip" ]; then
|
|
||||||
continue
|
|
||||||
fi
|
|
||||||
sketchnum=$(($sketchnum + 1))
|
|
||||||
if [ "$sketchnum" -le "$start_index" ] \
|
|
||||||
|| [ "$sketchnum" -gt "$end_index" ]; then
|
|
||||||
continue
|
|
||||||
fi
|
|
||||||
build_pio_sketch "$board" "$sketch"
|
|
||||||
local result=$?
|
|
||||||
if [ $result -ne 0 ]; then
|
|
||||||
return $result
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
return 0
|
|
||||||
}
|
|
||||||
64
lib/AsyncTCP/.github/scripts/on-push.sh
vendored
64
lib/AsyncTCP/.github/scripts/on-push.sh
vendored
@@ -1,64 +0,0 @@
|
|||||||
#!/bin/bash
|
|
||||||
|
|
||||||
set -e
|
|
||||||
|
|
||||||
if [ ! -z "$TRAVIS_BUILD_DIR" ]; then
|
|
||||||
export GITHUB_WORKSPACE="$TRAVIS_BUILD_DIR"
|
|
||||||
export GITHUB_REPOSITORY="$TRAVIS_REPO_SLUG"
|
|
||||||
elif [ -z "$GITHUB_WORKSPACE" ]; then
|
|
||||||
export GITHUB_WORKSPACE="$PWD"
|
|
||||||
export GITHUB_REPOSITORY="me-no-dev/AsyncTCP"
|
|
||||||
fi
|
|
||||||
|
|
||||||
CHUNK_INDEX=$1
|
|
||||||
CHUNKS_CNT=$2
|
|
||||||
BUILD_PIO=0
|
|
||||||
if [ "$#" -lt 2 ] || [ "$CHUNKS_CNT" -le 0 ]; then
|
|
||||||
CHUNK_INDEX=0
|
|
||||||
CHUNKS_CNT=1
|
|
||||||
elif [ "$CHUNK_INDEX" -gt "$CHUNKS_CNT" ]; then
|
|
||||||
CHUNK_INDEX=$CHUNKS_CNT
|
|
||||||
elif [ "$CHUNK_INDEX" -eq "$CHUNKS_CNT" ]; then
|
|
||||||
BUILD_PIO=1
|
|
||||||
fi
|
|
||||||
|
|
||||||
if [ "$BUILD_PIO" -eq 0 ]; then
|
|
||||||
# ArduinoIDE Test
|
|
||||||
source ./.github/scripts/install-arduino-ide.sh
|
|
||||||
source ./.github/scripts/install-arduino-core-esp32.sh
|
|
||||||
|
|
||||||
echo "Installing AsyncTCP ..."
|
|
||||||
cp -rf "$GITHUB_WORKSPACE" "$ARDUINO_USR_PATH/libraries/AsyncTCP"
|
|
||||||
|
|
||||||
FQBN="espressif:esp32:esp32:PSRAM=enabled,PartitionScheme=huge_app"
|
|
||||||
build_sketches "$FQBN" "$GITHUB_WORKSPACE/examples"
|
|
||||||
if [ ! "$OS_IS_WINDOWS" == "1" ]; then
|
|
||||||
echo "Installing ESPAsyncWebServer ..."
|
|
||||||
git clone https://github.com/me-no-dev/ESPAsyncWebServer "$ARDUINO_USR_PATH/libraries/ESPAsyncWebServer" > /dev/null 2>&1
|
|
||||||
|
|
||||||
echo "Installing ArduinoJson ..."
|
|
||||||
git clone https://github.com/bblanchon/ArduinoJson "$ARDUINO_USR_PATH/libraries/ArduinoJson" > /dev/null 2>&1
|
|
||||||
|
|
||||||
build_sketches "$FQBN" "$ARDUINO_USR_PATH/libraries/ESPAsyncWebServer/examples"
|
|
||||||
fi
|
|
||||||
else
|
|
||||||
# PlatformIO Test
|
|
||||||
source ./.github/scripts/install-platformio.sh
|
|
||||||
|
|
||||||
echo "Installing AsyncTCP ..."
|
|
||||||
python -m platformio lib --storage-dir "$GITHUB_WORKSPACE" install
|
|
||||||
|
|
||||||
BOARD="esp32dev"
|
|
||||||
build_pio_sketches "$BOARD" "$GITHUB_WORKSPACE/examples"
|
|
||||||
|
|
||||||
if [[ "$OSTYPE" != "cygwin" ]] && [[ "$OSTYPE" != "msys" ]] && [[ "$OSTYPE" != "win32" ]]; then
|
|
||||||
echo "Installing ESPAsyncWebServer ..."
|
|
||||||
python -m platformio lib -g install https://github.com/me-no-dev/ESPAsyncWebServer.git > /dev/null 2>&1
|
|
||||||
git clone https://github.com/me-no-dev/ESPAsyncWebServer "$HOME/ESPAsyncWebServer" > /dev/null 2>&1
|
|
||||||
|
|
||||||
echo "Installing ArduinoJson ..."
|
|
||||||
python -m platformio lib -g install https://github.com/bblanchon/ArduinoJson.git > /dev/null 2>&1
|
|
||||||
|
|
||||||
build_pio_sketches "$BOARD" "$HOME/ESPAsyncWebServer/examples"
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
52
lib/AsyncTCP/.github/workflows/push.yml
vendored
52
lib/AsyncTCP/.github/workflows/push.yml
vendored
@@ -2,31 +2,51 @@ name: Async TCP CI
|
|||||||
|
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
branches:
|
|
||||||
- master
|
|
||||||
- release/*
|
|
||||||
pull_request:
|
pull_request:
|
||||||
|
workflow_dispatch:
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
|
|
||||||
build-arduino:
|
build-arduino:
|
||||||
name: Arduino on ${{ matrix.os }}
|
name: ${{ matrix.config }}
|
||||||
runs-on: ${{ matrix.os }}
|
runs-on: ubuntu-latest
|
||||||
strategy:
|
strategy:
|
||||||
|
fail-fast: false
|
||||||
matrix:
|
matrix:
|
||||||
os: [ubuntu-latest, macOS-latest]
|
config: [arduino-cli.yaml, arduino-cli-dev.yaml]
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v1
|
- uses: actions/checkout@v4
|
||||||
- name: Build Tests
|
- uses: arduino/setup-arduino-cli@v1
|
||||||
run: bash ./.github/scripts/on-push.sh 0 1
|
- name: Download board
|
||||||
|
run: |
|
||||||
|
arduino-cli --config-file ${{ matrix.config }} core update-index
|
||||||
|
arduino-cli --config-file ${{ matrix.config }} board listall
|
||||||
|
arduino-cli --config-file ${{ matrix.config }} core install esp32:esp32
|
||||||
|
- name: Compile Sketch
|
||||||
|
run: arduino-cli --config-file ${{ matrix.config }} --library ./src/ compile --fqbn esp32:esp32:esp32 ./examples/ClientServer/Client/Client.ino
|
||||||
|
- name: Compile Sketch with IPv6
|
||||||
|
env:
|
||||||
|
LWIP_IPV6: true
|
||||||
|
run: arduino-cli --config-file ${{ matrix.config }} --library ./src/ compile --fqbn esp32:esp32:esp32 ./examples/ClientServer/Client/Client.ino
|
||||||
|
|
||||||
build-pio:
|
build-pio:
|
||||||
name: PlatformIO on ${{ matrix.os }}
|
name: ${{ matrix.board }} ${{ matrix.env }}
|
||||||
runs-on: ${{ matrix.os }}
|
runs-on: ubuntu-latest
|
||||||
strategy:
|
strategy:
|
||||||
|
fail-fast: false
|
||||||
matrix:
|
matrix:
|
||||||
os: [ubuntu-latest, macOS-latest]
|
board: [esp32dev, esp32-s3-devkitc-1]
|
||||||
|
env: [arduino-2, arduino-3]
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v1
|
- uses: actions/checkout@v4
|
||||||
- name: Build Tests
|
- uses: actions/cache@v4
|
||||||
run: bash ./.github/scripts/on-push.sh 1 1
|
with:
|
||||||
|
path: |
|
||||||
|
~/.platformio
|
||||||
|
~/.cache/pip
|
||||||
|
key: ${{ matrix.env }}
|
||||||
|
- uses: actions/setup-python@v5
|
||||||
|
with:
|
||||||
|
python-version: "3.x"
|
||||||
|
- run: pip install platformio
|
||||||
|
- run: sed -i -e 's/esp32dev/${{ matrix.board }}/g' platformio.ini
|
||||||
|
- run: pio run -e ${{ matrix.env }}
|
||||||
|
|||||||
6
lib/AsyncTCP/.gitignore
vendored
6
lib/AsyncTCP/.gitignore
vendored
@@ -1,2 +1,6 @@
|
|||||||
|
|
||||||
.DS_Store
|
.DS_Store
|
||||||
|
.lh
|
||||||
|
/.pio
|
||||||
|
/.vscode/*
|
||||||
|
!/.vscode/settings.json
|
||||||
|
/logs
|
||||||
|
|||||||
@@ -1,34 +0,0 @@
|
|||||||
sudo: false
|
|
||||||
language: python
|
|
||||||
os:
|
|
||||||
- linux
|
|
||||||
|
|
||||||
git:
|
|
||||||
depth: false
|
|
||||||
|
|
||||||
stages:
|
|
||||||
- build
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
include:
|
|
||||||
|
|
||||||
- name: "Arduino Build"
|
|
||||||
if: tag IS blank AND (type = pull_request OR (type = push AND branch = master))
|
|
||||||
stage: build
|
|
||||||
script: bash $TRAVIS_BUILD_DIR/.github/scripts/on-push.sh
|
|
||||||
|
|
||||||
- name: "PlatformIO Build"
|
|
||||||
if: tag IS blank AND (type = pull_request OR (type = push AND branch = master))
|
|
||||||
stage: build
|
|
||||||
script: bash $TRAVIS_BUILD_DIR/.github/scripts/on-push.sh 1 1
|
|
||||||
|
|
||||||
notifications:
|
|
||||||
email:
|
|
||||||
on_success: change
|
|
||||||
on_failure: change
|
|
||||||
webhooks:
|
|
||||||
urls:
|
|
||||||
- https://webhooks.gitter.im/e/60e65d0c78ea0a920347
|
|
||||||
on_success: change # options: [always|never|change] default: always
|
|
||||||
on_failure: always # options: [always|never|change] default: always
|
|
||||||
on_start: false # default: false
|
|
||||||
@@ -1,13 +1,52 @@
|
|||||||
# AsyncTCP
|
# AsyncTCP
|
||||||
[](https://travis-ci.org/me-no-dev/AsyncTCP)  [](https://www.codacy.com/manual/me-no-dev/AsyncTCP?utm_source=github.com&utm_medium=referral&utm_content=me-no-dev/AsyncTCP&utm_campaign=Badge_Grade)
|
|
||||||
|
[](https://opensource.org/license/lgpl-3-0/)
|
||||||
|
[](https://github.com/mathieucarbou/AsyncTCP/actions/workflows/push.yml)
|
||||||
|
[](https://registry.platformio.org/libraries/mathieucarbou/Async%20TCP)
|
||||||
|
|
||||||
|
A fork of the [AsyncTCP](https://github.com/me-no-dev/AsyncTCP) library by [@me-no-dev](https://github.com/me-no-dev) for [ESPHome](https://esphome.io).
|
||||||
|
|
||||||
### Async TCP Library for ESP32 Arduino
|
### Async TCP Library for ESP32 Arduino
|
||||||
|
|
||||||
[](https://gitter.im/me-no-dev/ESPAsyncWebServer?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
|
||||||
|
|
||||||
This is a fully asynchronous TCP library, aimed at enabling trouble-free, multi-connection network environment for Espressif's ESP32 MCUs.
|
This is a fully asynchronous TCP library, aimed at enabling trouble-free, multi-connection network environment for Espressif's ESP32 MCUs.
|
||||||
|
|
||||||
This library is the base for [ESPAsyncWebServer](https://github.com/me-no-dev/ESPAsyncWebServer)
|
This library is the base for [ESPAsyncWebServer](https://github.com/mathieucarbou/ESPAsyncWebServer)
|
||||||
|
|
||||||
## AsyncClient and AsyncServer
|
## AsyncClient and AsyncServer
|
||||||
|
|
||||||
The base classes on which everything else is built. They expose all possible scenarios, but are really raw and require more skills to use.
|
The base classes on which everything else is built. They expose all possible scenarios, but are really raw and require more skills to use.
|
||||||
|
|
||||||
|
## Changes in this fork
|
||||||
|
|
||||||
|
- All improvements from [ESPHome fork](https://github.com/esphome/AsyncTCP)
|
||||||
|
- Reverted back `library.properties` for Arduino IDE users
|
||||||
|
- Arduino 3 / ESP-IDF 5 compatibility
|
||||||
|
- Changed lib name: `AsyncTCP` -> `Async TCP`
|
||||||
|
- Point to `mathieucarbou/Async TCP @ ^3.1.4`
|
||||||
|
- IPv6 support
|
||||||
|
|
||||||
|
## Important recommendations
|
||||||
|
|
||||||
|
Most of the crashes are caused by improper configuration of the library for the project.
|
||||||
|
Here are some recommendations to avoid them.
|
||||||
|
|
||||||
|
1. Set the running core to be on the same core of your application (usually core 1) `-D CONFIG_ASYNC_TCP_RUNNING_CORE=1`
|
||||||
|
2. Set the stack size appropriately with `-D CONFIG_ASYNC_TCP_STACK_SIZE=16384`.
|
||||||
|
The default value of `16384` might be too much for your project.
|
||||||
|
You can look at the [MycilaTaskMonitor](https://oss.carbou.me/MycilaTaskMonitor) project to monitor the stack usage.
|
||||||
|
3. You can change **if you know what you are doing** the task priority with `-D CONFIG_ASYNC_TCP_PRIORITY=10`.
|
||||||
|
Default is `10`.
|
||||||
|
4. You can increase the queue size with `-D CONFIG_ASYNC_TCP_QUEUE_SIZE=128`.
|
||||||
|
Default is `64`.
|
||||||
|
5. You can decrease the maximum ack time `-D CONFIG_ASYNC_TCP_MAX_ACK_TIME=3000`.
|
||||||
|
Default is `5000`.
|
||||||
|
|
||||||
|
I personally use the following configuration in my projects:
|
||||||
|
|
||||||
|
```c++
|
||||||
|
-D CONFIG_ASYNC_TCP_MAX_ACK_TIME=3000
|
||||||
|
-D CONFIG_ASYNC_TCP_PRIORITY=10
|
||||||
|
-D CONFIG_ASYNC_TCP_QUEUE_SIZE=128
|
||||||
|
-D CONFIG_ASYNC_TCP_RUNNING_CORE=1
|
||||||
|
-D CONFIG_ASYNC_TCP_STACK_SIZE=4096
|
||||||
|
```
|
||||||
|
|||||||
25
lib/AsyncTCP/arduino-cli-dev.yaml
Normal file
25
lib/AsyncTCP/arduino-cli-dev.yaml
Normal file
@@ -0,0 +1,25 @@
|
|||||||
|
board_manager:
|
||||||
|
additional_urls:
|
||||||
|
- https://espressif.github.io/arduino-esp32/package_esp32_dev_index.json
|
||||||
|
directories:
|
||||||
|
builtin.libraries: ./src/
|
||||||
|
build_cache:
|
||||||
|
compilations_before_purge: 10
|
||||||
|
ttl: 720h0m0s
|
||||||
|
daemon:
|
||||||
|
port: "50051"
|
||||||
|
library:
|
||||||
|
enable_unsafe_install: false
|
||||||
|
logging:
|
||||||
|
file: ""
|
||||||
|
format: text
|
||||||
|
level: info
|
||||||
|
metrics:
|
||||||
|
addr: :9090
|
||||||
|
enabled: true
|
||||||
|
output:
|
||||||
|
no_color: false
|
||||||
|
sketch:
|
||||||
|
always_export_binaries: false
|
||||||
|
updater:
|
||||||
|
enable_notification: true
|
||||||
@@ -1,22 +1,38 @@
|
|||||||
{
|
{
|
||||||
"name":"AsyncTCP",
|
"name": "Async TCP",
|
||||||
"description":"Asynchronous TCP Library for ESP32",
|
"version": "3.1.4",
|
||||||
"keywords":"async,tcp",
|
"description": "Asynchronous TCP Library for ESP32",
|
||||||
"authors":
|
"keywords": "async,tcp",
|
||||||
{
|
"repository": {
|
||||||
"name": "Hristo Gochkov",
|
|
||||||
"maintainer": true
|
|
||||||
},
|
|
||||||
"repository":
|
|
||||||
{
|
|
||||||
"type": "git",
|
"type": "git",
|
||||||
"url": "https://github.com/me-no-dev/AsyncTCP.git"
|
"url": "https://github.com/mathieucarbou/AsyncTCP.git"
|
||||||
},
|
},
|
||||||
"version": "1.1.1",
|
"authors": [
|
||||||
|
{
|
||||||
|
"name": "Hristo Gochkov"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "Mathieu Carbou",
|
||||||
|
"maintainer": true
|
||||||
|
}
|
||||||
|
],
|
||||||
"license": "LGPL-3.0",
|
"license": "LGPL-3.0",
|
||||||
"frameworks": "arduino",
|
"frameworks": "arduino",
|
||||||
"platforms": "espressif32",
|
"platforms": [
|
||||||
|
"espressif32",
|
||||||
|
"libretiny"
|
||||||
|
],
|
||||||
"build": {
|
"build": {
|
||||||
"libCompatMode": 2
|
"libCompatMode": 2
|
||||||
}
|
},
|
||||||
}
|
"export": {
|
||||||
|
"include": [
|
||||||
|
"examples",
|
||||||
|
"src",
|
||||||
|
"library.json",
|
||||||
|
"library.properties",
|
||||||
|
"LICENSE",
|
||||||
|
"README.md"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,9 +1,9 @@
|
|||||||
name=AsyncTCP
|
name=Async TCP
|
||||||
version=1.1.1
|
version=3.1.4
|
||||||
author=Me-No-Dev
|
author=Me-No-Dev
|
||||||
maintainer=Me-No-Dev
|
maintainer=Mathieu Carbou <mathieu.carbou@gmail.com>
|
||||||
sentence=Async TCP Library for ESP32
|
sentence=Async TCP Library for ESP32
|
||||||
paragraph=Async TCP Library for ESP32
|
paragraph=Async TCP Library for ESP32
|
||||||
category=Other
|
category=Other
|
||||||
url=https://github.com/me-no-dev/AsyncTCP
|
url=https://github.com/mathieucarbou/AsyncTCP.git
|
||||||
architectures=*
|
architectures=*
|
||||||
|
|||||||
28
lib/AsyncTCP/platformio.ini
Normal file
28
lib/AsyncTCP/platformio.ini
Normal file
@@ -0,0 +1,28 @@
|
|||||||
|
[env]
|
||||||
|
framework = arduino
|
||||||
|
build_flags =
|
||||||
|
-Wall -Wextra
|
||||||
|
-D CONFIG_ARDUHAL_LOG_COLORS
|
||||||
|
-D CORE_DEBUG_LEVEL=ARDUHAL_LOG_LEVEL_DEBUG
|
||||||
|
upload_protocol = esptool
|
||||||
|
monitor_speed = 115200
|
||||||
|
monitor_filters = esp32_exception_decoder, log2file
|
||||||
|
|
||||||
|
[platformio]
|
||||||
|
lib_dir = .
|
||||||
|
src_dir = examples/ClientServer/Client
|
||||||
|
|
||||||
|
[env:arduino]
|
||||||
|
platform = espressif32
|
||||||
|
board = esp32dev
|
||||||
|
|
||||||
|
[env:arduino-2]
|
||||||
|
platform = espressif32@6.7.0
|
||||||
|
board = esp32dev
|
||||||
|
|
||||||
|
[env:arduino-3]
|
||||||
|
platform = espressif32
|
||||||
|
platform_packages=
|
||||||
|
platformio/framework-arduinoespressif32 @ https://github.com/espressif/arduino-esp32.git#3.0.2
|
||||||
|
platformio/framework-arduinoespressif32-libs @ https://github.com/espressif/arduino-esp32/releases/download/3.0.2/esp32-arduino-libs-3.0.2.zip
|
||||||
|
board = esp32dev
|
||||||
@@ -29,7 +29,9 @@ extern "C"{
|
|||||||
#include "lwip/dns.h"
|
#include "lwip/dns.h"
|
||||||
#include "lwip/err.h"
|
#include "lwip/err.h"
|
||||||
}
|
}
|
||||||
|
#if CONFIG_ASYNC_TCP_USE_WDT
|
||||||
#include "esp_task_wdt.h"
|
#include "esp_task_wdt.h"
|
||||||
|
#endif
|
||||||
|
|
||||||
/*
|
/*
|
||||||
* TCP/IP Event Task
|
* TCP/IP Event Task
|
||||||
@@ -44,7 +46,7 @@ typedef struct {
|
|||||||
void *arg;
|
void *arg;
|
||||||
union {
|
union {
|
||||||
struct {
|
struct {
|
||||||
void * pcb;
|
tcp_pcb * pcb;
|
||||||
int8_t err;
|
int8_t err;
|
||||||
} connected;
|
} connected;
|
||||||
struct {
|
struct {
|
||||||
@@ -76,7 +78,7 @@ typedef struct {
|
|||||||
};
|
};
|
||||||
} lwip_event_packet_t;
|
} lwip_event_packet_t;
|
||||||
|
|
||||||
static xQueueHandle _async_queue;
|
static QueueHandle_t _async_queue;
|
||||||
static TaskHandle_t _async_service_task_handle = NULL;
|
static TaskHandle_t _async_service_task_handle = NULL;
|
||||||
|
|
||||||
|
|
||||||
@@ -95,7 +97,7 @@ static uint32_t _closed_index = []() {
|
|||||||
|
|
||||||
static inline bool _init_async_event_queue(){
|
static inline bool _init_async_event_queue(){
|
||||||
if(!_async_queue){
|
if(!_async_queue){
|
||||||
_async_queue = xQueueCreate(32, sizeof(lwip_event_packet_t *));
|
_async_queue = xQueueCreate(CONFIG_ASYNC_TCP_QUEUE_SIZE, sizeof(lwip_event_packet_t *));
|
||||||
if(!_async_queue){
|
if(!_async_queue){
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
@@ -213,12 +215,32 @@ static void _stop_async_task(){
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
static bool customTaskCreateUniversal(
|
||||||
|
TaskFunction_t pxTaskCode,
|
||||||
|
const char * const pcName,
|
||||||
|
const uint32_t usStackDepth,
|
||||||
|
void * const pvParameters,
|
||||||
|
UBaseType_t uxPriority,
|
||||||
|
TaskHandle_t * const pxCreatedTask,
|
||||||
|
const BaseType_t xCoreID) {
|
||||||
|
#ifndef CONFIG_FREERTOS_UNICORE
|
||||||
|
if(xCoreID >= 0 && xCoreID < 2) {
|
||||||
|
return xTaskCreatePinnedToCore(pxTaskCode, pcName, usStackDepth, pvParameters, uxPriority, pxCreatedTask, xCoreID);
|
||||||
|
} else {
|
||||||
|
#endif
|
||||||
|
return xTaskCreate(pxTaskCode, pcName, usStackDepth, pvParameters, uxPriority, pxCreatedTask);
|
||||||
|
#ifndef CONFIG_FREERTOS_UNICORE
|
||||||
|
}
|
||||||
|
#endif
|
||||||
|
}
|
||||||
|
|
||||||
static bool _start_async_task(){
|
static bool _start_async_task(){
|
||||||
if(!_init_async_event_queue()){
|
if(!_init_async_event_queue()){
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
if(!_async_service_task_handle){
|
if(!_async_service_task_handle){
|
||||||
xTaskCreateUniversal(_async_service_task, "async_tcp", 8192 * 2, NULL, 3, &_async_service_task_handle, CONFIG_ASYNC_TCP_RUNNING_CORE);
|
customTaskCreateUniversal(_async_service_task, "async_tcp", CONFIG_ASYNC_TCP_STACK_SIZE, NULL, CONFIG_ASYNC_TCP_PRIORITY, &_async_service_task_handle, CONFIG_ASYNC_TCP_RUNNING_CORE);
|
||||||
if(!_async_service_task_handle){
|
if(!_async_service_task_handle){
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
@@ -555,12 +577,11 @@ AsyncClient::AsyncClient(tcp_pcb* pcb)
|
|||||||
, _pb_cb_arg(0)
|
, _pb_cb_arg(0)
|
||||||
, _timeout_cb(0)
|
, _timeout_cb(0)
|
||||||
, _timeout_cb_arg(0)
|
, _timeout_cb_arg(0)
|
||||||
, _pcb_busy(false)
|
|
||||||
, _pcb_sent_at(0)
|
|
||||||
, _ack_pcb(true)
|
, _ack_pcb(true)
|
||||||
, _rx_last_packet(0)
|
, _tx_last_packet(0)
|
||||||
, _rx_since_timeout(0)
|
, _rx_timeout(0)
|
||||||
, _ack_timeout(ASYNC_MAX_ACK_TIME)
|
, _rx_last_ack(0)
|
||||||
|
, _ack_timeout(CONFIG_ASYNC_TCP_MAX_ACK_TIME)
|
||||||
, _connect_port(0)
|
, _connect_port(0)
|
||||||
, prev(NULL)
|
, prev(NULL)
|
||||||
, next(NULL)
|
, next(NULL)
|
||||||
@@ -568,13 +589,15 @@ AsyncClient::AsyncClient(tcp_pcb* pcb)
|
|||||||
_pcb = pcb;
|
_pcb = pcb;
|
||||||
_closed_slot = -1;
|
_closed_slot = -1;
|
||||||
if(_pcb){
|
if(_pcb){
|
||||||
_allocate_closed_slot();
|
|
||||||
_rx_last_packet = millis();
|
_rx_last_packet = millis();
|
||||||
tcp_arg(_pcb, this);
|
tcp_arg(_pcb, this);
|
||||||
tcp_recv(_pcb, &_tcp_recv);
|
tcp_recv(_pcb, &_tcp_recv);
|
||||||
tcp_sent(_pcb, &_tcp_sent);
|
tcp_sent(_pcb, &_tcp_sent);
|
||||||
tcp_err(_pcb, &_tcp_error);
|
tcp_err(_pcb, &_tcp_error);
|
||||||
tcp_poll(_pcb, &_tcp_poll, 1);
|
tcp_poll(_pcb, &_tcp_poll, 1);
|
||||||
|
if(!_allocate_closed_slot()) {
|
||||||
|
_close();
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -674,9 +697,9 @@ void AsyncClient::onPoll(AcConnectHandler cb, void* arg){
|
|||||||
* Main Public Methods
|
* Main Public Methods
|
||||||
* */
|
* */
|
||||||
|
|
||||||
bool AsyncClient::connect(IPAddress ip, uint16_t port){
|
bool AsyncClient::_connect(ip_addr_t addr, uint16_t port){
|
||||||
if (_pcb){
|
if (_pcb){
|
||||||
log_w("already connected, state %d", _pcb->state);
|
log_d("already connected, state %d", _pcb->state);
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
if(!_start_async_task()){
|
if(!_start_async_task()){
|
||||||
@@ -684,11 +707,12 @@ bool AsyncClient::connect(IPAddress ip, uint16_t port){
|
|||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
|
|
||||||
ip_addr_t addr;
|
if(!_allocate_closed_slot()) {
|
||||||
addr.type = IPADDR_TYPE_V4;
|
log_e("failed to allocate: closed slot full");
|
||||||
addr.u_addr.ip4.addr = ip;
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
tcp_pcb* pcb = tcp_new_ip_type(IPADDR_TYPE_V4);
|
tcp_pcb* pcb = tcp_new_ip_type(addr.type);
|
||||||
if (!pcb){
|
if (!pcb){
|
||||||
log_e("pcb == NULL");
|
log_e("pcb == NULL");
|
||||||
return false;
|
return false;
|
||||||
@@ -699,27 +723,59 @@ bool AsyncClient::connect(IPAddress ip, uint16_t port){
|
|||||||
tcp_recv(pcb, &_tcp_recv);
|
tcp_recv(pcb, &_tcp_recv);
|
||||||
tcp_sent(pcb, &_tcp_sent);
|
tcp_sent(pcb, &_tcp_sent);
|
||||||
tcp_poll(pcb, &_tcp_poll, 1);
|
tcp_poll(pcb, &_tcp_poll, 1);
|
||||||
//_tcp_connect(pcb, &addr, port,(tcp_connected_fn)&_s_connected);
|
|
||||||
_tcp_connect(pcb, _closed_slot, &addr, port,(tcp_connected_fn)&_tcp_connected);
|
_tcp_connect(pcb, _closed_slot, &addr, port,(tcp_connected_fn)&_tcp_connected);
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
bool AsyncClient::connect(const IPAddress& ip, uint16_t port){
|
||||||
|
ip_addr_t addr;
|
||||||
|
#if ESP_IDF_VERSION_MAJOR < 5
|
||||||
|
addr.u_addr.ip4.addr = ip;
|
||||||
|
addr.type = IPADDR_TYPE_V4;
|
||||||
|
#else
|
||||||
|
ip.to_ip_addr_t(&addr);
|
||||||
|
#endif
|
||||||
|
|
||||||
|
return _connect(addr, port);
|
||||||
|
}
|
||||||
|
|
||||||
|
#if LWIP_IPV6 && ESP_IDF_VERSION_MAJOR < 5
|
||||||
|
bool AsyncClient::connect(const IPv6Address& ip, uint16_t port){
|
||||||
|
ip_addr_t addr;
|
||||||
|
addr.type = IPADDR_TYPE_V6;
|
||||||
|
memcpy(addr.u_addr.ip6.addr, static_cast<const uint32_t*>(ip), sizeof(uint32_t) * 4);
|
||||||
|
|
||||||
|
return _connect(addr, port);
|
||||||
|
}
|
||||||
|
#endif
|
||||||
|
|
||||||
bool AsyncClient::connect(const char* host, uint16_t port){
|
bool AsyncClient::connect(const char* host, uint16_t port){
|
||||||
ip_addr_t addr;
|
ip_addr_t addr;
|
||||||
|
|
||||||
if(!_start_async_task()){
|
if(!_start_async_task()){
|
||||||
log_e("failed to start task");
|
log_e("failed to start task");
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
|
|
||||||
err_t err = dns_gethostbyname(host, &addr, (dns_found_callback)&_tcp_dns_found, this);
|
err_t err = dns_gethostbyname(host, &addr, (dns_found_callback)&_tcp_dns_found, this);
|
||||||
if(err == ERR_OK) {
|
if(err == ERR_OK) {
|
||||||
|
#if ESP_IDF_VERSION_MAJOR < 5
|
||||||
|
#if LWIP_IPV6
|
||||||
|
if(addr.type == IPADDR_TYPE_V6) {
|
||||||
|
return connect(IPv6Address(addr.u_addr.ip6.addr), port);
|
||||||
|
}
|
||||||
return connect(IPAddress(addr.u_addr.ip4.addr), port);
|
return connect(IPAddress(addr.u_addr.ip4.addr), port);
|
||||||
|
#else
|
||||||
|
return connect(IPAddress(addr.addr), port);
|
||||||
|
#endif
|
||||||
|
#else
|
||||||
|
return _connect(addr, port);
|
||||||
|
#endif
|
||||||
} else if(err == ERR_INPROGRESS) {
|
} else if(err == ERR_INPROGRESS) {
|
||||||
_connect_port = port;
|
_connect_port = port;
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
log_e("error: %d", err);
|
log_d("error: %d", err);
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -763,13 +819,12 @@ size_t AsyncClient::add(const char* data, size_t size, uint8_t apiflags) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
bool AsyncClient::send(){
|
bool AsyncClient::send(){
|
||||||
int8_t err = ERR_OK;
|
auto backup = _tx_last_packet;
|
||||||
err = _tcp_output(_pcb, _closed_slot);
|
_tx_last_packet = millis();
|
||||||
if(err == ERR_OK){
|
if (_tcp_output(_pcb, _closed_slot) == ERR_OK) {
|
||||||
_pcb_busy = true;
|
|
||||||
_pcb_sent_at = millis();
|
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
_tx_last_packet = backup;
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -799,7 +854,6 @@ int8_t AsyncClient::_close(){
|
|||||||
//ets_printf("X: 0x%08x\n", (uint32_t)this);
|
//ets_printf("X: 0x%08x\n", (uint32_t)this);
|
||||||
int8_t err = ERR_OK;
|
int8_t err = ERR_OK;
|
||||||
if(_pcb) {
|
if(_pcb) {
|
||||||
//log_i("");
|
|
||||||
tcp_arg(_pcb, NULL);
|
tcp_arg(_pcb, NULL);
|
||||||
tcp_sent(_pcb, NULL);
|
tcp_sent(_pcb, NULL);
|
||||||
tcp_recv(_pcb, NULL);
|
tcp_recv(_pcb, NULL);
|
||||||
@@ -810,6 +864,7 @@ int8_t AsyncClient::_close(){
|
|||||||
if(err != ERR_OK) {
|
if(err != ERR_OK) {
|
||||||
err = abort();
|
err = abort();
|
||||||
}
|
}
|
||||||
|
_free_closed_slot();
|
||||||
_pcb = NULL;
|
_pcb = NULL;
|
||||||
if(_discard_cb) {
|
if(_discard_cb) {
|
||||||
_discard_cb(_discard_cb_arg, this);
|
_discard_cb(_discard_cb_arg, this);
|
||||||
@@ -818,7 +873,10 @@ int8_t AsyncClient::_close(){
|
|||||||
return err;
|
return err;
|
||||||
}
|
}
|
||||||
|
|
||||||
void AsyncClient::_allocate_closed_slot(){
|
bool AsyncClient::_allocate_closed_slot(){
|
||||||
|
if (_closed_slot != -1) {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
xSemaphoreTake(_slots_lock, portMAX_DELAY);
|
xSemaphoreTake(_slots_lock, portMAX_DELAY);
|
||||||
uint32_t closed_slot_min_index = 0;
|
uint32_t closed_slot_min_index = 0;
|
||||||
for (int i = 0; i < _number_of_closed_slots; ++ i) {
|
for (int i = 0; i < _number_of_closed_slots; ++ i) {
|
||||||
@@ -831,28 +889,27 @@ void AsyncClient::_allocate_closed_slot(){
|
|||||||
_closed_slots[_closed_slot] = 0;
|
_closed_slots[_closed_slot] = 0;
|
||||||
}
|
}
|
||||||
xSemaphoreGive(_slots_lock);
|
xSemaphoreGive(_slots_lock);
|
||||||
|
return (_closed_slot != -1);
|
||||||
}
|
}
|
||||||
|
|
||||||
void AsyncClient::_free_closed_slot(){
|
void AsyncClient::_free_closed_slot(){
|
||||||
|
xSemaphoreTake(_slots_lock, portMAX_DELAY);
|
||||||
if (_closed_slot != -1) {
|
if (_closed_slot != -1) {
|
||||||
_closed_slots[_closed_slot] = _closed_index;
|
_closed_slots[_closed_slot] = _closed_index;
|
||||||
_closed_slot = -1;
|
_closed_slot = -1;
|
||||||
++ _closed_index;
|
++ _closed_index;
|
||||||
}
|
}
|
||||||
|
xSemaphoreGive(_slots_lock);
|
||||||
}
|
}
|
||||||
|
|
||||||
/*
|
/*
|
||||||
* Private Callbacks
|
* Private Callbacks
|
||||||
* */
|
* */
|
||||||
|
|
||||||
int8_t AsyncClient::_connected(void* pcb, int8_t err){
|
int8_t AsyncClient::_connected(tcp_pcb* pcb, int8_t err){
|
||||||
_pcb = reinterpret_cast<tcp_pcb*>(pcb);
|
_pcb = reinterpret_cast<tcp_pcb*>(pcb);
|
||||||
if(_pcb){
|
if(_pcb){
|
||||||
_rx_last_packet = millis();
|
_rx_last_packet = millis();
|
||||||
_pcb_busy = false;
|
|
||||||
// tcp_recv(_pcb, &_tcp_recv);
|
|
||||||
// tcp_sent(_pcb, &_tcp_sent);
|
|
||||||
// tcp_poll(_pcb, &_tcp_poll, 1);
|
|
||||||
}
|
}
|
||||||
if(_connect_cb) {
|
if(_connect_cb) {
|
||||||
_connect_cb(_connect_cb_arg, this);
|
_connect_cb(_connect_cb_arg, this);
|
||||||
@@ -869,6 +926,7 @@ void AsyncClient::_error(int8_t err) {
|
|||||||
tcp_err(_pcb, NULL);
|
tcp_err(_pcb, NULL);
|
||||||
tcp_poll(_pcb, NULL, 0);
|
tcp_poll(_pcb, NULL, 0);
|
||||||
}
|
}
|
||||||
|
_free_closed_slot();
|
||||||
_pcb = NULL;
|
_pcb = NULL;
|
||||||
}
|
}
|
||||||
if(_error_cb) {
|
if(_error_cb) {
|
||||||
@@ -882,7 +940,7 @@ void AsyncClient::_error(int8_t err) {
|
|||||||
//In LwIP Thread
|
//In LwIP Thread
|
||||||
int8_t AsyncClient::_lwip_fin(tcp_pcb* pcb, int8_t err) {
|
int8_t AsyncClient::_lwip_fin(tcp_pcb* pcb, int8_t err) {
|
||||||
if(!_pcb || pcb != _pcb){
|
if(!_pcb || pcb != _pcb){
|
||||||
log_e("0x%08x != 0x%08x", (uint32_t)pcb, (uint32_t)_pcb);
|
log_d("0x%08x != 0x%08x", (uint32_t)pcb, (uint32_t)_pcb);
|
||||||
return ERR_OK;
|
return ERR_OK;
|
||||||
}
|
}
|
||||||
tcp_arg(_pcb, NULL);
|
tcp_arg(_pcb, NULL);
|
||||||
@@ -910,23 +968,27 @@ int8_t AsyncClient::_fin(tcp_pcb* pcb, int8_t err) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
int8_t AsyncClient::_sent(tcp_pcb* pcb, uint16_t len) {
|
int8_t AsyncClient::_sent(tcp_pcb* pcb, uint16_t len) {
|
||||||
_rx_last_packet = millis();
|
_rx_last_ack = _rx_last_packet = millis();
|
||||||
//log_i("%u", len);
|
|
||||||
_pcb_busy = false;
|
|
||||||
if(_sent_cb) {
|
if(_sent_cb) {
|
||||||
_sent_cb(_sent_cb_arg, this, len, (millis() - _pcb_sent_at));
|
_sent_cb(_sent_cb_arg, this, len, (_rx_last_packet - _tx_last_packet));
|
||||||
}
|
}
|
||||||
return ERR_OK;
|
return ERR_OK;
|
||||||
}
|
}
|
||||||
|
|
||||||
int8_t AsyncClient::_recv(tcp_pcb* pcb, pbuf* pb, int8_t err) {
|
int8_t AsyncClient::_recv(tcp_pcb* pcb, pbuf* pb, int8_t err) {
|
||||||
while(pb != NULL) {
|
if(!_pcb || pcb != _pcb){
|
||||||
|
log_d("0x%08x != 0x%08x", (uint32_t)pcb, (uint32_t)_pcb);
|
||||||
|
return ERR_OK;
|
||||||
|
}
|
||||||
|
size_t total = 0;
|
||||||
|
while((pb != NULL) && (ERR_OK == err)) {
|
||||||
_rx_last_packet = millis();
|
_rx_last_packet = millis();
|
||||||
//we should not ack before we assimilate the data
|
//we should not ack before we assimilate the data
|
||||||
_ack_pcb = true;
|
_ack_pcb = true;
|
||||||
pbuf *b = pb;
|
pbuf *b = pb;
|
||||||
pb = b->next;
|
pb = b->next;
|
||||||
b->next = NULL;
|
b->next = NULL;
|
||||||
|
total += b->len;
|
||||||
if(_pb_cb){
|
if(_pb_cb){
|
||||||
_pb_cb(_pb_cb_arg, this, b);
|
_pb_cb(_pb_cb_arg, this, b);
|
||||||
} else {
|
} else {
|
||||||
@@ -935,38 +997,39 @@ int8_t AsyncClient::_recv(tcp_pcb* pcb, pbuf* pb, int8_t err) {
|
|||||||
}
|
}
|
||||||
if(!_ack_pcb) {
|
if(!_ack_pcb) {
|
||||||
_rx_ack_len += b->len;
|
_rx_ack_len += b->len;
|
||||||
} else if(_pcb) {
|
|
||||||
_tcp_recved(_pcb, _closed_slot, b->len);
|
|
||||||
}
|
}
|
||||||
pbuf_free(b);
|
|
||||||
}
|
}
|
||||||
|
pbuf_free(b);
|
||||||
}
|
}
|
||||||
return ERR_OK;
|
return _tcp_recved(pcb, _closed_slot, total);
|
||||||
}
|
}
|
||||||
|
|
||||||
int8_t AsyncClient::_poll(tcp_pcb* pcb){
|
int8_t AsyncClient::_poll(tcp_pcb* pcb){
|
||||||
if(!_pcb){
|
if(!_pcb){
|
||||||
log_w("pcb is NULL");
|
log_d("pcb is NULL");
|
||||||
return ERR_OK;
|
return ERR_OK;
|
||||||
}
|
}
|
||||||
if(pcb != _pcb){
|
if(pcb != _pcb){
|
||||||
log_e("0x%08x != 0x%08x", (uint32_t)pcb, (uint32_t)_pcb);
|
log_d("0x%08x != 0x%08x", (uint32_t)pcb, (uint32_t)_pcb);
|
||||||
return ERR_OK;
|
return ERR_OK;
|
||||||
}
|
}
|
||||||
|
|
||||||
uint32_t now = millis();
|
uint32_t now = millis();
|
||||||
|
|
||||||
// ACK Timeout
|
// ACK Timeout
|
||||||
if(_pcb_busy && _ack_timeout && (now - _pcb_sent_at) >= _ack_timeout){
|
if(_ack_timeout){
|
||||||
_pcb_busy = false;
|
const uint32_t one_day = 86400000;
|
||||||
log_w("ack timeout %d", pcb->state);
|
bool last_tx_is_after_last_ack = (_rx_last_ack - _tx_last_packet + one_day) < one_day;
|
||||||
if(_timeout_cb)
|
if(last_tx_is_after_last_ack && (now - _tx_last_packet) >= _ack_timeout) {
|
||||||
_timeout_cb(_timeout_cb_arg, this, (now - _pcb_sent_at));
|
log_d("ack timeout %d", pcb->state);
|
||||||
return ERR_OK;
|
if(_timeout_cb)
|
||||||
|
_timeout_cb(_timeout_cb_arg, this, (now - _tx_last_packet));
|
||||||
|
return ERR_OK;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
// RX Timeout
|
// RX Timeout
|
||||||
if(_rx_since_timeout && (now - _rx_last_packet) >= (_rx_since_timeout * 1000)){
|
if(_rx_timeout && (now - _rx_last_packet) >= (_rx_timeout * 1000)) {
|
||||||
log_w("rx timeout %d", pcb->state);
|
log_d("rx timeout %d", pcb->state);
|
||||||
_close();
|
_close();
|
||||||
return ERR_OK;
|
return ERR_OK;
|
||||||
}
|
}
|
||||||
@@ -978,8 +1041,19 @@ int8_t AsyncClient::_poll(tcp_pcb* pcb){
|
|||||||
}
|
}
|
||||||
|
|
||||||
void AsyncClient::_dns_found(struct ip_addr *ipaddr){
|
void AsyncClient::_dns_found(struct ip_addr *ipaddr){
|
||||||
if(ipaddr && ipaddr->u_addr.ip4.addr){
|
#if ESP_IDF_VERSION_MAJOR < 5
|
||||||
connect(IPAddress(ipaddr->u_addr.ip4.addr), _connect_port);
|
if(ipaddr && IP_IS_V4(ipaddr)){
|
||||||
|
connect(IPAddress(ip_addr_get_ip4_u32(ipaddr)), _connect_port);
|
||||||
|
#if LWIP_IPV6
|
||||||
|
} else if(ipaddr && ipaddr->u_addr.ip6.addr){
|
||||||
|
connect(IPv6Address(ipaddr->u_addr.ip6.addr), _connect_port);
|
||||||
|
#endif
|
||||||
|
#else
|
||||||
|
if(ipaddr) {
|
||||||
|
IPAddress ip;
|
||||||
|
ip.from_ip_addr_t(ipaddr);
|
||||||
|
connect(ip, _connect_port);
|
||||||
|
#endif
|
||||||
} else {
|
} else {
|
||||||
if(_error_cb) {
|
if(_error_cb) {
|
||||||
_error_cb(_error_cb_arg, this, -55);
|
_error_cb(_error_cb_arg, this, -55);
|
||||||
@@ -1017,18 +1091,21 @@ size_t AsyncClient::write(const char* data) {
|
|||||||
|
|
||||||
size_t AsyncClient::write(const char* data, size_t size, uint8_t apiflags) {
|
size_t AsyncClient::write(const char* data, size_t size, uint8_t apiflags) {
|
||||||
size_t will_send = add(data, size, apiflags);
|
size_t will_send = add(data, size, apiflags);
|
||||||
if(!will_send || !send()) {
|
if(!will_send) {
|
||||||
return 0;
|
return 0;
|
||||||
}
|
}
|
||||||
|
while (connected() && !send()) {
|
||||||
|
taskYIELD();
|
||||||
|
}
|
||||||
return will_send;
|
return will_send;
|
||||||
}
|
}
|
||||||
|
|
||||||
void AsyncClient::setRxTimeout(uint32_t timeout){
|
void AsyncClient::setRxTimeout(uint32_t timeout){
|
||||||
_rx_since_timeout = timeout;
|
_rx_timeout = timeout;
|
||||||
}
|
}
|
||||||
|
|
||||||
uint32_t AsyncClient::getRxTimeout(){
|
uint32_t AsyncClient::getRxTimeout(){
|
||||||
return _rx_since_timeout;
|
return _rx_timeout;
|
||||||
}
|
}
|
||||||
|
|
||||||
uint32_t AsyncClient::getAckTimeout(){
|
uint32_t AsyncClient::getAckTimeout(){
|
||||||
@@ -1057,6 +1134,18 @@ bool AsyncClient::getNoDelay(){
|
|||||||
return tcp_nagle_disabled(_pcb);
|
return tcp_nagle_disabled(_pcb);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
void AsyncClient::setKeepAlive(uint32_t ms, uint8_t cnt){
|
||||||
|
if(ms!=0) {
|
||||||
|
_pcb->so_options |= SOF_KEEPALIVE; //Turn on TCP Keepalive for the given pcb
|
||||||
|
// Set the time between keepalive messages in milli-seconds
|
||||||
|
_pcb->keep_idle = ms;
|
||||||
|
_pcb->keep_intvl = ms;
|
||||||
|
_pcb->keep_cnt = cnt; //The number of unanswered probes required to force closure of the socket
|
||||||
|
} else {
|
||||||
|
_pcb->so_options &= ~SOF_KEEPALIVE; //Turn off TCP Keepalive for the given pcb
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
uint16_t AsyncClient::getMss(){
|
uint16_t AsyncClient::getMss(){
|
||||||
if(!_pcb) {
|
if(!_pcb) {
|
||||||
return 0;
|
return 0;
|
||||||
@@ -1068,9 +1157,60 @@ uint32_t AsyncClient::getRemoteAddress() {
|
|||||||
if(!_pcb) {
|
if(!_pcb) {
|
||||||
return 0;
|
return 0;
|
||||||
}
|
}
|
||||||
|
#if LWIP_IPV4 && LWIP_IPV6
|
||||||
return _pcb->remote_ip.u_addr.ip4.addr;
|
return _pcb->remote_ip.u_addr.ip4.addr;
|
||||||
|
#else
|
||||||
|
return _pcb->remote_ip.addr;
|
||||||
|
#endif
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#if LWIP_IPV6
|
||||||
|
ip6_addr_t AsyncClient::getRemoteAddress6() {
|
||||||
|
if(!_pcb) {
|
||||||
|
ip6_addr_t nulladdr;
|
||||||
|
ip6_addr_set_zero(&nulladdr);
|
||||||
|
return nulladdr;
|
||||||
|
}
|
||||||
|
return _pcb->remote_ip.u_addr.ip6;
|
||||||
|
}
|
||||||
|
|
||||||
|
ip6_addr_t AsyncClient::getLocalAddress6() {
|
||||||
|
if(!_pcb) {
|
||||||
|
ip6_addr_t nulladdr;
|
||||||
|
ip6_addr_set_zero(&nulladdr);
|
||||||
|
return nulladdr;
|
||||||
|
}
|
||||||
|
return _pcb->local_ip.u_addr.ip6;
|
||||||
|
}
|
||||||
|
#if ESP_IDF_VERSION_MAJOR < 5
|
||||||
|
IPv6Address AsyncClient::remoteIP6() {
|
||||||
|
return IPv6Address(getRemoteAddress6().addr);
|
||||||
|
}
|
||||||
|
|
||||||
|
IPv6Address AsyncClient::localIP6() {
|
||||||
|
return IPv6Address(getLocalAddress6().addr);
|
||||||
|
}
|
||||||
|
#else
|
||||||
|
IPAddress AsyncClient::remoteIP6() {
|
||||||
|
if (!_pcb) {
|
||||||
|
return IPAddress(IPType::IPv6);
|
||||||
|
}
|
||||||
|
IPAddress ip;
|
||||||
|
ip.from_ip_addr_t(&(_pcb->remote_ip));
|
||||||
|
return ip;
|
||||||
|
}
|
||||||
|
|
||||||
|
IPAddress AsyncClient::localIP6() {
|
||||||
|
if (!_pcb) {
|
||||||
|
return IPAddress(IPType::IPv6);
|
||||||
|
}
|
||||||
|
IPAddress ip;
|
||||||
|
ip.from_ip_addr_t(&(_pcb->local_ip));
|
||||||
|
return ip;
|
||||||
|
}
|
||||||
|
#endif
|
||||||
|
#endif
|
||||||
|
|
||||||
uint16_t AsyncClient::getRemotePort() {
|
uint16_t AsyncClient::getRemotePort() {
|
||||||
if(!_pcb) {
|
if(!_pcb) {
|
||||||
return 0;
|
return 0;
|
||||||
@@ -1082,7 +1222,11 @@ uint32_t AsyncClient::getLocalAddress() {
|
|||||||
if(!_pcb) {
|
if(!_pcb) {
|
||||||
return 0;
|
return 0;
|
||||||
}
|
}
|
||||||
|
#if LWIP_IPV4 && LWIP_IPV6
|
||||||
return _pcb->local_ip.u_addr.ip4.addr;
|
return _pcb->local_ip.u_addr.ip4.addr;
|
||||||
|
#else
|
||||||
|
return _pcb->local_ip.addr;
|
||||||
|
#endif
|
||||||
}
|
}
|
||||||
|
|
||||||
uint16_t AsyncClient::getLocalPort() {
|
uint16_t AsyncClient::getLocalPort() {
|
||||||
@@ -1093,7 +1237,16 @@ uint16_t AsyncClient::getLocalPort() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
IPAddress AsyncClient::remoteIP() {
|
IPAddress AsyncClient::remoteIP() {
|
||||||
|
#if ESP_IDF_VERSION_MAJOR < 5
|
||||||
return IPAddress(getRemoteAddress());
|
return IPAddress(getRemoteAddress());
|
||||||
|
#else
|
||||||
|
if (!_pcb) {
|
||||||
|
return IPAddress();
|
||||||
|
}
|
||||||
|
IPAddress ip;
|
||||||
|
ip.from_ip_addr_t(&(_pcb->remote_ip));
|
||||||
|
return ip;
|
||||||
|
#endif
|
||||||
}
|
}
|
||||||
|
|
||||||
uint16_t AsyncClient::remotePort() {
|
uint16_t AsyncClient::remotePort() {
|
||||||
@@ -1101,9 +1254,19 @@ uint16_t AsyncClient::remotePort() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
IPAddress AsyncClient::localIP() {
|
IPAddress AsyncClient::localIP() {
|
||||||
|
#if ESP_IDF_VERSION_MAJOR < 5
|
||||||
return IPAddress(getLocalAddress());
|
return IPAddress(getLocalAddress());
|
||||||
|
#else
|
||||||
|
if (!_pcb) {
|
||||||
|
return IPAddress();
|
||||||
|
}
|
||||||
|
IPAddress ip;
|
||||||
|
ip.from_ip_addr_t(&(_pcb->local_ip));
|
||||||
|
return ip;
|
||||||
|
#endif
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
uint16_t AsyncClient::localPort() {
|
uint16_t AsyncClient::localPort() {
|
||||||
return getLocalPort();
|
return getLocalPort();
|
||||||
}
|
}
|
||||||
@@ -1226,7 +1389,7 @@ void AsyncClient::_s_error(void * arg, int8_t err) {
|
|||||||
reinterpret_cast<AsyncClient*>(arg)->_error(err);
|
reinterpret_cast<AsyncClient*>(arg)->_error(err);
|
||||||
}
|
}
|
||||||
|
|
||||||
int8_t AsyncClient::_s_connected(void * arg, void * pcb, int8_t err){
|
int8_t AsyncClient::_s_connected(void * arg, struct tcp_pcb * pcb, int8_t err){
|
||||||
return reinterpret_cast<AsyncClient*>(arg)->_connected(pcb, err);
|
return reinterpret_cast<AsyncClient*>(arg)->_connected(pcb, err);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -1236,6 +1399,13 @@ int8_t AsyncClient::_s_connected(void * arg, void * pcb, int8_t err){
|
|||||||
|
|
||||||
AsyncServer::AsyncServer(IPAddress addr, uint16_t port)
|
AsyncServer::AsyncServer(IPAddress addr, uint16_t port)
|
||||||
: _port(port)
|
: _port(port)
|
||||||
|
#if ESP_IDF_VERSION_MAJOR < 5
|
||||||
|
, _bind4(true)
|
||||||
|
, _bind6(false)
|
||||||
|
#else
|
||||||
|
, _bind4(addr.type() != IPType::IPv6)
|
||||||
|
, _bind6(addr.type() == IPType::IPv6)
|
||||||
|
#endif
|
||||||
, _addr(addr)
|
, _addr(addr)
|
||||||
, _noDelay(false)
|
, _noDelay(false)
|
||||||
, _pcb(0)
|
, _pcb(0)
|
||||||
@@ -1243,9 +1413,27 @@ AsyncServer::AsyncServer(IPAddress addr, uint16_t port)
|
|||||||
, _connect_cb_arg(0)
|
, _connect_cb_arg(0)
|
||||||
{}
|
{}
|
||||||
|
|
||||||
|
#if ESP_IDF_VERSION_MAJOR < 5
|
||||||
|
AsyncServer::AsyncServer(IPv6Address addr, uint16_t port)
|
||||||
|
: _port(port)
|
||||||
|
, _bind4(false)
|
||||||
|
, _bind6(true)
|
||||||
|
, _addr6(addr)
|
||||||
|
, _noDelay(false)
|
||||||
|
, _pcb(0)
|
||||||
|
, _connect_cb(0)
|
||||||
|
, _connect_cb_arg(0)
|
||||||
|
{}
|
||||||
|
#endif
|
||||||
|
|
||||||
AsyncServer::AsyncServer(uint16_t port)
|
AsyncServer::AsyncServer(uint16_t port)
|
||||||
: _port(port)
|
: _port(port)
|
||||||
|
, _bind4(true)
|
||||||
|
, _bind6(false)
|
||||||
, _addr((uint32_t) IPADDR_ANY)
|
, _addr((uint32_t) IPADDR_ANY)
|
||||||
|
#if ESP_IDF_VERSION_MAJOR < 5
|
||||||
|
, _addr6()
|
||||||
|
#endif
|
||||||
, _noDelay(false)
|
, _noDelay(false)
|
||||||
, _pcb(0)
|
, _pcb(0)
|
||||||
, _connect_cb(0)
|
, _connect_cb(0)
|
||||||
@@ -1271,15 +1459,24 @@ void AsyncServer::begin(){
|
|||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
int8_t err;
|
int8_t err;
|
||||||
_pcb = tcp_new_ip_type(IPADDR_TYPE_V4);
|
_pcb = tcp_new_ip_type(_bind4 && _bind6 ? IPADDR_TYPE_ANY : (_bind6 ? IPADDR_TYPE_V6 : IPADDR_TYPE_V4));
|
||||||
if (!_pcb){
|
if (!_pcb){
|
||||||
log_e("_pcb == NULL");
|
log_e("_pcb == NULL");
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
ip_addr_t local_addr;
|
ip_addr_t local_addr;
|
||||||
local_addr.type = IPADDR_TYPE_V4;
|
#if ESP_IDF_VERSION_MAJOR < 5
|
||||||
local_addr.u_addr.ip4.addr = (uint32_t) _addr;
|
if (_bind6) { // _bind6 && _bind4 both at the same time is not supported on Arduino 2 in this lib API
|
||||||
|
local_addr.type = IPADDR_TYPE_V6;
|
||||||
|
memcpy(local_addr.u_addr.ip6.addr, static_cast<const uint32_t*>(_addr6), sizeof(uint32_t) * 4);
|
||||||
|
} else {
|
||||||
|
local_addr.type = IPADDR_TYPE_V4;
|
||||||
|
local_addr.u_addr.ip4.addr = _addr;
|
||||||
|
}
|
||||||
|
#else
|
||||||
|
_addr.to_ip_addr_t(&local_addr);
|
||||||
|
#endif
|
||||||
err = _tcp_bind(_pcb, &local_addr, _port);
|
err = _tcp_bind(_pcb, &local_addr, _port);
|
||||||
|
|
||||||
if (err != ERR_OK) {
|
if (err != ERR_OK) {
|
||||||
@@ -1322,7 +1519,7 @@ int8_t AsyncServer::_accept(tcp_pcb* pcb, int8_t err){
|
|||||||
if(tcp_close(pcb) != ERR_OK){
|
if(tcp_close(pcb) != ERR_OK){
|
||||||
tcp_abort(pcb);
|
tcp_abort(pcb);
|
||||||
}
|
}
|
||||||
log_e("FAIL");
|
log_d("FAIL");
|
||||||
return ERR_OK;
|
return ERR_OK;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -22,13 +22,34 @@
|
|||||||
#ifndef ASYNCTCP_H_
|
#ifndef ASYNCTCP_H_
|
||||||
#define ASYNCTCP_H_
|
#define ASYNCTCP_H_
|
||||||
|
|
||||||
|
#define ASYNCTCP_VERSION "3.1.4"
|
||||||
|
#define ASYNCTCP_VERSION_MAJOR 3
|
||||||
|
#define ASYNCTCP_VERSION_MINOR 1
|
||||||
|
#define ASYNCTCP_VERSION_REVISION 4
|
||||||
|
#define ASYNCTCP_FORK_mathieucarbou
|
||||||
|
|
||||||
#include "IPAddress.h"
|
#include "IPAddress.h"
|
||||||
#include "sdkconfig.h"
|
#if ESP_IDF_VERSION_MAJOR < 5
|
||||||
|
#include "IPv6Address.h"
|
||||||
|
#endif
|
||||||
#include <functional>
|
#include <functional>
|
||||||
|
#include "lwip/ip_addr.h"
|
||||||
|
#include "lwip/ip6_addr.h"
|
||||||
|
|
||||||
|
#ifndef LIBRETINY
|
||||||
|
#include "sdkconfig.h"
|
||||||
extern "C" {
|
extern "C" {
|
||||||
#include "freertos/semphr.h"
|
#include "freertos/semphr.h"
|
||||||
#include "lwip/pbuf.h"
|
#include "lwip/pbuf.h"
|
||||||
}
|
}
|
||||||
|
#else
|
||||||
|
extern "C" {
|
||||||
|
#include <semphr.h>
|
||||||
|
#include <lwip/pbuf.h>
|
||||||
|
}
|
||||||
|
#define CONFIG_ASYNC_TCP_RUNNING_CORE -1 //any available core
|
||||||
|
#define CONFIG_ASYNC_TCP_USE_WDT 0
|
||||||
|
#endif
|
||||||
|
|
||||||
//If core is not defined, then we are running in Arduino or PIO
|
//If core is not defined, then we are running in Arduino or PIO
|
||||||
#ifndef CONFIG_ASYNC_TCP_RUNNING_CORE
|
#ifndef CONFIG_ASYNC_TCP_RUNNING_CORE
|
||||||
@@ -36,9 +57,24 @@ extern "C" {
|
|||||||
#define CONFIG_ASYNC_TCP_USE_WDT 1 //if enabled, adds between 33us and 200us per event
|
#define CONFIG_ASYNC_TCP_USE_WDT 1 //if enabled, adds between 33us and 200us per event
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
|
#ifndef CONFIG_ASYNC_TCP_STACK_SIZE
|
||||||
|
#define CONFIG_ASYNC_TCP_STACK_SIZE 8192 * 2
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#ifndef CONFIG_ASYNC_TCP_PRIORITY
|
||||||
|
#define CONFIG_ASYNC_TCP_PRIORITY 10
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#ifndef CONFIG_ASYNC_TCP_QUEUE_SIZE
|
||||||
|
#define CONFIG_ASYNC_TCP_QUEUE_SIZE 64
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#ifndef CONFIG_ASYNC_TCP_MAX_ACK_TIME
|
||||||
|
#define CONFIG_ASYNC_TCP_MAX_ACK_TIME 5000
|
||||||
|
#endif
|
||||||
|
|
||||||
class AsyncClient;
|
class AsyncClient;
|
||||||
|
|
||||||
#define ASYNC_MAX_ACK_TIME 5000
|
|
||||||
#define ASYNC_WRITE_FLAG_COPY 0x01 //will allocate new buffer to hold the data while sending (else will hold reference to the data given)
|
#define ASYNC_WRITE_FLAG_COPY 0x01 //will allocate new buffer to hold the data while sending (else will hold reference to the data given)
|
||||||
#define ASYNC_WRITE_FLAG_MORE 0x02 //will not send PSH flag, meaning that there should be more data to be sent before the application should react.
|
#define ASYNC_WRITE_FLAG_MORE 0x02 //will not send PSH flag, meaning that there should be more data to be sent before the application should react.
|
||||||
|
|
||||||
@@ -65,8 +101,11 @@ class AsyncClient {
|
|||||||
bool operator!=(const AsyncClient &other) {
|
bool operator!=(const AsyncClient &other) {
|
||||||
return !(*this == other);
|
return !(*this == other);
|
||||||
}
|
}
|
||||||
bool connect(IPAddress ip, uint16_t port);
|
bool connect(const IPAddress& ip, uint16_t port);
|
||||||
bool connect(const char* host, uint16_t port);
|
#if ESP_IDF_VERSION_MAJOR < 5
|
||||||
|
bool connect(const IPv6Address& ip, uint16_t port);
|
||||||
|
#endif
|
||||||
|
bool connect(const char *host, uint16_t port);
|
||||||
void close(bool now = false);
|
void close(bool now = false);
|
||||||
void stop();
|
void stop();
|
||||||
int8_t abort();
|
int8_t abort();
|
||||||
@@ -99,16 +138,29 @@ class AsyncClient {
|
|||||||
void setNoDelay(bool nodelay);
|
void setNoDelay(bool nodelay);
|
||||||
bool getNoDelay();
|
bool getNoDelay();
|
||||||
|
|
||||||
|
void setKeepAlive(uint32_t ms, uint8_t cnt);
|
||||||
|
|
||||||
uint32_t getRemoteAddress();
|
uint32_t getRemoteAddress();
|
||||||
uint16_t getRemotePort();
|
uint16_t getRemotePort();
|
||||||
uint32_t getLocalAddress();
|
uint32_t getLocalAddress();
|
||||||
uint16_t getLocalPort();
|
uint16_t getLocalPort();
|
||||||
|
#if LWIP_IPV6
|
||||||
|
ip6_addr_t getRemoteAddress6();
|
||||||
|
ip6_addr_t getLocalAddress6();
|
||||||
|
#if ESP_IDF_VERSION_MAJOR < 5
|
||||||
|
IPv6Address remoteIP6();
|
||||||
|
IPv6Address localIP6();
|
||||||
|
#else
|
||||||
|
IPAddress remoteIP6();
|
||||||
|
IPAddress localIP6();
|
||||||
|
#endif
|
||||||
|
#endif
|
||||||
|
|
||||||
//compatibility
|
//compatibility
|
||||||
IPAddress remoteIP();
|
IPAddress remoteIP();
|
||||||
uint16_t remotePort();
|
uint16_t remotePort();
|
||||||
IPAddress localIP();
|
IPAddress localIP();
|
||||||
uint16_t localPort();
|
uint16_t localPort();
|
||||||
|
|
||||||
void onConnect(AcConnectHandler cb, void* arg = 0); //on successful connect
|
void onConnect(AcConnectHandler cb, void* arg = 0); //on successful connect
|
||||||
void onDisconnect(AcConnectHandler cb, void* arg = 0); //disconnected
|
void onDisconnect(AcConnectHandler cb, void* arg = 0); //disconnected
|
||||||
@@ -133,13 +185,15 @@ class AsyncClient {
|
|||||||
static int8_t _s_lwip_fin(void *arg, struct tcp_pcb *tpcb, int8_t err);
|
static int8_t _s_lwip_fin(void *arg, struct tcp_pcb *tpcb, int8_t err);
|
||||||
static void _s_error(void *arg, int8_t err);
|
static void _s_error(void *arg, int8_t err);
|
||||||
static int8_t _s_sent(void *arg, struct tcp_pcb *tpcb, uint16_t len);
|
static int8_t _s_sent(void *arg, struct tcp_pcb *tpcb, uint16_t len);
|
||||||
static int8_t _s_connected(void* arg, void* tpcb, int8_t err);
|
static int8_t _s_connected(void* arg, struct tcp_pcb *tpcb, int8_t err);
|
||||||
static void _s_dns_found(const char *name, struct ip_addr *ipaddr, void *arg);
|
static void _s_dns_found(const char *name, struct ip_addr *ipaddr, void *arg);
|
||||||
|
|
||||||
int8_t _recv(tcp_pcb* pcb, pbuf* pb, int8_t err);
|
int8_t _recv(tcp_pcb* pcb, pbuf* pb, int8_t err);
|
||||||
tcp_pcb * pcb(){ return _pcb; }
|
tcp_pcb * pcb(){ return _pcb; }
|
||||||
|
|
||||||
protected:
|
protected:
|
||||||
|
bool _connect(ip_addr_t addr, uint16_t port);
|
||||||
|
|
||||||
tcp_pcb* _pcb;
|
tcp_pcb* _pcb;
|
||||||
int8_t _closed_slot;
|
int8_t _closed_slot;
|
||||||
|
|
||||||
@@ -160,19 +214,19 @@ class AsyncClient {
|
|||||||
AcConnectHandler _poll_cb;
|
AcConnectHandler _poll_cb;
|
||||||
void* _poll_cb_arg;
|
void* _poll_cb_arg;
|
||||||
|
|
||||||
bool _pcb_busy;
|
|
||||||
uint32_t _pcb_sent_at;
|
|
||||||
bool _ack_pcb;
|
bool _ack_pcb;
|
||||||
|
uint32_t _tx_last_packet;
|
||||||
uint32_t _rx_ack_len;
|
uint32_t _rx_ack_len;
|
||||||
uint32_t _rx_last_packet;
|
uint32_t _rx_last_packet;
|
||||||
uint32_t _rx_since_timeout;
|
uint32_t _rx_timeout;
|
||||||
|
uint32_t _rx_last_ack;
|
||||||
uint32_t _ack_timeout;
|
uint32_t _ack_timeout;
|
||||||
uint16_t _connect_port;
|
uint16_t _connect_port;
|
||||||
|
|
||||||
int8_t _close();
|
int8_t _close();
|
||||||
void _free_closed_slot();
|
void _free_closed_slot();
|
||||||
void _allocate_closed_slot();
|
bool _allocate_closed_slot();
|
||||||
int8_t _connected(void* pcb, int8_t err);
|
int8_t _connected(tcp_pcb* pcb, int8_t err);
|
||||||
void _error(int8_t err);
|
void _error(int8_t err);
|
||||||
int8_t _poll(tcp_pcb* pcb);
|
int8_t _poll(tcp_pcb* pcb);
|
||||||
int8_t _sent(tcp_pcb* pcb, uint16_t len);
|
int8_t _sent(tcp_pcb* pcb, uint16_t len);
|
||||||
@@ -188,6 +242,9 @@ class AsyncClient {
|
|||||||
class AsyncServer {
|
class AsyncServer {
|
||||||
public:
|
public:
|
||||||
AsyncServer(IPAddress addr, uint16_t port);
|
AsyncServer(IPAddress addr, uint16_t port);
|
||||||
|
#if ESP_IDF_VERSION_MAJOR < 5
|
||||||
|
AsyncServer(IPv6Address addr, uint16_t port);
|
||||||
|
#endif
|
||||||
AsyncServer(uint16_t port);
|
AsyncServer(uint16_t port);
|
||||||
~AsyncServer();
|
~AsyncServer();
|
||||||
void onClient(AcConnectHandler cb, void* arg);
|
void onClient(AcConnectHandler cb, void* arg);
|
||||||
@@ -203,7 +260,12 @@ class AsyncServer {
|
|||||||
|
|
||||||
protected:
|
protected:
|
||||||
uint16_t _port;
|
uint16_t _port;
|
||||||
|
bool _bind4 = false;
|
||||||
|
bool _bind6 = false;
|
||||||
IPAddress _addr;
|
IPAddress _addr;
|
||||||
|
#if ESP_IDF_VERSION_MAJOR < 5
|
||||||
|
IPv6Address _addr6;
|
||||||
|
#endif
|
||||||
bool _noDelay;
|
bool _noDelay;
|
||||||
tcp_pcb* _pcb;
|
tcp_pcb* _pcb;
|
||||||
AcConnectHandler _connect_cb;
|
AcConnectHandler _connect_cb;
|
||||||
|
|||||||
@@ -1,90 +0,0 @@
|
|||||||
/*
|
|
||||||
IPv6Address.cpp - Base class that provides IPv6Address
|
|
||||||
Copyright (c) 2011 Adrian McEwen. All right reserved.
|
|
||||||
|
|
||||||
This library is free software; you can redistribute it and/or
|
|
||||||
modify it under the terms of the GNU Lesser General Public
|
|
||||||
License as published by the Free Software Foundation; either
|
|
||||||
version 2.1 of the License, or (at your option) any later version.
|
|
||||||
|
|
||||||
This library is distributed in the hope that it will be useful,
|
|
||||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
||||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
||||||
Lesser General Public License for more details.
|
|
||||||
|
|
||||||
You should have received a copy of the GNU Lesser General Public
|
|
||||||
License along with this library; if not, write to the Free Software
|
|
||||||
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
|
|
||||||
*/
|
|
||||||
|
|
||||||
#include <Arduino.h>
|
|
||||||
#include <IPv6Address.h>
|
|
||||||
#include <Print.h>
|
|
||||||
|
|
||||||
IPv6Address::IPv6Address()
|
|
||||||
{
|
|
||||||
memset(_address.bytes, 0, sizeof(_address.bytes));
|
|
||||||
}
|
|
||||||
|
|
||||||
IPv6Address::IPv6Address(const uint8_t *address)
|
|
||||||
{
|
|
||||||
memcpy(_address.bytes, address, sizeof(_address.bytes));
|
|
||||||
}
|
|
||||||
|
|
||||||
IPv6Address::IPv6Address(const uint32_t *address)
|
|
||||||
{
|
|
||||||
memcpy(_address.bytes, (const uint8_t *)address, sizeof(_address.bytes));
|
|
||||||
}
|
|
||||||
|
|
||||||
IPv6Address& IPv6Address::operator=(const uint8_t *address)
|
|
||||||
{
|
|
||||||
memcpy(_address.bytes, address, sizeof(_address.bytes));
|
|
||||||
return *this;
|
|
||||||
}
|
|
||||||
|
|
||||||
bool IPv6Address::operator==(const uint8_t* addr) const
|
|
||||||
{
|
|
||||||
return memcmp(addr, _address.bytes, sizeof(_address.bytes)) == 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
size_t IPv6Address::printTo(Print& p) const
|
|
||||||
{
|
|
||||||
size_t n = 0;
|
|
||||||
for(int i = 0; i < 16; i+=2) {
|
|
||||||
if(i){
|
|
||||||
n += p.print(':');
|
|
||||||
}
|
|
||||||
n += p.printf("%02x", _address.bytes[i]);
|
|
||||||
n += p.printf("%02x", _address.bytes[i+1]);
|
|
||||||
|
|
||||||
}
|
|
||||||
return n;
|
|
||||||
}
|
|
||||||
|
|
||||||
String IPv6Address::toString() const
|
|
||||||
{
|
|
||||||
char szRet[40];
|
|
||||||
sprintf(szRet,"%02x%02x:%02x%02x:%02x%02x:%02x%02x:%02x%02x:%02x%02x:%02x%02x:%02x%02x",
|
|
||||||
_address.bytes[0], _address.bytes[1], _address.bytes[2], _address.bytes[3],
|
|
||||||
_address.bytes[4], _address.bytes[5], _address.bytes[6], _address.bytes[7],
|
|
||||||
_address.bytes[8], _address.bytes[9], _address.bytes[10], _address.bytes[11],
|
|
||||||
_address.bytes[12], _address.bytes[13], _address.bytes[14], _address.bytes[15]);
|
|
||||||
return String(szRet);
|
|
||||||
}
|
|
||||||
|
|
||||||
bool IPv6Address::fromString(const char *address)
|
|
||||||
{
|
|
||||||
//format 0011:2233:4455:6677:8899:aabb:ccdd:eeff
|
|
||||||
if(strlen(address) != 39){
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
char * pos = (char *)address;
|
|
||||||
size_t i = 0;
|
|
||||||
for(i = 0; i < 16; i+=2) {
|
|
||||||
if(!sscanf(pos, "%2hhx", &_address.bytes[i]) || !sscanf(pos+2, "%2hhx", &_address.bytes[i+1])){
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
pos += 5;
|
|
||||||
}
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
@@ -1,94 +0,0 @@
|
|||||||
/*
|
|
||||||
IPv6Address.h - Base class that provides IPv6Address
|
|
||||||
Copyright (c) 2011 Adrian McEwen. All right reserved.
|
|
||||||
|
|
||||||
This library is free software; you can redistribute it and/or
|
|
||||||
modify it under the terms of the GNU Lesser General Public
|
|
||||||
License as published by the Free Software Foundation; either
|
|
||||||
version 2.1 of the License, or (at your option) any later version.
|
|
||||||
|
|
||||||
This library is distributed in the hope that it will be useful,
|
|
||||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
||||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
||||||
Lesser General Public License for more details.
|
|
||||||
|
|
||||||
You should have received a copy of the GNU Lesser General Public
|
|
||||||
License along with this library; if not, write to the Free Software
|
|
||||||
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
|
|
||||||
*/
|
|
||||||
|
|
||||||
#ifndef IPv6Address_h
|
|
||||||
#define IPv6Address_h
|
|
||||||
|
|
||||||
#include <stdint.h>
|
|
||||||
#include <WString.h>
|
|
||||||
#include <Printable.h>
|
|
||||||
|
|
||||||
// A class to make it easier to handle and pass around IP addresses
|
|
||||||
|
|
||||||
class IPv6Address: public Printable
|
|
||||||
{
|
|
||||||
private:
|
|
||||||
union {
|
|
||||||
uint8_t bytes[16]; // IPv4 address
|
|
||||||
uint32_t dword[4];
|
|
||||||
} _address;
|
|
||||||
|
|
||||||
// Access the raw byte array containing the address. Because this returns a pointer
|
|
||||||
// to the internal structure rather than a copy of the address this function should only
|
|
||||||
// be used when you know that the usage of the returned uint8_t* will be transient and not
|
|
||||||
// stored.
|
|
||||||
uint8_t* raw_address()
|
|
||||||
{
|
|
||||||
return _address.bytes;
|
|
||||||
}
|
|
||||||
|
|
||||||
public:
|
|
||||||
// Constructors
|
|
||||||
IPv6Address();
|
|
||||||
IPv6Address(const uint8_t *address);
|
|
||||||
IPv6Address(const uint32_t *address);
|
|
||||||
virtual ~IPv6Address() {}
|
|
||||||
|
|
||||||
bool fromString(const char *address);
|
|
||||||
bool fromString(const String &address) { return fromString(address.c_str()); }
|
|
||||||
|
|
||||||
operator const uint8_t*() const
|
|
||||||
{
|
|
||||||
return _address.bytes;
|
|
||||||
}
|
|
||||||
operator const uint32_t*() const
|
|
||||||
{
|
|
||||||
return _address.dword;
|
|
||||||
}
|
|
||||||
bool operator==(const IPv6Address& addr) const
|
|
||||||
{
|
|
||||||
return (_address.dword[0] == addr._address.dword[0])
|
|
||||||
&& (_address.dword[1] == addr._address.dword[1])
|
|
||||||
&& (_address.dword[2] == addr._address.dword[2])
|
|
||||||
&& (_address.dword[3] == addr._address.dword[3]);
|
|
||||||
}
|
|
||||||
bool operator==(const uint8_t* addr) const;
|
|
||||||
|
|
||||||
// Overloaded index operator to allow getting and setting individual octets of the address
|
|
||||||
uint8_t operator[](int index) const
|
|
||||||
{
|
|
||||||
return _address.bytes[index];
|
|
||||||
}
|
|
||||||
uint8_t& operator[](int index)
|
|
||||||
{
|
|
||||||
return _address.bytes[index];
|
|
||||||
}
|
|
||||||
|
|
||||||
// Overloaded copy operators to allow initialisation of IPv6Address objects from other types
|
|
||||||
IPv6Address& operator=(const uint8_t *address);
|
|
||||||
|
|
||||||
virtual size_t printTo(Print& p) const;
|
|
||||||
String toString() const;
|
|
||||||
|
|
||||||
friend class UDP;
|
|
||||||
friend class Client;
|
|
||||||
friend class Server;
|
|
||||||
};
|
|
||||||
|
|
||||||
#endif
|
|
||||||
@@ -24,12 +24,19 @@ void Scanner::initialize(const std::string& deviceName, const bool wantDuplicate
|
|||||||
if (!BLEDevice::getInitialized()) {
|
if (!BLEDevice::getInitialized()) {
|
||||||
if (wantDuplicates) {
|
if (wantDuplicates) {
|
||||||
// reduce memory footprint, cache is not used anyway
|
// reduce memory footprint, cache is not used anyway
|
||||||
|
#ifdef CONFIG_BTDM_BLE_SCAN_DUPL
|
||||||
NimBLEDevice::setScanDuplicateCacheSize(10);
|
NimBLEDevice::setScanDuplicateCacheSize(10);
|
||||||
|
#endif
|
||||||
}
|
}
|
||||||
BLEDevice::init(deviceName);
|
BLEDevice::init(deviceName);
|
||||||
}
|
}
|
||||||
bleScan = BLEDevice::getScan();
|
bleScan = BLEDevice::getScan();
|
||||||
|
|
||||||
|
#if (ESP_IDF_VERSION < ESP_IDF_VERSION_VAL(5, 0, 0))
|
||||||
bleScan->setAdvertisedDeviceCallbacks(this, wantDuplicates);
|
bleScan->setAdvertisedDeviceCallbacks(this, wantDuplicates);
|
||||||
|
#else
|
||||||
|
bleScan->setScanCallbacks(this, wantDuplicates);
|
||||||
|
#endif
|
||||||
bleScan->setInterval(interval);
|
bleScan->setInterval(interval);
|
||||||
bleScan->setWindow(window);
|
bleScan->setWindow(window);
|
||||||
bleScan->setActiveScan(false);
|
bleScan->setActiveScan(false);
|
||||||
@@ -47,7 +54,11 @@ void Scanner::update() {
|
|||||||
log_w("Ble scanner max results not 0. Be aware of memory issue due to unbridled growth of results vector");
|
log_w("Ble scanner max results not 0. Be aware of memory issue due to unbridled growth of results vector");
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#if (ESP_IDF_VERSION < ESP_IDF_VERSION_VAL(5, 0, 0))
|
||||||
bool result = bleScan->start(scanDuration, nullptr, false);
|
bool result = bleScan->start(scanDuration, nullptr, false);
|
||||||
|
#else
|
||||||
|
bool result = bleScan->start(scanDuration * 1000, false);
|
||||||
|
#endif
|
||||||
// if (!result) {
|
// if (!result) {
|
||||||
// scanErrors++;
|
// scanErrors++;
|
||||||
// if (scanErrors % 100 == 0) {
|
// if (scanErrors % 100 == 0) {
|
||||||
@@ -87,4 +98,4 @@ void Scanner::onResult(NimBLEAdvertisedDevice* advertisedDevice) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
} // namespace BleScanner
|
} // namespace BleScanner
|
||||||
@@ -1,243 +0,0 @@
|
|||||||
//-------------------------------------------------------------------------------------
|
|
||||||
// CRC16 support class
|
|
||||||
// Based on various examples found on the web
|
|
||||||
// Copyright (C) 2014 Vincenzo Mennella (see license.txt)
|
|
||||||
// History
|
|
||||||
// 0.1.0 31/05/2014: First public code release
|
|
||||||
// 0.1.1 17/12/2014: Minor revision and commented code
|
|
||||||
// 0.1.2 06/06/2019: Fix reflect routine for 16 bit data
|
|
||||||
// Added ModBus and Mcrf4XX inline functions
|
|
||||||
//
|
|
||||||
// License
|
|
||||||
// "MIT Open Source Software License":
|
|
||||||
// Permission is hereby granted, free of charge, to any person obtaining a copy of
|
|
||||||
// this software and associated documentation files (the "Software"), to deal in the
|
|
||||||
// Software without restriction, including without limitation the rights to use, copy,
|
|
||||||
// modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
|
|
||||||
// and to permit persons to whom the Software is furnished to do so, subject to
|
|
||||||
// the following conditions:
|
|
||||||
//
|
|
||||||
// The above copyright notice and this permission notice shall be included in all
|
|
||||||
// copies or substantial portions of the Software.
|
|
||||||
//
|
|
||||||
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
||||||
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
|
||||||
// FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
|
||||||
// COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
|
||||||
// IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
|
||||||
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
||||||
//-------------------------------------------------------------------------------------
|
|
||||||
#ifndef CRC16_H
|
|
||||||
#define CRC16_H
|
|
||||||
#define LIBRARY_VERSION_CRC16_H "0.1.2"
|
|
||||||
|
|
||||||
#if defined(ARDUINO) && ARDUINO >= 100
|
|
||||||
#include "Arduino.h"
|
|
||||||
#elif defined(ARDUINO)
|
|
||||||
#include "WProgram.h"
|
|
||||||
#else
|
|
||||||
#include <cstdint>
|
|
||||||
#endif
|
|
||||||
|
|
||||||
class Crc16 {
|
|
||||||
private:
|
|
||||||
//Crc parameters
|
|
||||||
uint16_t _msbMask;
|
|
||||||
uint16_t _mask;
|
|
||||||
uint16_t _xorIn;
|
|
||||||
uint16_t _xorOut;
|
|
||||||
uint16_t _polynomial;
|
|
||||||
uint8_t _reflectIn;
|
|
||||||
uint8_t _reflectOut;
|
|
||||||
//Crc value
|
|
||||||
uint16_t _crc;
|
|
||||||
uint8_t reflect(uint8_t data);
|
|
||||||
uint16_t reflect(uint16_t data);
|
|
||||||
|
|
||||||
public:
|
|
||||||
inline Crc16()
|
|
||||||
{
|
|
||||||
//Default to XModem parameters
|
|
||||||
_reflectIn = false;
|
|
||||||
_reflectOut = false;
|
|
||||||
_polynomial = 0x1021;
|
|
||||||
_xorIn = 0x0000;
|
|
||||||
_xorOut = 0x0000;
|
|
||||||
_msbMask = 0x8000;
|
|
||||||
_mask = 0xFFFF;
|
|
||||||
_crc = _xorIn;
|
|
||||||
}
|
|
||||||
inline Crc16(uint8_t reflectIn, uint8_t reflectOut, uint16_t polynomial, uint16_t xorIn, uint16_t xorOut, uint16_t msbMask, uint16_t mask)
|
|
||||||
{
|
|
||||||
_reflectIn = reflectIn;
|
|
||||||
_reflectOut = reflectOut;
|
|
||||||
_polynomial = polynomial;
|
|
||||||
_xorIn = xorIn;
|
|
||||||
_xorOut = xorOut;
|
|
||||||
_msbMask = msbMask;
|
|
||||||
_mask = mask;
|
|
||||||
_crc = _xorIn;
|
|
||||||
}
|
|
||||||
inline void clearCrc();
|
|
||||||
inline void updateCrc(uint8_t data);
|
|
||||||
inline uint16_t getCrc();
|
|
||||||
inline unsigned int fastCrc(uint8_t data[], uint8_t start, uint16_t length, uint8_t reflectIn, uint8_t reflectOut, uint16_t polynomial, uint16_t xorIn, uint16_t xorOut, uint16_t msbMask, uint16_t mask);
|
|
||||||
inline unsigned int XModemCrc(uint8_t data[], uint8_t start, uint16_t length)
|
|
||||||
{
|
|
||||||
// XModem parameters: poly=0x1021 initialize=0x0000 refin=false refout=false xorout=0x0000
|
|
||||||
return fastCrc(data, start, length, false, false, 0x1021, 0x0000, 0x0000, 0x8000, 0xffff);
|
|
||||||
}
|
|
||||||
inline unsigned int Mcrf4XX(uint8_t data[], uint8_t start, uint16_t length)
|
|
||||||
{
|
|
||||||
return fastCrc(data, start, length, true, true, 0x1021, 0xffff, 0x0000, 0x8000, 0xffff);
|
|
||||||
}
|
|
||||||
inline unsigned int Modbus(uint8_t data[], uint8_t start, uint16_t length)
|
|
||||||
{
|
|
||||||
return fastCrc(data, start, length, true, true, 0x8005, 0xffff, 0x0000, 0x8000, 0xffff);
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
//---------------------------------------------------
|
|
||||||
// Initialize crc calculation
|
|
||||||
//---------------------------------------------------
|
|
||||||
void Crc16::clearCrc()
|
|
||||||
{
|
|
||||||
_crc = _xorIn;
|
|
||||||
}
|
|
||||||
//---------------------------------------------------
|
|
||||||
// Update crc with new data
|
|
||||||
//---------------------------------------------------
|
|
||||||
void Crc16::updateCrc(uint8_t data)
|
|
||||||
{
|
|
||||||
if (_reflectIn != 0)
|
|
||||||
data = (uint8_t) reflect(data);
|
|
||||||
|
|
||||||
int j = 0x80;
|
|
||||||
|
|
||||||
while (j > 0)
|
|
||||||
{
|
|
||||||
uint16_t bit = (uint16_t)(_crc & _msbMask);
|
|
||||||
|
|
||||||
_crc <<= 1;
|
|
||||||
|
|
||||||
if ((data & j) != 0)
|
|
||||||
{
|
|
||||||
bit = (uint16_t)(bit ^ _msbMask);
|
|
||||||
}
|
|
||||||
|
|
||||||
if (bit != 0)
|
|
||||||
{
|
|
||||||
_crc ^= _polynomial;
|
|
||||||
}
|
|
||||||
|
|
||||||
j >>= 1;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
//---------------------------------------------------
|
|
||||||
// Get final crc value
|
|
||||||
//---------------------------------------------------
|
|
||||||
uint16_t Crc16::getCrc()
|
|
||||||
{
|
|
||||||
if (_reflectOut != 0)
|
|
||||||
_crc = (unsigned int)((reflect(_crc) ^ _xorOut) & _mask);
|
|
||||||
|
|
||||||
return _crc;
|
|
||||||
}
|
|
||||||
|
|
||||||
//---------------------------------------------------
|
|
||||||
// Calculate generic crc code on data array
|
|
||||||
// Examples of crc 16:
|
|
||||||
// Kermit: width=16 poly=0x1021 initialize=0x0000 refin=true refout=true xorout=0x0000 check=0x2189
|
|
||||||
// Modbus: width=16 poly=0x8005 initialize=0xffff refin=true refout=true xorout=0x0000 check=0x4b37
|
|
||||||
// XModem: width=16 poly=0x1021 initialize=0x0000 refin=false refout=false xorout=0x0000 check=0x31c3
|
|
||||||
// CCITT-False: width=16 poly=0x1021 initialize=0xffff refin=false refout=false xorout=0x0000 check=0x29b1
|
|
||||||
//---------------------------------------------------
|
|
||||||
unsigned int Crc16::fastCrc(uint8_t data[], uint8_t start, uint16_t length, uint8_t reflectIn, uint8_t reflectOut, uint16_t polynomial, uint16_t xorIn, uint16_t xorOut, uint16_t msbMask, uint16_t mask)
|
|
||||||
{
|
|
||||||
uint16_t crc = xorIn;
|
|
||||||
|
|
||||||
int j;
|
|
||||||
uint8_t c;
|
|
||||||
unsigned int bit;
|
|
||||||
|
|
||||||
if (length == 0) return crc;
|
|
||||||
|
|
||||||
for (int i = start; i < (start + length); i++)
|
|
||||||
{
|
|
||||||
c = data[i];
|
|
||||||
|
|
||||||
if (reflectIn != 0)
|
|
||||||
c = (uint8_t) reflect(c);
|
|
||||||
|
|
||||||
j = 0x80;
|
|
||||||
|
|
||||||
while (j > 0)
|
|
||||||
{
|
|
||||||
bit = (unsigned int)(crc & msbMask);
|
|
||||||
crc <<= 1;
|
|
||||||
|
|
||||||
if ((c & j) != 0)
|
|
||||||
{
|
|
||||||
bit = (unsigned int)(bit ^ msbMask);
|
|
||||||
}
|
|
||||||
|
|
||||||
if (bit != 0)
|
|
||||||
{
|
|
||||||
crc ^= polynomial;
|
|
||||||
}
|
|
||||||
|
|
||||||
j >>= 1;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if (reflectOut != 0)
|
|
||||||
crc = (unsigned int)((reflect((uint16_t) crc) ^ xorOut) & mask);
|
|
||||||
|
|
||||||
return crc;
|
|
||||||
}
|
|
||||||
|
|
||||||
//-------------------------------------------------------
|
|
||||||
// Reflects bit in a uint8_t
|
|
||||||
//-------------------------------------------------------
|
|
||||||
uint8_t Crc16::reflect(uint8_t data)
|
|
||||||
{
|
|
||||||
const uint8_t bits = 8;
|
|
||||||
unsigned long reflection = 0x00000000;
|
|
||||||
// Reflect the data about the center bit.
|
|
||||||
for (uint8_t bit = 0; bit < bits; bit++)
|
|
||||||
{
|
|
||||||
// If the LSB bit is set, set the reflection of it.
|
|
||||||
if ((data & 0x01) != 0)
|
|
||||||
{
|
|
||||||
reflection |= (unsigned long)(1 << ((bits - 1) - bit));
|
|
||||||
}
|
|
||||||
|
|
||||||
data = (uint8_t)(data >> 1);
|
|
||||||
}
|
|
||||||
|
|
||||||
return reflection;
|
|
||||||
}
|
|
||||||
//-------------------------------------------------------
|
|
||||||
// Reflects bit in a uint16_t
|
|
||||||
//-------------------------------------------------------
|
|
||||||
uint16_t Crc16::reflect(uint16_t data)
|
|
||||||
{
|
|
||||||
const uint8_t bits = 16;
|
|
||||||
unsigned long reflection = 0x00000000;
|
|
||||||
// Reflect the data about the center bit.
|
|
||||||
for (uint8_t bit = 0; bit < bits; bit++)
|
|
||||||
{
|
|
||||||
// If the LSB bit is set, set the reflection of it.
|
|
||||||
if ((data & 0x01) != 0)
|
|
||||||
{
|
|
||||||
reflection |= (unsigned long)(1 << ((bits - 1) - bit));
|
|
||||||
}
|
|
||||||
|
|
||||||
data = (uint16_t)(data >> 1);
|
|
||||||
}
|
|
||||||
|
|
||||||
return reflection;
|
|
||||||
}
|
|
||||||
|
|
||||||
#endif
|
|
||||||
1
lib/ESP Async WebServer/.piopm
Normal file
1
lib/ESP Async WebServer/.piopm
Normal file
@@ -0,0 +1 @@
|
|||||||
|
{"type": "library", "name": "ESP Async WebServer", "version": "3.0.6", "spec": {"owner": "mathieucarbou", "id": 16603, "name": "ESP Async WebServer", "requirements": null, "uri": null}}
|
||||||
@@ -1,7 +1,7 @@
|
|||||||
GNU LESSER GENERAL PUBLIC LICENSE
|
GNU LESSER GENERAL PUBLIC LICENSE
|
||||||
Version 3, 29 June 2007
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
Everyone is permitted to copy and distribute verbatim copies
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
of this license document, but changing it is not allowed.
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
@@ -162,4 +162,4 @@ General Public License ever published by the Free Software Foundation.
|
|||||||
whether future versions of the GNU Lesser General Public License shall
|
whether future versions of the GNU Lesser General Public License shall
|
||||||
apply, that proxy's public statement of acceptance of any version is
|
apply, that proxy's public statement of acceptance of any version is
|
||||||
permanent authorization for you to choose that version for the
|
permanent authorization for you to choose that version for the
|
||||||
Library.
|
Library.
|
||||||
117
lib/ESP Async WebServer/README.md
Normal file
117
lib/ESP Async WebServer/README.md
Normal file
@@ -0,0 +1,117 @@
|
|||||||
|
# ESP Async WebServer
|
||||||
|
|
||||||
|
[](https://opensource.org/license/lgpl-3-0/)
|
||||||
|
[](https://github.com/mathieucarbou/ESPAsyncWebServer/actions/workflows/ci.yml)
|
||||||
|
[](https://registry.platformio.org/libraries/mathieucarbou/ESP%20Async%20WebServer)
|
||||||
|
|
||||||
|
Asynchronous HTTP and WebSocket Server Library for ESP32, ESP8266 and RP2040
|
||||||
|
Supports: WebSocket, SSE, Authentication, Arduino Json 7, File Upload, Static File serving, URL Rewrite, URL Redirect, etc.
|
||||||
|
|
||||||
|
This fork is based on [yubox-node-org/ESPAsyncWebServer](https://github.com/yubox-node-org/ESPAsyncWebServer) and includes all the concurrency fixes.
|
||||||
|
|
||||||
|
## Changes in this fork
|
||||||
|
|
||||||
|
- [@ayushsharma82](https://github.com/ayushsharma82) and [@mathieucarbou](https://github.com/mathieucarbou): Add RP2040 support ([#31](https://github.com/mathieucarbou/ESPAsyncWebServer/pull/31))
|
||||||
|
- [@mathieucarbou](https://github.com/mathieucarbou): `SSE_MAX_QUEUED_MESSAGES` to control the maximum number of messages that can be queued for a SSE client
|
||||||
|
- [@mathieucarbou](https://github.com/mathieucarbou): `write()` function public in `AsyncEventSource.h`
|
||||||
|
- [@mathieucarbou](https://github.com/mathieucarbou): `WS_MAX_QUEUED_MESSAGES`: control the maximum number of messages that can be queued for a Websocket client
|
||||||
|
- [@mathieucarbou](https://github.com/mathieucarbou): Added `setAuthentication(const String& username, const String& password)`
|
||||||
|
- [@mathieucarbou](https://github.com/mathieucarbou): Added `setCloseClientOnQueueFull(bool)` which can be set on a client to either close the connection or discard messages but not close the connection when the queue is full
|
||||||
|
- [@mathieucarbou](https://github.com/mathieucarbou): Added `StreamConcat` example to show how to stream multiple files in one response
|
||||||
|
- [@mathieucarbou](https://github.com/mathieucarbou): Added all flavors of `binary()`, `text()`, `binaryAll()` and `textAll()` in `AsyncWebSocket`
|
||||||
|
- [@mathieucarbou](https://github.com/mathieucarbou): Arduino 3 / ESP-IDF 5.1 compatibility
|
||||||
|
- [@mathieucarbou](https://github.com/mathieucarbou): Arduino Json 7 compatibility and backward compatible with 6 and 6 (changes in `AsyncJson.h`). The API to use Json has not changed. These are only internal changes.
|
||||||
|
- [@mathieucarbou](https://github.com/mathieucarbou): CI
|
||||||
|
- [@mathieucarbou](https://github.com/mathieucarbou): Depends on `mathieucarbou/Async TCP @ ^3.1.4`
|
||||||
|
- [@mathieucarbou](https://github.com/mathieucarbou): Deployed in PlatformIO registry and Arduino IDE library manager
|
||||||
|
- [@mathieucarbou](https://github.com/mathieucarbou): Firmware size optimization: remove mbedtls dependency (accounts for 33KB in firmware)
|
||||||
|
- [@mathieucarbou](https://github.com/mathieucarbou): Made DEFAULT_MAX_SSE_CLIENTS customizable
|
||||||
|
- [@mathieucarbou](https://github.com/mathieucarbou): Made DEFAULT_MAX_WS_CLIENTS customizable
|
||||||
|
- [@mathieucarbou](https://github.com/mathieucarbou): Remove filename after inline in Content-Disposition header according to RFC2183
|
||||||
|
- [@mathieucarbou](https://github.com/mathieucarbou): Removed SPIFFSEditor to reduce library size and maintainance. SPIFF si also deprecated. If you need it, please copy the files from the original repository in your project. This fork focus on maintaining the server part and the SPIFFEditor is an application which has nothing to do inside a server library.
|
||||||
|
- [@mathieucarbou](https://github.com/mathieucarbou): Resurrected `AsyncWebSocketMessageBuffer` and `makeBuffer()` in order to make the fork API-compatible with the original library from me-no-dev regarding WebSocket.
|
||||||
|
- [@mathieucarbou](https://github.com/mathieucarbou): Some code cleanup
|
||||||
|
- [@mathieucarbou](https://github.com/mathieucarbou): Use `-D DEFAULT_MAX_WS_CLIENTS` to change the number of allows WebSocket clients and use `cleanupClients()` to help cleanup resources about dead clients
|
||||||
|
- [@nilo85](https://github.com/nilo85): Add support for Auth & GET requests in AsyncCallbackJsonWebHandler ([#14](https://github.com/mathieucarbou/ESPAsyncWebServer/pull/14))
|
||||||
|
- [@p0p-x](https://github.com/p0p-x): ESP IDF Compatibility (added back CMakeLists.txt) ([#32](https://github.com/mathieucarbou/ESPAsyncWebServer/pull/32))
|
||||||
|
- [@tueddy](https://github.com/tueddy): Compile with Arduino 3 (ESP-IDF 5.1) ([#13](https://github.com/mathieucarbou/ESPAsyncWebServer/pull/13))
|
||||||
|
- [@vortigont](https://github.com/vortigont): Set real "Last-Modified" header based on file's LastWrite time ([#5](https://github.com/mathieucarbou/ESPAsyncWebServer/pull/5))
|
||||||
|
- [@vortigont](https://github.com/vortigont): Some websocket code cleanup ([#29](https://github.com/mathieucarbou/ESPAsyncWebServer/pull/29))
|
||||||
|
- [@vortigont](https://github.com/vortigont): Refactor code - replace DYI structs with STL objects ([#39](https://github.com/mathieucarbou/ESPAsyncWebServer/pull/39))
|
||||||
|
|
||||||
|
## Dependencies:
|
||||||
|
|
||||||
|
- **ESP32**: `mathieucarbou/Async TCP @ ^3.1.4` (Arduino IDE: [https://github.com/mathieucarbou/AsyncTCP#v3.1.4](https://github.com/mathieucarbou/AsyncTCP/releases/tag/v3.1.4))
|
||||||
|
- **ESP8266**: `esphome/ESPAsyncTCP-esphome @ 2.0.0` (Arduino IDE: [https://github.com/mathieucarbou/esphome-ESPAsyncTCP#v2.0.0](https://github.com/mathieucarbou/esphome-ESPAsyncTCP/releases/tag/v2.0.0))
|
||||||
|
- **RP2040**: `khoih-prog/AsyncTCP_RP2040W @ 1.2.0` (Arduino IDE: [https://github.com/khoih-prog/AsyncTCP_RP2040W#v1.2.0](https://github.com/khoih-prog/AsyncTCP_RP2040W/releases/tag/v1.2.0))
|
||||||
|
|
||||||
|
## Documentation
|
||||||
|
|
||||||
|
Usage and API stays the same as the original library.
|
||||||
|
Please look at the original libraries for more examples and documentation.
|
||||||
|
|
||||||
|
- [https://github.com/me-no-dev/ESPAsyncWebServer](https://github.com/me-no-dev/ESPAsyncWebServer) (original library)
|
||||||
|
- [https://github.com/yubox-node-org/ESPAsyncWebServer](https://github.com/yubox-node-org/ESPAsyncWebServer) (fork of the original library)
|
||||||
|
|
||||||
|
## `AsyncWebSocketMessageBuffer` and `makeBuffer()`
|
||||||
|
|
||||||
|
The fork from `yubox-node-org` introduces some breaking API changes compared to the original library, especially regarding the use of `std::shared_ptr<std::vector<uint8_t>>` for WebSocket.
|
||||||
|
|
||||||
|
This fork is compatible with the original library from `me-no-dev` regarding WebSocket, and wraps the optimizations done by `yubox-node-org` in the `AsyncWebSocketMessageBuffer` class.
|
||||||
|
So you have the choice of which API to use.
|
||||||
|
|
||||||
|
Here are examples for serializing a Json document in a websocket message buffer:
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
void send(JsonDocument& doc) {
|
||||||
|
const size_t len = measureJson(doc);
|
||||||
|
|
||||||
|
// original API from me-no-dev
|
||||||
|
AsyncWebSocketMessageBuffer* buffer = _ws->makeBuffer(len);
|
||||||
|
assert(buffer); // up to you to keep or remove this
|
||||||
|
serializeJson(doc, buffer->get(), len);
|
||||||
|
_ws->textAll(buffer);
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
void send(JsonDocument& doc) {
|
||||||
|
const size_t len = measureJson(doc);
|
||||||
|
|
||||||
|
// this fork (originally from yubox-node-org), uses another API with shared pointer
|
||||||
|
auto buffer = std::make_shared<std::vector<uint8_t>>(len);
|
||||||
|
assert(buffer); // up to you to keep or remove this
|
||||||
|
serializeJson(doc, buffer->data(), len);
|
||||||
|
_ws->textAll(std::move(buffer));
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
I recommend to use the official API `AsyncWebSocketMessageBuffer` to retain further compatibility.
|
||||||
|
|
||||||
|
## Important recommendations
|
||||||
|
|
||||||
|
Most of the crashes are caused by improper configuration of the library for the project.
|
||||||
|
Here are some recommendations to avoid them.
|
||||||
|
|
||||||
|
1. Set the running core to be on the same core of your application (usually core 1) `-D CONFIG_ASYNC_TCP_RUNNING_CORE=1`
|
||||||
|
2. Set the stack size appropriately with `-D CONFIG_ASYNC_TCP_STACK_SIZE=16384`.
|
||||||
|
The default value of `16384` might be too much for your project.
|
||||||
|
You can look at the [MycilaTaskMonitor](https://oss.carbou.me/MycilaTaskMonitor) project to monitor the stack usage.
|
||||||
|
3. You can change **if you know what you are doing** the task priority with `-D CONFIG_ASYNC_TCP_PRIORITY=10`.
|
||||||
|
Default is `10`.
|
||||||
|
4. You can increase the queue size with `-D CONFIG_ASYNC_TCP_QUEUE_SIZE=128`.
|
||||||
|
Default is `64`.
|
||||||
|
5. You can decrease the maximum ack time `-D CONFIG_ASYNC_TCP_MAX_ACK_TIME=3000`.
|
||||||
|
Default is `5000`.
|
||||||
|
|
||||||
|
I personally use the following configuration in my projects because my WS messages can be big (up to 4k).
|
||||||
|
If you have smaller messages, you can increase `WS_MAX_QUEUED_MESSAGES` to 128.
|
||||||
|
|
||||||
|
```c++
|
||||||
|
-D CONFIG_ASYNC_TCP_MAX_ACK_TIME=3000
|
||||||
|
-D CONFIG_ASYNC_TCP_PRIORITY=10
|
||||||
|
-D CONFIG_ASYNC_TCP_QUEUE_SIZE=128
|
||||||
|
-D CONFIG_ASYNC_TCP_RUNNING_CORE=1
|
||||||
|
-D CONFIG_ASYNC_TCP_STACK_SIZE=4096
|
||||||
|
-D WS_MAX_QUEUED_MESSAGES=64
|
||||||
|
```
|
||||||
@@ -0,0 +1,57 @@
|
|||||||
|
#include <DNSServer.h>
|
||||||
|
#ifdef ESP32
|
||||||
|
#include <AsyncTCP.h>
|
||||||
|
#include <WiFi.h>
|
||||||
|
#elif defined(ESP8266)
|
||||||
|
#include <ESP8266WiFi.h>
|
||||||
|
#include <ESPAsyncTCP.h>
|
||||||
|
#elif defined(TARGET_RP2040)
|
||||||
|
#include <WebServer.h>
|
||||||
|
#include <WiFi.h>
|
||||||
|
#endif
|
||||||
|
#include "ESPAsyncWebServer.h"
|
||||||
|
|
||||||
|
DNSServer dnsServer;
|
||||||
|
AsyncWebServer server(80);
|
||||||
|
|
||||||
|
class CaptiveRequestHandler : public AsyncWebHandler {
|
||||||
|
public:
|
||||||
|
CaptiveRequestHandler() {}
|
||||||
|
virtual ~CaptiveRequestHandler() {}
|
||||||
|
|
||||||
|
bool canHandle(__unused AsyncWebServerRequest* request) {
|
||||||
|
// request->addInterestingHeader("ANY");
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
void handleRequest(AsyncWebServerRequest* request) {
|
||||||
|
AsyncResponseStream* response = request->beginResponseStream("text/html");
|
||||||
|
response->print("<!DOCTYPE html><html><head><title>Captive Portal</title></head><body>");
|
||||||
|
response->print("<p>This is out captive portal front page.</p>");
|
||||||
|
response->printf("<p>You were trying to reach: http://%s%s</p>", request->host().c_str(), request->url().c_str());
|
||||||
|
response->printf("<p>Try opening <a href='http://%s'>this link</a> instead</p>", WiFi.softAPIP().toString().c_str());
|
||||||
|
response->print("</body></html>");
|
||||||
|
request->send(response);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
void setup() {
|
||||||
|
Serial.begin(115200);
|
||||||
|
Serial.println();
|
||||||
|
Serial.println("Configuring access point...");
|
||||||
|
|
||||||
|
if (!WiFi.softAP("esp-captive")) {
|
||||||
|
Serial.println("Soft AP creation failed.");
|
||||||
|
while (1)
|
||||||
|
;
|
||||||
|
}
|
||||||
|
|
||||||
|
dnsServer.start(53, "*", WiFi.softAPIP());
|
||||||
|
server.addHandler(new CaptiveRequestHandler()).setFilter(ON_AP_FILTER); // only when requested from AP
|
||||||
|
// more handlers...
|
||||||
|
server.begin();
|
||||||
|
}
|
||||||
|
|
||||||
|
void loop() {
|
||||||
|
dnsServer.processNextRequest();
|
||||||
|
}
|
||||||
37
lib/ESP Async WebServer/examples/Draft/Draft.ino
Normal file
37
lib/ESP Async WebServer/examples/Draft/Draft.ino
Normal file
@@ -0,0 +1,37 @@
|
|||||||
|
#include "mbedtls/md5.h"
|
||||||
|
#include <Arduino.h>
|
||||||
|
#include <MD5Builder.h>
|
||||||
|
|
||||||
|
void setup() {
|
||||||
|
Serial.begin(115200);
|
||||||
|
delay(2000);
|
||||||
|
|
||||||
|
const char* data = "Hello World";
|
||||||
|
|
||||||
|
{
|
||||||
|
uint8_t md5[16];
|
||||||
|
mbedtls_md5_context _ctx;
|
||||||
|
mbedtls_md5_init(&_ctx);
|
||||||
|
mbedtls_md5_starts(&_ctx);
|
||||||
|
mbedtls_md5_update(&_ctx, (const unsigned char*)data, strlen(data));
|
||||||
|
mbedtls_md5_finish(&_ctx, md5);
|
||||||
|
char output[33];
|
||||||
|
for (int i = 0; i < 16; i++) {
|
||||||
|
sprintf_P(output + (i * 2), PSTR("%02x"), md5[i]);
|
||||||
|
}
|
||||||
|
Serial.println(String(output));
|
||||||
|
}
|
||||||
|
|
||||||
|
{
|
||||||
|
MD5Builder md5;
|
||||||
|
md5.begin();
|
||||||
|
md5.add(data, strlen(data);
|
||||||
|
md5.calculate();
|
||||||
|
char output[33];
|
||||||
|
md5.getChars(output);
|
||||||
|
Serial.println(String(output));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
void loop() {
|
||||||
|
}
|
||||||
111
lib/ESP Async WebServer/examples/Filters/Filters.ino
Normal file
111
lib/ESP Async WebServer/examples/Filters/Filters.ino
Normal file
@@ -0,0 +1,111 @@
|
|||||||
|
// Reproduced issue https://github.com/mathieucarbou/ESPAsyncWebServer/issues/26
|
||||||
|
|
||||||
|
#include <DNSServer.h>
|
||||||
|
#ifdef ESP32
|
||||||
|
#include <AsyncTCP.h>
|
||||||
|
#include <WiFi.h>
|
||||||
|
#elif defined(ESP8266)
|
||||||
|
#include <ESP8266WiFi.h>
|
||||||
|
#include <ESPAsyncTCP.h>
|
||||||
|
#elif defined(TARGET_RP2040)
|
||||||
|
#include <WebServer.h>
|
||||||
|
#include <WiFi.h>
|
||||||
|
#endif
|
||||||
|
#include "ESPAsyncWebServer.h"
|
||||||
|
|
||||||
|
DNSServer dnsServer;
|
||||||
|
AsyncWebServer server(80);
|
||||||
|
|
||||||
|
class CaptiveRequestHandler : public AsyncWebHandler {
|
||||||
|
public:
|
||||||
|
CaptiveRequestHandler() {}
|
||||||
|
virtual ~CaptiveRequestHandler() {}
|
||||||
|
|
||||||
|
bool canHandle(__unused AsyncWebServerRequest* request) {
|
||||||
|
// request->addInterestingHeader("ANY");
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
void handleRequest(AsyncWebServerRequest* request) {
|
||||||
|
AsyncResponseStream* response = request->beginResponseStream("text/html");
|
||||||
|
response->print("<!DOCTYPE html><html><head><title>Captive Portal</title></head><body>");
|
||||||
|
response->print("<p>This is out captive portal front page.</p>");
|
||||||
|
response->printf("<p>You were trying to reach: http://%s%s</p>", request->host().c_str(), request->url().c_str());
|
||||||
|
response->printf("<p>Try opening <a href='http://%s'>this link</a> instead</p>", WiFi.softAPIP().toString().c_str());
|
||||||
|
response->print("</body></html>");
|
||||||
|
request->send(response);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
bool hit1 = false;
|
||||||
|
bool hit2 = false;
|
||||||
|
|
||||||
|
void setup() {
|
||||||
|
Serial.begin(115200);
|
||||||
|
|
||||||
|
server
|
||||||
|
.on("/", HTTP_GET, [](AsyncWebServerRequest* request) {
|
||||||
|
Serial.println("Captive portal request...");
|
||||||
|
Serial.println("WiFi.localIP(): " + WiFi.localIP().toString());
|
||||||
|
Serial.println("request->client()->localIP(): " + request->client()->localIP().toString());
|
||||||
|
#if ESP_IDF_VERSION_MAJOR >= 5
|
||||||
|
Serial.println("WiFi.type(): " + String((int)WiFi.localIP().type()));
|
||||||
|
Serial.println("request->client()->type(): " + String((int)request->client()->localIP().type()));
|
||||||
|
#endif
|
||||||
|
Serial.println(WiFi.localIP() == request->client()->localIP() ? "should be: ON_STA_FILTER" : "should be: ON_AP_FILTER");
|
||||||
|
Serial.println(WiFi.localIP() == request->client()->localIP());
|
||||||
|
Serial.println(WiFi.localIP().toString() == request->client()->localIP().toString());
|
||||||
|
request->send(200, "text/plain", "This is the captive portal");
|
||||||
|
hit1 = true;
|
||||||
|
})
|
||||||
|
.setFilter(ON_AP_FILTER);
|
||||||
|
|
||||||
|
server
|
||||||
|
.on("/", HTTP_GET, [](AsyncWebServerRequest* request) {
|
||||||
|
Serial.println("Website request...");
|
||||||
|
Serial.println("WiFi.localIP(): " + WiFi.localIP().toString());
|
||||||
|
Serial.println("request->client()->localIP(): " + request->client()->localIP().toString());
|
||||||
|
#if ESP_IDF_VERSION_MAJOR >= 5
|
||||||
|
Serial.println("WiFi.type(): " + String((int)WiFi.localIP().type()));
|
||||||
|
Serial.println("request->client()->type(): " + String((int)request->client()->localIP().type()));
|
||||||
|
#endif
|
||||||
|
Serial.println(WiFi.localIP() == request->client()->localIP() ? "should be: ON_STA_FILTER" : "should be: ON_AP_FILTER");
|
||||||
|
Serial.println(WiFi.localIP() == request->client()->localIP());
|
||||||
|
Serial.println(WiFi.localIP().toString() == request->client()->localIP().toString());
|
||||||
|
request->send(200, "text/plain", "This is the website");
|
||||||
|
hit2 = true;
|
||||||
|
})
|
||||||
|
.setFilter(ON_STA_FILTER);
|
||||||
|
|
||||||
|
// assert(WiFi.softAP("esp-captive-portal"));
|
||||||
|
// dnsServer.start(53, "*", WiFi.softAPIP());
|
||||||
|
// server.begin();
|
||||||
|
// Serial.println("Captive portal started!");
|
||||||
|
|
||||||
|
// while (!hit1) {
|
||||||
|
// dnsServer.processNextRequest();
|
||||||
|
// yield();
|
||||||
|
// }
|
||||||
|
// delay(1000); // Wait for the client to process the response
|
||||||
|
|
||||||
|
// Serial.println("Captive portal opened, stopping it and connecting to WiFi...");
|
||||||
|
// dnsServer.stop();
|
||||||
|
// WiFi.softAPdisconnect();
|
||||||
|
|
||||||
|
WiFi.persistent(false);
|
||||||
|
WiFi.begin("IoT");
|
||||||
|
while (WiFi.status() != WL_CONNECTED) {
|
||||||
|
delay(500);
|
||||||
|
}
|
||||||
|
Serial.println("Connected to WiFi with IP address: " + WiFi.localIP().toString());
|
||||||
|
server.begin();
|
||||||
|
|
||||||
|
// while (!hit2) {
|
||||||
|
// delay(10);
|
||||||
|
// }
|
||||||
|
// delay(1000); // Wait for the client to process the response
|
||||||
|
// ESP.restart();
|
||||||
|
}
|
||||||
|
|
||||||
|
void loop() {
|
||||||
|
}
|
||||||
@@ -0,0 +1,77 @@
|
|||||||
|
//
|
||||||
|
// A simple server implementation showing how to:
|
||||||
|
// * serve static messages
|
||||||
|
// * read GET and POST parameters
|
||||||
|
// * handle missing pages / 404s
|
||||||
|
//
|
||||||
|
|
||||||
|
#include <Arduino.h>
|
||||||
|
#ifdef ESP32
|
||||||
|
#include <AsyncTCP.h>
|
||||||
|
#include <WiFi.h>
|
||||||
|
#elif defined(ESP8266)
|
||||||
|
#include <ESP8266WiFi.h>
|
||||||
|
#include <ESPAsyncTCP.h>
|
||||||
|
#elif defined(TARGET_RP2040)
|
||||||
|
#include <WebServer.h>
|
||||||
|
#include <WiFi.h>
|
||||||
|
#endif
|
||||||
|
#include <ESPAsyncWebServer.h>
|
||||||
|
|
||||||
|
AsyncWebServer server(80);
|
||||||
|
|
||||||
|
const char* ssid = "YOUR_SSID";
|
||||||
|
const char* password = "YOUR_PASSWORD";
|
||||||
|
|
||||||
|
const char* PARAM_MESSAGE = "message";
|
||||||
|
|
||||||
|
void notFound(AsyncWebServerRequest* request) {
|
||||||
|
request->send(404, "text/plain", "Not found");
|
||||||
|
}
|
||||||
|
|
||||||
|
void setup() {
|
||||||
|
|
||||||
|
Serial.begin(115200);
|
||||||
|
WiFi.mode(WIFI_STA);
|
||||||
|
WiFi.begin(ssid, password);
|
||||||
|
if (WiFi.waitForConnectResult() != WL_CONNECTED) {
|
||||||
|
Serial.printf("WiFi Failed!\n");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
Serial.print("IP Address: ");
|
||||||
|
Serial.println(WiFi.localIP());
|
||||||
|
|
||||||
|
server.on("/", HTTP_GET, [](AsyncWebServerRequest* request) {
|
||||||
|
request->send(200, "text/plain", "Hello, world");
|
||||||
|
});
|
||||||
|
|
||||||
|
// Send a GET request to <IP>/get?message=<message>
|
||||||
|
server.on("/get", HTTP_GET, [](AsyncWebServerRequest* request) {
|
||||||
|
String message;
|
||||||
|
if (request->hasParam(PARAM_MESSAGE)) {
|
||||||
|
message = request->getParam(PARAM_MESSAGE)->value();
|
||||||
|
} else {
|
||||||
|
message = "No message sent";
|
||||||
|
}
|
||||||
|
request->send(200, "text/plain", "Hello, GET: " + message);
|
||||||
|
});
|
||||||
|
|
||||||
|
// Send a POST request to <IP>/post with a form field message set to <message>
|
||||||
|
server.on("/post", HTTP_POST, [](AsyncWebServerRequest* request) {
|
||||||
|
String message;
|
||||||
|
if (request->hasParam(PARAM_MESSAGE, true)) {
|
||||||
|
message = request->getParam(PARAM_MESSAGE, true)->value();
|
||||||
|
} else {
|
||||||
|
message = "No message sent";
|
||||||
|
}
|
||||||
|
request->send(200, "text/plain", "Hello, POST: " + message);
|
||||||
|
});
|
||||||
|
|
||||||
|
server.onNotFound(notFound);
|
||||||
|
|
||||||
|
server.begin();
|
||||||
|
}
|
||||||
|
|
||||||
|
void loop() {
|
||||||
|
}
|
||||||
37
lib/ESP Async WebServer/examples/StreamFiles/StreamConcat.h
Normal file
37
lib/ESP Async WebServer/examples/StreamFiles/StreamConcat.h
Normal file
@@ -0,0 +1,37 @@
|
|||||||
|
#pragma once
|
||||||
|
|
||||||
|
#include <Stream.h>
|
||||||
|
|
||||||
|
class StreamConcat : public Stream {
|
||||||
|
public:
|
||||||
|
StreamConcat(Stream* s1, Stream* s2) : _s1(s1), _s2(s2) {}
|
||||||
|
|
||||||
|
size_t write(__unused const uint8_t* p, __unused size_t n) override { return 0; }
|
||||||
|
size_t write(__unused uint8_t c) override { return 0; }
|
||||||
|
void flush() override {}
|
||||||
|
|
||||||
|
int available() override { return _s1->available() + _s2->available(); }
|
||||||
|
|
||||||
|
int read() override {
|
||||||
|
int c = _s1->read();
|
||||||
|
return c != -1 ? c : _s2->read();
|
||||||
|
}
|
||||||
|
|
||||||
|
#if defined(TARGET_RP2040)
|
||||||
|
size_t readBytes(char* buffer, size_t length) {
|
||||||
|
#else
|
||||||
|
size_t readBytes(char* buffer, size_t length) override {
|
||||||
|
#endif
|
||||||
|
size_t count = _s1->readBytes(buffer, length);
|
||||||
|
return count > 0 ? count : _s2->readBytes(buffer, length);
|
||||||
|
}
|
||||||
|
|
||||||
|
int peek() override {
|
||||||
|
int c = _s1->peek();
|
||||||
|
return c != -1 ? c : _s2->peek();
|
||||||
|
}
|
||||||
|
|
||||||
|
private:
|
||||||
|
Stream* _s1;
|
||||||
|
Stream* _s2;
|
||||||
|
};
|
||||||
84
lib/ESP Async WebServer/examples/StreamFiles/StreamFiles.ino
Normal file
84
lib/ESP Async WebServer/examples/StreamFiles/StreamFiles.ino
Normal file
@@ -0,0 +1,84 @@
|
|||||||
|
#include <Arduino.h>
|
||||||
|
#include <DNSServer.h>
|
||||||
|
#ifdef ESP32
|
||||||
|
#include <AsyncTCP.h>
|
||||||
|
#include <WiFi.h>
|
||||||
|
#elif defined(ESP8266)
|
||||||
|
#include <ESP8266WiFi.h>
|
||||||
|
#include <ESPAsyncTCP.h>
|
||||||
|
#elif defined(TARGET_RP2040)
|
||||||
|
#include <WebServer.h>
|
||||||
|
#include <WiFi.h>
|
||||||
|
#endif
|
||||||
|
#include "StreamConcat.h"
|
||||||
|
#include "StreamString.h"
|
||||||
|
#include <ESPAsyncWebServer.h>
|
||||||
|
#include <LittleFS.h>
|
||||||
|
|
||||||
|
DNSServer dnsServer;
|
||||||
|
AsyncWebServer server(80);
|
||||||
|
|
||||||
|
void setup() {
|
||||||
|
Serial.begin(115200);
|
||||||
|
|
||||||
|
LittleFS.begin();
|
||||||
|
|
||||||
|
WiFi.mode(WIFI_AP);
|
||||||
|
WiFi.softAP("esp-captive");
|
||||||
|
dnsServer.start(53, "*", WiFi.softAPIP());
|
||||||
|
|
||||||
|
File file1 = LittleFS.open("/header.html", "w");
|
||||||
|
file1.print("<html><head><title>ESP Captive Portal</title><meta http-equiv=\"refresh\" content=\"1\"></head><body>");
|
||||||
|
file1.close();
|
||||||
|
|
||||||
|
File file2 = LittleFS.open("/body.html", "w");
|
||||||
|
file2.print("<h1>Welcome to ESP Captive Portal</h1>");
|
||||||
|
file2.close();
|
||||||
|
|
||||||
|
File file3 = LittleFS.open("/footer.html", "w");
|
||||||
|
file3.print("</body></html>");
|
||||||
|
file3.close();
|
||||||
|
|
||||||
|
server.on("/", HTTP_GET, [](AsyncWebServerRequest* request) {
|
||||||
|
File header = LittleFS.open("/header.html", "r");
|
||||||
|
File body = LittleFS.open("/body.html", "r");
|
||||||
|
StreamConcat stream1(&header, &body);
|
||||||
|
|
||||||
|
StreamString content;
|
||||||
|
#if defined(TARGET_RP2040)
|
||||||
|
content.printf("FreeHeap: %d", rp2040.getFreeHeap());
|
||||||
|
#else
|
||||||
|
content.printf("FreeHeap: %" PRIu32, ESP.getFreeHeap());
|
||||||
|
#endif
|
||||||
|
StreamConcat stream2 = StreamConcat(&stream1, &content);
|
||||||
|
|
||||||
|
File footer = LittleFS.open("/footer.html", "r");
|
||||||
|
StreamConcat stream3 = StreamConcat(&stream2, &footer);
|
||||||
|
|
||||||
|
request->send(stream3, "text/html", stream3.available());
|
||||||
|
header.close();
|
||||||
|
body.close();
|
||||||
|
footer.close();
|
||||||
|
});
|
||||||
|
|
||||||
|
server.onNotFound([](AsyncWebServerRequest* request) {
|
||||||
|
request->send(404, "text/plain", "Not found");
|
||||||
|
});
|
||||||
|
|
||||||
|
server.begin();
|
||||||
|
}
|
||||||
|
|
||||||
|
uint32_t last = 0;
|
||||||
|
|
||||||
|
void loop() {
|
||||||
|
// dnsServer.processNextRequest();
|
||||||
|
|
||||||
|
if (millis() - last > 2000) {
|
||||||
|
#if defined(TARGET_RP2040)
|
||||||
|
Serial.printf("FreeHeap: %d", rp2040.getFreeHeap());
|
||||||
|
#else
|
||||||
|
Serial.printf("FreeHeap: %" PRIu32, ESP.getFreeHeap());
|
||||||
|
#endif
|
||||||
|
last = millis();
|
||||||
|
}
|
||||||
|
}
|
||||||
40
lib/ESP Async WebServer/examples/StreamFiles/StreamString.h
Normal file
40
lib/ESP Async WebServer/examples/StreamFiles/StreamString.h
Normal file
@@ -0,0 +1,40 @@
|
|||||||
|
#pragma once
|
||||||
|
|
||||||
|
#include <Stream.h>
|
||||||
|
|
||||||
|
class StreamString : public Stream {
|
||||||
|
public:
|
||||||
|
size_t write(const uint8_t* p, size_t n) override { return _buffer.concat(reinterpret_cast<const char*>(p), n) ? n : 0; }
|
||||||
|
size_t write(uint8_t c) override { return _buffer.concat(static_cast<char>(c)) ? 1 : 0; }
|
||||||
|
void flush() override {}
|
||||||
|
|
||||||
|
int available() override { return static_cast<int>(_buffer.length()); }
|
||||||
|
|
||||||
|
int read() override {
|
||||||
|
if (_buffer.length() == 0)
|
||||||
|
return -1;
|
||||||
|
char c = _buffer[0];
|
||||||
|
_buffer.remove(0, 1);
|
||||||
|
return c;
|
||||||
|
}
|
||||||
|
|
||||||
|
#if defined(TARGET_RP2040)
|
||||||
|
size_t readBytes(char* buffer, size_t length) {
|
||||||
|
#else
|
||||||
|
size_t readBytes(char* buffer, size_t length) override {
|
||||||
|
#endif
|
||||||
|
if (length > _buffer.length())
|
||||||
|
length = _buffer.length();
|
||||||
|
// Don't use _str.ToCharArray() because it inserts a terminator
|
||||||
|
memcpy(buffer, _buffer.c_str(), length);
|
||||||
|
_buffer.remove(0, static_cast<unsigned int>(length));
|
||||||
|
return length;
|
||||||
|
}
|
||||||
|
|
||||||
|
int peek() override { return _buffer.length() > 0 ? _buffer[0] : -1; }
|
||||||
|
|
||||||
|
const String& buffer() const { return _buffer; }
|
||||||
|
|
||||||
|
private:
|
||||||
|
String _buffer;
|
||||||
|
};
|
||||||
64
lib/ESP Async WebServer/library.json
Normal file
64
lib/ESP Async WebServer/library.json
Normal file
@@ -0,0 +1,64 @@
|
|||||||
|
{
|
||||||
|
"name": "ESP Async WebServer",
|
||||||
|
"version": "3.0.6",
|
||||||
|
"description": "Asynchronous HTTP and WebSocket Server Library for ESP32, ESP8266 and RP2040. Supports: WebSocket, SSE, Authentication, Arduino Json 7, File Upload, Static File serving, URL Rewrite, URL Redirect, etc.",
|
||||||
|
"keywords": "http,async,websocket,webserver",
|
||||||
|
"homepage": "https://github.com/mathieucarbou/ESPAsyncWebServer",
|
||||||
|
"repository": {
|
||||||
|
"type": "git",
|
||||||
|
"url": "https://github.com/mathieucarbou/ESPAsyncWebServer.git"
|
||||||
|
},
|
||||||
|
"authors": [
|
||||||
|
{
|
||||||
|
"name": "Hristo Gochkov"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "Mathieu Carbou",
|
||||||
|
"maintainer": true
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"license": "LGPL-3.0",
|
||||||
|
"frameworks": "arduino",
|
||||||
|
"platforms": [
|
||||||
|
"espressif32",
|
||||||
|
"espressif8266",
|
||||||
|
"raspberrypi"
|
||||||
|
],
|
||||||
|
"dependencies": [
|
||||||
|
{
|
||||||
|
"owner": "mathieucarbou",
|
||||||
|
"name": "Async TCP",
|
||||||
|
"version": "^3.1.4",
|
||||||
|
"platforms": "espressif32"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"owner": "esphome",
|
||||||
|
"name": "ESPAsyncTCP-esphome",
|
||||||
|
"version": "^2.0.0",
|
||||||
|
"platforms": "espressif8266"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "Hash",
|
||||||
|
"platforms": "espressif8266"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"owner": "khoih-prog",
|
||||||
|
"name": "AsyncTCP_RP2040W",
|
||||||
|
"version": "^1.2.0",
|
||||||
|
"platforms": "raspberrypi"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"export": {
|
||||||
|
"include": [
|
||||||
|
"examples",
|
||||||
|
"src",
|
||||||
|
"library.json",
|
||||||
|
"library.properties",
|
||||||
|
"LICENSE",
|
||||||
|
"README.md"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"build": {
|
||||||
|
"libCompatMode": "strict"
|
||||||
|
}
|
||||||
|
}
|
||||||
10
lib/ESP Async WebServer/library.properties
Normal file
10
lib/ESP Async WebServer/library.properties
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
name=ESP Async WebServer
|
||||||
|
version=3.0.6
|
||||||
|
author=Me-No-Dev
|
||||||
|
maintainer=Mathieu Carbou <mathieu.carbou@gmail.com>
|
||||||
|
sentence=Asynchronous HTTP and WebSocket Server Library for ESP32, ESP8266 and RP2040
|
||||||
|
paragraph=Supports: WebSocket, SSE, Authentication, Arduino Json 7, File Upload, Static File serving, URL Rewrite, URL Redirect, etc
|
||||||
|
category=Other
|
||||||
|
url=https://github.com/mathieucarbou/ESPAsyncWebServer
|
||||||
|
architectures=*
|
||||||
|
license=LGPL-3.0
|
||||||
402
lib/ESP Async WebServer/src/AsyncEventSource.cpp
Normal file
402
lib/ESP Async WebServer/src/AsyncEventSource.cpp
Normal file
@@ -0,0 +1,402 @@
|
|||||||
|
/*
|
||||||
|
Asynchronous WebServer library for Espressif MCUs
|
||||||
|
|
||||||
|
Copyright (c) 2016 Hristo Gochkov. All rights reserved.
|
||||||
|
|
||||||
|
This library is free software; you can redistribute it and/or
|
||||||
|
modify it under the terms of the GNU Lesser General Public
|
||||||
|
License as published by the Free Software Foundation; either
|
||||||
|
version 2.1 of the License, or (at your option) any later version.
|
||||||
|
|
||||||
|
This library is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||||
|
Lesser General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Lesser General Public
|
||||||
|
License along with this library; if not, write to the Free Software
|
||||||
|
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
|
||||||
|
*/
|
||||||
|
#include "Arduino.h"
|
||||||
|
#if defined(ESP32)
|
||||||
|
#include <rom/ets_sys.h>
|
||||||
|
#endif
|
||||||
|
#include "AsyncEventSource.h"
|
||||||
|
|
||||||
|
static String generateEventMessage(const char* message, const char* event, uint32_t id, uint32_t reconnect) {
|
||||||
|
String ev;
|
||||||
|
|
||||||
|
if (reconnect) {
|
||||||
|
ev += F("retry: ");
|
||||||
|
ev += reconnect;
|
||||||
|
ev += F("\r\n");
|
||||||
|
}
|
||||||
|
|
||||||
|
if (id) {
|
||||||
|
ev += F("id: ");
|
||||||
|
ev += String(id);
|
||||||
|
ev += F("\r\n");
|
||||||
|
}
|
||||||
|
|
||||||
|
if (event != NULL) {
|
||||||
|
ev += F("event: ");
|
||||||
|
ev += String(event);
|
||||||
|
ev += F("\r\n");
|
||||||
|
}
|
||||||
|
|
||||||
|
if (message != NULL) {
|
||||||
|
size_t messageLen = strlen(message);
|
||||||
|
char* lineStart = (char*)message;
|
||||||
|
char* lineEnd;
|
||||||
|
do {
|
||||||
|
char* nextN = strchr(lineStart, '\n');
|
||||||
|
char* nextR = strchr(lineStart, '\r');
|
||||||
|
if (nextN == NULL && nextR == NULL) {
|
||||||
|
size_t llen = ((char*)message + messageLen) - lineStart;
|
||||||
|
char* ldata = (char*)malloc(llen + 1);
|
||||||
|
if (ldata != NULL) {
|
||||||
|
memcpy(ldata, lineStart, llen);
|
||||||
|
ldata[llen] = 0;
|
||||||
|
ev += F("data: ");
|
||||||
|
ev += ldata;
|
||||||
|
ev += F("\r\n\r\n");
|
||||||
|
free(ldata);
|
||||||
|
}
|
||||||
|
lineStart = (char*)message + messageLen;
|
||||||
|
} else {
|
||||||
|
char* nextLine = NULL;
|
||||||
|
if (nextN != NULL && nextR != NULL) {
|
||||||
|
if (nextR < nextN) {
|
||||||
|
lineEnd = nextR;
|
||||||
|
if (nextN == (nextR + 1))
|
||||||
|
nextLine = nextN + 1;
|
||||||
|
else
|
||||||
|
nextLine = nextR + 1;
|
||||||
|
} else {
|
||||||
|
lineEnd = nextN;
|
||||||
|
if (nextR == (nextN + 1))
|
||||||
|
nextLine = nextR + 1;
|
||||||
|
else
|
||||||
|
nextLine = nextN + 1;
|
||||||
|
}
|
||||||
|
} else if (nextN != NULL) {
|
||||||
|
lineEnd = nextN;
|
||||||
|
nextLine = nextN + 1;
|
||||||
|
} else {
|
||||||
|
lineEnd = nextR;
|
||||||
|
nextLine = nextR + 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
size_t llen = lineEnd - lineStart;
|
||||||
|
char* ldata = (char*)malloc(llen + 1);
|
||||||
|
if (ldata != NULL) {
|
||||||
|
memcpy(ldata, lineStart, llen);
|
||||||
|
ldata[llen] = 0;
|
||||||
|
ev += F("data: ");
|
||||||
|
ev += ldata;
|
||||||
|
ev += F("\r\n");
|
||||||
|
free(ldata);
|
||||||
|
}
|
||||||
|
lineStart = nextLine;
|
||||||
|
if (lineStart == ((char*)message + messageLen))
|
||||||
|
ev += F("\r\n");
|
||||||
|
}
|
||||||
|
} while (lineStart < ((char*)message + messageLen));
|
||||||
|
}
|
||||||
|
|
||||||
|
return ev;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Message
|
||||||
|
|
||||||
|
AsyncEventSourceMessage::AsyncEventSourceMessage(const char* data, size_t len)
|
||||||
|
: _data(nullptr), _len(len), _sent(0), _acked(0) {
|
||||||
|
_data = (uint8_t*)malloc(_len + 1);
|
||||||
|
if (_data == nullptr) {
|
||||||
|
_len = 0;
|
||||||
|
} else {
|
||||||
|
memcpy(_data, data, len);
|
||||||
|
_data[_len] = 0;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
AsyncEventSourceMessage::~AsyncEventSourceMessage() {
|
||||||
|
if (_data != NULL)
|
||||||
|
free(_data);
|
||||||
|
}
|
||||||
|
|
||||||
|
size_t AsyncEventSourceMessage::ack(size_t len, uint32_t time) {
|
||||||
|
(void)time;
|
||||||
|
// If the whole message is now acked...
|
||||||
|
if (_acked + len > _len) {
|
||||||
|
// Return the number of extra bytes acked (they will be carried on to the next message)
|
||||||
|
const size_t extra = _acked + len - _len;
|
||||||
|
_acked = _len;
|
||||||
|
return extra;
|
||||||
|
}
|
||||||
|
// Return that no extra bytes left.
|
||||||
|
_acked += len;
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
// This could also return void as the return value is not used.
|
||||||
|
// Leaving as-is for compatibility...
|
||||||
|
size_t AsyncEventSourceMessage::send(AsyncClient* client) {
|
||||||
|
if (_sent >= _len) {
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
const size_t len_to_send = _len - _sent;
|
||||||
|
auto position = reinterpret_cast<const char*>(_data + _sent);
|
||||||
|
const size_t sent_now = client->write(position, len_to_send);
|
||||||
|
_sent += sent_now;
|
||||||
|
return sent_now;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Client
|
||||||
|
|
||||||
|
AsyncEventSourceClient::AsyncEventSourceClient(AsyncWebServerRequest* request, AsyncEventSource* server) {
|
||||||
|
_client = request->client();
|
||||||
|
_server = server;
|
||||||
|
_lastId = 0;
|
||||||
|
if (request->hasHeader(F("Last-Event-ID")))
|
||||||
|
_lastId = atoi(request->getHeader(F("Last-Event-ID"))->value().c_str());
|
||||||
|
|
||||||
|
_client->setRxTimeout(0);
|
||||||
|
_client->onError(NULL, NULL);
|
||||||
|
_client->onAck([](void* r, AsyncClient* c, size_t len, uint32_t time) { (void)c; ((AsyncEventSourceClient*)(r))->_onAck(len, time); }, this);
|
||||||
|
_client->onPoll([](void* r, AsyncClient* c) { (void)c; ((AsyncEventSourceClient*)(r))->_onPoll(); }, this);
|
||||||
|
_client->onData(NULL, NULL);
|
||||||
|
_client->onTimeout([this](void* r, AsyncClient* c __attribute__((unused)), uint32_t time) { ((AsyncEventSourceClient*)(r))->_onTimeout(time); }, this);
|
||||||
|
_client->onDisconnect([this](void* r, AsyncClient* c) { ((AsyncEventSourceClient*)(r))->_onDisconnect(); delete c; }, this);
|
||||||
|
|
||||||
|
_server->_addClient(this);
|
||||||
|
delete request;
|
||||||
|
}
|
||||||
|
|
||||||
|
AsyncEventSourceClient::~AsyncEventSourceClient() {
|
||||||
|
#ifdef ESP32
|
||||||
|
std::lock_guard<std::mutex> lock(_lockmq);
|
||||||
|
#endif
|
||||||
|
_messageQueue.clear();
|
||||||
|
close();
|
||||||
|
}
|
||||||
|
|
||||||
|
void AsyncEventSourceClient::_queueMessage(const char* message, size_t len) {
|
||||||
|
#ifdef ESP32
|
||||||
|
// length() is not thread-safe, thus acquiring the lock before this call..
|
||||||
|
std::lock_guard<std::mutex> lock(_lockmq);
|
||||||
|
#endif
|
||||||
|
|
||||||
|
if (_messageQueue.size() >= SSE_MAX_QUEUED_MESSAGES) {
|
||||||
|
#ifdef ESP8266
|
||||||
|
ets_printf(String(F("ERROR: Too many messages queued\n")).c_str());
|
||||||
|
#elif defined(ESP32)
|
||||||
|
log_e("Too many messages queued: deleting message");
|
||||||
|
#endif
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
_messageQueue.emplace_back(message, len);
|
||||||
|
// runqueue trigger when new messages added
|
||||||
|
if (_client->canSend()) {
|
||||||
|
_runQueue();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
void AsyncEventSourceClient::_onAck(size_t len, uint32_t time) {
|
||||||
|
#ifdef ESP32
|
||||||
|
// Same here, acquiring the lock early
|
||||||
|
std::lock_guard<std::mutex> lock(_lockmq);
|
||||||
|
#endif
|
||||||
|
while (len && _messageQueue.size()) {
|
||||||
|
len = _messageQueue.front().ack(len, time);
|
||||||
|
if (_messageQueue.front().finished())
|
||||||
|
_messageQueue.pop_front();
|
||||||
|
}
|
||||||
|
_runQueue();
|
||||||
|
}
|
||||||
|
|
||||||
|
void AsyncEventSourceClient::_onPoll() {
|
||||||
|
#ifdef ESP32
|
||||||
|
// Same here, acquiring the lock early
|
||||||
|
std::lock_guard<std::mutex> lock(_lockmq);
|
||||||
|
#endif
|
||||||
|
if (_messageQueue.size()) {
|
||||||
|
_runQueue();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
void AsyncEventSourceClient::_onTimeout(uint32_t time __attribute__((unused))) {
|
||||||
|
_client->close(true);
|
||||||
|
}
|
||||||
|
|
||||||
|
void AsyncEventSourceClient::_onDisconnect() {
|
||||||
|
_client = NULL;
|
||||||
|
_server->_handleDisconnect(this);
|
||||||
|
}
|
||||||
|
|
||||||
|
void AsyncEventSourceClient::close() {
|
||||||
|
if (_client != NULL)
|
||||||
|
_client->close();
|
||||||
|
}
|
||||||
|
|
||||||
|
void AsyncEventSourceClient::write(const char* message, size_t len) {
|
||||||
|
if (!connected())
|
||||||
|
return;
|
||||||
|
_queueMessage(message, len);
|
||||||
|
}
|
||||||
|
|
||||||
|
void AsyncEventSourceClient::send(const char* message, const char* event, uint32_t id, uint32_t reconnect) {
|
||||||
|
if (!connected())
|
||||||
|
return;
|
||||||
|
String ev = generateEventMessage(message, event, id, reconnect);
|
||||||
|
_queueMessage(ev.c_str(), ev.length());
|
||||||
|
}
|
||||||
|
|
||||||
|
size_t AsyncEventSourceClient::packetsWaiting() const {
|
||||||
|
#ifdef ESP32
|
||||||
|
std::lock_guard<std::mutex> lock(_lockmq);
|
||||||
|
#endif
|
||||||
|
return _messageQueue.size();
|
||||||
|
}
|
||||||
|
|
||||||
|
void AsyncEventSourceClient::_runQueue() {
|
||||||
|
// Calls to this private method now already protected by _lockmq acquisition
|
||||||
|
// so no extra call of _lockmq.lock() here..
|
||||||
|
for (auto& i : _messageQueue) {
|
||||||
|
if (!i.sent())
|
||||||
|
i.send(_client);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Handler
|
||||||
|
void AsyncEventSource::onConnect(ArEventHandlerFunction cb) {
|
||||||
|
_connectcb = cb;
|
||||||
|
}
|
||||||
|
|
||||||
|
void AsyncEventSource::authorizeConnect(ArAuthorizeConnectHandler cb) {
|
||||||
|
_authorizeConnectHandler = cb;
|
||||||
|
}
|
||||||
|
|
||||||
|
void AsyncEventSource::_addClient(AsyncEventSourceClient* client) {
|
||||||
|
if (!client)
|
||||||
|
return;
|
||||||
|
#ifdef ESP32
|
||||||
|
std::lock_guard<std::mutex> lock(_client_queue_lock);
|
||||||
|
#endif
|
||||||
|
_clients.emplace_back(client);
|
||||||
|
if (_connectcb)
|
||||||
|
_connectcb(client);
|
||||||
|
}
|
||||||
|
|
||||||
|
void AsyncEventSource::_handleDisconnect(AsyncEventSourceClient* client) {
|
||||||
|
#ifdef ESP32
|
||||||
|
std::lock_guard<std::mutex> lock(_client_queue_lock);
|
||||||
|
#endif
|
||||||
|
for (auto i = _clients.begin(); i != _clients.end(); ++i) {
|
||||||
|
if (i->get() == client)
|
||||||
|
_clients.erase(i);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
void AsyncEventSource::close() {
|
||||||
|
// While the whole loop is not done, the linked list is locked and so the
|
||||||
|
// iterator should remain valid even when AsyncEventSource::_handleDisconnect()
|
||||||
|
// is called very early
|
||||||
|
#ifdef ESP32
|
||||||
|
std::lock_guard<std::mutex> lock(_client_queue_lock);
|
||||||
|
#endif
|
||||||
|
for (const auto& c : _clients) {
|
||||||
|
if (c->connected())
|
||||||
|
c->close();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// pmb fix
|
||||||
|
size_t AsyncEventSource::avgPacketsWaiting() const {
|
||||||
|
size_t aql = 0;
|
||||||
|
uint32_t nConnectedClients = 0;
|
||||||
|
#ifdef ESP32
|
||||||
|
std::lock_guard<std::mutex> lock(_client_queue_lock);
|
||||||
|
#endif
|
||||||
|
if (!_clients.size())
|
||||||
|
return 0;
|
||||||
|
|
||||||
|
for (const auto& c : _clients) {
|
||||||
|
if (c->connected()) {
|
||||||
|
aql += c->packetsWaiting();
|
||||||
|
++nConnectedClients;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return ((aql) + (nConnectedClients / 2)) / (nConnectedClients); // round up
|
||||||
|
}
|
||||||
|
|
||||||
|
void AsyncEventSource::send(
|
||||||
|
const char* message, const char* event, uint32_t id, uint32_t reconnect) {
|
||||||
|
String ev = generateEventMessage(message, event, id, reconnect);
|
||||||
|
#ifdef ESP32
|
||||||
|
std::lock_guard<std::mutex> lock(_client_queue_lock);
|
||||||
|
#endif
|
||||||
|
for (const auto& c : _clients) {
|
||||||
|
if (c->connected()) {
|
||||||
|
c->write(ev.c_str(), ev.length());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
size_t AsyncEventSource::count() const {
|
||||||
|
#ifdef ESP32
|
||||||
|
std::lock_guard<std::mutex> lock(_client_queue_lock);
|
||||||
|
#endif
|
||||||
|
size_t n_clients{0};
|
||||||
|
for (const auto& i : _clients)
|
||||||
|
if (i->connected())
|
||||||
|
++n_clients;
|
||||||
|
|
||||||
|
return n_clients;
|
||||||
|
}
|
||||||
|
|
||||||
|
bool AsyncEventSource::canHandle(AsyncWebServerRequest* request) {
|
||||||
|
if (request->method() != HTTP_GET || !request->url().equals(_url)) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
request->addInterestingHeader(F("Last-Event-ID"));
|
||||||
|
request->addInterestingHeader("Cookie");
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
void AsyncEventSource::handleRequest(AsyncWebServerRequest* request) {
|
||||||
|
if ((_username.length() && _password.length()) && !request->authenticate(_username.c_str(), _password.c_str())) {
|
||||||
|
return request->requestAuthentication();
|
||||||
|
}
|
||||||
|
if (_authorizeConnectHandler != NULL) {
|
||||||
|
if (!_authorizeConnectHandler(request)) {
|
||||||
|
return request->send(401);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
request->send(new AsyncEventSourceResponse(this));
|
||||||
|
}
|
||||||
|
|
||||||
|
// Response
|
||||||
|
|
||||||
|
AsyncEventSourceResponse::AsyncEventSourceResponse(AsyncEventSource* server) {
|
||||||
|
_server = server;
|
||||||
|
_code = 200;
|
||||||
|
_contentType = F("text/event-stream");
|
||||||
|
_sendContentLength = false;
|
||||||
|
addHeader(F("Cache-Control"), F("no-cache"));
|
||||||
|
addHeader(F("Connection"), F("keep-alive"));
|
||||||
|
}
|
||||||
|
|
||||||
|
void AsyncEventSourceResponse::_respond(AsyncWebServerRequest* request) {
|
||||||
|
String out = _assembleHead(request->version());
|
||||||
|
request->client()->write(out.c_str(), _headLength);
|
||||||
|
_state = RESPONSE_WAIT_ACK;
|
||||||
|
}
|
||||||
|
|
||||||
|
size_t AsyncEventSourceResponse::_ack(AsyncWebServerRequest* request, size_t len, uint32_t time __attribute__((unused))) {
|
||||||
|
if (len) {
|
||||||
|
new AsyncEventSourceClient(request, _server);
|
||||||
|
}
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
158
lib/ESP Async WebServer/src/AsyncEventSource.h
Normal file
158
lib/ESP Async WebServer/src/AsyncEventSource.h
Normal file
@@ -0,0 +1,158 @@
|
|||||||
|
/*
|
||||||
|
Asynchronous WebServer library for Espressif MCUs
|
||||||
|
|
||||||
|
Copyright (c) 2016 Hristo Gochkov. All rights reserved.
|
||||||
|
|
||||||
|
This library is free software; you can redistribute it and/or
|
||||||
|
modify it under the terms of the GNU Lesser General Public
|
||||||
|
License as published by the Free Software Foundation; either
|
||||||
|
version 2.1 of the License, or (at your option) any later version.
|
||||||
|
|
||||||
|
This library is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||||
|
Lesser General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Lesser General Public
|
||||||
|
License along with this library; if not, write to the Free Software
|
||||||
|
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
|
||||||
|
*/
|
||||||
|
#ifndef ASYNCEVENTSOURCE_H_
|
||||||
|
#define ASYNCEVENTSOURCE_H_
|
||||||
|
|
||||||
|
#include <Arduino.h>
|
||||||
|
#include <list>
|
||||||
|
#ifdef ESP32
|
||||||
|
#include <AsyncTCP.h>
|
||||||
|
#include <mutex>
|
||||||
|
#ifndef SSE_MAX_QUEUED_MESSAGES
|
||||||
|
#define SSE_MAX_QUEUED_MESSAGES 32
|
||||||
|
#endif
|
||||||
|
#elif defined(ESP8266)
|
||||||
|
#include <ESPAsyncTCP.h>
|
||||||
|
#ifndef SSE_MAX_QUEUED_MESSAGES
|
||||||
|
#define SSE_MAX_QUEUED_MESSAGES 8
|
||||||
|
#endif
|
||||||
|
#elif defined(TARGET_RP2040)
|
||||||
|
#include <AsyncTCP_RP2040W.h>
|
||||||
|
#ifndef SSE_MAX_QUEUED_MESSAGES
|
||||||
|
#define SSE_MAX_QUEUED_MESSAGES 32
|
||||||
|
#endif
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#include <ESPAsyncWebServer.h>
|
||||||
|
|
||||||
|
#ifdef ESP8266
|
||||||
|
#include <Hash.h>
|
||||||
|
#ifdef CRYPTO_HASH_h // include Hash.h from espressif framework if the first include was from the crypto library
|
||||||
|
#include <../src/Hash.h>
|
||||||
|
#endif
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#ifndef DEFAULT_MAX_SSE_CLIENTS
|
||||||
|
#ifdef ESP32
|
||||||
|
#define DEFAULT_MAX_SSE_CLIENTS 8
|
||||||
|
#else
|
||||||
|
#define DEFAULT_MAX_SSE_CLIENTS 4
|
||||||
|
#endif
|
||||||
|
#endif
|
||||||
|
|
||||||
|
class AsyncEventSource;
|
||||||
|
class AsyncEventSourceResponse;
|
||||||
|
class AsyncEventSourceClient;
|
||||||
|
using ArEventHandlerFunction = std::function<void(AsyncEventSourceClient* client)>;
|
||||||
|
using ArAuthorizeConnectHandler = std::function<bool(AsyncWebServerRequest* request)>;
|
||||||
|
|
||||||
|
class AsyncEventSourceMessage {
|
||||||
|
private:
|
||||||
|
uint8_t* _data;
|
||||||
|
size_t _len;
|
||||||
|
size_t _sent;
|
||||||
|
// size_t _ack;
|
||||||
|
size_t _acked;
|
||||||
|
|
||||||
|
public:
|
||||||
|
AsyncEventSourceMessage(const char* data, size_t len);
|
||||||
|
~AsyncEventSourceMessage();
|
||||||
|
size_t ack(size_t len, uint32_t time __attribute__((unused)));
|
||||||
|
size_t send(AsyncClient* client);
|
||||||
|
bool finished() { return _acked == _len; }
|
||||||
|
bool sent() { return _sent == _len; }
|
||||||
|
};
|
||||||
|
|
||||||
|
class AsyncEventSourceClient {
|
||||||
|
private:
|
||||||
|
AsyncClient* _client;
|
||||||
|
AsyncEventSource* _server;
|
||||||
|
uint32_t _lastId;
|
||||||
|
std::list<AsyncEventSourceMessage> _messageQueue;
|
||||||
|
#ifdef ESP32
|
||||||
|
mutable std::mutex _lockmq;
|
||||||
|
#endif
|
||||||
|
void _queueMessage(const char* message, size_t len);
|
||||||
|
void _runQueue();
|
||||||
|
|
||||||
|
public:
|
||||||
|
AsyncEventSourceClient(AsyncWebServerRequest* request, AsyncEventSource* server);
|
||||||
|
~AsyncEventSourceClient();
|
||||||
|
|
||||||
|
AsyncClient* client() { return _client; }
|
||||||
|
void close();
|
||||||
|
void write(const char* message, size_t len);
|
||||||
|
void send(const char* message, const char* event = NULL, uint32_t id = 0, uint32_t reconnect = 0);
|
||||||
|
bool connected() const { return (_client != NULL) && _client->connected(); }
|
||||||
|
uint32_t lastId() const { return _lastId; }
|
||||||
|
size_t packetsWaiting() const;
|
||||||
|
|
||||||
|
// system callbacks (do not call)
|
||||||
|
void _onAck(size_t len, uint32_t time);
|
||||||
|
void _onPoll();
|
||||||
|
void _onTimeout(uint32_t time);
|
||||||
|
void _onDisconnect();
|
||||||
|
};
|
||||||
|
|
||||||
|
class AsyncEventSource : public AsyncWebHandler {
|
||||||
|
private:
|
||||||
|
String _url;
|
||||||
|
std::list<std::unique_ptr<AsyncEventSourceClient>> _clients;
|
||||||
|
#ifdef ESP32
|
||||||
|
// Same as for individual messages, protect mutations of _clients list
|
||||||
|
// since simultaneous access from different tasks is possible
|
||||||
|
mutable std::mutex _client_queue_lock;
|
||||||
|
#endif
|
||||||
|
ArEventHandlerFunction _connectcb{nullptr};
|
||||||
|
ArAuthorizeConnectHandler _authorizeConnectHandler;
|
||||||
|
|
||||||
|
public:
|
||||||
|
AsyncEventSource(const String& url) : _url(url){};
|
||||||
|
~AsyncEventSource() { close(); };
|
||||||
|
|
||||||
|
const char* url() const { return _url.c_str(); }
|
||||||
|
void close();
|
||||||
|
void onConnect(ArEventHandlerFunction cb);
|
||||||
|
void authorizeConnect(ArAuthorizeConnectHandler cb);
|
||||||
|
void send(const char* message, const char* event = NULL, uint32_t id = 0, uint32_t reconnect = 0);
|
||||||
|
// number of clients connected
|
||||||
|
size_t count() const;
|
||||||
|
size_t avgPacketsWaiting() const;
|
||||||
|
|
||||||
|
// system callbacks (do not call)
|
||||||
|
void _addClient(AsyncEventSourceClient* client);
|
||||||
|
void _handleDisconnect(AsyncEventSourceClient* client);
|
||||||
|
virtual bool canHandle(AsyncWebServerRequest* request) override final;
|
||||||
|
virtual void handleRequest(AsyncWebServerRequest* request) override final;
|
||||||
|
};
|
||||||
|
|
||||||
|
class AsyncEventSourceResponse : public AsyncWebServerResponse {
|
||||||
|
private:
|
||||||
|
String _content;
|
||||||
|
AsyncEventSource* _server;
|
||||||
|
|
||||||
|
public:
|
||||||
|
AsyncEventSourceResponse(AsyncEventSource* server);
|
||||||
|
void _respond(AsyncWebServerRequest* request);
|
||||||
|
size_t _ack(AsyncWebServerRequest* request, size_t len, uint32_t time);
|
||||||
|
bool _sourceValid() const { return true; }
|
||||||
|
};
|
||||||
|
|
||||||
|
#endif /* ASYNCEVENTSOURCE_H_ */
|
||||||
281
lib/ESP Async WebServer/src/AsyncJson.h
Normal file
281
lib/ESP Async WebServer/src/AsyncJson.h
Normal file
@@ -0,0 +1,281 @@
|
|||||||
|
// AsyncJson.h
|
||||||
|
/*
|
||||||
|
Async Response to use with ArduinoJson and AsyncWebServer
|
||||||
|
Written by Andrew Melvin (SticilFace) with help from me-no-dev and BBlanchon.
|
||||||
|
|
||||||
|
Example of callback in use
|
||||||
|
|
||||||
|
server.on("/json", HTTP_ANY, [](AsyncWebServerRequest * request) {
|
||||||
|
|
||||||
|
AsyncJsonResponse * response = new AsyncJsonResponse();
|
||||||
|
JsonObject& root = response->getRoot();
|
||||||
|
root["key1"] = "key number one";
|
||||||
|
JsonObject& nested = root.createNestedObject("nested");
|
||||||
|
nested["key1"] = "key number one";
|
||||||
|
|
||||||
|
response->setLength();
|
||||||
|
request->send(response);
|
||||||
|
});
|
||||||
|
|
||||||
|
--------------------
|
||||||
|
|
||||||
|
Async Request to use with ArduinoJson and AsyncWebServer
|
||||||
|
Written by Arsène von Wyss (avonwyss)
|
||||||
|
|
||||||
|
Example
|
||||||
|
|
||||||
|
AsyncCallbackJsonWebHandler* handler = new AsyncCallbackJsonWebHandler("/rest/endpoint");
|
||||||
|
handler->onRequest([](AsyncWebServerRequest *request, JsonVariant &json) {
|
||||||
|
JsonObject& jsonObj = json.as<JsonObject>();
|
||||||
|
// ...
|
||||||
|
});
|
||||||
|
server.addHandler(handler);
|
||||||
|
|
||||||
|
*/
|
||||||
|
#ifndef ASYNC_JSON_H_
|
||||||
|
#define ASYNC_JSON_H_
|
||||||
|
#include <ArduinoJson.h>
|
||||||
|
#include <ESPAsyncWebServer.h>
|
||||||
|
#include <Print.h>
|
||||||
|
|
||||||
|
#if ARDUINOJSON_VERSION_MAJOR == 6
|
||||||
|
#ifndef DYNAMIC_JSON_DOCUMENT_SIZE
|
||||||
|
#define DYNAMIC_JSON_DOCUMENT_SIZE 1024
|
||||||
|
#endif
|
||||||
|
#endif
|
||||||
|
|
||||||
|
constexpr const char* JSON_MIMETYPE = "application/json";
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Json Response
|
||||||
|
* */
|
||||||
|
|
||||||
|
class ChunkPrint : public Print {
|
||||||
|
private:
|
||||||
|
uint8_t* _destination;
|
||||||
|
size_t _to_skip;
|
||||||
|
size_t _to_write;
|
||||||
|
size_t _pos;
|
||||||
|
|
||||||
|
public:
|
||||||
|
ChunkPrint(uint8_t* destination, size_t from, size_t len)
|
||||||
|
: _destination(destination), _to_skip(from), _to_write(len), _pos{0} {}
|
||||||
|
virtual ~ChunkPrint() {}
|
||||||
|
size_t write(uint8_t c) {
|
||||||
|
if (_to_skip > 0) {
|
||||||
|
_to_skip--;
|
||||||
|
return 1;
|
||||||
|
} else if (_to_write > 0) {
|
||||||
|
_to_write--;
|
||||||
|
_destination[_pos++] = c;
|
||||||
|
return 1;
|
||||||
|
}
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
size_t write(const uint8_t* buffer, size_t size) {
|
||||||
|
return this->Print::write(buffer, size);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
class AsyncJsonResponse : public AsyncAbstractResponse {
|
||||||
|
protected:
|
||||||
|
#if ARDUINOJSON_VERSION_MAJOR == 5
|
||||||
|
DynamicJsonBuffer _jsonBuffer;
|
||||||
|
#elif ARDUINOJSON_VERSION_MAJOR == 6
|
||||||
|
DynamicJsonDocument _jsonBuffer;
|
||||||
|
#else
|
||||||
|
JsonDocument _jsonBuffer;
|
||||||
|
#endif
|
||||||
|
|
||||||
|
JsonVariant _root;
|
||||||
|
bool _isValid;
|
||||||
|
|
||||||
|
public:
|
||||||
|
#if ARDUINOJSON_VERSION_MAJOR == 5
|
||||||
|
AsyncJsonResponse(bool isArray = false) : _isValid{false} {
|
||||||
|
_code = 200;
|
||||||
|
_contentType = JSON_MIMETYPE;
|
||||||
|
if (isArray)
|
||||||
|
_root = _jsonBuffer.createArray();
|
||||||
|
else
|
||||||
|
_root = _jsonBuffer.createObject();
|
||||||
|
}
|
||||||
|
#elif ARDUINOJSON_VERSION_MAJOR == 6
|
||||||
|
AsyncJsonResponse(bool isArray = false, size_t maxJsonBufferSize = DYNAMIC_JSON_DOCUMENT_SIZE) : _jsonBuffer(maxJsonBufferSize), _isValid{false} {
|
||||||
|
_code = 200;
|
||||||
|
_contentType = JSON_MIMETYPE;
|
||||||
|
if (isArray)
|
||||||
|
_root = _jsonBuffer.createNestedArray();
|
||||||
|
else
|
||||||
|
_root = _jsonBuffer.createNestedObject();
|
||||||
|
}
|
||||||
|
#else
|
||||||
|
AsyncJsonResponse(bool isArray = false) : _isValid{false} {
|
||||||
|
_code = 200;
|
||||||
|
_contentType = JSON_MIMETYPE;
|
||||||
|
if (isArray)
|
||||||
|
_root = _jsonBuffer.add<JsonArray>();
|
||||||
|
else
|
||||||
|
_root = _jsonBuffer.add<JsonObject>();
|
||||||
|
}
|
||||||
|
#endif
|
||||||
|
|
||||||
|
JsonVariant& getRoot() { return _root; }
|
||||||
|
bool _sourceValid() const { return _isValid; }
|
||||||
|
size_t setLength() {
|
||||||
|
|
||||||
|
#if ARDUINOJSON_VERSION_MAJOR == 5
|
||||||
|
_contentLength = _root.measureLength();
|
||||||
|
#else
|
||||||
|
_contentLength = measureJson(_root);
|
||||||
|
#endif
|
||||||
|
|
||||||
|
if (_contentLength) {
|
||||||
|
_isValid = true;
|
||||||
|
}
|
||||||
|
return _contentLength;
|
||||||
|
}
|
||||||
|
|
||||||
|
size_t getSize() const { return _jsonBuffer.size(); }
|
||||||
|
|
||||||
|
#if ARDUINOJSON_VERSION_MAJOR >= 6
|
||||||
|
bool overflowed() const { return _jsonBuffer.overflowed(); }
|
||||||
|
#endif
|
||||||
|
|
||||||
|
size_t _fillBuffer(uint8_t* data, size_t len) {
|
||||||
|
ChunkPrint dest(data, _sentLength, len);
|
||||||
|
|
||||||
|
#if ARDUINOJSON_VERSION_MAJOR == 5
|
||||||
|
_root.printTo(dest);
|
||||||
|
#else
|
||||||
|
serializeJson(_root, dest);
|
||||||
|
#endif
|
||||||
|
return len;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
class PrettyAsyncJsonResponse : public AsyncJsonResponse {
|
||||||
|
public:
|
||||||
|
#if ARDUINOJSON_VERSION_MAJOR == 6
|
||||||
|
PrettyAsyncJsonResponse(bool isArray = false, size_t maxJsonBufferSize = DYNAMIC_JSON_DOCUMENT_SIZE) : AsyncJsonResponse{isArray, maxJsonBufferSize} {}
|
||||||
|
#else
|
||||||
|
PrettyAsyncJsonResponse(bool isArray = false) : AsyncJsonResponse{isArray} {}
|
||||||
|
#endif
|
||||||
|
size_t setLength() {
|
||||||
|
#if ARDUINOJSON_VERSION_MAJOR == 5
|
||||||
|
_contentLength = _root.measurePrettyLength();
|
||||||
|
#else
|
||||||
|
_contentLength = measureJsonPretty(_root);
|
||||||
|
#endif
|
||||||
|
if (_contentLength) {
|
||||||
|
_isValid = true;
|
||||||
|
}
|
||||||
|
return _contentLength;
|
||||||
|
}
|
||||||
|
size_t _fillBuffer(uint8_t* data, size_t len) {
|
||||||
|
ChunkPrint dest(data, _sentLength, len);
|
||||||
|
#if ARDUINOJSON_VERSION_MAJOR == 5
|
||||||
|
_root.prettyPrintTo(dest);
|
||||||
|
#else
|
||||||
|
serializeJsonPretty(_root, dest);
|
||||||
|
#endif
|
||||||
|
return len;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
typedef std::function<void(AsyncWebServerRequest* request, JsonVariant& json)> ArJsonRequestHandlerFunction;
|
||||||
|
|
||||||
|
class AsyncCallbackJsonWebHandler : public AsyncWebHandler {
|
||||||
|
private:
|
||||||
|
protected:
|
||||||
|
const String _uri;
|
||||||
|
WebRequestMethodComposite _method;
|
||||||
|
ArJsonRequestHandlerFunction _onRequest;
|
||||||
|
size_t _contentLength;
|
||||||
|
#if ARDUINOJSON_VERSION_MAJOR == 6
|
||||||
|
const size_t maxJsonBufferSize;
|
||||||
|
#endif
|
||||||
|
size_t _maxContentLength;
|
||||||
|
|
||||||
|
public:
|
||||||
|
#if ARDUINOJSON_VERSION_MAJOR == 6
|
||||||
|
AsyncCallbackJsonWebHandler(const String& uri, ArJsonRequestHandlerFunction onRequest, size_t maxJsonBufferSize = DYNAMIC_JSON_DOCUMENT_SIZE)
|
||||||
|
: _uri(uri), _method(HTTP_GET | HTTP_POST | HTTP_PUT | HTTP_PATCH), _onRequest(onRequest), maxJsonBufferSize(maxJsonBufferSize), _maxContentLength(16384) {}
|
||||||
|
#else
|
||||||
|
AsyncCallbackJsonWebHandler(const String& uri, ArJsonRequestHandlerFunction onRequest)
|
||||||
|
: _uri(uri), _method(HTTP_GET | HTTP_POST | HTTP_PUT | HTTP_PATCH), _onRequest(onRequest), _maxContentLength(16384) {}
|
||||||
|
#endif
|
||||||
|
|
||||||
|
void setMethod(WebRequestMethodComposite method) { _method = method; }
|
||||||
|
void setMaxContentLength(int maxContentLength) { _maxContentLength = maxContentLength; }
|
||||||
|
void onRequest(ArJsonRequestHandlerFunction fn) { _onRequest = fn; }
|
||||||
|
|
||||||
|
virtual bool canHandle(AsyncWebServerRequest* request) override final {
|
||||||
|
if (!_onRequest)
|
||||||
|
return false;
|
||||||
|
|
||||||
|
WebRequestMethodComposite request_method = request->method();
|
||||||
|
if (!(_method & request_method))
|
||||||
|
return false;
|
||||||
|
|
||||||
|
if (_uri.length() && (_uri != request->url() && !request->url().startsWith(_uri + "/")))
|
||||||
|
return false;
|
||||||
|
|
||||||
|
if (request_method != HTTP_GET && !request->contentType().equalsIgnoreCase(JSON_MIMETYPE))
|
||||||
|
return false;
|
||||||
|
|
||||||
|
request->addInterestingHeader("ANY");
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
virtual void handleRequest(AsyncWebServerRequest* request) override final {
|
||||||
|
if ((_username != "" && _password != "") && !request->authenticate(_username.c_str(), _password.c_str()))
|
||||||
|
return request->requestAuthentication();
|
||||||
|
if (_onRequest) {
|
||||||
|
if (request->method() == HTTP_GET) {
|
||||||
|
JsonVariant json;
|
||||||
|
_onRequest(request, json);
|
||||||
|
return;
|
||||||
|
} else if (request->_tempObject != NULL) {
|
||||||
|
|
||||||
|
#if ARDUINOJSON_VERSION_MAJOR == 5
|
||||||
|
DynamicJsonBuffer jsonBuffer;
|
||||||
|
JsonVariant json = jsonBuffer.parse((uint8_t*)(request->_tempObject));
|
||||||
|
if (json.success()) {
|
||||||
|
#elif ARDUINOJSON_VERSION_MAJOR == 6
|
||||||
|
DynamicJsonDocument jsonBuffer(this->maxJsonBufferSize);
|
||||||
|
DeserializationError error = deserializeJson(jsonBuffer, (uint8_t*)(request->_tempObject));
|
||||||
|
if (!error) {
|
||||||
|
JsonVariant json = jsonBuffer.as<JsonVariant>();
|
||||||
|
#else
|
||||||
|
JsonDocument jsonBuffer;
|
||||||
|
DeserializationError error = deserializeJson(jsonBuffer, (uint8_t*)(request->_tempObject));
|
||||||
|
if (!error) {
|
||||||
|
JsonVariant json = jsonBuffer.as<JsonVariant>();
|
||||||
|
#endif
|
||||||
|
|
||||||
|
_onRequest(request, json);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
request->send(_contentLength > _maxContentLength ? 413 : 400);
|
||||||
|
} else {
|
||||||
|
request->send(500);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
virtual void handleUpload(__unused AsyncWebServerRequest* request, __unused const String& filename, __unused size_t index, __unused uint8_t* data, __unused size_t len, __unused bool final) override final {
|
||||||
|
}
|
||||||
|
virtual void handleBody(AsyncWebServerRequest* request, uint8_t* data, size_t len, size_t index, size_t total) override final {
|
||||||
|
if (_onRequest) {
|
||||||
|
_contentLength = total;
|
||||||
|
if (total > 0 && request->_tempObject == NULL && total < _maxContentLength) {
|
||||||
|
request->_tempObject = malloc(total);
|
||||||
|
}
|
||||||
|
if (request->_tempObject != NULL) {
|
||||||
|
memcpy((uint8_t*)(request->_tempObject) + index, data, len);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
virtual bool isRequestHandlerTrivial() override final { return _onRequest ? false : true; }
|
||||||
|
};
|
||||||
|
#endif
|
||||||
1197
lib/ESP Async WebServer/src/AsyncWebSocket.cpp
Normal file
1197
lib/ESP Async WebServer/src/AsyncWebSocket.cpp
Normal file
File diff suppressed because it is too large
Load Diff
390
lib/ESP Async WebServer/src/AsyncWebSocket.h
Normal file
390
lib/ESP Async WebServer/src/AsyncWebSocket.h
Normal file
@@ -0,0 +1,390 @@
|
|||||||
|
/*
|
||||||
|
Asynchronous WebServer library for Espressif MCUs
|
||||||
|
|
||||||
|
Copyright (c) 2016 Hristo Gochkov. All rights reserved.
|
||||||
|
This file is part of the esp8266 core for Arduino environment.
|
||||||
|
|
||||||
|
This library is free software; you can redistribute it and/or
|
||||||
|
modify it under the terms of the GNU Lesser General Public
|
||||||
|
License as published by the Free Software Foundation; either
|
||||||
|
version 2.1 of the License, or (at your option) any later version.
|
||||||
|
|
||||||
|
This library is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||||
|
Lesser General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Lesser General Public
|
||||||
|
License along with this library; if not, write to the Free Software
|
||||||
|
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
|
||||||
|
*/
|
||||||
|
#ifndef ASYNCWEBSOCKET_H_
|
||||||
|
#define ASYNCWEBSOCKET_H_
|
||||||
|
|
||||||
|
#include <Arduino.h>
|
||||||
|
#ifdef ESP32
|
||||||
|
#include <AsyncTCP.h>
|
||||||
|
#include <mutex>
|
||||||
|
#ifndef WS_MAX_QUEUED_MESSAGES
|
||||||
|
#define WS_MAX_QUEUED_MESSAGES 32
|
||||||
|
#endif
|
||||||
|
#elif defined(ESP8266)
|
||||||
|
#include <ESPAsyncTCP.h>
|
||||||
|
#ifndef WS_MAX_QUEUED_MESSAGES
|
||||||
|
#define WS_MAX_QUEUED_MESSAGES 8
|
||||||
|
#endif
|
||||||
|
#elif defined(TARGET_RP2040)
|
||||||
|
#include <AsyncTCP_RP2040W.h>
|
||||||
|
#ifndef WS_MAX_QUEUED_MESSAGES
|
||||||
|
#define WS_MAX_QUEUED_MESSAGES 32
|
||||||
|
#endif
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#include <ESPAsyncWebServer.h>
|
||||||
|
|
||||||
|
#include <deque>
|
||||||
|
#include <list>
|
||||||
|
#include <memory>
|
||||||
|
|
||||||
|
#ifdef ESP8266
|
||||||
|
#include <Hash.h>
|
||||||
|
#ifdef CRYPTO_HASH_h // include Hash.h from espressif framework if the first include was from the crypto library
|
||||||
|
#include <../src/Hash.h>
|
||||||
|
#endif
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#ifndef DEFAULT_MAX_WS_CLIENTS
|
||||||
|
#ifdef ESP32
|
||||||
|
#define DEFAULT_MAX_WS_CLIENTS 8
|
||||||
|
#else
|
||||||
|
#define DEFAULT_MAX_WS_CLIENTS 4
|
||||||
|
#endif
|
||||||
|
#endif
|
||||||
|
|
||||||
|
using AsyncWebSocketSharedBuffer = std::shared_ptr<std::vector<uint8_t>>;
|
||||||
|
|
||||||
|
class AsyncWebSocket;
|
||||||
|
class AsyncWebSocketResponse;
|
||||||
|
class AsyncWebSocketClient;
|
||||||
|
class AsyncWebSocketControl;
|
||||||
|
|
||||||
|
typedef struct {
|
||||||
|
/** Message type as defined by enum AwsFrameType.
|
||||||
|
* Note: Applications will only see WS_TEXT and WS_BINARY.
|
||||||
|
* All other types are handled by the library. */
|
||||||
|
uint8_t message_opcode;
|
||||||
|
/** Frame number of a fragmented message. */
|
||||||
|
uint32_t num;
|
||||||
|
/** Is this the last frame in a fragmented message ?*/
|
||||||
|
uint8_t final;
|
||||||
|
/** Is this frame masked? */
|
||||||
|
uint8_t masked;
|
||||||
|
/** Message type as defined by enum AwsFrameType.
|
||||||
|
* This value is the same as message_opcode for non-fragmented
|
||||||
|
* messages, but may also be WS_CONTINUATION in a fragmented message. */
|
||||||
|
uint8_t opcode;
|
||||||
|
/** Length of the current frame.
|
||||||
|
* This equals the total length of the message if num == 0 && final == true */
|
||||||
|
uint64_t len;
|
||||||
|
/** Mask key */
|
||||||
|
uint8_t mask[4];
|
||||||
|
/** Offset of the data inside the current frame. */
|
||||||
|
uint64_t index;
|
||||||
|
} AwsFrameInfo;
|
||||||
|
|
||||||
|
typedef enum { WS_DISCONNECTED,
|
||||||
|
WS_CONNECTED,
|
||||||
|
WS_DISCONNECTING } AwsClientStatus;
|
||||||
|
typedef enum { WS_CONTINUATION,
|
||||||
|
WS_TEXT,
|
||||||
|
WS_BINARY,
|
||||||
|
WS_DISCONNECT = 0x08,
|
||||||
|
WS_PING,
|
||||||
|
WS_PONG } AwsFrameType;
|
||||||
|
typedef enum { WS_MSG_SENDING,
|
||||||
|
WS_MSG_SENT,
|
||||||
|
WS_MSG_ERROR } AwsMessageStatus;
|
||||||
|
typedef enum { WS_EVT_CONNECT,
|
||||||
|
WS_EVT_DISCONNECT,
|
||||||
|
WS_EVT_PONG,
|
||||||
|
WS_EVT_ERROR,
|
||||||
|
WS_EVT_DATA } AwsEventType;
|
||||||
|
|
||||||
|
class AsyncWebSocketMessageBuffer {
|
||||||
|
friend AsyncWebSocket;
|
||||||
|
friend AsyncWebSocketClient;
|
||||||
|
|
||||||
|
private:
|
||||||
|
AsyncWebSocketSharedBuffer _buffer;
|
||||||
|
|
||||||
|
public:
|
||||||
|
AsyncWebSocketMessageBuffer() {}
|
||||||
|
explicit AsyncWebSocketMessageBuffer(size_t size);
|
||||||
|
AsyncWebSocketMessageBuffer(const uint8_t* data, size_t size);
|
||||||
|
//~AsyncWebSocketMessageBuffer();
|
||||||
|
bool reserve(size_t size);
|
||||||
|
uint8_t* get() { return _buffer->data(); }
|
||||||
|
size_t length() const { return _buffer->size(); }
|
||||||
|
};
|
||||||
|
|
||||||
|
class AsyncWebSocketMessage {
|
||||||
|
private:
|
||||||
|
AsyncWebSocketSharedBuffer _WSbuffer;
|
||||||
|
uint8_t _opcode{WS_TEXT};
|
||||||
|
bool _mask{false};
|
||||||
|
AwsMessageStatus _status{WS_MSG_ERROR};
|
||||||
|
size_t _sent{};
|
||||||
|
size_t _ack{};
|
||||||
|
size_t _acked{};
|
||||||
|
|
||||||
|
public:
|
||||||
|
AsyncWebSocketMessage(AsyncWebSocketSharedBuffer buffer, uint8_t opcode = WS_TEXT, bool mask = false);
|
||||||
|
|
||||||
|
bool finished() const { return _status != WS_MSG_SENDING; }
|
||||||
|
bool betweenFrames() const { return _acked == _ack; }
|
||||||
|
|
||||||
|
void ack(size_t len, uint32_t time);
|
||||||
|
size_t send(AsyncClient* client);
|
||||||
|
};
|
||||||
|
|
||||||
|
class AsyncWebSocketClient {
|
||||||
|
private:
|
||||||
|
AsyncClient* _client;
|
||||||
|
AsyncWebSocket* _server;
|
||||||
|
uint32_t _clientId;
|
||||||
|
AwsClientStatus _status;
|
||||||
|
#ifdef ESP32
|
||||||
|
mutable std::mutex _lock;
|
||||||
|
#endif
|
||||||
|
std::deque<AsyncWebSocketControl> _controlQueue;
|
||||||
|
std::deque<AsyncWebSocketMessage> _messageQueue;
|
||||||
|
bool closeWhenFull = true;
|
||||||
|
|
||||||
|
uint8_t _pstate;
|
||||||
|
AwsFrameInfo _pinfo;
|
||||||
|
|
||||||
|
uint32_t _lastMessageTime;
|
||||||
|
uint32_t _keepAlivePeriod;
|
||||||
|
|
||||||
|
void _queueControl(uint8_t opcode, const uint8_t* data = NULL, size_t len = 0, bool mask = false);
|
||||||
|
void _queueMessage(AsyncWebSocketSharedBuffer buffer, uint8_t opcode = WS_TEXT, bool mask = false);
|
||||||
|
void _runQueue();
|
||||||
|
void _clearQueue();
|
||||||
|
|
||||||
|
public:
|
||||||
|
void* _tempObject;
|
||||||
|
|
||||||
|
AsyncWebSocketClient(AsyncWebServerRequest* request, AsyncWebSocket* server);
|
||||||
|
~AsyncWebSocketClient();
|
||||||
|
|
||||||
|
// client id increments for the given server
|
||||||
|
uint32_t id() const { return _clientId; }
|
||||||
|
AwsClientStatus status() const { return _status; }
|
||||||
|
AsyncClient* client() { return _client; }
|
||||||
|
const AsyncClient* client() const { return _client; }
|
||||||
|
AsyncWebSocket* server() { return _server; }
|
||||||
|
const AsyncWebSocket* server() const { return _server; }
|
||||||
|
AwsFrameInfo const& pinfo() const { return _pinfo; }
|
||||||
|
|
||||||
|
// - If "true" (default), the connection will be closed if the message queue is full.
|
||||||
|
// This is the default behavior in yubox-node-org, which is not silently discarding messages but instead closes the connection.
|
||||||
|
// The big issue with this behavior is that is can cause the UI to automatically re-create a new WS connection, which can be filled again,
|
||||||
|
// and so on, causing a resource exhaustion.
|
||||||
|
//
|
||||||
|
// - If "false", the incoming message will be discarded if the queue is full.
|
||||||
|
// This is the default behavior in the original ESPAsyncWebServer library from me-no-dev.
|
||||||
|
// This behavior allows the best performance at the expense of unreliable message delivery in case the queue is full (some messages may be lost).
|
||||||
|
//
|
||||||
|
// - In any case, when the queue is full, a message is logged.
|
||||||
|
// - IT is recommended to use the methods queueIsFull(), availableForWriteAll(), availableForWrite(clientId) to check if the queue is full before sending a message.
|
||||||
|
//
|
||||||
|
// Usage:
|
||||||
|
// - can be set in the onEvent listener when connecting (event type is: WS_EVT_CONNECT)
|
||||||
|
//
|
||||||
|
// Use cases:,
|
||||||
|
// - if using websocket to send logging messages, maybe some loss is acceptable.
|
||||||
|
// - But if using websocket to send UI update messages, maybe the connection should be closed and the UI redrawn.
|
||||||
|
void setCloseClientOnQueueFull(bool close) { closeWhenFull = close; }
|
||||||
|
bool willCloseClientOnQueueFull() const { return closeWhenFull; }
|
||||||
|
|
||||||
|
IPAddress remoteIP() const;
|
||||||
|
uint16_t remotePort() const;
|
||||||
|
|
||||||
|
bool shouldBeDeleted() const { return !_client; }
|
||||||
|
|
||||||
|
// control frames
|
||||||
|
void close(uint16_t code = 0, const char* message = NULL);
|
||||||
|
void ping(const uint8_t* data = NULL, size_t len = 0);
|
||||||
|
|
||||||
|
// set auto-ping period in seconds. disabled if zero (default)
|
||||||
|
void keepAlivePeriod(uint16_t seconds) {
|
||||||
|
_keepAlivePeriod = seconds * 1000;
|
||||||
|
}
|
||||||
|
uint16_t keepAlivePeriod() {
|
||||||
|
return (uint16_t)(_keepAlivePeriod / 1000);
|
||||||
|
}
|
||||||
|
|
||||||
|
// data packets
|
||||||
|
void message(AsyncWebSocketSharedBuffer buffer, uint8_t opcode = WS_TEXT, bool mask = false) { _queueMessage(buffer, opcode, mask); }
|
||||||
|
bool queueIsFull() const;
|
||||||
|
size_t queueLen() const;
|
||||||
|
|
||||||
|
size_t printf(const char* format, ...) __attribute__((format(printf, 2, 3)));
|
||||||
|
#ifndef ESP32
|
||||||
|
size_t printf_P(PGM_P formatP, ...) __attribute__((format(printf, 2, 3)));
|
||||||
|
#endif
|
||||||
|
|
||||||
|
void text(AsyncWebSocketSharedBuffer buffer);
|
||||||
|
void text(const uint8_t* message, size_t len);
|
||||||
|
void text(const char* message, size_t len);
|
||||||
|
void text(const char* message);
|
||||||
|
void text(const String& message);
|
||||||
|
#ifndef ESP32
|
||||||
|
void text(const __FlashStringHelper* message);
|
||||||
|
#endif // ESP32
|
||||||
|
void text(AsyncWebSocketMessageBuffer* buffer);
|
||||||
|
|
||||||
|
void binary(AsyncWebSocketSharedBuffer buffer);
|
||||||
|
void binary(const uint8_t* message, size_t len);
|
||||||
|
void binary(const char* message, size_t len);
|
||||||
|
void binary(const char* message);
|
||||||
|
void binary(const String& message);
|
||||||
|
#ifndef ESP32
|
||||||
|
void binary(const __FlashStringHelper* message, size_t len);
|
||||||
|
#endif // ESP32
|
||||||
|
void binary(AsyncWebSocketMessageBuffer* buffer);
|
||||||
|
|
||||||
|
bool canSend() const;
|
||||||
|
|
||||||
|
// system callbacks (do not call)
|
||||||
|
void _onAck(size_t len, uint32_t time);
|
||||||
|
void _onError(int8_t);
|
||||||
|
void _onPoll();
|
||||||
|
void _onTimeout(uint32_t time);
|
||||||
|
void _onDisconnect();
|
||||||
|
void _onData(void* pbuf, size_t plen);
|
||||||
|
};
|
||||||
|
|
||||||
|
using AwsHandshakeHandler = std::function<bool(AsyncWebServerRequest* request)>;
|
||||||
|
using AwsEventHandler = std::function<void(AsyncWebSocket* server, AsyncWebSocketClient* client, AwsEventType type, void* arg, uint8_t* data, size_t len)>;
|
||||||
|
|
||||||
|
// WebServer Handler implementation that plays the role of a socket server
|
||||||
|
class AsyncWebSocket : public AsyncWebHandler {
|
||||||
|
private:
|
||||||
|
String _url;
|
||||||
|
std::list<AsyncWebSocketClient> _clients;
|
||||||
|
uint32_t _cNextId;
|
||||||
|
AwsEventHandler _eventHandler{nullptr};
|
||||||
|
AwsHandshakeHandler _handshakeHandler;
|
||||||
|
bool _enabled;
|
||||||
|
#ifdef ESP32
|
||||||
|
mutable std::mutex _lock;
|
||||||
|
#endif
|
||||||
|
|
||||||
|
public:
|
||||||
|
explicit AsyncWebSocket(const char* url) : _url(url), _cNextId(1), _enabled(true) {}
|
||||||
|
AsyncWebSocket(const String& url) : _url(url), _cNextId(1), _enabled(true) {}
|
||||||
|
~AsyncWebSocket(){};
|
||||||
|
const char* url() const { return _url.c_str(); }
|
||||||
|
void enable(bool e) { _enabled = e; }
|
||||||
|
bool enabled() const { return _enabled; }
|
||||||
|
bool availableForWriteAll();
|
||||||
|
bool availableForWrite(uint32_t id);
|
||||||
|
|
||||||
|
size_t count() const;
|
||||||
|
AsyncWebSocketClient* client(uint32_t id);
|
||||||
|
bool hasClient(uint32_t id) { return client(id) != nullptr; }
|
||||||
|
|
||||||
|
void close(uint32_t id, uint16_t code = 0, const char* message = NULL);
|
||||||
|
void closeAll(uint16_t code = 0, const char* message = NULL);
|
||||||
|
void cleanupClients(uint16_t maxClients = DEFAULT_MAX_WS_CLIENTS);
|
||||||
|
|
||||||
|
void ping(uint32_t id, const uint8_t* data = NULL, size_t len = 0);
|
||||||
|
void pingAll(const uint8_t* data = NULL, size_t len = 0); // done
|
||||||
|
|
||||||
|
void text(uint32_t id, const uint8_t* message, size_t len);
|
||||||
|
void text(uint32_t id, const char* message, size_t len);
|
||||||
|
void text(uint32_t id, const char* message);
|
||||||
|
void text(uint32_t id, const String& message);
|
||||||
|
#ifndef ESP32
|
||||||
|
void text(uint32_t id, const __FlashStringHelper* message);
|
||||||
|
#endif // ESP32
|
||||||
|
void text(uint32_t id, AsyncWebSocketMessageBuffer* buffer);
|
||||||
|
void text(uint32_t id, AsyncWebSocketSharedBuffer buffer);
|
||||||
|
|
||||||
|
void textAll(const uint8_t* message, size_t len);
|
||||||
|
void textAll(const char* message, size_t len);
|
||||||
|
void textAll(const char* message);
|
||||||
|
void textAll(const String& message);
|
||||||
|
#ifndef ESP32
|
||||||
|
void textAll(const __FlashStringHelper* message);
|
||||||
|
#endif // ESP32
|
||||||
|
void textAll(AsyncWebSocketMessageBuffer* buffer);
|
||||||
|
void textAll(AsyncWebSocketSharedBuffer buffer);
|
||||||
|
|
||||||
|
void binary(uint32_t id, const uint8_t* message, size_t len);
|
||||||
|
void binary(uint32_t id, const char* message, size_t len);
|
||||||
|
void binary(uint32_t id, const char* message);
|
||||||
|
void binary(uint32_t id, const String& message);
|
||||||
|
#ifndef ESP32
|
||||||
|
void binary(uint32_t id, const __FlashStringHelper* message, size_t len);
|
||||||
|
#endif // ESP32
|
||||||
|
void binary(uint32_t id, AsyncWebSocketMessageBuffer* buffer);
|
||||||
|
void binary(uint32_t id, AsyncWebSocketSharedBuffer buffer);
|
||||||
|
|
||||||
|
void binaryAll(const uint8_t* message, size_t len);
|
||||||
|
void binaryAll(const char* message, size_t len);
|
||||||
|
void binaryAll(const char* message);
|
||||||
|
void binaryAll(const String& message);
|
||||||
|
#ifndef ESP32
|
||||||
|
void binaryAll(const __FlashStringHelper* message, size_t len);
|
||||||
|
#endif // ESP32
|
||||||
|
void binaryAll(AsyncWebSocketMessageBuffer* buffer);
|
||||||
|
void binaryAll(AsyncWebSocketSharedBuffer buffer);
|
||||||
|
|
||||||
|
size_t printf(uint32_t id, const char* format, ...) __attribute__((format(printf, 3, 4)));
|
||||||
|
size_t printfAll(const char* format, ...) __attribute__((format(printf, 2, 3)));
|
||||||
|
|
||||||
|
#ifndef ESP32
|
||||||
|
size_t printf_P(uint32_t id, PGM_P formatP, ...) __attribute__((format(printf, 3, 4)));
|
||||||
|
size_t printfAll_P(PGM_P formatP, ...) __attribute__((format(printf, 2, 3)));
|
||||||
|
#endif
|
||||||
|
|
||||||
|
// event listener
|
||||||
|
void onEvent(AwsEventHandler handler) {
|
||||||
|
_eventHandler = handler;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Handshake Handler
|
||||||
|
void handleHandshake(AwsHandshakeHandler handler) {
|
||||||
|
_handshakeHandler = handler;
|
||||||
|
}
|
||||||
|
|
||||||
|
// system callbacks (do not call)
|
||||||
|
uint32_t _getNextId() { return _cNextId++; }
|
||||||
|
AsyncWebSocketClient* _newClient(AsyncWebServerRequest* request);
|
||||||
|
void _handleEvent(AsyncWebSocketClient* client, AwsEventType type, void* arg, uint8_t* data, size_t len);
|
||||||
|
virtual bool canHandle(AsyncWebServerRequest* request) override final;
|
||||||
|
virtual void handleRequest(AsyncWebServerRequest* request) override final;
|
||||||
|
|
||||||
|
// messagebuffer functions/objects.
|
||||||
|
AsyncWebSocketMessageBuffer* makeBuffer(size_t size = 0);
|
||||||
|
AsyncWebSocketMessageBuffer* makeBuffer(const uint8_t* data, size_t size);
|
||||||
|
|
||||||
|
const std::list<AsyncWebSocketClient>& getClients() const { return _clients; }
|
||||||
|
};
|
||||||
|
|
||||||
|
// WebServer response to authenticate the socket and detach the tcp client from the web server request
|
||||||
|
class AsyncWebSocketResponse : public AsyncWebServerResponse {
|
||||||
|
private:
|
||||||
|
String _content;
|
||||||
|
AsyncWebSocket* _server;
|
||||||
|
|
||||||
|
public:
|
||||||
|
AsyncWebSocketResponse(const String& key, AsyncWebSocket* server);
|
||||||
|
void _respond(AsyncWebServerRequest* request);
|
||||||
|
size_t _ack(AsyncWebServerRequest* request, size_t len, uint32_t time);
|
||||||
|
bool _sourceValid() const { return true; }
|
||||||
|
};
|
||||||
|
|
||||||
|
#endif /* ASYNCWEBSOCKET_H_ */
|
||||||
652
lib/ESP Async WebServer/src/ESPAsyncWebServer.h
Normal file
652
lib/ESP Async WebServer/src/ESPAsyncWebServer.h
Normal file
@@ -0,0 +1,652 @@
|
|||||||
|
/*
|
||||||
|
Asynchronous WebServer library for Espressif MCUs
|
||||||
|
|
||||||
|
Copyright (c) 2016 Hristo Gochkov. All rights reserved.
|
||||||
|
This file is part of the esp8266 core for Arduino environment.
|
||||||
|
|
||||||
|
This library is free software; you can redistribute it and/or
|
||||||
|
modify it under the terms of the GNU Lesser General Public
|
||||||
|
License as published by the Free Software Foundation; either
|
||||||
|
version 2.1 of the License, or (at your option) any later version.
|
||||||
|
|
||||||
|
This library is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||||
|
Lesser General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Lesser General Public
|
||||||
|
License along with this library; if not, write to the Free Software
|
||||||
|
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
|
||||||
|
*/
|
||||||
|
#ifndef _ESPAsyncWebServer_H_
|
||||||
|
#define _ESPAsyncWebServer_H_
|
||||||
|
|
||||||
|
#include "Arduino.h"
|
||||||
|
|
||||||
|
#include "FS.h"
|
||||||
|
#include <functional>
|
||||||
|
#include <list>
|
||||||
|
#include <vector>
|
||||||
|
|
||||||
|
#ifdef ESP32
|
||||||
|
#include <AsyncTCP.h>
|
||||||
|
#include <WiFi.h>
|
||||||
|
#elif defined(ESP8266)
|
||||||
|
#include <ESP8266WiFi.h>
|
||||||
|
#include <ESPAsyncTCP.h>
|
||||||
|
#elif defined(TARGET_RP2040)
|
||||||
|
#include <WiFi.h>
|
||||||
|
#include <AsyncTCP_RP2040W.h>
|
||||||
|
#include <http_parser.h>
|
||||||
|
#include <HTTP_Method.h>
|
||||||
|
#else
|
||||||
|
#error Platform not supported
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#define ASYNCWEBSERVER_VERSION "3.0.6"
|
||||||
|
#define ASYNCWEBSERVER_VERSION_MAJOR 3
|
||||||
|
#define ASYNCWEBSERVER_VERSION_MINOR 0
|
||||||
|
#define ASYNCWEBSERVER_VERSION_REVISION 6
|
||||||
|
#define ASYNCWEBSERVER_FORK_mathieucarbou
|
||||||
|
|
||||||
|
#ifdef ASYNCWEBSERVER_REGEX
|
||||||
|
#define ASYNCWEBSERVER_REGEX_ATTRIBUTE
|
||||||
|
#else
|
||||||
|
#define ASYNCWEBSERVER_REGEX_ATTRIBUTE __attribute__((warning("ASYNCWEBSERVER_REGEX not defined")))
|
||||||
|
#endif
|
||||||
|
|
||||||
|
class AsyncWebServer;
|
||||||
|
class AsyncWebServerRequest;
|
||||||
|
class AsyncWebServerResponse;
|
||||||
|
class AsyncWebHeader;
|
||||||
|
class AsyncWebParameter;
|
||||||
|
class AsyncWebRewrite;
|
||||||
|
class AsyncWebHandler;
|
||||||
|
class AsyncStaticWebHandler;
|
||||||
|
class AsyncCallbackWebHandler;
|
||||||
|
class AsyncResponseStream;
|
||||||
|
|
||||||
|
#if defined (TARGET_RP2040)
|
||||||
|
typedef enum http_method WebRequestMethod;
|
||||||
|
#else
|
||||||
|
#ifndef WEBSERVER_H
|
||||||
|
typedef enum {
|
||||||
|
HTTP_GET = 0b00000001,
|
||||||
|
HTTP_POST = 0b00000010,
|
||||||
|
HTTP_DELETE = 0b00000100,
|
||||||
|
HTTP_PUT = 0b00001000,
|
||||||
|
HTTP_PATCH = 0b00010000,
|
||||||
|
HTTP_HEAD = 0b00100000,
|
||||||
|
HTTP_OPTIONS = 0b01000000,
|
||||||
|
HTTP_ANY = 0b01111111,
|
||||||
|
} WebRequestMethod;
|
||||||
|
#endif
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#ifndef HAVE_FS_FILE_OPEN_MODE
|
||||||
|
namespace fs {
|
||||||
|
class FileOpenMode {
|
||||||
|
public:
|
||||||
|
static const char* read;
|
||||||
|
static const char* write;
|
||||||
|
static const char* append;
|
||||||
|
};
|
||||||
|
};
|
||||||
|
#else
|
||||||
|
#include "FileOpenMode.h"
|
||||||
|
#endif
|
||||||
|
|
||||||
|
// if this value is returned when asked for data, packet will not be sent and you will be asked for data again
|
||||||
|
#define RESPONSE_TRY_AGAIN 0xFFFFFFFF
|
||||||
|
|
||||||
|
typedef uint8_t WebRequestMethodComposite;
|
||||||
|
typedef std::function<void(void)> ArDisconnectHandler;
|
||||||
|
|
||||||
|
/*
|
||||||
|
* PARAMETER :: Chainable object to hold GET/POST and FILE parameters
|
||||||
|
* */
|
||||||
|
|
||||||
|
class AsyncWebParameter {
|
||||||
|
private:
|
||||||
|
String _name;
|
||||||
|
String _value;
|
||||||
|
size_t _size;
|
||||||
|
bool _isForm;
|
||||||
|
bool _isFile;
|
||||||
|
|
||||||
|
public:
|
||||||
|
AsyncWebParameter(const String& name, const String& value, bool form = false, bool file = false, size_t size = 0) : _name(name), _value(value), _size(size), _isForm(form), _isFile(file) {}
|
||||||
|
const String& name() const { return _name; }
|
||||||
|
const String& value() const { return _value; }
|
||||||
|
size_t size() const { return _size; }
|
||||||
|
bool isPost() const { return _isForm; }
|
||||||
|
bool isFile() const { return _isFile; }
|
||||||
|
};
|
||||||
|
|
||||||
|
/*
|
||||||
|
* HEADER :: Chainable object to hold the headers
|
||||||
|
* */
|
||||||
|
|
||||||
|
class AsyncWebHeader {
|
||||||
|
private:
|
||||||
|
String _name;
|
||||||
|
String _value;
|
||||||
|
|
||||||
|
public:
|
||||||
|
AsyncWebHeader() = default;
|
||||||
|
AsyncWebHeader(const AsyncWebHeader&) = default;
|
||||||
|
|
||||||
|
AsyncWebHeader(const String& name, const String& value) : _name(name), _value(value) {}
|
||||||
|
AsyncWebHeader(const String& data) {
|
||||||
|
if (!data)
|
||||||
|
return;
|
||||||
|
int index = data.indexOf(':');
|
||||||
|
if (index < 0)
|
||||||
|
return;
|
||||||
|
_name = data.substring(0, index);
|
||||||
|
_value = data.substring(index + 2);
|
||||||
|
}
|
||||||
|
|
||||||
|
AsyncWebHeader& operator=(const AsyncWebHeader&) = default;
|
||||||
|
|
||||||
|
const String& name() const { return _name; }
|
||||||
|
const String& value() const { return _value; }
|
||||||
|
String toString() const { return _name + F(": ") + _value + F("\r\n"); }
|
||||||
|
};
|
||||||
|
|
||||||
|
/*
|
||||||
|
* REQUEST :: Each incoming Client is wrapped inside a Request and both live together until disconnect
|
||||||
|
* */
|
||||||
|
|
||||||
|
typedef enum { RCT_NOT_USED = -1,
|
||||||
|
RCT_DEFAULT = 0,
|
||||||
|
RCT_HTTP,
|
||||||
|
RCT_WS,
|
||||||
|
RCT_EVENT,
|
||||||
|
RCT_MAX } RequestedConnectionType;
|
||||||
|
|
||||||
|
typedef std::function<size_t(uint8_t*, size_t, size_t)> AwsResponseFiller;
|
||||||
|
typedef std::function<String(const String&)> AwsTemplateProcessor;
|
||||||
|
|
||||||
|
class AsyncWebServerRequest {
|
||||||
|
using File = fs::File;
|
||||||
|
using FS = fs::FS;
|
||||||
|
friend class AsyncWebServer;
|
||||||
|
friend class AsyncCallbackWebHandler;
|
||||||
|
|
||||||
|
private:
|
||||||
|
AsyncClient* _client;
|
||||||
|
AsyncWebServer* _server;
|
||||||
|
AsyncWebHandler* _handler;
|
||||||
|
AsyncWebServerResponse* _response;
|
||||||
|
std::vector<String> _interestingHeaders;
|
||||||
|
ArDisconnectHandler _onDisconnectfn;
|
||||||
|
|
||||||
|
String _temp;
|
||||||
|
uint8_t _parseState;
|
||||||
|
|
||||||
|
uint8_t _version;
|
||||||
|
WebRequestMethodComposite _method;
|
||||||
|
String _url;
|
||||||
|
String _host;
|
||||||
|
String _contentType;
|
||||||
|
String _boundary;
|
||||||
|
String _authorization;
|
||||||
|
RequestedConnectionType _reqconntype;
|
||||||
|
void _removeNotInterestingHeaders();
|
||||||
|
bool _isDigest;
|
||||||
|
bool _isMultipart;
|
||||||
|
bool _isPlainPost;
|
||||||
|
bool _expectingContinue;
|
||||||
|
size_t _contentLength;
|
||||||
|
size_t _parsedLength;
|
||||||
|
|
||||||
|
std::list<AsyncWebHeader> _headers;
|
||||||
|
std::list<AsyncWebParameter> _params;
|
||||||
|
std::vector<String> _pathParams;
|
||||||
|
|
||||||
|
uint8_t _multiParseState;
|
||||||
|
uint8_t _boundaryPosition;
|
||||||
|
size_t _itemStartIndex;
|
||||||
|
size_t _itemSize;
|
||||||
|
String _itemName;
|
||||||
|
String _itemFilename;
|
||||||
|
String _itemType;
|
||||||
|
String _itemValue;
|
||||||
|
uint8_t* _itemBuffer;
|
||||||
|
size_t _itemBufferIndex;
|
||||||
|
bool _itemIsFile;
|
||||||
|
|
||||||
|
void _onPoll();
|
||||||
|
void _onAck(size_t len, uint32_t time);
|
||||||
|
void _onError(int8_t error);
|
||||||
|
void _onTimeout(uint32_t time);
|
||||||
|
void _onDisconnect();
|
||||||
|
void _onData(void* buf, size_t len);
|
||||||
|
|
||||||
|
void _addPathParam(const char* param);
|
||||||
|
|
||||||
|
bool _parseReqHead();
|
||||||
|
bool _parseReqHeader();
|
||||||
|
void _parseLine();
|
||||||
|
void _parsePlainPostChar(uint8_t data);
|
||||||
|
void _parseMultipartPostByte(uint8_t data, bool last);
|
||||||
|
void _addGetParams(const String& params);
|
||||||
|
|
||||||
|
void _handleUploadStart();
|
||||||
|
void _handleUploadByte(uint8_t data, bool last);
|
||||||
|
void _handleUploadEnd();
|
||||||
|
|
||||||
|
public:
|
||||||
|
File _tempFile;
|
||||||
|
void* _tempObject;
|
||||||
|
|
||||||
|
AsyncWebServerRequest(AsyncWebServer*, AsyncClient*);
|
||||||
|
~AsyncWebServerRequest();
|
||||||
|
|
||||||
|
AsyncClient* client() { return _client; }
|
||||||
|
uint8_t version() const { return _version; }
|
||||||
|
WebRequestMethodComposite method() const { return _method; }
|
||||||
|
const String& url() const { return _url; }
|
||||||
|
const String& host() const { return _host; }
|
||||||
|
const String& contentType() const { return _contentType; }
|
||||||
|
size_t contentLength() const { return _contentLength; }
|
||||||
|
bool multipart() const { return _isMultipart; }
|
||||||
|
|
||||||
|
#ifndef ESP8266
|
||||||
|
const char* methodToString() const;
|
||||||
|
const char* requestedConnTypeToString() const;
|
||||||
|
#else
|
||||||
|
const __FlashStringHelper* methodToString() const;
|
||||||
|
const __FlashStringHelper* requestedConnTypeToString() const;
|
||||||
|
#endif
|
||||||
|
|
||||||
|
RequestedConnectionType requestedConnType() const { return _reqconntype; }
|
||||||
|
bool isExpectedRequestedConnType(RequestedConnectionType erct1, RequestedConnectionType erct2 = RCT_NOT_USED, RequestedConnectionType erct3 = RCT_NOT_USED);
|
||||||
|
void onDisconnect(ArDisconnectHandler fn);
|
||||||
|
|
||||||
|
// hash is the string representation of:
|
||||||
|
// base64(user:pass) for basic or
|
||||||
|
// user:realm:md5(user:realm:pass) for digest
|
||||||
|
bool authenticate(const char* hash);
|
||||||
|
bool authenticate(const char* username, const char* password, const char* realm = NULL, bool passwordIsHash = false);
|
||||||
|
void requestAuthentication(const char* realm = NULL, bool isDigest = true);
|
||||||
|
|
||||||
|
void setHandler(AsyncWebHandler* handler) { _handler = handler; }
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief add header to collect from a response
|
||||||
|
*
|
||||||
|
* @param name
|
||||||
|
*/
|
||||||
|
void addInterestingHeader(const char* name);
|
||||||
|
void addInterestingHeader(const String& name) { return addInterestingHeader(name.c_str()); };
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief issue 302 redirect response
|
||||||
|
*
|
||||||
|
* @param url
|
||||||
|
*/
|
||||||
|
void redirect(const char* url);
|
||||||
|
void redirect(const String& url) { return redirect(url.c_str()); };
|
||||||
|
|
||||||
|
void send(AsyncWebServerResponse* response);
|
||||||
|
void send(int code, const String& contentType = String(), const String& content = String());
|
||||||
|
void send(int code, const String& contentType, const uint8_t* content, size_t len, AwsTemplateProcessor callback = nullptr);
|
||||||
|
void send(int code, const String& contentType, PGM_P content, AwsTemplateProcessor callback = nullptr);
|
||||||
|
void send(FS& fs, const String& path, const String& contentType = String(), bool download = false, AwsTemplateProcessor callback = nullptr);
|
||||||
|
void send(File content, const String& path, const String& contentType = String(), bool download = false, AwsTemplateProcessor callback = nullptr);
|
||||||
|
void send(Stream& stream, const String& contentType, size_t len, AwsTemplateProcessor callback = nullptr);
|
||||||
|
void send(const String& contentType, size_t len, AwsResponseFiller callback, AwsTemplateProcessor templateCallback = nullptr);
|
||||||
|
void sendChunked(const String& contentType, AwsResponseFiller callback, AwsTemplateProcessor templateCallback = nullptr);
|
||||||
|
|
||||||
|
[[deprecated("Replaced by send(...)")]]
|
||||||
|
void send_P(int code, const String& contentType, const uint8_t* content, size_t len, AwsTemplateProcessor callback = nullptr) {
|
||||||
|
send(code, contentType, content, len, callback);
|
||||||
|
}
|
||||||
|
[[deprecated("Replaced by send(...)")]]
|
||||||
|
void send_P(int code, const String& contentType, PGM_P content, AwsTemplateProcessor callback = nullptr) {
|
||||||
|
send(code, contentType, content, callback);
|
||||||
|
}
|
||||||
|
|
||||||
|
AsyncWebServerResponse* beginResponse(int code, const String& contentType = String(), const String& content = String());
|
||||||
|
AsyncWebServerResponse* beginResponse(int code, const String& contentType, const uint8_t* content, size_t len, AwsTemplateProcessor callback = nullptr);
|
||||||
|
AsyncWebServerResponse* beginResponse(int code, const String& contentType, PGM_P content, AwsTemplateProcessor callback = nullptr);
|
||||||
|
AsyncWebServerResponse* beginResponse(FS& fs, const String& path, const String& contentType = String(), bool download = false, AwsTemplateProcessor callback = nullptr);
|
||||||
|
AsyncWebServerResponse* beginResponse(File content, const String& path, const String& contentType = String(), bool download = false, AwsTemplateProcessor callback = nullptr);
|
||||||
|
AsyncWebServerResponse* beginResponse(Stream& stream, const String& contentType, size_t len, AwsTemplateProcessor callback = nullptr);
|
||||||
|
AsyncWebServerResponse* beginResponse(const String& contentType, size_t len, AwsResponseFiller callback, AwsTemplateProcessor templateCallback = nullptr);
|
||||||
|
AsyncWebServerResponse* beginChunkedResponse(const String& contentType, AwsResponseFiller callback, AwsTemplateProcessor templateCallback = nullptr);
|
||||||
|
AsyncResponseStream* beginResponseStream(const String& contentType, size_t bufferSize = 1460);
|
||||||
|
|
||||||
|
|
||||||
|
[[deprecated("Replaced by beginResponse(...)")]]
|
||||||
|
AsyncWebServerResponse* beginResponse_P(int code, const String& contentType, const uint8_t* content, size_t len, AwsTemplateProcessor callback = nullptr) {
|
||||||
|
return beginResponse(code, contentType, content, len, callback);
|
||||||
|
}
|
||||||
|
[[deprecated("Replaced by beginResponse(...)")]]
|
||||||
|
AsyncWebServerResponse* beginResponse_P(int code, const String& contentType, PGM_P content, AwsTemplateProcessor callback = nullptr) {
|
||||||
|
return beginResponse(code, contentType, content, callback);
|
||||||
|
}
|
||||||
|
|
||||||
|
size_t headers() const; // get header count
|
||||||
|
|
||||||
|
// check if header exists
|
||||||
|
bool hasHeader(const char* name) const;
|
||||||
|
bool hasHeader(const String& name) const { return hasHeader(name.c_str()); };
|
||||||
|
#ifdef ESP8266
|
||||||
|
bool hasHeader(const __FlashStringHelper* data) const; // check if header exists
|
||||||
|
#endif
|
||||||
|
|
||||||
|
const AsyncWebHeader* getHeader(const char* name) const;
|
||||||
|
const AsyncWebHeader* getHeader(const String& name) const { return getHeader(name.c_str()); };
|
||||||
|
#ifdef ESP8266
|
||||||
|
const AsyncWebHeader* getHeader(const __FlashStringHelper* data) const;
|
||||||
|
#endif
|
||||||
|
const AsyncWebHeader* getHeader(size_t num) const;
|
||||||
|
|
||||||
|
size_t params() const; // get arguments count
|
||||||
|
bool hasParam(const String& name, bool post = false, bool file = false) const;
|
||||||
|
bool hasParam(const __FlashStringHelper* data, bool post = false, bool file = false) const;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Get the Request parameter by name
|
||||||
|
*
|
||||||
|
* @param name
|
||||||
|
* @param post
|
||||||
|
* @param file
|
||||||
|
* @return const AsyncWebParameter*
|
||||||
|
*/
|
||||||
|
const AsyncWebParameter* getParam(const char* name, bool post = false, bool file = false) const;
|
||||||
|
|
||||||
|
const AsyncWebParameter* getParam(const String& name, bool post = false, bool file = false) const { return getParam(name.c_str(), post, file); };
|
||||||
|
#ifdef ESP8266
|
||||||
|
const AsyncWebParameter* getParam(const __FlashStringHelper* data, bool post, bool file) const;
|
||||||
|
#endif
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Get request parameter by number
|
||||||
|
* i.e., n-th parameter
|
||||||
|
* @param num
|
||||||
|
* @return const AsyncWebParameter*
|
||||||
|
*/
|
||||||
|
const AsyncWebParameter* getParam(size_t num) const;
|
||||||
|
|
||||||
|
size_t args() const { return params(); } // get arguments count
|
||||||
|
|
||||||
|
// get request argument value by name
|
||||||
|
const String& arg(const char* name) const;
|
||||||
|
// get request argument value by name
|
||||||
|
const String& arg(const String& name) const { return arg(name.c_str()); };
|
||||||
|
#ifdef ESP8266
|
||||||
|
const String& arg(const __FlashStringHelper* data) const; // get request argument value by F(name)
|
||||||
|
#endif
|
||||||
|
const String& arg(size_t i) const; // get request argument value by number
|
||||||
|
const String& argName(size_t i) const; // get request argument name by number
|
||||||
|
bool hasArg(const char* name) const; // check if argument exists
|
||||||
|
bool hasArg(const String& name) const { return hasArg(name.c_str()); };
|
||||||
|
#ifdef ESP8266
|
||||||
|
bool hasArg(const __FlashStringHelper* data) const; // check if F(argument) exists
|
||||||
|
#endif
|
||||||
|
|
||||||
|
const String& ASYNCWEBSERVER_REGEX_ATTRIBUTE pathArg(size_t i) const;
|
||||||
|
|
||||||
|
// get request header value by name
|
||||||
|
const String& header(const char* name) const;
|
||||||
|
const String& header(const String& name) const { return header(name.c_str()); };
|
||||||
|
|
||||||
|
#ifdef ESP8266
|
||||||
|
const String& header(const __FlashStringHelper* data) const; // get request header value by F(name)
|
||||||
|
#endif
|
||||||
|
|
||||||
|
const String& header(size_t i) const; // get request header value by number
|
||||||
|
const String& headerName(size_t i) const; // get request header name by number
|
||||||
|
|
||||||
|
String urlDecode(const String& text) const;
|
||||||
|
};
|
||||||
|
|
||||||
|
/*
|
||||||
|
* FILTER :: Callback to filter AsyncWebRewrite and AsyncWebHandler (done by the Server)
|
||||||
|
* */
|
||||||
|
|
||||||
|
using ArRequestFilterFunction = std::function<bool(AsyncWebServerRequest* request)>;
|
||||||
|
|
||||||
|
bool ON_STA_FILTER(AsyncWebServerRequest* request);
|
||||||
|
|
||||||
|
bool ON_AP_FILTER(AsyncWebServerRequest* request);
|
||||||
|
|
||||||
|
/*
|
||||||
|
* REWRITE :: One instance can be handle any Request (done by the Server)
|
||||||
|
* */
|
||||||
|
|
||||||
|
class AsyncWebRewrite {
|
||||||
|
protected:
|
||||||
|
String _from;
|
||||||
|
String _toUrl;
|
||||||
|
String _params;
|
||||||
|
ArRequestFilterFunction _filter{nullptr};
|
||||||
|
|
||||||
|
public:
|
||||||
|
AsyncWebRewrite(const char* from, const char* to) : _from(from), _toUrl(to) {
|
||||||
|
int index = _toUrl.indexOf('?');
|
||||||
|
if (index > 0) {
|
||||||
|
_params = _toUrl.substring(index + 1);
|
||||||
|
_toUrl = _toUrl.substring(0, index);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
virtual ~AsyncWebRewrite() {}
|
||||||
|
AsyncWebRewrite& setFilter(ArRequestFilterFunction fn) {
|
||||||
|
_filter = fn;
|
||||||
|
return *this;
|
||||||
|
}
|
||||||
|
bool filter(AsyncWebServerRequest* request) const { return _filter == NULL || _filter(request); }
|
||||||
|
const String& from(void) const { return _from; }
|
||||||
|
const String& toUrl(void) const { return _toUrl; }
|
||||||
|
const String& params(void) const { return _params; }
|
||||||
|
virtual bool match(AsyncWebServerRequest* request) { return from() == request->url() && filter(request); }
|
||||||
|
};
|
||||||
|
|
||||||
|
/*
|
||||||
|
* HANDLER :: One instance can be attached to any Request (done by the Server)
|
||||||
|
* */
|
||||||
|
|
||||||
|
class AsyncWebHandler {
|
||||||
|
protected:
|
||||||
|
ArRequestFilterFunction _filter{nullptr};
|
||||||
|
String _username;
|
||||||
|
String _password;
|
||||||
|
|
||||||
|
public:
|
||||||
|
AsyncWebHandler() {}
|
||||||
|
AsyncWebHandler& setFilter(ArRequestFilterFunction fn) {
|
||||||
|
_filter = fn;
|
||||||
|
return *this;
|
||||||
|
}
|
||||||
|
AsyncWebHandler& setAuthentication(const char* username, const char* password) {
|
||||||
|
_username = username;
|
||||||
|
_password = password;
|
||||||
|
return *this;
|
||||||
|
};
|
||||||
|
AsyncWebHandler& setAuthentication(const String& username, const String& password) {
|
||||||
|
_username = username;
|
||||||
|
_password = password;
|
||||||
|
return *this;
|
||||||
|
};
|
||||||
|
bool filter(AsyncWebServerRequest* request) { return _filter == NULL || _filter(request); }
|
||||||
|
virtual ~AsyncWebHandler() {}
|
||||||
|
virtual bool canHandle(AsyncWebServerRequest* request __attribute__((unused))) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
virtual void handleRequest(AsyncWebServerRequest* request __attribute__((unused))) {}
|
||||||
|
virtual void handleUpload(AsyncWebServerRequest* request __attribute__((unused)), const String& filename __attribute__((unused)), size_t index __attribute__((unused)), uint8_t* data __attribute__((unused)), size_t len __attribute__((unused)), bool final __attribute__((unused))) {}
|
||||||
|
virtual void handleBody(AsyncWebServerRequest* request __attribute__((unused)), uint8_t* data __attribute__((unused)), size_t len __attribute__((unused)), size_t index __attribute__((unused)), size_t total __attribute__((unused))) {}
|
||||||
|
virtual bool isRequestHandlerTrivial() { return true; }
|
||||||
|
};
|
||||||
|
|
||||||
|
/*
|
||||||
|
* RESPONSE :: One instance is created for each Request (attached by the Handler)
|
||||||
|
* */
|
||||||
|
|
||||||
|
typedef enum {
|
||||||
|
RESPONSE_SETUP,
|
||||||
|
RESPONSE_HEADERS,
|
||||||
|
RESPONSE_CONTENT,
|
||||||
|
RESPONSE_WAIT_ACK,
|
||||||
|
RESPONSE_END,
|
||||||
|
RESPONSE_FAILED
|
||||||
|
} WebResponseState;
|
||||||
|
|
||||||
|
class AsyncWebServerResponse {
|
||||||
|
protected:
|
||||||
|
int _code;
|
||||||
|
std::list<AsyncWebHeader> _headers;
|
||||||
|
String _contentType;
|
||||||
|
size_t _contentLength;
|
||||||
|
bool _sendContentLength;
|
||||||
|
bool _chunked;
|
||||||
|
size_t _headLength;
|
||||||
|
size_t _sentLength;
|
||||||
|
size_t _ackedLength;
|
||||||
|
size_t _writtenLength;
|
||||||
|
WebResponseState _state;
|
||||||
|
const char* _responseCodeToString(int code);
|
||||||
|
|
||||||
|
public:
|
||||||
|
static const __FlashStringHelper* responseCodeToString(int code);
|
||||||
|
|
||||||
|
public:
|
||||||
|
AsyncWebServerResponse();
|
||||||
|
virtual ~AsyncWebServerResponse();
|
||||||
|
virtual void setCode(int code);
|
||||||
|
virtual void setContentLength(size_t len);
|
||||||
|
virtual void setContentType(const String& type);
|
||||||
|
virtual void addHeader(const String& name, const String& value);
|
||||||
|
virtual String _assembleHead(uint8_t version);
|
||||||
|
virtual bool _started() const;
|
||||||
|
virtual bool _finished() const;
|
||||||
|
virtual bool _failed() const;
|
||||||
|
virtual bool _sourceValid() const;
|
||||||
|
virtual void _respond(AsyncWebServerRequest* request);
|
||||||
|
virtual size_t _ack(AsyncWebServerRequest* request, size_t len, uint32_t time);
|
||||||
|
};
|
||||||
|
|
||||||
|
/*
|
||||||
|
* SERVER :: One instance
|
||||||
|
* */
|
||||||
|
|
||||||
|
typedef std::function<void(AsyncWebServerRequest* request)> ArRequestHandlerFunction;
|
||||||
|
typedef std::function<void(AsyncWebServerRequest* request, const String& filename, size_t index, uint8_t* data, size_t len, bool final)> ArUploadHandlerFunction;
|
||||||
|
typedef std::function<void(AsyncWebServerRequest* request, uint8_t* data, size_t len, size_t index, size_t total)> ArBodyHandlerFunction;
|
||||||
|
|
||||||
|
class AsyncWebServer {
|
||||||
|
protected:
|
||||||
|
AsyncServer _server;
|
||||||
|
std::list<std::shared_ptr<AsyncWebRewrite>> _rewrites;
|
||||||
|
std::list<std::unique_ptr<AsyncWebHandler>> _handlers;
|
||||||
|
AsyncCallbackWebHandler* _catchAllHandler;
|
||||||
|
|
||||||
|
public:
|
||||||
|
AsyncWebServer(uint16_t port);
|
||||||
|
~AsyncWebServer();
|
||||||
|
|
||||||
|
void begin();
|
||||||
|
void end();
|
||||||
|
|
||||||
|
#if ASYNC_TCP_SSL_ENABLED
|
||||||
|
void onSslFileRequest(AcSSlFileHandler cb, void* arg);
|
||||||
|
void beginSecure(const char* cert, const char* private_key_file, const char* password);
|
||||||
|
#endif
|
||||||
|
|
||||||
|
AsyncWebRewrite& addRewrite(AsyncWebRewrite* rewrite);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief (compat) Add url rewrite rule by pointer
|
||||||
|
* a deep copy of the pounter object will be created,
|
||||||
|
* it is up to user to manage further lifetime of the object in argument
|
||||||
|
*
|
||||||
|
* @param rewrite pointer to rewrite object to copy setting from
|
||||||
|
* @return AsyncWebRewrite& reference to a newly created rewrite rule
|
||||||
|
*/
|
||||||
|
AsyncWebRewrite& addRewrite(std::shared_ptr<AsyncWebRewrite> rewrite);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief add url rewrite rule
|
||||||
|
*
|
||||||
|
* @param from
|
||||||
|
* @param to
|
||||||
|
* @return AsyncWebRewrite&
|
||||||
|
*/
|
||||||
|
AsyncWebRewrite& rewrite(const char* from, const char* to);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief (compat) remove rewrite rule via referenced object
|
||||||
|
* this will NOT deallocate pointed object itself, internal rule with same from/to urls will be removed if any
|
||||||
|
* it's a compat method, better use `removeRewrite(const char* from, const char* to)`
|
||||||
|
* @param rewrite
|
||||||
|
* @return true
|
||||||
|
* @return false
|
||||||
|
*/
|
||||||
|
bool removeRewrite(AsyncWebRewrite* rewrite);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief remove rewrite rule
|
||||||
|
*
|
||||||
|
* @param from
|
||||||
|
* @param to
|
||||||
|
* @return true
|
||||||
|
* @return false
|
||||||
|
*/
|
||||||
|
bool removeRewrite(const char* from, const char* to);
|
||||||
|
|
||||||
|
AsyncWebHandler& addHandler(AsyncWebHandler* handler);
|
||||||
|
bool removeHandler(AsyncWebHandler* handler);
|
||||||
|
|
||||||
|
AsyncCallbackWebHandler& on(const char* uri, ArRequestHandlerFunction onRequest);
|
||||||
|
AsyncCallbackWebHandler& on(const char* uri, WebRequestMethodComposite method, ArRequestHandlerFunction onRequest);
|
||||||
|
AsyncCallbackWebHandler& on(const char* uri, WebRequestMethodComposite method, ArRequestHandlerFunction onRequest, ArUploadHandlerFunction onUpload);
|
||||||
|
AsyncCallbackWebHandler& on(const char* uri, WebRequestMethodComposite method, ArRequestHandlerFunction onRequest, ArUploadHandlerFunction onUpload, ArBodyHandlerFunction onBody);
|
||||||
|
|
||||||
|
AsyncStaticWebHandler& serveStatic(const char* uri, fs::FS& fs, const char* path, const char* cache_control = NULL);
|
||||||
|
|
||||||
|
void onNotFound(ArRequestHandlerFunction fn); // called when handler is not assigned
|
||||||
|
void onFileUpload(ArUploadHandlerFunction fn); // handle file uploads
|
||||||
|
void onRequestBody(ArBodyHandlerFunction fn); // handle posts with plain body content (JSON often transmitted this way as a request)
|
||||||
|
|
||||||
|
void reset(); // remove all writers and handlers, with onNotFound/onFileUpload/onRequestBody
|
||||||
|
|
||||||
|
void _handleDisconnect(AsyncWebServerRequest* request);
|
||||||
|
void _attachHandler(AsyncWebServerRequest* request);
|
||||||
|
void _rewriteRequest(AsyncWebServerRequest* request);
|
||||||
|
};
|
||||||
|
|
||||||
|
class DefaultHeaders {
|
||||||
|
using headers_t = std::list<AsyncWebHeader>;
|
||||||
|
headers_t _headers;
|
||||||
|
|
||||||
|
public:
|
||||||
|
DefaultHeaders() = default;
|
||||||
|
|
||||||
|
using ConstIterator = headers_t::const_iterator;
|
||||||
|
|
||||||
|
void addHeader(const String& name, const String& value) {
|
||||||
|
_headers.emplace_back(name, value);
|
||||||
|
}
|
||||||
|
|
||||||
|
ConstIterator begin() const { return _headers.begin(); }
|
||||||
|
ConstIterator end() const { return _headers.end(); }
|
||||||
|
|
||||||
|
DefaultHeaders(DefaultHeaders const&) = delete;
|
||||||
|
DefaultHeaders& operator=(DefaultHeaders const&) = delete;
|
||||||
|
|
||||||
|
static DefaultHeaders& Instance() {
|
||||||
|
static DefaultHeaders instance;
|
||||||
|
return instance;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
#include "AsyncEventSource.h"
|
||||||
|
#include "AsyncWebSocket.h"
|
||||||
|
#include "WebHandlerImpl.h"
|
||||||
|
#include "WebResponseImpl.h"
|
||||||
|
|
||||||
|
#endif /* _AsyncWebServer_H_ */
|
||||||
2
lib/ESP Async WebServer/src/ESP_Async_WebServer.h
Normal file
2
lib/ESP Async WebServer/src/ESP_Async_WebServer.h
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
// to please Arduino Lint
|
||||||
|
#include "ESPAsyncWebServer.h"
|
||||||
245
lib/ESP Async WebServer/src/WebAuthentication.cpp
Normal file
245
lib/ESP Async WebServer/src/WebAuthentication.cpp
Normal file
@@ -0,0 +1,245 @@
|
|||||||
|
/*
|
||||||
|
Asynchronous WebServer library for Espressif MCUs
|
||||||
|
|
||||||
|
Copyright (c) 2016 Hristo Gochkov. All rights reserved.
|
||||||
|
This file is part of the esp8266 core for Arduino environment.
|
||||||
|
|
||||||
|
This library is free software; you can redistribute it and/or
|
||||||
|
modify it under the terms of the GNU Lesser General Public
|
||||||
|
License as published by the Free Software Foundation; either
|
||||||
|
version 2.1 of the License, or (at your option) any later version.
|
||||||
|
|
||||||
|
This library is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||||
|
Lesser General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Lesser General Public
|
||||||
|
License along with this library; if not, write to the Free Software
|
||||||
|
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
|
||||||
|
*/
|
||||||
|
#include "WebAuthentication.h"
|
||||||
|
#include <libb64/cencode.h>
|
||||||
|
#if defined(ESP32) || defined(TARGET_RP2040)
|
||||||
|
#include <MD5Builder.h>
|
||||||
|
#else
|
||||||
|
#include "md5.h"
|
||||||
|
#endif
|
||||||
|
|
||||||
|
// Basic Auth hash = base64("username:password")
|
||||||
|
|
||||||
|
bool checkBasicAuthentication(const char* hash, const char* username, const char* password) {
|
||||||
|
if (username == NULL || password == NULL || hash == NULL)
|
||||||
|
return false;
|
||||||
|
|
||||||
|
size_t toencodeLen = strlen(username) + strlen(password) + 1;
|
||||||
|
size_t encodedLen = base64_encode_expected_len(toencodeLen);
|
||||||
|
if (strlen(hash) != encodedLen)
|
||||||
|
// Fix from https://github.com/me-no-dev/ESPAsyncWebServer/issues/667
|
||||||
|
#ifdef ARDUINO_ARCH_ESP32
|
||||||
|
if (strlen(hash) != encodedLen)
|
||||||
|
#else
|
||||||
|
if (strlen(hash) != encodedLen - 1)
|
||||||
|
#endif
|
||||||
|
return false;
|
||||||
|
|
||||||
|
char* toencode = new char[toencodeLen + 1];
|
||||||
|
if (toencode == NULL) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
char* encoded = new char[base64_encode_expected_len(toencodeLen) + 1];
|
||||||
|
if (encoded == NULL) {
|
||||||
|
delete[] toencode;
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
sprintf_P(toencode, PSTR("%s:%s"), username, password);
|
||||||
|
if (base64_encode_chars(toencode, toencodeLen, encoded) > 0 && memcmp(hash, encoded, encodedLen) == 0) {
|
||||||
|
delete[] toencode;
|
||||||
|
delete[] encoded;
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
delete[] toencode;
|
||||||
|
delete[] encoded;
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
static bool getMD5(uint8_t* data, uint16_t len, char* output) { // 33 bytes or more
|
||||||
|
#if defined(ESP32) || defined(TARGET_RP2040)
|
||||||
|
MD5Builder md5;
|
||||||
|
md5.begin();
|
||||||
|
md5.add(data, len);
|
||||||
|
md5.calculate();
|
||||||
|
md5.getChars(output);
|
||||||
|
#else
|
||||||
|
md5_context_t _ctx;
|
||||||
|
|
||||||
|
uint8_t* _buf = (uint8_t*)malloc(16);
|
||||||
|
if (_buf == NULL)
|
||||||
|
return false;
|
||||||
|
memset(_buf, 0x00, 16);
|
||||||
|
|
||||||
|
MD5Init(&_ctx);
|
||||||
|
MD5Update(&_ctx, data, len);
|
||||||
|
MD5Final(_buf, &_ctx);
|
||||||
|
|
||||||
|
for (uint8_t i = 0; i < 16; i++) {
|
||||||
|
sprintf_P(output + (i * 2), PSTR("%02x"), _buf[i]);
|
||||||
|
}
|
||||||
|
|
||||||
|
free(_buf);
|
||||||
|
#endif
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
static String genRandomMD5() {
|
||||||
|
#ifdef ESP8266
|
||||||
|
uint32_t r = RANDOM_REG32;
|
||||||
|
#else
|
||||||
|
uint32_t r = rand();
|
||||||
|
#endif
|
||||||
|
char* out = (char*)malloc(33);
|
||||||
|
if (out == NULL || !getMD5((uint8_t*)(&r), 4, out))
|
||||||
|
return emptyString;
|
||||||
|
String res = String(out);
|
||||||
|
free(out);
|
||||||
|
return res;
|
||||||
|
}
|
||||||
|
|
||||||
|
static String stringMD5(const String& in) {
|
||||||
|
char* out = (char*)malloc(33);
|
||||||
|
if (out == NULL || !getMD5((uint8_t*)(in.c_str()), in.length(), out))
|
||||||
|
return emptyString;
|
||||||
|
String res = String(out);
|
||||||
|
free(out);
|
||||||
|
return res;
|
||||||
|
}
|
||||||
|
|
||||||
|
String generateDigestHash(const char* username, const char* password, const char* realm) {
|
||||||
|
if (username == NULL || password == NULL || realm == NULL) {
|
||||||
|
return emptyString;
|
||||||
|
}
|
||||||
|
char* out = (char*)malloc(33);
|
||||||
|
String res = String(username);
|
||||||
|
res += ':';
|
||||||
|
res.concat(realm);
|
||||||
|
res += ':';
|
||||||
|
String in = res;
|
||||||
|
in.concat(password);
|
||||||
|
if (out == NULL || !getMD5((uint8_t*)(in.c_str()), in.length(), out))
|
||||||
|
return emptyString;
|
||||||
|
res.concat(out);
|
||||||
|
free(out);
|
||||||
|
return res;
|
||||||
|
}
|
||||||
|
|
||||||
|
String requestDigestAuthentication(const char* realm) {
|
||||||
|
String header = F("realm=\"");
|
||||||
|
if (realm == NULL)
|
||||||
|
header.concat(F("asyncesp"));
|
||||||
|
else
|
||||||
|
header.concat(realm);
|
||||||
|
header.concat(F("\", qop=\"auth\", nonce=\""));
|
||||||
|
header.concat(genRandomMD5());
|
||||||
|
header.concat(F("\", opaque=\""));
|
||||||
|
header.concat(genRandomMD5());
|
||||||
|
header += '"';
|
||||||
|
return header;
|
||||||
|
}
|
||||||
|
|
||||||
|
#ifndef ESP8266
|
||||||
|
bool checkDigestAuthentication(const char* header, const char* method, const char* username, const char* password, const char* realm, bool passwordIsHash, const char* nonce, const char* opaque, const char* uri)
|
||||||
|
#else
|
||||||
|
bool checkDigestAuthentication(const char* header, const __FlashStringHelper* method, const char* username, const char* password, const char* realm, bool passwordIsHash, const char* nonce, const char* opaque, const char* uri)
|
||||||
|
#endif
|
||||||
|
{
|
||||||
|
if (username == NULL || password == NULL || header == NULL || method == NULL) {
|
||||||
|
// os_printf("AUTH FAIL: missing requred fields\n");
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
String myHeader(header);
|
||||||
|
int nextBreak = myHeader.indexOf(',');
|
||||||
|
if (nextBreak < 0) {
|
||||||
|
// os_printf("AUTH FAIL: no variables\n");
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
String myUsername;
|
||||||
|
String myRealm;
|
||||||
|
String myNonce;
|
||||||
|
String myUri;
|
||||||
|
String myResponse;
|
||||||
|
String myQop;
|
||||||
|
String myNc;
|
||||||
|
String myCnonce;
|
||||||
|
|
||||||
|
myHeader += F(", ");
|
||||||
|
do {
|
||||||
|
String avLine(myHeader.substring(0, nextBreak));
|
||||||
|
avLine.trim();
|
||||||
|
myHeader = myHeader.substring(nextBreak + 1);
|
||||||
|
nextBreak = myHeader.indexOf(',');
|
||||||
|
|
||||||
|
int eqSign = avLine.indexOf('=');
|
||||||
|
if (eqSign < 0) {
|
||||||
|
// os_printf("AUTH FAIL: no = sign\n");
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
String varName(avLine.substring(0, eqSign));
|
||||||
|
avLine = avLine.substring(eqSign + 1);
|
||||||
|
if (avLine.startsWith(String('"'))) {
|
||||||
|
avLine = avLine.substring(1, avLine.length() - 1);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (varName.equals(F("username"))) {
|
||||||
|
if (!avLine.equals(username)) {
|
||||||
|
// os_printf("AUTH FAIL: username\n");
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
myUsername = avLine;
|
||||||
|
} else if (varName.equals(F("realm"))) {
|
||||||
|
if (realm != NULL && !avLine.equals(realm)) {
|
||||||
|
// os_printf("AUTH FAIL: realm\n");
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
myRealm = avLine;
|
||||||
|
} else if (varName.equals(F("nonce"))) {
|
||||||
|
if (nonce != NULL && !avLine.equals(nonce)) {
|
||||||
|
// os_printf("AUTH FAIL: nonce\n");
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
myNonce = avLine;
|
||||||
|
} else if (varName.equals(F("opaque"))) {
|
||||||
|
if (opaque != NULL && !avLine.equals(opaque)) {
|
||||||
|
// os_printf("AUTH FAIL: opaque\n");
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
} else if (varName.equals(F("uri"))) {
|
||||||
|
if (uri != NULL && !avLine.equals(uri)) {
|
||||||
|
// os_printf("AUTH FAIL: uri\n");
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
myUri = avLine;
|
||||||
|
} else if (varName.equals(F("response"))) {
|
||||||
|
myResponse = avLine;
|
||||||
|
} else if (varName.equals(F("qop"))) {
|
||||||
|
myQop = avLine;
|
||||||
|
} else if (varName.equals(F("nc"))) {
|
||||||
|
myNc = avLine;
|
||||||
|
} else if (varName.equals(F("cnonce"))) {
|
||||||
|
myCnonce = avLine;
|
||||||
|
}
|
||||||
|
} while (nextBreak > 0);
|
||||||
|
|
||||||
|
String ha1 = (passwordIsHash) ? String(password) : stringMD5(myUsername + ':' + myRealm + ':' + password);
|
||||||
|
String ha2 = String(method) + ':' + myUri;
|
||||||
|
String response = ha1 + ':' + myNonce + ':' + myNc + ':' + myCnonce + ':' + myQop + ':' + stringMD5(ha2);
|
||||||
|
|
||||||
|
if (myResponse.equals(stringMD5(response))) {
|
||||||
|
// os_printf("AUTH SUCCESS\n");
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
// os_printf("AUTH FAIL: password\n");
|
||||||
|
return false;
|
||||||
|
}
|
||||||
39
lib/ESP Async WebServer/src/WebAuthentication.h
Normal file
39
lib/ESP Async WebServer/src/WebAuthentication.h
Normal file
@@ -0,0 +1,39 @@
|
|||||||
|
/*
|
||||||
|
Asynchronous WebServer library for Espressif MCUs
|
||||||
|
|
||||||
|
Copyright (c) 2016 Hristo Gochkov. All rights reserved.
|
||||||
|
This file is part of the esp8266 core for Arduino environment.
|
||||||
|
|
||||||
|
This library is free software; you can redistribute it and/or
|
||||||
|
modify it under the terms of the GNU Lesser General Public
|
||||||
|
License as published by the Free Software Foundation; either
|
||||||
|
version 2.1 of the License, or (at your option) any later version.
|
||||||
|
|
||||||
|
This library is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||||
|
Lesser General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Lesser General Public
|
||||||
|
License along with this library; if not, write to the Free Software
|
||||||
|
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
|
||||||
|
*/
|
||||||
|
|
||||||
|
#ifndef WEB_AUTHENTICATION_H_
|
||||||
|
#define WEB_AUTHENTICATION_H_
|
||||||
|
|
||||||
|
#include "Arduino.h"
|
||||||
|
|
||||||
|
bool checkBasicAuthentication(const char* header, const char* username, const char* password);
|
||||||
|
String requestDigestAuthentication(const char* realm);
|
||||||
|
|
||||||
|
bool checkDigestAuthentication(const char* header, const char* method, const char* username, const char* password, const char* realm, bool passwordIsHash, const char* nonce, const char* opaque, const char* uri);
|
||||||
|
|
||||||
|
#ifdef ESP8266
|
||||||
|
bool checkDigestAuthentication(const char* header, const __FlashStringHelper* method, const char* username, const char* password, const char* realm, bool passwordIsHash, const char* nonce, const char* opaque, const char* uri);
|
||||||
|
#endif
|
||||||
|
|
||||||
|
// for storing hashed versions on the device that can be authenticated against
|
||||||
|
String generateDigestHash(const char* username, const char* password, const char* realm);
|
||||||
|
|
||||||
|
#endif
|
||||||
155
lib/ESP Async WebServer/src/WebHandlerImpl.h
Normal file
155
lib/ESP Async WebServer/src/WebHandlerImpl.h
Normal file
@@ -0,0 +1,155 @@
|
|||||||
|
/*
|
||||||
|
Asynchronous WebServer library for Espressif MCUs
|
||||||
|
|
||||||
|
Copyright (c) 2016 Hristo Gochkov. All rights reserved.
|
||||||
|
This file is part of the esp8266 core for Arduino environment.
|
||||||
|
|
||||||
|
This library is free software; you can redistribute it and/or
|
||||||
|
modify it under the terms of the GNU Lesser General Public
|
||||||
|
License as published by the Free Software Foundation; either
|
||||||
|
version 2.1 of the License, or (at your option) any later version.
|
||||||
|
|
||||||
|
This library is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||||
|
Lesser General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Lesser General Public
|
||||||
|
License along with this library; if not, write to the Free Software
|
||||||
|
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
|
||||||
|
*/
|
||||||
|
#ifndef ASYNCWEBSERVERHANDLERIMPL_H_
|
||||||
|
#define ASYNCWEBSERVERHANDLERIMPL_H_
|
||||||
|
|
||||||
|
#include <string>
|
||||||
|
#ifdef ASYNCWEBSERVER_REGEX
|
||||||
|
#include <regex>
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#include "stddef.h"
|
||||||
|
#include <time.h>
|
||||||
|
|
||||||
|
class AsyncStaticWebHandler : public AsyncWebHandler {
|
||||||
|
using File = fs::File;
|
||||||
|
using FS = fs::FS;
|
||||||
|
|
||||||
|
private:
|
||||||
|
bool _getFile(AsyncWebServerRequest* request);
|
||||||
|
bool _fileExists(AsyncWebServerRequest* request, const String& path);
|
||||||
|
uint8_t _countBits(const uint8_t value) const;
|
||||||
|
|
||||||
|
protected:
|
||||||
|
FS _fs;
|
||||||
|
String _uri;
|
||||||
|
String _path;
|
||||||
|
String _default_file;
|
||||||
|
String _cache_control;
|
||||||
|
String _last_modified;
|
||||||
|
AwsTemplateProcessor _callback;
|
||||||
|
bool _isDir;
|
||||||
|
bool _gzipFirst;
|
||||||
|
uint8_t _gzipStats;
|
||||||
|
|
||||||
|
public:
|
||||||
|
AsyncStaticWebHandler(const char* uri, FS& fs, const char* path, const char* cache_control);
|
||||||
|
virtual bool canHandle(AsyncWebServerRequest* request) override final;
|
||||||
|
virtual void handleRequest(AsyncWebServerRequest* request) override final;
|
||||||
|
AsyncStaticWebHandler& setIsDir(bool isDir);
|
||||||
|
AsyncStaticWebHandler& setDefaultFile(const char* filename);
|
||||||
|
AsyncStaticWebHandler& setCacheControl(const char* cache_control);
|
||||||
|
AsyncStaticWebHandler& setLastModified(const char* last_modified);
|
||||||
|
AsyncStaticWebHandler& setLastModified(struct tm* last_modified);
|
||||||
|
#ifdef ESP8266
|
||||||
|
AsyncStaticWebHandler& setLastModified(time_t last_modified);
|
||||||
|
AsyncStaticWebHandler& setLastModified(); // sets to current time. Make sure sntp is runing and time is updated
|
||||||
|
#endif
|
||||||
|
AsyncStaticWebHandler& setTemplateProcessor(AwsTemplateProcessor newCallback) {
|
||||||
|
_callback = newCallback;
|
||||||
|
return *this;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
class AsyncCallbackWebHandler : public AsyncWebHandler {
|
||||||
|
private:
|
||||||
|
protected:
|
||||||
|
String _uri;
|
||||||
|
WebRequestMethodComposite _method;
|
||||||
|
ArRequestHandlerFunction _onRequest;
|
||||||
|
ArUploadHandlerFunction _onUpload;
|
||||||
|
ArBodyHandlerFunction _onBody;
|
||||||
|
bool _isRegex;
|
||||||
|
|
||||||
|
public:
|
||||||
|
AsyncCallbackWebHandler() : _uri(), _method(HTTP_ANY), _onRequest(NULL), _onUpload(NULL), _onBody(NULL), _isRegex(false) {}
|
||||||
|
void setUri(const String& uri) {
|
||||||
|
_uri = uri;
|
||||||
|
_isRegex = uri.startsWith("^") && uri.endsWith("$");
|
||||||
|
}
|
||||||
|
void setMethod(WebRequestMethodComposite method) { _method = method; }
|
||||||
|
void onRequest(ArRequestHandlerFunction fn) { _onRequest = fn; }
|
||||||
|
void onUpload(ArUploadHandlerFunction fn) { _onUpload = fn; }
|
||||||
|
void onBody(ArBodyHandlerFunction fn) { _onBody = fn; }
|
||||||
|
|
||||||
|
virtual bool canHandle(AsyncWebServerRequest* request) override final {
|
||||||
|
|
||||||
|
if (!_onRequest)
|
||||||
|
return false;
|
||||||
|
|
||||||
|
if (!(_method & request->method()))
|
||||||
|
return false;
|
||||||
|
|
||||||
|
#ifdef ASYNCWEBSERVER_REGEX
|
||||||
|
if (_isRegex) {
|
||||||
|
std::regex pattern(_uri.c_str());
|
||||||
|
std::smatch matches;
|
||||||
|
std::string s(request->url().c_str());
|
||||||
|
if (std::regex_search(s, matches, pattern)) {
|
||||||
|
for (size_t i = 1; i < matches.size(); ++i) { // start from 1
|
||||||
|
request->_addPathParam(matches[i].str().c_str());
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
} else
|
||||||
|
#endif
|
||||||
|
if (_uri.length() && _uri.startsWith("/*.")) {
|
||||||
|
String uriTemplate = String(_uri);
|
||||||
|
uriTemplate = uriTemplate.substring(uriTemplate.lastIndexOf("."));
|
||||||
|
if (!request->url().endsWith(uriTemplate))
|
||||||
|
return false;
|
||||||
|
} else if (_uri.length() && _uri.endsWith("*")) {
|
||||||
|
String uriTemplate = String(_uri);
|
||||||
|
uriTemplate = uriTemplate.substring(0, uriTemplate.length() - 1);
|
||||||
|
if (!request->url().startsWith(uriTemplate))
|
||||||
|
return false;
|
||||||
|
} else if (_uri.length() && (_uri != request->url() && !request->url().startsWith(_uri + "/")))
|
||||||
|
return false;
|
||||||
|
|
||||||
|
request->addInterestingHeader("ANY");
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
virtual void handleRequest(AsyncWebServerRequest* request) override final {
|
||||||
|
if ((_username != "" && _password != "") && !request->authenticate(_username.c_str(), _password.c_str()))
|
||||||
|
return request->requestAuthentication();
|
||||||
|
if (_onRequest)
|
||||||
|
_onRequest(request);
|
||||||
|
else
|
||||||
|
request->send(500);
|
||||||
|
}
|
||||||
|
virtual void handleUpload(AsyncWebServerRequest* request, const String& filename, size_t index, uint8_t* data, size_t len, bool final) override final {
|
||||||
|
if ((_username != "" && _password != "") && !request->authenticate(_username.c_str(), _password.c_str()))
|
||||||
|
return request->requestAuthentication();
|
||||||
|
if (_onUpload)
|
||||||
|
_onUpload(request, filename, index, data, len, final);
|
||||||
|
}
|
||||||
|
virtual void handleBody(AsyncWebServerRequest* request, uint8_t* data, size_t len, size_t index, size_t total) override final {
|
||||||
|
if ((_username != "" && _password != "") && !request->authenticate(_username.c_str(), _password.c_str()))
|
||||||
|
return request->requestAuthentication();
|
||||||
|
if (_onBody)
|
||||||
|
_onBody(request, data, len, index, total);
|
||||||
|
}
|
||||||
|
virtual bool isRequestHandlerTrivial() override final { return _onRequest ? false : true; }
|
||||||
|
};
|
||||||
|
|
||||||
|
#endif /* ASYNCWEBSERVERHANDLERIMPL_H_ */
|
||||||
247
lib/ESP Async WebServer/src/WebHandlers.cpp
Normal file
247
lib/ESP Async WebServer/src/WebHandlers.cpp
Normal file
@@ -0,0 +1,247 @@
|
|||||||
|
/*
|
||||||
|
Asynchronous WebServer library for Espressif MCUs
|
||||||
|
|
||||||
|
Copyright (c) 2016 Hristo Gochkov. All rights reserved.
|
||||||
|
This file is part of the esp8266 core for Arduino environment.
|
||||||
|
|
||||||
|
This library is free software; you can redistribute it and/or
|
||||||
|
modify it under the terms of the GNU Lesser General Public
|
||||||
|
License as published by the Free Software Foundation; either
|
||||||
|
version 2.1 of the License, or (at your option) any later version.
|
||||||
|
|
||||||
|
This library is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||||
|
Lesser General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Lesser General Public
|
||||||
|
License along with this library; if not, write to the Free Software
|
||||||
|
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
|
||||||
|
*/
|
||||||
|
#include "ESPAsyncWebServer.h"
|
||||||
|
#include "WebHandlerImpl.h"
|
||||||
|
|
||||||
|
AsyncStaticWebHandler::AsyncStaticWebHandler(const char* uri, FS& fs, const char* path, const char* cache_control)
|
||||||
|
: _fs(fs), _uri(uri), _path(path), _default_file(F("index.htm")), _cache_control(cache_control), _last_modified(), _callback(nullptr) {
|
||||||
|
// Ensure leading '/'
|
||||||
|
if (_uri.length() == 0 || _uri[0] != '/')
|
||||||
|
_uri = String('/') + _uri;
|
||||||
|
if (_path.length() == 0 || _path[0] != '/')
|
||||||
|
_path = String('/') + _path;
|
||||||
|
|
||||||
|
// If path ends with '/' we assume a hint that this is a directory to improve performance.
|
||||||
|
// However - if it does not end with '/' we, can't assume a file, path can still be a directory.
|
||||||
|
_isDir = _path[_path.length() - 1] == '/';
|
||||||
|
|
||||||
|
// Remove the trailing '/' so we can handle default file
|
||||||
|
// Notice that root will be "" not "/"
|
||||||
|
if (_uri[_uri.length() - 1] == '/')
|
||||||
|
_uri = _uri.substring(0, _uri.length() - 1);
|
||||||
|
if (_path[_path.length() - 1] == '/')
|
||||||
|
_path = _path.substring(0, _path.length() - 1);
|
||||||
|
|
||||||
|
// Reset stats
|
||||||
|
_gzipFirst = false;
|
||||||
|
_gzipStats = 0xF8;
|
||||||
|
}
|
||||||
|
|
||||||
|
AsyncStaticWebHandler& AsyncStaticWebHandler::setIsDir(bool isDir) {
|
||||||
|
_isDir = isDir;
|
||||||
|
return *this;
|
||||||
|
}
|
||||||
|
|
||||||
|
AsyncStaticWebHandler& AsyncStaticWebHandler::setDefaultFile(const char* filename) {
|
||||||
|
_default_file = String(filename);
|
||||||
|
return *this;
|
||||||
|
}
|
||||||
|
|
||||||
|
AsyncStaticWebHandler& AsyncStaticWebHandler::setCacheControl(const char* cache_control) {
|
||||||
|
_cache_control = String(cache_control);
|
||||||
|
return *this;
|
||||||
|
}
|
||||||
|
|
||||||
|
AsyncStaticWebHandler& AsyncStaticWebHandler::setLastModified(const char* last_modified) {
|
||||||
|
_last_modified = last_modified;
|
||||||
|
return *this;
|
||||||
|
}
|
||||||
|
|
||||||
|
AsyncStaticWebHandler& AsyncStaticWebHandler::setLastModified(struct tm* last_modified) {
|
||||||
|
auto formatP = PSTR("%a, %d %b %Y %H:%M:%S %Z");
|
||||||
|
char format[strlen_P(formatP) + 1];
|
||||||
|
strcpy_P(format, formatP);
|
||||||
|
|
||||||
|
char result[30];
|
||||||
|
strftime(result, sizeof(result), format, last_modified);
|
||||||
|
return setLastModified((const char*)result);
|
||||||
|
}
|
||||||
|
|
||||||
|
#ifdef ESP8266
|
||||||
|
AsyncStaticWebHandler& AsyncStaticWebHandler::setLastModified(time_t last_modified) {
|
||||||
|
return setLastModified((struct tm*)gmtime(&last_modified));
|
||||||
|
}
|
||||||
|
|
||||||
|
AsyncStaticWebHandler& AsyncStaticWebHandler::setLastModified() {
|
||||||
|
time_t last_modified;
|
||||||
|
if (time(&last_modified) == 0) // time is not yet set
|
||||||
|
return *this;
|
||||||
|
return setLastModified(last_modified);
|
||||||
|
}
|
||||||
|
#endif
|
||||||
|
bool AsyncStaticWebHandler::canHandle(AsyncWebServerRequest* request) {
|
||||||
|
if (request->method() != HTTP_GET || !request->url().startsWith(_uri) || !request->isExpectedRequestedConnType(RCT_DEFAULT, RCT_HTTP)) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
if (_getFile(request)) {
|
||||||
|
// We interested in "If-Modified-Since" header to check if file was modified
|
||||||
|
if (_last_modified.length())
|
||||||
|
request->addInterestingHeader(F("If-Modified-Since"));
|
||||||
|
|
||||||
|
if (_cache_control.length())
|
||||||
|
request->addInterestingHeader(F("If-None-Match"));
|
||||||
|
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
bool AsyncStaticWebHandler::_getFile(AsyncWebServerRequest* request) {
|
||||||
|
// Remove the found uri
|
||||||
|
String path = request->url().substring(_uri.length());
|
||||||
|
|
||||||
|
// We can skip the file check and look for default if request is to the root of a directory or that request path ends with '/'
|
||||||
|
bool canSkipFileCheck = (_isDir && path.length() == 0) || (path.length() && path[path.length() - 1] == '/');
|
||||||
|
|
||||||
|
path = _path + path;
|
||||||
|
|
||||||
|
// Do we have a file or .gz file
|
||||||
|
if (!canSkipFileCheck && _fileExists(request, path))
|
||||||
|
return true;
|
||||||
|
|
||||||
|
// Can't handle if not default file
|
||||||
|
if (_default_file.length() == 0)
|
||||||
|
return false;
|
||||||
|
|
||||||
|
// Try to add default file, ensure there is a trailing '/' ot the path.
|
||||||
|
if (path.length() == 0 || path[path.length() - 1] != '/')
|
||||||
|
path += String('/');
|
||||||
|
path += _default_file;
|
||||||
|
|
||||||
|
return _fileExists(request, path);
|
||||||
|
}
|
||||||
|
|
||||||
|
#ifdef ESP32
|
||||||
|
#define FILE_IS_REAL(f) (f == true && !f.isDirectory())
|
||||||
|
#else
|
||||||
|
#define FILE_IS_REAL(f) (f == true)
|
||||||
|
#endif
|
||||||
|
|
||||||
|
bool AsyncStaticWebHandler::_fileExists(AsyncWebServerRequest* request, const String& path) {
|
||||||
|
bool fileFound = false;
|
||||||
|
bool gzipFound = false;
|
||||||
|
|
||||||
|
String gzip = path + F(".gz");
|
||||||
|
|
||||||
|
if (_gzipFirst) {
|
||||||
|
if (_fs.exists(gzip)) {
|
||||||
|
request->_tempFile = _fs.open(gzip, fs::FileOpenMode::read);
|
||||||
|
gzipFound = FILE_IS_REAL(request->_tempFile);
|
||||||
|
}
|
||||||
|
if (!gzipFound) {
|
||||||
|
if (_fs.exists(path)) {
|
||||||
|
request->_tempFile = _fs.open(path, fs::FileOpenMode::read);
|
||||||
|
fileFound = FILE_IS_REAL(request->_tempFile);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
if (_fs.exists(path)) {
|
||||||
|
request->_tempFile = _fs.open(path, fs::FileOpenMode::read);
|
||||||
|
fileFound = FILE_IS_REAL(request->_tempFile);
|
||||||
|
}
|
||||||
|
if (!fileFound) {
|
||||||
|
if (_fs.exists(gzip)) {
|
||||||
|
request->_tempFile = _fs.open(gzip, fs::FileOpenMode::read);
|
||||||
|
gzipFound = FILE_IS_REAL(request->_tempFile);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
bool found = fileFound || gzipFound;
|
||||||
|
|
||||||
|
if (found) {
|
||||||
|
// Extract the file name from the path and keep it in _tempObject
|
||||||
|
size_t pathLen = path.length();
|
||||||
|
char* _tempPath = (char*)malloc(pathLen + 1);
|
||||||
|
snprintf_P(_tempPath, pathLen + 1, PSTR("%s"), path.c_str());
|
||||||
|
request->_tempObject = (void*)_tempPath;
|
||||||
|
|
||||||
|
// Calculate gzip statistic
|
||||||
|
_gzipStats = (_gzipStats << 1) + (gzipFound ? 1 : 0);
|
||||||
|
if (_gzipStats == 0x00)
|
||||||
|
_gzipFirst = false; // All files are not gzip
|
||||||
|
else if (_gzipStats == 0xFF)
|
||||||
|
_gzipFirst = true; // All files are gzip
|
||||||
|
else
|
||||||
|
_gzipFirst = _countBits(_gzipStats) > 4; // IF we have more gzip files - try gzip first
|
||||||
|
}
|
||||||
|
|
||||||
|
return found;
|
||||||
|
}
|
||||||
|
|
||||||
|
uint8_t AsyncStaticWebHandler::_countBits(const uint8_t value) const {
|
||||||
|
uint8_t w = value;
|
||||||
|
uint8_t n;
|
||||||
|
for (n = 0; w != 0; n++)
|
||||||
|
w &= w - 1;
|
||||||
|
return n;
|
||||||
|
}
|
||||||
|
|
||||||
|
void AsyncStaticWebHandler::handleRequest(AsyncWebServerRequest* request) {
|
||||||
|
// Get the filename from request->_tempObject and free it
|
||||||
|
String filename = String((char*)request->_tempObject);
|
||||||
|
free(request->_tempObject);
|
||||||
|
request->_tempObject = NULL;
|
||||||
|
if ((_username.length() && _password.length()) && !request->authenticate(_username.c_str(), _password.c_str()))
|
||||||
|
return request->requestAuthentication();
|
||||||
|
|
||||||
|
if (request->_tempFile == true) {
|
||||||
|
time_t lw = request->_tempFile.getLastWrite(); // get last file mod time (if supported by FS)
|
||||||
|
// set etag to lastmod timestamp if available, otherwise to size
|
||||||
|
String etag;
|
||||||
|
if (lw) {
|
||||||
|
setLastModified(gmtime(&lw));
|
||||||
|
#if defined(TARGET_RP2040)
|
||||||
|
// time_t == long long int
|
||||||
|
const size_t len = 1 + 8 * sizeof(time_t);
|
||||||
|
char buf[len];
|
||||||
|
char* ret = lltoa(lw, buf, len, 10);
|
||||||
|
etag = ret ? String(ret) : String(request->_tempFile.size());
|
||||||
|
#else
|
||||||
|
etag = String(lw);
|
||||||
|
#endif
|
||||||
|
} else {
|
||||||
|
etag = String(request->_tempFile.size());
|
||||||
|
}
|
||||||
|
if (_last_modified.length() && _last_modified == request->header(F("If-Modified-Since"))) {
|
||||||
|
request->_tempFile.close();
|
||||||
|
request->send(304); // Not modified
|
||||||
|
} else if (_cache_control.length() && request->hasHeader(F("If-None-Match")) && request->header(F("If-None-Match")).equals(etag)) {
|
||||||
|
request->_tempFile.close();
|
||||||
|
AsyncWebServerResponse* response = new AsyncBasicResponse(304); // Not modified
|
||||||
|
response->addHeader(F("Cache-Control"), _cache_control);
|
||||||
|
response->addHeader(F("ETag"), etag);
|
||||||
|
request->send(response);
|
||||||
|
} else {
|
||||||
|
AsyncWebServerResponse* response = new AsyncFileResponse(request->_tempFile, filename, String(), false, _callback);
|
||||||
|
if (_last_modified.length())
|
||||||
|
response->addHeader(F("Last-Modified"), _last_modified);
|
||||||
|
if (_cache_control.length()) {
|
||||||
|
response->addHeader(F("Cache-Control"), _cache_control);
|
||||||
|
response->addHeader(F("ETag"), etag);
|
||||||
|
}
|
||||||
|
request->send(response);
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
request->send(404);
|
||||||
|
}
|
||||||
|
}
|
||||||
1028
lib/ESP Async WebServer/src/WebRequest.cpp
Normal file
1028
lib/ESP Async WebServer/src/WebRequest.cpp
Normal file
File diff suppressed because it is too large
Load Diff
148
lib/ESP Async WebServer/src/WebResponseImpl.h
Normal file
148
lib/ESP Async WebServer/src/WebResponseImpl.h
Normal file
@@ -0,0 +1,148 @@
|
|||||||
|
/*
|
||||||
|
Asynchronous WebServer library for Espressif MCUs
|
||||||
|
|
||||||
|
Copyright (c) 2016 Hristo Gochkov. All rights reserved.
|
||||||
|
This file is part of the esp8266 core for Arduino environment.
|
||||||
|
|
||||||
|
This library is free software; you can redistribute it and/or
|
||||||
|
modify it under the terms of the GNU Lesser General Public
|
||||||
|
License as published by the Free Software Foundation; either
|
||||||
|
version 2.1 of the License, or (at your option) any later version.
|
||||||
|
|
||||||
|
This library is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||||
|
Lesser General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Lesser General Public
|
||||||
|
License along with this library; if not, write to the Free Software
|
||||||
|
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
|
||||||
|
*/
|
||||||
|
#ifndef ASYNCWEBSERVERRESPONSEIMPL_H_
|
||||||
|
#define ASYNCWEBSERVERRESPONSEIMPL_H_
|
||||||
|
|
||||||
|
#ifdef Arduino_h
|
||||||
|
// arduino is not compatible with std::vector
|
||||||
|
#undef min
|
||||||
|
#undef max
|
||||||
|
#endif
|
||||||
|
#include <memory>
|
||||||
|
#include <vector>
|
||||||
|
|
||||||
|
// It is possible to restore these defines, but one can use _min and _max instead. Or std::min, std::max.
|
||||||
|
|
||||||
|
class AsyncBasicResponse : public AsyncWebServerResponse {
|
||||||
|
private:
|
||||||
|
String _content;
|
||||||
|
|
||||||
|
public:
|
||||||
|
AsyncBasicResponse(int code, const String& contentType = String(), const String& content = String());
|
||||||
|
void _respond(AsyncWebServerRequest* request);
|
||||||
|
size_t _ack(AsyncWebServerRequest* request, size_t len, uint32_t time);
|
||||||
|
bool _sourceValid() const { return true; }
|
||||||
|
};
|
||||||
|
|
||||||
|
class AsyncAbstractResponse : public AsyncWebServerResponse {
|
||||||
|
private:
|
||||||
|
String _head;
|
||||||
|
// Data is inserted into cache at begin().
|
||||||
|
// This is inefficient with vector, but if we use some other container,
|
||||||
|
// we won't be able to access it as contiguous array of bytes when reading from it,
|
||||||
|
// so by gaining performance in one place, we'll lose it in another.
|
||||||
|
std::vector<uint8_t> _cache;
|
||||||
|
size_t _readDataFromCacheOrContent(uint8_t* data, const size_t len);
|
||||||
|
size_t _fillBufferAndProcessTemplates(uint8_t* buf, size_t maxLen);
|
||||||
|
|
||||||
|
protected:
|
||||||
|
AwsTemplateProcessor _callback;
|
||||||
|
|
||||||
|
public:
|
||||||
|
AsyncAbstractResponse(AwsTemplateProcessor callback = nullptr);
|
||||||
|
void _respond(AsyncWebServerRequest* request);
|
||||||
|
size_t _ack(AsyncWebServerRequest* request, size_t len, uint32_t time);
|
||||||
|
bool _sourceValid() const { return false; }
|
||||||
|
virtual size_t _fillBuffer(uint8_t* buf __attribute__((unused)), size_t maxLen __attribute__((unused))) { return 0; }
|
||||||
|
};
|
||||||
|
|
||||||
|
#ifndef TEMPLATE_PLACEHOLDER
|
||||||
|
#define TEMPLATE_PLACEHOLDER '%'
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#define TEMPLATE_PARAM_NAME_LENGTH 32
|
||||||
|
class AsyncFileResponse : public AsyncAbstractResponse {
|
||||||
|
using File = fs::File;
|
||||||
|
using FS = fs::FS;
|
||||||
|
|
||||||
|
private:
|
||||||
|
File _content;
|
||||||
|
String _path;
|
||||||
|
void _setContentType(const String& path);
|
||||||
|
|
||||||
|
public:
|
||||||
|
AsyncFileResponse(FS& fs, const String& path, const String& contentType = String(), bool download = false, AwsTemplateProcessor callback = nullptr);
|
||||||
|
AsyncFileResponse(File content, const String& path, const String& contentType = String(), bool download = false, AwsTemplateProcessor callback = nullptr);
|
||||||
|
~AsyncFileResponse();
|
||||||
|
bool _sourceValid() const { return !!(_content); }
|
||||||
|
virtual size_t _fillBuffer(uint8_t* buf, size_t maxLen) override;
|
||||||
|
};
|
||||||
|
|
||||||
|
class AsyncStreamResponse : public AsyncAbstractResponse {
|
||||||
|
private:
|
||||||
|
Stream* _content;
|
||||||
|
|
||||||
|
public:
|
||||||
|
AsyncStreamResponse(Stream& stream, const String& contentType, size_t len, AwsTemplateProcessor callback = nullptr);
|
||||||
|
bool _sourceValid() const { return !!(_content); }
|
||||||
|
virtual size_t _fillBuffer(uint8_t* buf, size_t maxLen) override;
|
||||||
|
};
|
||||||
|
|
||||||
|
class AsyncCallbackResponse : public AsyncAbstractResponse {
|
||||||
|
private:
|
||||||
|
AwsResponseFiller _content;
|
||||||
|
size_t _filledLength;
|
||||||
|
|
||||||
|
public:
|
||||||
|
AsyncCallbackResponse(const String& contentType, size_t len, AwsResponseFiller callback, AwsTemplateProcessor templateCallback = nullptr);
|
||||||
|
bool _sourceValid() const { return !!(_content); }
|
||||||
|
virtual size_t _fillBuffer(uint8_t* buf, size_t maxLen) override;
|
||||||
|
};
|
||||||
|
|
||||||
|
class AsyncChunkedResponse : public AsyncAbstractResponse {
|
||||||
|
private:
|
||||||
|
AwsResponseFiller _content;
|
||||||
|
size_t _filledLength;
|
||||||
|
|
||||||
|
public:
|
||||||
|
AsyncChunkedResponse(const String& contentType, AwsResponseFiller callback, AwsTemplateProcessor templateCallback = nullptr);
|
||||||
|
bool _sourceValid() const { return !!(_content); }
|
||||||
|
virtual size_t _fillBuffer(uint8_t* buf, size_t maxLen) override;
|
||||||
|
};
|
||||||
|
|
||||||
|
class AsyncProgmemResponse : public AsyncAbstractResponse {
|
||||||
|
private:
|
||||||
|
const uint8_t* _content;
|
||||||
|
size_t _readLength;
|
||||||
|
|
||||||
|
public:
|
||||||
|
AsyncProgmemResponse(int code, const String& contentType, const uint8_t* content, size_t len, AwsTemplateProcessor callback = nullptr);
|
||||||
|
bool _sourceValid() const { return true; }
|
||||||
|
virtual size_t _fillBuffer(uint8_t* buf, size_t maxLen) override;
|
||||||
|
};
|
||||||
|
|
||||||
|
class cbuf;
|
||||||
|
|
||||||
|
class AsyncResponseStream : public AsyncAbstractResponse, public Print {
|
||||||
|
private:
|
||||||
|
std::unique_ptr<cbuf> _content;
|
||||||
|
|
||||||
|
public:
|
||||||
|
AsyncResponseStream(const String& contentType, size_t bufferSize);
|
||||||
|
~AsyncResponseStream();
|
||||||
|
bool _sourceValid() const { return (_state < RESPONSE_END); }
|
||||||
|
virtual size_t _fillBuffer(uint8_t* buf, size_t maxLen) override;
|
||||||
|
size_t write(const uint8_t* data, size_t len);
|
||||||
|
size_t write(uint8_t data);
|
||||||
|
using Print::write;
|
||||||
|
};
|
||||||
|
|
||||||
|
#endif /* ASYNCWEBSERVERRESPONSEIMPL_H_ */
|
||||||
751
lib/ESP Async WebServer/src/WebResponses.cpp
Normal file
751
lib/ESP Async WebServer/src/WebResponses.cpp
Normal file
@@ -0,0 +1,751 @@
|
|||||||
|
/*
|
||||||
|
Asynchronous WebServer library for Espressif MCUs
|
||||||
|
|
||||||
|
Copyright (c) 2016 Hristo Gochkov. All rights reserved.
|
||||||
|
This file is part of the esp8266 core for Arduino environment.
|
||||||
|
|
||||||
|
This library is free software; you can redistribute it and/or
|
||||||
|
modify it under the terms of the GNU Lesser General Public
|
||||||
|
License as published by the Free Software Foundation; either
|
||||||
|
version 2.1 of the License, or (at your option) any later version.
|
||||||
|
|
||||||
|
This library is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||||
|
Lesser General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Lesser General Public
|
||||||
|
License along with this library; if not, write to the Free Software
|
||||||
|
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
|
||||||
|
*/
|
||||||
|
#include "ESPAsyncWebServer.h"
|
||||||
|
#include "WebResponseImpl.h"
|
||||||
|
#include "cbuf.h"
|
||||||
|
|
||||||
|
// Since ESP8266 does not link memchr by default, here's its implementation.
|
||||||
|
void* memchr(void* ptr, int ch, size_t count) {
|
||||||
|
unsigned char* p = static_cast<unsigned char*>(ptr);
|
||||||
|
while (count--)
|
||||||
|
if (*p++ == static_cast<unsigned char>(ch))
|
||||||
|
return --p;
|
||||||
|
return nullptr;
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Abstract Response
|
||||||
|
* */
|
||||||
|
const char* AsyncWebServerResponse::_responseCodeToString(int code) {
|
||||||
|
return reinterpret_cast<const char*>(responseCodeToString(code));
|
||||||
|
}
|
||||||
|
|
||||||
|
const __FlashStringHelper* AsyncWebServerResponse::responseCodeToString(int code) {
|
||||||
|
switch (code) {
|
||||||
|
case 100:
|
||||||
|
return F("Continue");
|
||||||
|
case 101:
|
||||||
|
return F("Switching Protocols");
|
||||||
|
case 200:
|
||||||
|
return F("OK");
|
||||||
|
case 201:
|
||||||
|
return F("Created");
|
||||||
|
case 202:
|
||||||
|
return F("Accepted");
|
||||||
|
case 203:
|
||||||
|
return F("Non-Authoritative Information");
|
||||||
|
case 204:
|
||||||
|
return F("No Content");
|
||||||
|
case 205:
|
||||||
|
return F("Reset Content");
|
||||||
|
case 206:
|
||||||
|
return F("Partial Content");
|
||||||
|
case 300:
|
||||||
|
return F("Multiple Choices");
|
||||||
|
case 301:
|
||||||
|
return F("Moved Permanently");
|
||||||
|
case 302:
|
||||||
|
return F("Found");
|
||||||
|
case 303:
|
||||||
|
return F("See Other");
|
||||||
|
case 304:
|
||||||
|
return F("Not Modified");
|
||||||
|
case 305:
|
||||||
|
return F("Use Proxy");
|
||||||
|
case 307:
|
||||||
|
return F("Temporary Redirect");
|
||||||
|
case 400:
|
||||||
|
return F("Bad Request");
|
||||||
|
case 401:
|
||||||
|
return F("Unauthorized");
|
||||||
|
case 402:
|
||||||
|
return F("Payment Required");
|
||||||
|
case 403:
|
||||||
|
return F("Forbidden");
|
||||||
|
case 404:
|
||||||
|
return F("Not Found");
|
||||||
|
case 405:
|
||||||
|
return F("Method Not Allowed");
|
||||||
|
case 406:
|
||||||
|
return F("Not Acceptable");
|
||||||
|
case 407:
|
||||||
|
return F("Proxy Authentication Required");
|
||||||
|
case 408:
|
||||||
|
return F("Request Time-out");
|
||||||
|
case 409:
|
||||||
|
return F("Conflict");
|
||||||
|
case 410:
|
||||||
|
return F("Gone");
|
||||||
|
case 411:
|
||||||
|
return F("Length Required");
|
||||||
|
case 412:
|
||||||
|
return F("Precondition Failed");
|
||||||
|
case 413:
|
||||||
|
return F("Request Entity Too Large");
|
||||||
|
case 414:
|
||||||
|
return F("Request-URI Too Large");
|
||||||
|
case 415:
|
||||||
|
return F("Unsupported Media Type");
|
||||||
|
case 416:
|
||||||
|
return F("Requested range not satisfiable");
|
||||||
|
case 417:
|
||||||
|
return F("Expectation Failed");
|
||||||
|
case 500:
|
||||||
|
return F("Internal Server Error");
|
||||||
|
case 501:
|
||||||
|
return F("Not Implemented");
|
||||||
|
case 502:
|
||||||
|
return F("Bad Gateway");
|
||||||
|
case 503:
|
||||||
|
return F("Service Unavailable");
|
||||||
|
case 504:
|
||||||
|
return F("Gateway Time-out");
|
||||||
|
case 505:
|
||||||
|
return F("HTTP Version not supported");
|
||||||
|
default:
|
||||||
|
return F("");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
AsyncWebServerResponse::AsyncWebServerResponse()
|
||||||
|
: _code(0), _contentType(), _contentLength(0), _sendContentLength(true), _chunked(false), _headLength(0), _sentLength(0), _ackedLength(0), _writtenLength(0), _state(RESPONSE_SETUP) {
|
||||||
|
for (const auto& header : DefaultHeaders::Instance()) {
|
||||||
|
_headers.emplace_back(header);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
AsyncWebServerResponse::~AsyncWebServerResponse() = default;
|
||||||
|
|
||||||
|
void AsyncWebServerResponse::setCode(int code) {
|
||||||
|
if (_state == RESPONSE_SETUP)
|
||||||
|
_code = code;
|
||||||
|
}
|
||||||
|
|
||||||
|
void AsyncWebServerResponse::setContentLength(size_t len) {
|
||||||
|
if (_state == RESPONSE_SETUP)
|
||||||
|
_contentLength = len;
|
||||||
|
}
|
||||||
|
|
||||||
|
void AsyncWebServerResponse::setContentType(const String& type) {
|
||||||
|
if (_state == RESPONSE_SETUP)
|
||||||
|
_contentType = type;
|
||||||
|
}
|
||||||
|
|
||||||
|
void AsyncWebServerResponse::addHeader(const String& name, const String& value) {
|
||||||
|
_headers.emplace_back(name, value);
|
||||||
|
}
|
||||||
|
|
||||||
|
String AsyncWebServerResponse::_assembleHead(uint8_t version) {
|
||||||
|
if (version) {
|
||||||
|
addHeader(F("Accept-Ranges"), F("none"));
|
||||||
|
if (_chunked)
|
||||||
|
addHeader(F("Transfer-Encoding"), F("chunked"));
|
||||||
|
}
|
||||||
|
String out = String();
|
||||||
|
int bufSize = 300;
|
||||||
|
char buf[bufSize];
|
||||||
|
|
||||||
|
snprintf_P(buf, bufSize, PSTR("HTTP/1.%d %d %s\r\n"), version, _code, _responseCodeToString(_code));
|
||||||
|
out.concat(buf);
|
||||||
|
|
||||||
|
if (_sendContentLength) {
|
||||||
|
snprintf_P(buf, bufSize, PSTR("Content-Length: %d\r\n"), _contentLength);
|
||||||
|
out.concat(buf);
|
||||||
|
}
|
||||||
|
if (_contentType.length()) {
|
||||||
|
snprintf_P(buf, bufSize, PSTR("Content-Type: %s\r\n"), _contentType.c_str());
|
||||||
|
out.concat(buf);
|
||||||
|
}
|
||||||
|
|
||||||
|
for (const auto& header : _headers) {
|
||||||
|
snprintf_P(buf, bufSize, PSTR("%s: %s\r\n"), header.name().c_str(), header.value().c_str());
|
||||||
|
out.concat(buf);
|
||||||
|
}
|
||||||
|
_headers.clear();
|
||||||
|
|
||||||
|
out.concat(F("\r\n"));
|
||||||
|
_headLength = out.length();
|
||||||
|
return out;
|
||||||
|
}
|
||||||
|
|
||||||
|
bool AsyncWebServerResponse::_started() const { return _state > RESPONSE_SETUP; }
|
||||||
|
bool AsyncWebServerResponse::_finished() const { return _state > RESPONSE_WAIT_ACK; }
|
||||||
|
bool AsyncWebServerResponse::_failed() const { return _state == RESPONSE_FAILED; }
|
||||||
|
bool AsyncWebServerResponse::_sourceValid() const { return false; }
|
||||||
|
void AsyncWebServerResponse::_respond(AsyncWebServerRequest* request) {
|
||||||
|
_state = RESPONSE_END;
|
||||||
|
request->client()->close();
|
||||||
|
}
|
||||||
|
size_t AsyncWebServerResponse::_ack(AsyncWebServerRequest* request, size_t len, uint32_t time) {
|
||||||
|
(void)request;
|
||||||
|
(void)len;
|
||||||
|
(void)time;
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
* String/Code Response
|
||||||
|
* */
|
||||||
|
AsyncBasicResponse::AsyncBasicResponse(int code, const String& contentType, const String& content) {
|
||||||
|
_code = code;
|
||||||
|
_content = content;
|
||||||
|
_contentType = contentType;
|
||||||
|
if (_content.length()) {
|
||||||
|
_contentLength = _content.length();
|
||||||
|
if (!_contentType.length())
|
||||||
|
_contentType = F("text/plain");
|
||||||
|
}
|
||||||
|
addHeader(F("Connection"), F("close"));
|
||||||
|
}
|
||||||
|
|
||||||
|
void AsyncBasicResponse::_respond(AsyncWebServerRequest* request) {
|
||||||
|
_state = RESPONSE_HEADERS;
|
||||||
|
String out = _assembleHead(request->version());
|
||||||
|
size_t outLen = out.length();
|
||||||
|
size_t space = request->client()->space();
|
||||||
|
if (!_contentLength && space >= outLen) {
|
||||||
|
_writtenLength += request->client()->write(out.c_str(), outLen);
|
||||||
|
_state = RESPONSE_WAIT_ACK;
|
||||||
|
} else if (_contentLength && space >= outLen + _contentLength) {
|
||||||
|
out += _content;
|
||||||
|
outLen += _contentLength;
|
||||||
|
_writtenLength += request->client()->write(out.c_str(), outLen);
|
||||||
|
_state = RESPONSE_WAIT_ACK;
|
||||||
|
} else if (space && space < outLen) {
|
||||||
|
String partial = out.substring(0, space);
|
||||||
|
_content = out.substring(space) + _content;
|
||||||
|
_contentLength += outLen - space;
|
||||||
|
_writtenLength += request->client()->write(partial.c_str(), partial.length());
|
||||||
|
_state = RESPONSE_CONTENT;
|
||||||
|
} else if (space > outLen && space < (outLen + _contentLength)) {
|
||||||
|
size_t shift = space - outLen;
|
||||||
|
outLen += shift;
|
||||||
|
_sentLength += shift;
|
||||||
|
out += _content.substring(0, shift);
|
||||||
|
_content = _content.substring(shift);
|
||||||
|
_writtenLength += request->client()->write(out.c_str(), outLen);
|
||||||
|
_state = RESPONSE_CONTENT;
|
||||||
|
} else {
|
||||||
|
_content = out + _content;
|
||||||
|
_contentLength += outLen;
|
||||||
|
_state = RESPONSE_CONTENT;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
size_t AsyncBasicResponse::_ack(AsyncWebServerRequest* request, size_t len, uint32_t time) {
|
||||||
|
(void)time;
|
||||||
|
_ackedLength += len;
|
||||||
|
if (_state == RESPONSE_CONTENT) {
|
||||||
|
size_t available = _contentLength - _sentLength;
|
||||||
|
size_t space = request->client()->space();
|
||||||
|
// we can fit in this packet
|
||||||
|
if (space > available) {
|
||||||
|
_writtenLength += request->client()->write(_content.c_str(), available);
|
||||||
|
_content = String();
|
||||||
|
_state = RESPONSE_WAIT_ACK;
|
||||||
|
return available;
|
||||||
|
}
|
||||||
|
// send some data, the rest on ack
|
||||||
|
String out = _content.substring(0, space);
|
||||||
|
_content = _content.substring(space);
|
||||||
|
_sentLength += space;
|
||||||
|
_writtenLength += request->client()->write(out.c_str(), space);
|
||||||
|
return space;
|
||||||
|
} else if (_state == RESPONSE_WAIT_ACK) {
|
||||||
|
if (_ackedLength >= _writtenLength) {
|
||||||
|
_state = RESPONSE_END;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Abstract Response
|
||||||
|
* */
|
||||||
|
|
||||||
|
AsyncAbstractResponse::AsyncAbstractResponse(AwsTemplateProcessor callback) : _callback(callback) {
|
||||||
|
// In case of template processing, we're unable to determine real response size
|
||||||
|
if (callback) {
|
||||||
|
_contentLength = 0;
|
||||||
|
_sendContentLength = false;
|
||||||
|
_chunked = true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
void AsyncAbstractResponse::_respond(AsyncWebServerRequest* request) {
|
||||||
|
addHeader(F("Connection"), F("close"));
|
||||||
|
_head = _assembleHead(request->version());
|
||||||
|
_state = RESPONSE_HEADERS;
|
||||||
|
_ack(request, 0, 0);
|
||||||
|
}
|
||||||
|
|
||||||
|
size_t AsyncAbstractResponse::_ack(AsyncWebServerRequest* request, size_t len, uint32_t time) {
|
||||||
|
(void)time;
|
||||||
|
if (!_sourceValid()) {
|
||||||
|
_state = RESPONSE_FAILED;
|
||||||
|
request->client()->close();
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
_ackedLength += len;
|
||||||
|
size_t space = request->client()->space();
|
||||||
|
|
||||||
|
size_t headLen = _head.length();
|
||||||
|
if (_state == RESPONSE_HEADERS) {
|
||||||
|
if (space >= headLen) {
|
||||||
|
_state = RESPONSE_CONTENT;
|
||||||
|
space -= headLen;
|
||||||
|
} else {
|
||||||
|
String out = _head.substring(0, space);
|
||||||
|
_head = _head.substring(space);
|
||||||
|
_writtenLength += request->client()->write(out.c_str(), out.length());
|
||||||
|
return out.length();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (_state == RESPONSE_CONTENT) {
|
||||||
|
size_t outLen;
|
||||||
|
if (_chunked) {
|
||||||
|
if (space <= 8) {
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
outLen = space;
|
||||||
|
} else if (!_sendContentLength) {
|
||||||
|
outLen = space;
|
||||||
|
} else {
|
||||||
|
outLen = ((_contentLength - _sentLength) > space) ? space : (_contentLength - _sentLength);
|
||||||
|
}
|
||||||
|
|
||||||
|
uint8_t* buf = (uint8_t*)malloc(outLen + headLen);
|
||||||
|
if (!buf) {
|
||||||
|
// os_printf("_ack malloc %d failed\n", outLen+headLen);
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (headLen) {
|
||||||
|
memcpy(buf, _head.c_str(), _head.length());
|
||||||
|
}
|
||||||
|
|
||||||
|
size_t readLen = 0;
|
||||||
|
|
||||||
|
if (_chunked) {
|
||||||
|
// HTTP 1.1 allows leading zeros in chunk length. Or spaces may be added.
|
||||||
|
// See RFC2616 sections 2, 3.6.1.
|
||||||
|
readLen = _fillBufferAndProcessTemplates(buf + headLen + 6, outLen - 8);
|
||||||
|
if (readLen == RESPONSE_TRY_AGAIN) {
|
||||||
|
free(buf);
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
outLen = sprintf_P((char*)buf + headLen, PSTR("%x"), readLen) + headLen;
|
||||||
|
while (outLen < headLen + 4)
|
||||||
|
buf[outLen++] = ' ';
|
||||||
|
buf[outLen++] = '\r';
|
||||||
|
buf[outLen++] = '\n';
|
||||||
|
outLen += readLen;
|
||||||
|
buf[outLen++] = '\r';
|
||||||
|
buf[outLen++] = '\n';
|
||||||
|
} else {
|
||||||
|
readLen = _fillBufferAndProcessTemplates(buf + headLen, outLen);
|
||||||
|
if (readLen == RESPONSE_TRY_AGAIN) {
|
||||||
|
free(buf);
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
outLen = readLen + headLen;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (headLen) {
|
||||||
|
_head = String();
|
||||||
|
}
|
||||||
|
|
||||||
|
if (outLen) {
|
||||||
|
_writtenLength += request->client()->write((const char*)buf, outLen);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (_chunked) {
|
||||||
|
_sentLength += readLen;
|
||||||
|
} else {
|
||||||
|
_sentLength += outLen - headLen;
|
||||||
|
}
|
||||||
|
|
||||||
|
free(buf);
|
||||||
|
|
||||||
|
if ((_chunked && readLen == 0) || (!_sendContentLength && outLen == 0) || (!_chunked && _sentLength == _contentLength)) {
|
||||||
|
_state = RESPONSE_WAIT_ACK;
|
||||||
|
}
|
||||||
|
return outLen;
|
||||||
|
|
||||||
|
} else if (_state == RESPONSE_WAIT_ACK) {
|
||||||
|
if (!_sendContentLength || _ackedLength >= _writtenLength) {
|
||||||
|
_state = RESPONSE_END;
|
||||||
|
if (!_chunked && !_sendContentLength)
|
||||||
|
request->client()->close(true);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
size_t AsyncAbstractResponse::_readDataFromCacheOrContent(uint8_t* data, const size_t len) {
|
||||||
|
// If we have something in cache, copy it to buffer
|
||||||
|
const size_t readFromCache = std::min(len, _cache.size());
|
||||||
|
if (readFromCache) {
|
||||||
|
memcpy(data, _cache.data(), readFromCache);
|
||||||
|
_cache.erase(_cache.begin(), _cache.begin() + readFromCache);
|
||||||
|
}
|
||||||
|
// If we need to read more...
|
||||||
|
const size_t needFromFile = len - readFromCache;
|
||||||
|
const size_t readFromContent = _fillBuffer(data + readFromCache, needFromFile);
|
||||||
|
return readFromCache + readFromContent;
|
||||||
|
}
|
||||||
|
|
||||||
|
size_t AsyncAbstractResponse::_fillBufferAndProcessTemplates(uint8_t* data, size_t len) {
|
||||||
|
if (!_callback)
|
||||||
|
return _fillBuffer(data, len);
|
||||||
|
|
||||||
|
const size_t originalLen = len;
|
||||||
|
len = _readDataFromCacheOrContent(data, len);
|
||||||
|
// Now we've read 'len' bytes, either from cache or from file
|
||||||
|
// Search for template placeholders
|
||||||
|
uint8_t* pTemplateStart = data;
|
||||||
|
while ((pTemplateStart < &data[len]) && (pTemplateStart = (uint8_t*)memchr(pTemplateStart, TEMPLATE_PLACEHOLDER, &data[len - 1] - pTemplateStart + 1))) { // data[0] ... data[len - 1]
|
||||||
|
uint8_t* pTemplateEnd = (pTemplateStart < &data[len - 1]) ? (uint8_t*)memchr(pTemplateStart + 1, TEMPLATE_PLACEHOLDER, &data[len - 1] - pTemplateStart) : nullptr;
|
||||||
|
// temporary buffer to hold parameter name
|
||||||
|
uint8_t buf[TEMPLATE_PARAM_NAME_LENGTH + 1];
|
||||||
|
String paramName;
|
||||||
|
// If closing placeholder is found:
|
||||||
|
if (pTemplateEnd) {
|
||||||
|
// prepare argument to callback
|
||||||
|
const size_t paramNameLength = std::min((size_t)sizeof(buf) - 1, (size_t)(pTemplateEnd - pTemplateStart - 1));
|
||||||
|
if (paramNameLength) {
|
||||||
|
memcpy(buf, pTemplateStart + 1, paramNameLength);
|
||||||
|
buf[paramNameLength] = 0;
|
||||||
|
paramName = String(reinterpret_cast<char*>(buf));
|
||||||
|
} else { // double percent sign encountered, this is single percent sign escaped.
|
||||||
|
// remove the 2nd percent sign
|
||||||
|
memmove(pTemplateEnd, pTemplateEnd + 1, &data[len] - pTemplateEnd - 1);
|
||||||
|
len += _readDataFromCacheOrContent(&data[len - 1], 1) - 1;
|
||||||
|
++pTemplateStart;
|
||||||
|
}
|
||||||
|
} else if (&data[len - 1] - pTemplateStart + 1 < TEMPLATE_PARAM_NAME_LENGTH + 2) { // closing placeholder not found, check if it's in the remaining file data
|
||||||
|
memcpy(buf, pTemplateStart + 1, &data[len - 1] - pTemplateStart);
|
||||||
|
const size_t readFromCacheOrContent = _readDataFromCacheOrContent(buf + (&data[len - 1] - pTemplateStart), TEMPLATE_PARAM_NAME_LENGTH + 2 - (&data[len - 1] - pTemplateStart + 1));
|
||||||
|
if (readFromCacheOrContent) {
|
||||||
|
pTemplateEnd = (uint8_t*)memchr(buf + (&data[len - 1] - pTemplateStart), TEMPLATE_PLACEHOLDER, readFromCacheOrContent);
|
||||||
|
if (pTemplateEnd) {
|
||||||
|
// prepare argument to callback
|
||||||
|
*pTemplateEnd = 0;
|
||||||
|
paramName = String(reinterpret_cast<char*>(buf));
|
||||||
|
// Copy remaining read-ahead data into cache
|
||||||
|
_cache.insert(_cache.begin(), pTemplateEnd + 1, buf + (&data[len - 1] - pTemplateStart) + readFromCacheOrContent);
|
||||||
|
pTemplateEnd = &data[len - 1];
|
||||||
|
} else // closing placeholder not found in file data, store found percent symbol as is and advance to the next position
|
||||||
|
{
|
||||||
|
// but first, store read file data in cache
|
||||||
|
_cache.insert(_cache.begin(), buf + (&data[len - 1] - pTemplateStart), buf + (&data[len - 1] - pTemplateStart) + readFromCacheOrContent);
|
||||||
|
++pTemplateStart;
|
||||||
|
}
|
||||||
|
} else // closing placeholder not found in content data, store found percent symbol as is and advance to the next position
|
||||||
|
++pTemplateStart;
|
||||||
|
} else // closing placeholder not found in content data, store found percent symbol as is and advance to the next position
|
||||||
|
++pTemplateStart;
|
||||||
|
if (paramName.length()) {
|
||||||
|
// call callback and replace with result.
|
||||||
|
// Everything in range [pTemplateStart, pTemplateEnd] can be safely replaced with parameter value.
|
||||||
|
// Data after pTemplateEnd may need to be moved.
|
||||||
|
// The first byte of data after placeholder is located at pTemplateEnd + 1.
|
||||||
|
// It should be located at pTemplateStart + numBytesCopied (to begin right after inserted parameter value).
|
||||||
|
const String paramValue(_callback(paramName));
|
||||||
|
const char* pvstr = paramValue.c_str();
|
||||||
|
const unsigned int pvlen = paramValue.length();
|
||||||
|
const size_t numBytesCopied = std::min(pvlen, static_cast<unsigned int>(&data[originalLen - 1] - pTemplateStart + 1));
|
||||||
|
// make room for param value
|
||||||
|
// 1. move extra data to cache if parameter value is longer than placeholder AND if there is no room to store
|
||||||
|
if ((pTemplateEnd + 1 < pTemplateStart + numBytesCopied) && (originalLen - (pTemplateStart + numBytesCopied - pTemplateEnd - 1) < len)) {
|
||||||
|
_cache.insert(_cache.begin(), &data[originalLen - (pTemplateStart + numBytesCopied - pTemplateEnd - 1)], &data[len]);
|
||||||
|
// 2. parameter value is longer than placeholder text, push the data after placeholder which not saved into cache further to the end
|
||||||
|
memmove(pTemplateStart + numBytesCopied, pTemplateEnd + 1, &data[originalLen] - pTemplateStart - numBytesCopied);
|
||||||
|
len = originalLen; // fix issue with truncated data, not sure if it has any side effects
|
||||||
|
} else if (pTemplateEnd + 1 != pTemplateStart + numBytesCopied)
|
||||||
|
// 2. Either parameter value is shorter than placeholder text OR there is enough free space in buffer to fit.
|
||||||
|
// Move the entire data after the placeholder
|
||||||
|
memmove(pTemplateStart + numBytesCopied, pTemplateEnd + 1, &data[len] - pTemplateEnd - 1);
|
||||||
|
// 3. replace placeholder with actual value
|
||||||
|
memcpy(pTemplateStart, pvstr, numBytesCopied);
|
||||||
|
// If result is longer than buffer, copy the remainder into cache (this could happen only if placeholder text itself did not fit entirely in buffer)
|
||||||
|
if (numBytesCopied < pvlen) {
|
||||||
|
_cache.insert(_cache.begin(), pvstr + numBytesCopied, pvstr + pvlen);
|
||||||
|
} else if (pTemplateStart + numBytesCopied < pTemplateEnd + 1) { // result is copied fully; if result is shorter than placeholder text...
|
||||||
|
// there is some free room, fill it from cache
|
||||||
|
const size_t roomFreed = pTemplateEnd + 1 - pTemplateStart - numBytesCopied;
|
||||||
|
const size_t totalFreeRoom = originalLen - len + roomFreed;
|
||||||
|
len += _readDataFromCacheOrContent(&data[len - roomFreed], totalFreeRoom) - roomFreed;
|
||||||
|
} else { // result is copied fully; it is longer than placeholder text
|
||||||
|
const size_t roomTaken = pTemplateStart + numBytesCopied - pTemplateEnd - 1;
|
||||||
|
len = std::min(len + roomTaken, originalLen);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} // while(pTemplateStart)
|
||||||
|
return len;
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
* File Response
|
||||||
|
* */
|
||||||
|
|
||||||
|
AsyncFileResponse::~AsyncFileResponse() {
|
||||||
|
if (_content)
|
||||||
|
_content.close();
|
||||||
|
}
|
||||||
|
|
||||||
|
void AsyncFileResponse::_setContentType(const String& path) {
|
||||||
|
#if HAVE_EXTERN_GET_CONTENT_TYPE_FUNCTION
|
||||||
|
extern const __FlashStringHelper* getContentType(const String& path);
|
||||||
|
_contentType = getContentType(path);
|
||||||
|
#else
|
||||||
|
if (path.endsWith(F(".html")))
|
||||||
|
_contentType = F("text/html");
|
||||||
|
else if (path.endsWith(F(".htm")))
|
||||||
|
_contentType = F("text/html");
|
||||||
|
else if (path.endsWith(F(".css")))
|
||||||
|
_contentType = F("text/css");
|
||||||
|
else if (path.endsWith(F(".json")))
|
||||||
|
_contentType = F("application/json");
|
||||||
|
else if (path.endsWith(F(".js")))
|
||||||
|
_contentType = F("application/javascript");
|
||||||
|
else if (path.endsWith(F(".png")))
|
||||||
|
_contentType = F("image/png");
|
||||||
|
else if (path.endsWith(F(".gif")))
|
||||||
|
_contentType = F("image/gif");
|
||||||
|
else if (path.endsWith(F(".jpg")))
|
||||||
|
_contentType = F("image/jpeg");
|
||||||
|
else if (path.endsWith(F(".ico")))
|
||||||
|
_contentType = F("image/x-icon");
|
||||||
|
else if (path.endsWith(F(".svg")))
|
||||||
|
_contentType = F("image/svg+xml");
|
||||||
|
else if (path.endsWith(F(".eot")))
|
||||||
|
_contentType = F("font/eot");
|
||||||
|
else if (path.endsWith(F(".woff")))
|
||||||
|
_contentType = F("font/woff");
|
||||||
|
else if (path.endsWith(F(".woff2")))
|
||||||
|
_contentType = F("font/woff2");
|
||||||
|
else if (path.endsWith(F(".ttf")))
|
||||||
|
_contentType = F("font/ttf");
|
||||||
|
else if (path.endsWith(F(".xml")))
|
||||||
|
_contentType = F("text/xml");
|
||||||
|
else if (path.endsWith(F(".pdf")))
|
||||||
|
_contentType = F("application/pdf");
|
||||||
|
else if (path.endsWith(F(".zip")))
|
||||||
|
_contentType = F("application/zip");
|
||||||
|
else if (path.endsWith(F(".gz")))
|
||||||
|
_contentType = F("application/x-gzip");
|
||||||
|
else
|
||||||
|
_contentType = F("text/plain");
|
||||||
|
#endif
|
||||||
|
}
|
||||||
|
|
||||||
|
AsyncFileResponse::AsyncFileResponse(FS& fs, const String& path, const String& contentType, bool download, AwsTemplateProcessor callback) : AsyncAbstractResponse(callback) {
|
||||||
|
_code = 200;
|
||||||
|
_path = path;
|
||||||
|
|
||||||
|
if (!download && !fs.exists(_path) && fs.exists(_path + F(".gz"))) {
|
||||||
|
_path = _path + F(".gz");
|
||||||
|
addHeader(F("Content-Encoding"), F("gzip"));
|
||||||
|
_callback = nullptr; // Unable to process zipped templates
|
||||||
|
_sendContentLength = true;
|
||||||
|
_chunked = false;
|
||||||
|
}
|
||||||
|
|
||||||
|
_content = fs.open(_path, fs::FileOpenMode::read);
|
||||||
|
_contentLength = _content.size();
|
||||||
|
|
||||||
|
if (contentType.length() == 0)
|
||||||
|
_setContentType(path);
|
||||||
|
else
|
||||||
|
_contentType = contentType;
|
||||||
|
|
||||||
|
int filenameStart = path.lastIndexOf('/') + 1;
|
||||||
|
char buf[26 + path.length() - filenameStart];
|
||||||
|
char* filename = (char*)path.c_str() + filenameStart;
|
||||||
|
|
||||||
|
if (download) {
|
||||||
|
// set filename and force download
|
||||||
|
snprintf_P(buf, sizeof(buf), PSTR("attachment; filename=\"%s\""), filename);
|
||||||
|
} else {
|
||||||
|
// set filename and force rendering
|
||||||
|
snprintf_P(buf, sizeof(buf), PSTR("inline"));
|
||||||
|
}
|
||||||
|
addHeader(F("Content-Disposition"), buf);
|
||||||
|
}
|
||||||
|
|
||||||
|
AsyncFileResponse::AsyncFileResponse(File content, const String& path, const String& contentType, bool download, AwsTemplateProcessor callback) : AsyncAbstractResponse(callback) {
|
||||||
|
_code = 200;
|
||||||
|
_path = path;
|
||||||
|
|
||||||
|
if (!download && String(content.name()).endsWith(F(".gz")) && !path.endsWith(F(".gz"))) {
|
||||||
|
addHeader(F("Content-Encoding"), F("gzip"));
|
||||||
|
_callback = nullptr; // Unable to process gzipped templates
|
||||||
|
_sendContentLength = true;
|
||||||
|
_chunked = false;
|
||||||
|
}
|
||||||
|
|
||||||
|
_content = content;
|
||||||
|
_contentLength = _content.size();
|
||||||
|
|
||||||
|
if (contentType.length() == 0)
|
||||||
|
_setContentType(path);
|
||||||
|
else
|
||||||
|
_contentType = contentType;
|
||||||
|
|
||||||
|
int filenameStart = path.lastIndexOf('/') + 1;
|
||||||
|
char buf[26 + path.length() - filenameStart];
|
||||||
|
char* filename = (char*)path.c_str() + filenameStart;
|
||||||
|
|
||||||
|
if (download) {
|
||||||
|
snprintf_P(buf, sizeof(buf), PSTR("attachment; filename=\"%s\""), filename);
|
||||||
|
} else {
|
||||||
|
snprintf_P(buf, sizeof(buf), PSTR("inline"));
|
||||||
|
}
|
||||||
|
addHeader(F("Content-Disposition"), buf);
|
||||||
|
}
|
||||||
|
|
||||||
|
size_t AsyncFileResponse::_fillBuffer(uint8_t* data, size_t len) {
|
||||||
|
return _content.read(data, len);
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Stream Response
|
||||||
|
* */
|
||||||
|
|
||||||
|
AsyncStreamResponse::AsyncStreamResponse(Stream& stream, const String& contentType, size_t len, AwsTemplateProcessor callback) : AsyncAbstractResponse(callback) {
|
||||||
|
_code = 200;
|
||||||
|
_content = &stream;
|
||||||
|
_contentLength = len;
|
||||||
|
_contentType = contentType;
|
||||||
|
}
|
||||||
|
|
||||||
|
size_t AsyncStreamResponse::_fillBuffer(uint8_t* data, size_t len) {
|
||||||
|
size_t available = _content->available();
|
||||||
|
size_t outLen = (available > len) ? len : available;
|
||||||
|
size_t i;
|
||||||
|
for (i = 0; i < outLen; i++)
|
||||||
|
data[i] = _content->read();
|
||||||
|
return outLen;
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Callback Response
|
||||||
|
* */
|
||||||
|
|
||||||
|
AsyncCallbackResponse::AsyncCallbackResponse(const String& contentType, size_t len, AwsResponseFiller callback, AwsTemplateProcessor templateCallback) : AsyncAbstractResponse(templateCallback) {
|
||||||
|
_code = 200;
|
||||||
|
_content = callback;
|
||||||
|
_contentLength = len;
|
||||||
|
if (!len)
|
||||||
|
_sendContentLength = false;
|
||||||
|
_contentType = contentType;
|
||||||
|
_filledLength = 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
size_t AsyncCallbackResponse::_fillBuffer(uint8_t* data, size_t len) {
|
||||||
|
size_t ret = _content(data, len, _filledLength);
|
||||||
|
if (ret != RESPONSE_TRY_AGAIN) {
|
||||||
|
_filledLength += ret;
|
||||||
|
}
|
||||||
|
return ret;
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Chunked Response
|
||||||
|
* */
|
||||||
|
|
||||||
|
AsyncChunkedResponse::AsyncChunkedResponse(const String& contentType, AwsResponseFiller callback, AwsTemplateProcessor processorCallback) : AsyncAbstractResponse(processorCallback) {
|
||||||
|
_code = 200;
|
||||||
|
_content = callback;
|
||||||
|
_contentLength = 0;
|
||||||
|
_contentType = contentType;
|
||||||
|
_sendContentLength = false;
|
||||||
|
_chunked = true;
|
||||||
|
_filledLength = 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
size_t AsyncChunkedResponse::_fillBuffer(uint8_t* data, size_t len) {
|
||||||
|
size_t ret = _content(data, len, _filledLength);
|
||||||
|
if (ret != RESPONSE_TRY_AGAIN) {
|
||||||
|
_filledLength += ret;
|
||||||
|
}
|
||||||
|
return ret;
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Progmem Response
|
||||||
|
* */
|
||||||
|
|
||||||
|
AsyncProgmemResponse::AsyncProgmemResponse(int code, const String& contentType, const uint8_t* content, size_t len, AwsTemplateProcessor callback) : AsyncAbstractResponse(callback) {
|
||||||
|
_code = code;
|
||||||
|
_content = content;
|
||||||
|
_contentType = contentType;
|
||||||
|
_contentLength = len;
|
||||||
|
_readLength = 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
size_t AsyncProgmemResponse::_fillBuffer(uint8_t* data, size_t len) {
|
||||||
|
size_t left = _contentLength - _readLength;
|
||||||
|
if (left > len) {
|
||||||
|
memcpy_P(data, _content + _readLength, len);
|
||||||
|
_readLength += len;
|
||||||
|
return len;
|
||||||
|
}
|
||||||
|
memcpy_P(data, _content + _readLength, left);
|
||||||
|
_readLength += left;
|
||||||
|
return left;
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Response Stream (You can print/write/printf to it, up to the contentLen bytes)
|
||||||
|
* */
|
||||||
|
|
||||||
|
AsyncResponseStream::AsyncResponseStream(const String& contentType, size_t bufferSize) {
|
||||||
|
_code = 200;
|
||||||
|
_contentLength = 0;
|
||||||
|
_contentType = contentType;
|
||||||
|
_content = std::unique_ptr<cbuf>(new cbuf(bufferSize)); // std::make_unique<cbuf>(bufferSize);
|
||||||
|
}
|
||||||
|
|
||||||
|
AsyncResponseStream::~AsyncResponseStream() = default;
|
||||||
|
|
||||||
|
size_t AsyncResponseStream::_fillBuffer(uint8_t* buf, size_t maxLen) {
|
||||||
|
return _content->read((char*)buf, maxLen);
|
||||||
|
}
|
||||||
|
|
||||||
|
size_t AsyncResponseStream::write(const uint8_t* data, size_t len) {
|
||||||
|
if (_started())
|
||||||
|
return 0;
|
||||||
|
|
||||||
|
if (len > _content->room()) {
|
||||||
|
size_t needed = len - _content->room();
|
||||||
|
_content->resizeAdd(needed);
|
||||||
|
}
|
||||||
|
size_t written = _content->write((const char*)data, len);
|
||||||
|
_contentLength += written;
|
||||||
|
return written;
|
||||||
|
}
|
||||||
|
|
||||||
|
size_t AsyncResponseStream::write(uint8_t data) {
|
||||||
|
return write(&data, 1);
|
||||||
|
}
|
||||||
217
lib/ESP Async WebServer/src/WebServer.cpp
Normal file
217
lib/ESP Async WebServer/src/WebServer.cpp
Normal file
@@ -0,0 +1,217 @@
|
|||||||
|
/*
|
||||||
|
Asynchronous WebServer library for Espressif MCUs
|
||||||
|
|
||||||
|
Copyright (c) 2016 Hristo Gochkov. All rights reserved.
|
||||||
|
This file is part of the esp8266 core for Arduino environment.
|
||||||
|
|
||||||
|
This library is free software; you can redistribute it and/or
|
||||||
|
modify it under the terms of the GNU Lesser General Public
|
||||||
|
License as published by the Free Software Foundation; either
|
||||||
|
version 2.1 of the License, or (at your option) any later version.
|
||||||
|
|
||||||
|
This library is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||||
|
Lesser General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Lesser General Public
|
||||||
|
License along with this library; if not, write to the Free Software
|
||||||
|
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
|
||||||
|
*/
|
||||||
|
#include "ESPAsyncWebServer.h"
|
||||||
|
#include "WebHandlerImpl.h"
|
||||||
|
|
||||||
|
bool ON_STA_FILTER(AsyncWebServerRequest* request) {
|
||||||
|
return WiFi.localIP() == request->client()->localIP();
|
||||||
|
}
|
||||||
|
|
||||||
|
bool ON_AP_FILTER(AsyncWebServerRequest* request) {
|
||||||
|
return WiFi.localIP() != request->client()->localIP();
|
||||||
|
}
|
||||||
|
|
||||||
|
#ifndef HAVE_FS_FILE_OPEN_MODE
|
||||||
|
const char* fs::FileOpenMode::read = "r";
|
||||||
|
const char* fs::FileOpenMode::write = "w";
|
||||||
|
const char* fs::FileOpenMode::append = "a";
|
||||||
|
#endif
|
||||||
|
|
||||||
|
AsyncWebServer::AsyncWebServer(uint16_t port)
|
||||||
|
: _server(port) {
|
||||||
|
_catchAllHandler = new AsyncCallbackWebHandler();
|
||||||
|
if (_catchAllHandler == NULL)
|
||||||
|
return;
|
||||||
|
_server.onClient([](void* s, AsyncClient* c) {
|
||||||
|
if (c == NULL)
|
||||||
|
return;
|
||||||
|
c->setRxTimeout(3);
|
||||||
|
AsyncWebServerRequest* r = new AsyncWebServerRequest((AsyncWebServer*)s, c);
|
||||||
|
if (r == NULL) {
|
||||||
|
c->close(true);
|
||||||
|
c->free();
|
||||||
|
delete c;
|
||||||
|
}
|
||||||
|
},
|
||||||
|
this);
|
||||||
|
}
|
||||||
|
|
||||||
|
AsyncWebServer::~AsyncWebServer() {
|
||||||
|
reset();
|
||||||
|
end();
|
||||||
|
if (_catchAllHandler)
|
||||||
|
delete _catchAllHandler;
|
||||||
|
}
|
||||||
|
|
||||||
|
AsyncWebRewrite& AsyncWebServer::addRewrite(std::shared_ptr<AsyncWebRewrite> rewrite) {
|
||||||
|
_rewrites.emplace_back(rewrite);
|
||||||
|
return *_rewrites.back().get();
|
||||||
|
}
|
||||||
|
|
||||||
|
AsyncWebRewrite& AsyncWebServer::addRewrite(AsyncWebRewrite* rewrite) {
|
||||||
|
_rewrites.emplace_back(rewrite);
|
||||||
|
return *_rewrites.back().get();
|
||||||
|
}
|
||||||
|
|
||||||
|
bool AsyncWebServer::removeRewrite(AsyncWebRewrite* rewrite) {
|
||||||
|
return removeRewrite(rewrite->from().c_str(), rewrite->toUrl().c_str());
|
||||||
|
}
|
||||||
|
|
||||||
|
bool AsyncWebServer::removeRewrite(const char* from, const char* to) {
|
||||||
|
for (auto r = _rewrites.begin(); r != _rewrites.end(); ++r) {
|
||||||
|
if (r->get()->from() == from && r->get()->toUrl() == to) {
|
||||||
|
_rewrites.erase(r);
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
AsyncWebRewrite& AsyncWebServer::rewrite(const char* from, const char* to) {
|
||||||
|
_rewrites.emplace_back(std::make_shared<AsyncWebRewrite>(from, to));
|
||||||
|
return *_rewrites.back().get();
|
||||||
|
}
|
||||||
|
|
||||||
|
AsyncWebHandler& AsyncWebServer::addHandler(AsyncWebHandler* handler) {
|
||||||
|
_handlers.emplace_back(handler);
|
||||||
|
return *(_handlers.back().get());
|
||||||
|
}
|
||||||
|
|
||||||
|
bool AsyncWebServer::removeHandler(AsyncWebHandler* handler) {
|
||||||
|
for (auto i = _handlers.begin(); i != _handlers.end(); ++i) {
|
||||||
|
if (i->get() == handler) {
|
||||||
|
_handlers.erase(i);
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
void AsyncWebServer::begin() {
|
||||||
|
_server.setNoDelay(true);
|
||||||
|
_server.begin();
|
||||||
|
}
|
||||||
|
|
||||||
|
void AsyncWebServer::end() {
|
||||||
|
_server.end();
|
||||||
|
}
|
||||||
|
|
||||||
|
#if ASYNC_TCP_SSL_ENABLED
|
||||||
|
void AsyncWebServer::onSslFileRequest(AcSSlFileHandler cb, void* arg) {
|
||||||
|
_server.onSslFileRequest(cb, arg);
|
||||||
|
}
|
||||||
|
|
||||||
|
void AsyncWebServer::beginSecure(const char* cert, const char* key, const char* password) {
|
||||||
|
_server.beginSecure(cert, key, password);
|
||||||
|
}
|
||||||
|
#endif
|
||||||
|
|
||||||
|
void AsyncWebServer::_handleDisconnect(AsyncWebServerRequest* request) {
|
||||||
|
delete request;
|
||||||
|
}
|
||||||
|
|
||||||
|
void AsyncWebServer::_rewriteRequest(AsyncWebServerRequest* request) {
|
||||||
|
for (const auto& r : _rewrites) {
|
||||||
|
if (r->match(request)) {
|
||||||
|
request->_url = r->toUrl();
|
||||||
|
request->_addGetParams(r->params());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
void AsyncWebServer::_attachHandler(AsyncWebServerRequest* request) {
|
||||||
|
for (auto& h : _handlers) {
|
||||||
|
if (h->filter(request) && h->canHandle(request)) {
|
||||||
|
request->setHandler(h.get());
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
request->addInterestingHeader(F("ANY"));
|
||||||
|
request->setHandler(_catchAllHandler);
|
||||||
|
}
|
||||||
|
|
||||||
|
AsyncCallbackWebHandler& AsyncWebServer::on(const char* uri, WebRequestMethodComposite method, ArRequestHandlerFunction onRequest, ArUploadHandlerFunction onUpload, ArBodyHandlerFunction onBody) {
|
||||||
|
AsyncCallbackWebHandler* handler = new AsyncCallbackWebHandler();
|
||||||
|
handler->setUri(uri);
|
||||||
|
handler->setMethod(method);
|
||||||
|
handler->onRequest(onRequest);
|
||||||
|
handler->onUpload(onUpload);
|
||||||
|
handler->onBody(onBody);
|
||||||
|
addHandler(handler);
|
||||||
|
return *handler;
|
||||||
|
}
|
||||||
|
|
||||||
|
AsyncCallbackWebHandler& AsyncWebServer::on(const char* uri, WebRequestMethodComposite method, ArRequestHandlerFunction onRequest, ArUploadHandlerFunction onUpload) {
|
||||||
|
AsyncCallbackWebHandler* handler = new AsyncCallbackWebHandler();
|
||||||
|
handler->setUri(uri);
|
||||||
|
handler->setMethod(method);
|
||||||
|
handler->onRequest(onRequest);
|
||||||
|
handler->onUpload(onUpload);
|
||||||
|
addHandler(handler);
|
||||||
|
return *handler;
|
||||||
|
}
|
||||||
|
|
||||||
|
AsyncCallbackWebHandler& AsyncWebServer::on(const char* uri, WebRequestMethodComposite method, ArRequestHandlerFunction onRequest) {
|
||||||
|
AsyncCallbackWebHandler* handler = new AsyncCallbackWebHandler();
|
||||||
|
handler->setUri(uri);
|
||||||
|
handler->setMethod(method);
|
||||||
|
handler->onRequest(onRequest);
|
||||||
|
addHandler(handler);
|
||||||
|
return *handler;
|
||||||
|
}
|
||||||
|
|
||||||
|
AsyncCallbackWebHandler& AsyncWebServer::on(const char* uri, ArRequestHandlerFunction onRequest) {
|
||||||
|
AsyncCallbackWebHandler* handler = new AsyncCallbackWebHandler();
|
||||||
|
handler->setUri(uri);
|
||||||
|
handler->onRequest(onRequest);
|
||||||
|
addHandler(handler);
|
||||||
|
return *handler;
|
||||||
|
}
|
||||||
|
|
||||||
|
AsyncStaticWebHandler& AsyncWebServer::serveStatic(const char* uri, fs::FS& fs, const char* path, const char* cache_control) {
|
||||||
|
AsyncStaticWebHandler* handler = new AsyncStaticWebHandler(uri, fs, path, cache_control);
|
||||||
|
addHandler(handler);
|
||||||
|
return *handler;
|
||||||
|
}
|
||||||
|
|
||||||
|
void AsyncWebServer::onNotFound(ArRequestHandlerFunction fn) {
|
||||||
|
_catchAllHandler->onRequest(fn);
|
||||||
|
}
|
||||||
|
|
||||||
|
void AsyncWebServer::onFileUpload(ArUploadHandlerFunction fn) {
|
||||||
|
_catchAllHandler->onUpload(fn);
|
||||||
|
}
|
||||||
|
|
||||||
|
void AsyncWebServer::onRequestBody(ArBodyHandlerFunction fn) {
|
||||||
|
_catchAllHandler->onBody(fn);
|
||||||
|
}
|
||||||
|
|
||||||
|
void AsyncWebServer::reset() {
|
||||||
|
_rewrites.clear();
|
||||||
|
_handlers.clear();
|
||||||
|
|
||||||
|
if (_catchAllHandler != NULL) {
|
||||||
|
_catchAllHandler->onRequest(NULL);
|
||||||
|
_catchAllHandler->onUpload(NULL);
|
||||||
|
_catchAllHandler->onBody(NULL);
|
||||||
|
}
|
||||||
|
}
|
||||||
284
lib/ESP Async WebServer/src/port/SHA1Builder.cpp
Normal file
284
lib/ESP Async WebServer/src/port/SHA1Builder.cpp
Normal file
@@ -0,0 +1,284 @@
|
|||||||
|
/*
|
||||||
|
* FIPS-180-1 compliant SHA-1 implementation
|
||||||
|
*
|
||||||
|
* Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
|
||||||
|
* SPDX-License-Identifier: Apache-2.0
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License"); you may
|
||||||
|
* not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
||||||
|
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*
|
||||||
|
* This file is part of mbed TLS (https://tls.mbed.org)
|
||||||
|
* Modified for esp32 by Lucas Saavedra Vaz on 11 Jan 2024
|
||||||
|
*/
|
||||||
|
|
||||||
|
#include <Arduino.h>
|
||||||
|
#if ESP_IDF_VERSION_MAJOR < 5
|
||||||
|
|
||||||
|
#include "SHA1Builder.h"
|
||||||
|
|
||||||
|
// 32-bit integer manipulation macros (big endian)
|
||||||
|
|
||||||
|
#ifndef GET_UINT32_BE
|
||||||
|
#define GET_UINT32_BE(n, b, i) \
|
||||||
|
{ (n) = ((uint32_t)(b)[(i)] << 24) | ((uint32_t)(b)[(i) + 1] << 16) | ((uint32_t)(b)[(i) + 2] << 8) | ((uint32_t)(b)[(i) + 3]); }
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#ifndef PUT_UINT32_BE
|
||||||
|
#define PUT_UINT32_BE(n, b, i) \
|
||||||
|
{ \
|
||||||
|
(b)[(i)] = (uint8_t)((n) >> 24); \
|
||||||
|
(b)[(i) + 1] = (uint8_t)((n) >> 16); \
|
||||||
|
(b)[(i) + 2] = (uint8_t)((n) >> 8); \
|
||||||
|
(b)[(i) + 3] = (uint8_t)((n)); \
|
||||||
|
}
|
||||||
|
#endif
|
||||||
|
|
||||||
|
// Constants
|
||||||
|
|
||||||
|
static const uint8_t sha1_padding[64] = {0x80, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
|
||||||
|
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0};
|
||||||
|
|
||||||
|
// Private methods
|
||||||
|
|
||||||
|
void SHA1Builder::process(const uint8_t *data) {
|
||||||
|
uint32_t temp, W[16], A, B, C, D, E;
|
||||||
|
|
||||||
|
GET_UINT32_BE(W[0], data, 0);
|
||||||
|
GET_UINT32_BE(W[1], data, 4);
|
||||||
|
GET_UINT32_BE(W[2], data, 8);
|
||||||
|
GET_UINT32_BE(W[3], data, 12);
|
||||||
|
GET_UINT32_BE(W[4], data, 16);
|
||||||
|
GET_UINT32_BE(W[5], data, 20);
|
||||||
|
GET_UINT32_BE(W[6], data, 24);
|
||||||
|
GET_UINT32_BE(W[7], data, 28);
|
||||||
|
GET_UINT32_BE(W[8], data, 32);
|
||||||
|
GET_UINT32_BE(W[9], data, 36);
|
||||||
|
GET_UINT32_BE(W[10], data, 40);
|
||||||
|
GET_UINT32_BE(W[11], data, 44);
|
||||||
|
GET_UINT32_BE(W[12], data, 48);
|
||||||
|
GET_UINT32_BE(W[13], data, 52);
|
||||||
|
GET_UINT32_BE(W[14], data, 56);
|
||||||
|
GET_UINT32_BE(W[15], data, 60);
|
||||||
|
|
||||||
|
#define sha1_S(x, n) ((x << n) | ((x & 0xFFFFFFFF) >> (32 - n)))
|
||||||
|
|
||||||
|
#define sha1_R(t) (temp = W[(t - 3) & 0x0F] ^ W[(t - 8) & 0x0F] ^ W[(t - 14) & 0x0F] ^ W[t & 0x0F], (W[t & 0x0F] = sha1_S(temp, 1)))
|
||||||
|
|
||||||
|
#define sha1_P(a, b, c, d, e, x) \
|
||||||
|
{ \
|
||||||
|
e += sha1_S(a, 5) + sha1_F(b, c, d) + sha1_K + x; \
|
||||||
|
b = sha1_S(b, 30); \
|
||||||
|
}
|
||||||
|
|
||||||
|
A = state[0];
|
||||||
|
B = state[1];
|
||||||
|
C = state[2];
|
||||||
|
D = state[3];
|
||||||
|
E = state[4];
|
||||||
|
|
||||||
|
#define sha1_F(x, y, z) (z ^ (x & (y ^ z)))
|
||||||
|
#define sha1_K 0x5A827999
|
||||||
|
|
||||||
|
sha1_P(A, B, C, D, E, W[0]);
|
||||||
|
sha1_P(E, A, B, C, D, W[1]);
|
||||||
|
sha1_P(D, E, A, B, C, W[2]);
|
||||||
|
sha1_P(C, D, E, A, B, W[3]);
|
||||||
|
sha1_P(B, C, D, E, A, W[4]);
|
||||||
|
sha1_P(A, B, C, D, E, W[5]);
|
||||||
|
sha1_P(E, A, B, C, D, W[6]);
|
||||||
|
sha1_P(D, E, A, B, C, W[7]);
|
||||||
|
sha1_P(C, D, E, A, B, W[8]);
|
||||||
|
sha1_P(B, C, D, E, A, W[9]);
|
||||||
|
sha1_P(A, B, C, D, E, W[10]);
|
||||||
|
sha1_P(E, A, B, C, D, W[11]);
|
||||||
|
sha1_P(D, E, A, B, C, W[12]);
|
||||||
|
sha1_P(C, D, E, A, B, W[13]);
|
||||||
|
sha1_P(B, C, D, E, A, W[14]);
|
||||||
|
sha1_P(A, B, C, D, E, W[15]);
|
||||||
|
sha1_P(E, A, B, C, D, sha1_R(16));
|
||||||
|
sha1_P(D, E, A, B, C, sha1_R(17));
|
||||||
|
sha1_P(C, D, E, A, B, sha1_R(18));
|
||||||
|
sha1_P(B, C, D, E, A, sha1_R(19));
|
||||||
|
|
||||||
|
#undef sha1_K
|
||||||
|
#undef sha1_F
|
||||||
|
|
||||||
|
#define sha1_F(x, y, z) (x ^ y ^ z)
|
||||||
|
#define sha1_K 0x6ED9EBA1
|
||||||
|
|
||||||
|
sha1_P(A, B, C, D, E, sha1_R(20));
|
||||||
|
sha1_P(E, A, B, C, D, sha1_R(21));
|
||||||
|
sha1_P(D, E, A, B, C, sha1_R(22));
|
||||||
|
sha1_P(C, D, E, A, B, sha1_R(23));
|
||||||
|
sha1_P(B, C, D, E, A, sha1_R(24));
|
||||||
|
sha1_P(A, B, C, D, E, sha1_R(25));
|
||||||
|
sha1_P(E, A, B, C, D, sha1_R(26));
|
||||||
|
sha1_P(D, E, A, B, C, sha1_R(27));
|
||||||
|
sha1_P(C, D, E, A, B, sha1_R(28));
|
||||||
|
sha1_P(B, C, D, E, A, sha1_R(29));
|
||||||
|
sha1_P(A, B, C, D, E, sha1_R(30));
|
||||||
|
sha1_P(E, A, B, C, D, sha1_R(31));
|
||||||
|
sha1_P(D, E, A, B, C, sha1_R(32));
|
||||||
|
sha1_P(C, D, E, A, B, sha1_R(33));
|
||||||
|
sha1_P(B, C, D, E, A, sha1_R(34));
|
||||||
|
sha1_P(A, B, C, D, E, sha1_R(35));
|
||||||
|
sha1_P(E, A, B, C, D, sha1_R(36));
|
||||||
|
sha1_P(D, E, A, B, C, sha1_R(37));
|
||||||
|
sha1_P(C, D, E, A, B, sha1_R(38));
|
||||||
|
sha1_P(B, C, D, E, A, sha1_R(39));
|
||||||
|
|
||||||
|
#undef sha1_K
|
||||||
|
#undef sha1_F
|
||||||
|
|
||||||
|
#define sha1_F(x, y, z) ((x & y) | (z & (x | y)))
|
||||||
|
#define sha1_K 0x8F1BBCDC
|
||||||
|
|
||||||
|
sha1_P(A, B, C, D, E, sha1_R(40));
|
||||||
|
sha1_P(E, A, B, C, D, sha1_R(41));
|
||||||
|
sha1_P(D, E, A, B, C, sha1_R(42));
|
||||||
|
sha1_P(C, D, E, A, B, sha1_R(43));
|
||||||
|
sha1_P(B, C, D, E, A, sha1_R(44));
|
||||||
|
sha1_P(A, B, C, D, E, sha1_R(45));
|
||||||
|
sha1_P(E, A, B, C, D, sha1_R(46));
|
||||||
|
sha1_P(D, E, A, B, C, sha1_R(47));
|
||||||
|
sha1_P(C, D, E, A, B, sha1_R(48));
|
||||||
|
sha1_P(B, C, D, E, A, sha1_R(49));
|
||||||
|
sha1_P(A, B, C, D, E, sha1_R(50));
|
||||||
|
sha1_P(E, A, B, C, D, sha1_R(51));
|
||||||
|
sha1_P(D, E, A, B, C, sha1_R(52));
|
||||||
|
sha1_P(C, D, E, A, B, sha1_R(53));
|
||||||
|
sha1_P(B, C, D, E, A, sha1_R(54));
|
||||||
|
sha1_P(A, B, C, D, E, sha1_R(55));
|
||||||
|
sha1_P(E, A, B, C, D, sha1_R(56));
|
||||||
|
sha1_P(D, E, A, B, C, sha1_R(57));
|
||||||
|
sha1_P(C, D, E, A, B, sha1_R(58));
|
||||||
|
sha1_P(B, C, D, E, A, sha1_R(59));
|
||||||
|
|
||||||
|
#undef sha1_K
|
||||||
|
#undef sha1_F
|
||||||
|
|
||||||
|
#define sha1_F(x, y, z) (x ^ y ^ z)
|
||||||
|
#define sha1_K 0xCA62C1D6
|
||||||
|
|
||||||
|
sha1_P(A, B, C, D, E, sha1_R(60));
|
||||||
|
sha1_P(E, A, B, C, D, sha1_R(61));
|
||||||
|
sha1_P(D, E, A, B, C, sha1_R(62));
|
||||||
|
sha1_P(C, D, E, A, B, sha1_R(63));
|
||||||
|
sha1_P(B, C, D, E, A, sha1_R(64));
|
||||||
|
sha1_P(A, B, C, D, E, sha1_R(65));
|
||||||
|
sha1_P(E, A, B, C, D, sha1_R(66));
|
||||||
|
sha1_P(D, E, A, B, C, sha1_R(67));
|
||||||
|
sha1_P(C, D, E, A, B, sha1_R(68));
|
||||||
|
sha1_P(B, C, D, E, A, sha1_R(69));
|
||||||
|
sha1_P(A, B, C, D, E, sha1_R(70));
|
||||||
|
sha1_P(E, A, B, C, D, sha1_R(71));
|
||||||
|
sha1_P(D, E, A, B, C, sha1_R(72));
|
||||||
|
sha1_P(C, D, E, A, B, sha1_R(73));
|
||||||
|
sha1_P(B, C, D, E, A, sha1_R(74));
|
||||||
|
sha1_P(A, B, C, D, E, sha1_R(75));
|
||||||
|
sha1_P(E, A, B, C, D, sha1_R(76));
|
||||||
|
sha1_P(D, E, A, B, C, sha1_R(77));
|
||||||
|
sha1_P(C, D, E, A, B, sha1_R(78));
|
||||||
|
sha1_P(B, C, D, E, A, sha1_R(79));
|
||||||
|
|
||||||
|
#undef sha1_K
|
||||||
|
#undef sha1_F
|
||||||
|
|
||||||
|
state[0] += A;
|
||||||
|
state[1] += B;
|
||||||
|
state[2] += C;
|
||||||
|
state[3] += D;
|
||||||
|
state[4] += E;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Public methods
|
||||||
|
|
||||||
|
void SHA1Builder::begin(void) {
|
||||||
|
total[0] = 0;
|
||||||
|
total[1] = 0;
|
||||||
|
|
||||||
|
state[0] = 0x67452301;
|
||||||
|
state[1] = 0xEFCDAB89;
|
||||||
|
state[2] = 0x98BADCFE;
|
||||||
|
state[3] = 0x10325476;
|
||||||
|
state[4] = 0xC3D2E1F0;
|
||||||
|
|
||||||
|
memset(buffer, 0x00, sizeof(buffer));
|
||||||
|
memset(hash, 0x00, sizeof(hash));
|
||||||
|
}
|
||||||
|
|
||||||
|
void SHA1Builder::add(const uint8_t *data, size_t len) {
|
||||||
|
size_t fill;
|
||||||
|
uint32_t left;
|
||||||
|
|
||||||
|
if (len == 0) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
left = total[0] & 0x3F;
|
||||||
|
fill = 64 - left;
|
||||||
|
|
||||||
|
total[0] += (uint32_t)len;
|
||||||
|
total[0] &= 0xFFFFFFFF;
|
||||||
|
|
||||||
|
if (total[0] < (uint32_t)len) {
|
||||||
|
total[1]++;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (left && len >= fill) {
|
||||||
|
memcpy((void *)(buffer + left), data, fill);
|
||||||
|
process(buffer);
|
||||||
|
data += fill;
|
||||||
|
len -= fill;
|
||||||
|
left = 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
while (len >= 64) {
|
||||||
|
process(data);
|
||||||
|
data += 64;
|
||||||
|
len -= 64;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (len > 0) {
|
||||||
|
memcpy((void *)(buffer + left), data, len);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
void SHA1Builder::calculate(void) {
|
||||||
|
uint32_t last, padn;
|
||||||
|
uint32_t high, low;
|
||||||
|
uint8_t msglen[8];
|
||||||
|
|
||||||
|
high = (total[0] >> 29) | (total[1] << 3);
|
||||||
|
low = (total[0] << 3);
|
||||||
|
|
||||||
|
PUT_UINT32_BE(high, msglen, 0);
|
||||||
|
PUT_UINT32_BE(low, msglen, 4);
|
||||||
|
|
||||||
|
last = total[0] & 0x3F;
|
||||||
|
padn = (last < 56) ? (56 - last) : (120 - last);
|
||||||
|
|
||||||
|
add((uint8_t *)sha1_padding, padn);
|
||||||
|
add(msglen, 8);
|
||||||
|
|
||||||
|
PUT_UINT32_BE(state[0], hash, 0);
|
||||||
|
PUT_UINT32_BE(state[1], hash, 4);
|
||||||
|
PUT_UINT32_BE(state[2], hash, 8);
|
||||||
|
PUT_UINT32_BE(state[3], hash, 12);
|
||||||
|
PUT_UINT32_BE(state[4], hash, 16);
|
||||||
|
}
|
||||||
|
|
||||||
|
void SHA1Builder::getBytes(uint8_t *output) {
|
||||||
|
memcpy(output, hash, SHA1_HASH_SIZE);
|
||||||
|
}
|
||||||
|
|
||||||
|
#endif // ESP_IDF_VERSION_MAJOR < 5
|
||||||
39
lib/ESP Async WebServer/src/port/SHA1Builder.h
Normal file
39
lib/ESP Async WebServer/src/port/SHA1Builder.h
Normal file
@@ -0,0 +1,39 @@
|
|||||||
|
// Copyright 2024 Espressif Systems (Shanghai) PTE LTD
|
||||||
|
//
|
||||||
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
// you may not use this file except in compliance with the License.
|
||||||
|
// You may obtain a copy of the License at
|
||||||
|
//
|
||||||
|
// http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
//
|
||||||
|
// Unless required by applicable law or agreed to in writing, software
|
||||||
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
// See the License for the specific language governing permissions and
|
||||||
|
// limitations under the License.
|
||||||
|
|
||||||
|
#ifndef SHA1Builder_h
|
||||||
|
#define SHA1Builder_h
|
||||||
|
|
||||||
|
#include <Stream.h>
|
||||||
|
#include <WString.h>
|
||||||
|
|
||||||
|
#define SHA1_HASH_SIZE 20
|
||||||
|
|
||||||
|
class SHA1Builder {
|
||||||
|
private:
|
||||||
|
uint32_t total[2]; /* number of bytes processed */
|
||||||
|
uint32_t state[5]; /* intermediate digest state */
|
||||||
|
unsigned char buffer[64]; /* data block being processed */
|
||||||
|
uint8_t hash[SHA1_HASH_SIZE]; /* SHA-1 result */
|
||||||
|
|
||||||
|
void process(const uint8_t* data);
|
||||||
|
|
||||||
|
public:
|
||||||
|
void begin();
|
||||||
|
void add(const uint8_t* data, size_t len);
|
||||||
|
void calculate();
|
||||||
|
void getBytes(uint8_t* output);
|
||||||
|
};
|
||||||
|
|
||||||
|
#endif // SHA1Builder_h
|
||||||
@@ -1,29 +0,0 @@
|
|||||||
#!/bin/bash
|
|
||||||
|
|
||||||
echo "Installing ESP8266 Arduino Core ..."
|
|
||||||
script_init_path="$PWD"
|
|
||||||
mkdir -p "$ARDUINO_USR_PATH/hardware/esp8266com"
|
|
||||||
cd "$ARDUINO_USR_PATH/hardware/esp8266com"
|
|
||||||
|
|
||||||
echo "Installing Python Serial ..."
|
|
||||||
pip install pyserial > /dev/null
|
|
||||||
|
|
||||||
if [ "$OS_IS_WINDOWS" == "1" ]; then
|
|
||||||
echo "Installing Python Requests ..."
|
|
||||||
pip install requests > /dev/null
|
|
||||||
fi
|
|
||||||
|
|
||||||
echo "Cloning Core Repository ..."
|
|
||||||
git clone https://github.com/esp8266/Arduino.git esp8266 > /dev/null 2>&1
|
|
||||||
|
|
||||||
echo "Updating submodules ..."
|
|
||||||
cd esp8266
|
|
||||||
git submodule update --init --recursive > /dev/null 2>&1
|
|
||||||
|
|
||||||
echo "Installing Platform Tools ..."
|
|
||||||
cd tools
|
|
||||||
python get.py > /dev/null
|
|
||||||
cd $script_init_path
|
|
||||||
|
|
||||||
echo "ESP8266 Arduino has been installed in '$ARDUINO_USR_PATH/hardware/esp8266com'"
|
|
||||||
echo ""
|
|
||||||
@@ -1,220 +0,0 @@
|
|||||||
#!/bin/bash
|
|
||||||
|
|
||||||
#OSTYPE: 'linux-gnu', ARCH: 'x86_64' => linux64
|
|
||||||
#OSTYPE: 'msys', ARCH: 'x86_64' => win32
|
|
||||||
#OSTYPE: 'darwin18', ARCH: 'i386' => macos
|
|
||||||
|
|
||||||
OSBITS=`arch`
|
|
||||||
if [[ "$OSTYPE" == "linux"* ]]; then
|
|
||||||
export OS_IS_LINUX="1"
|
|
||||||
ARCHIVE_FORMAT="tar.xz"
|
|
||||||
if [[ "$OSBITS" == "i686" ]]; then
|
|
||||||
OS_NAME="linux32"
|
|
||||||
elif [[ "$OSBITS" == "x86_64" ]]; then
|
|
||||||
OS_NAME="linux64"
|
|
||||||
elif [[ "$OSBITS" == "armv7l" || "$OSBITS" == "aarch64" ]]; then
|
|
||||||
OS_NAME="linuxarm"
|
|
||||||
else
|
|
||||||
OS_NAME="$OSTYPE-$OSBITS"
|
|
||||||
echo "Unknown OS '$OS_NAME'"
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
elif [[ "$OSTYPE" == "darwin"* ]]; then
|
|
||||||
export OS_IS_MACOS="1"
|
|
||||||
ARCHIVE_FORMAT="zip"
|
|
||||||
OS_NAME="macosx"
|
|
||||||
elif [[ "$OSTYPE" == "cygwin" ]] || [[ "$OSTYPE" == "msys" ]] || [[ "$OSTYPE" == "win32" ]]; then
|
|
||||||
export OS_IS_WINDOWS="1"
|
|
||||||
ARCHIVE_FORMAT="zip"
|
|
||||||
OS_NAME="windows"
|
|
||||||
else
|
|
||||||
OS_NAME="$OSTYPE-$OSBITS"
|
|
||||||
echo "Unknown OS '$OS_NAME'"
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
export OS_NAME
|
|
||||||
|
|
||||||
ARDUINO_BUILD_DIR="$HOME/.arduino/build.tmp"
|
|
||||||
ARDUINO_CACHE_DIR="$HOME/.arduino/cache.tmp"
|
|
||||||
|
|
||||||
if [ "$OS_IS_MACOS" == "1" ]; then
|
|
||||||
export ARDUINO_IDE_PATH="/Applications/Arduino.app/Contents/Java"
|
|
||||||
export ARDUINO_USR_PATH="$HOME/Documents/Arduino"
|
|
||||||
elif [ "$OS_IS_WINDOWS" == "1" ]; then
|
|
||||||
export ARDUINO_IDE_PATH="$HOME/arduino_ide"
|
|
||||||
export ARDUINO_USR_PATH="$HOME/Documents/Arduino"
|
|
||||||
else
|
|
||||||
export ARDUINO_IDE_PATH="$HOME/arduino_ide"
|
|
||||||
export ARDUINO_USR_PATH="$HOME/Arduino"
|
|
||||||
fi
|
|
||||||
|
|
||||||
if [ ! -d "$ARDUINO_IDE_PATH" ]; then
|
|
||||||
echo "Installing Arduino IDE on $OS_NAME ..."
|
|
||||||
echo "Downloading 'arduino-nightly-$OS_NAME.$ARCHIVE_FORMAT' to 'arduino.$ARCHIVE_FORMAT' ..."
|
|
||||||
if [ "$OS_IS_LINUX" == "1" ]; then
|
|
||||||
wget -O "arduino.$ARCHIVE_FORMAT" "https://www.arduino.cc/download.php?f=/arduino-nightly-$OS_NAME.$ARCHIVE_FORMAT" > /dev/null 2>&1
|
|
||||||
echo "Extracting 'arduino.$ARCHIVE_FORMAT' ..."
|
|
||||||
tar xf "arduino.$ARCHIVE_FORMAT" > /dev/null
|
|
||||||
mv arduino-nightly "$ARDUINO_IDE_PATH"
|
|
||||||
else
|
|
||||||
curl -o "arduino.$ARCHIVE_FORMAT" -L "https://www.arduino.cc/download.php?f=/arduino-nightly-$OS_NAME.$ARCHIVE_FORMAT" > /dev/null 2>&1
|
|
||||||
echo "Extracting 'arduino.$ARCHIVE_FORMAT' ..."
|
|
||||||
unzip "arduino.$ARCHIVE_FORMAT" > /dev/null
|
|
||||||
if [ "$OS_IS_MACOS" == "1" ]; then
|
|
||||||
mv "Arduino.app" "/Applications/Arduino.app"
|
|
||||||
else
|
|
||||||
mv arduino-nightly "$ARDUINO_IDE_PATH"
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
rm -rf "arduino.$ARCHIVE_FORMAT"
|
|
||||||
|
|
||||||
mkdir -p "$ARDUINO_USR_PATH/libraries"
|
|
||||||
mkdir -p "$ARDUINO_USR_PATH/hardware"
|
|
||||||
|
|
||||||
echo "Arduino IDE Installed in '$ARDUINO_IDE_PATH'"
|
|
||||||
echo ""
|
|
||||||
fi
|
|
||||||
|
|
||||||
function build_sketch(){ # build_sketch <fqbn> <path-to-ino> [extra-options]
|
|
||||||
if [ "$#" -lt 2 ]; then
|
|
||||||
echo "ERROR: Illegal number of parameters"
|
|
||||||
echo "USAGE: build_sketch <fqbn> <path-to-ino> [extra-options]"
|
|
||||||
return 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
local fqbn="$1"
|
|
||||||
local sketch="$2"
|
|
||||||
local xtra_opts="$3"
|
|
||||||
local win_opts=""
|
|
||||||
if [ "$OS_IS_WINDOWS" == "1" ]; then
|
|
||||||
local ctags_version=`ls "$ARDUINO_IDE_PATH/tools-builder/ctags/"`
|
|
||||||
local preprocessor_version=`ls "$ARDUINO_IDE_PATH/tools-builder/arduino-preprocessor/"`
|
|
||||||
win_opts="-prefs=runtime.tools.ctags.path=$ARDUINO_IDE_PATH/tools-builder/ctags/$ctags_version -prefs=runtime.tools.arduino-preprocessor.path=$ARDUINO_IDE_PATH/tools-builder/arduino-preprocessor/$preprocessor_version"
|
|
||||||
fi
|
|
||||||
|
|
||||||
echo ""
|
|
||||||
echo "Compiling '"$(basename "$sketch")"' ..."
|
|
||||||
mkdir -p "$ARDUINO_BUILD_DIR"
|
|
||||||
mkdir -p "$ARDUINO_CACHE_DIR"
|
|
||||||
$ARDUINO_IDE_PATH/arduino-builder -compile -logger=human -core-api-version=10810 \
|
|
||||||
-fqbn=$fqbn \
|
|
||||||
-warnings="all" \
|
|
||||||
-tools "$ARDUINO_IDE_PATH/tools-builder" \
|
|
||||||
-tools "$ARDUINO_IDE_PATH/tools" \
|
|
||||||
-built-in-libraries "$ARDUINO_IDE_PATH/libraries" \
|
|
||||||
-hardware "$ARDUINO_IDE_PATH/hardware" \
|
|
||||||
-hardware "$ARDUINO_USR_PATH/hardware" \
|
|
||||||
-libraries "$ARDUINO_USR_PATH/libraries" \
|
|
||||||
-build-cache "$ARDUINO_CACHE_DIR" \
|
|
||||||
-build-path "$ARDUINO_BUILD_DIR" \
|
|
||||||
$win_opts $xtra_opts "$sketch"
|
|
||||||
}
|
|
||||||
|
|
||||||
function count_sketches() # count_sketches <examples-path>
|
|
||||||
{
|
|
||||||
local examples="$1"
|
|
||||||
rm -rf sketches.txt
|
|
||||||
if [ ! -d "$examples" ]; then
|
|
||||||
touch sketches.txt
|
|
||||||
return 0
|
|
||||||
fi
|
|
||||||
local sketches=$(find $examples -name *.ino)
|
|
||||||
local sketchnum=0
|
|
||||||
for sketch in $sketches; do
|
|
||||||
local sketchdir=$(dirname $sketch)
|
|
||||||
local sketchdirname=$(basename $sketchdir)
|
|
||||||
local sketchname=$(basename $sketch)
|
|
||||||
if [[ "${sketchdirname}.ino" != "$sketchname" ]]; then
|
|
||||||
continue
|
|
||||||
fi;
|
|
||||||
if [[ -f "$sketchdir/.test.skip" ]]; then
|
|
||||||
continue
|
|
||||||
fi
|
|
||||||
echo $sketch >> sketches.txt
|
|
||||||
sketchnum=$(($sketchnum + 1))
|
|
||||||
done
|
|
||||||
return $sketchnum
|
|
||||||
}
|
|
||||||
|
|
||||||
function build_sketches() # build_sketches <fqbn> <examples-path> <chunk> <total-chunks> [extra-options]
|
|
||||||
{
|
|
||||||
local fqbn=$1
|
|
||||||
local examples=$2
|
|
||||||
local chunk_idex=$3
|
|
||||||
local chunks_num=$4
|
|
||||||
local xtra_opts=$5
|
|
||||||
|
|
||||||
if [ "$#" -lt 2 ]; then
|
|
||||||
echo "ERROR: Illegal number of parameters"
|
|
||||||
echo "USAGE: build_sketches <fqbn> <examples-path> [<chunk> <total-chunks>] [extra-options]"
|
|
||||||
return 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
if [ "$#" -lt 4 ]; then
|
|
||||||
chunk_idex="0"
|
|
||||||
chunks_num="1"
|
|
||||||
xtra_opts=$3
|
|
||||||
fi
|
|
||||||
|
|
||||||
if [ "$chunks_num" -le 0 ]; then
|
|
||||||
echo "ERROR: Chunks count must be positive number"
|
|
||||||
return 1
|
|
||||||
fi
|
|
||||||
if [ "$chunk_idex" -ge "$chunks_num" ]; then
|
|
||||||
echo "ERROR: Chunk index must be less than chunks count"
|
|
||||||
return 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
set +e
|
|
||||||
count_sketches "$examples"
|
|
||||||
local sketchcount=$?
|
|
||||||
set -e
|
|
||||||
local sketches=$(cat sketches.txt)
|
|
||||||
rm -rf sketches.txt
|
|
||||||
|
|
||||||
local chunk_size=$(( $sketchcount / $chunks_num ))
|
|
||||||
local all_chunks=$(( $chunks_num * $chunk_size ))
|
|
||||||
if [ "$all_chunks" -lt "$sketchcount" ]; then
|
|
||||||
chunk_size=$(( $chunk_size + 1 ))
|
|
||||||
fi
|
|
||||||
|
|
||||||
local start_index=$(( $chunk_idex * $chunk_size ))
|
|
||||||
if [ "$sketchcount" -le "$start_index" ]; then
|
|
||||||
echo "Skipping job"
|
|
||||||
return 0
|
|
||||||
fi
|
|
||||||
|
|
||||||
local end_index=$(( $(( $chunk_idex + 1 )) * $chunk_size ))
|
|
||||||
if [ "$end_index" -gt "$sketchcount" ]; then
|
|
||||||
end_index=$sketchcount
|
|
||||||
fi
|
|
||||||
|
|
||||||
local start_num=$(( $start_index + 1 ))
|
|
||||||
echo "Found $sketchcount Sketches";
|
|
||||||
echo "Chunk Count : $chunks_num"
|
|
||||||
echo "Chunk Size : $chunk_size"
|
|
||||||
echo "Start Sketch: $start_num"
|
|
||||||
echo "End Sketch : $end_index"
|
|
||||||
|
|
||||||
local sketchnum=0
|
|
||||||
for sketch in $sketches; do
|
|
||||||
local sketchdir=$(dirname $sketch)
|
|
||||||
local sketchdirname=$(basename $sketchdir)
|
|
||||||
local sketchname=$(basename $sketch)
|
|
||||||
if [ "${sketchdirname}.ino" != "$sketchname" ] \
|
|
||||||
|| [ -f "$sketchdir/.test.skip" ]; then
|
|
||||||
continue
|
|
||||||
fi
|
|
||||||
sketchnum=$(($sketchnum + 1))
|
|
||||||
if [ "$sketchnum" -le "$start_index" ] \
|
|
||||||
|| [ "$sketchnum" -gt "$end_index" ]; then
|
|
||||||
continue
|
|
||||||
fi
|
|
||||||
build_sketch "$fqbn" "$sketch" "$xtra_opts"
|
|
||||||
local result=$?
|
|
||||||
if [ $result -ne 0 ]; then
|
|
||||||
return $result
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
return 0
|
|
||||||
}
|
|
||||||
@@ -1,133 +0,0 @@
|
|||||||
#!/bin/bash
|
|
||||||
|
|
||||||
echo "Installing Python Wheel ..."
|
|
||||||
pip install wheel > /dev/null 2>&1
|
|
||||||
|
|
||||||
echo "Installing PlatformIO ..."
|
|
||||||
pip install -U platformio > /dev/null 2>&1
|
|
||||||
|
|
||||||
echo "PlatformIO has been installed"
|
|
||||||
echo ""
|
|
||||||
|
|
||||||
|
|
||||||
function build_pio_sketch(){ # build_pio_sketch <board> <path-to-ino>
|
|
||||||
if [ "$#" -lt 2 ]; then
|
|
||||||
echo "ERROR: Illegal number of parameters"
|
|
||||||
echo "USAGE: build_pio_sketch <board> <path-to-ino>"
|
|
||||||
return 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
local board="$1"
|
|
||||||
local sketch="$2"
|
|
||||||
local sketch_dir=$(dirname "$sketch")
|
|
||||||
echo ""
|
|
||||||
echo "Compiling '"$(basename "$sketch")"' ..."
|
|
||||||
python -m platformio ci -l '.' --board "$board" "$sketch_dir" --project-option="board_build.partitions = huge_app.csv"
|
|
||||||
}
|
|
||||||
|
|
||||||
function count_sketches() # count_sketches <examples-path>
|
|
||||||
{
|
|
||||||
local examples="$1"
|
|
||||||
rm -rf sketches.txt
|
|
||||||
if [ ! -d "$examples" ]; then
|
|
||||||
touch sketches.txt
|
|
||||||
return 0
|
|
||||||
fi
|
|
||||||
local sketches=$(find $examples -name *.ino)
|
|
||||||
local sketchnum=0
|
|
||||||
for sketch in $sketches; do
|
|
||||||
local sketchdir=$(dirname $sketch)
|
|
||||||
local sketchdirname=$(basename $sketchdir)
|
|
||||||
local sketchname=$(basename $sketch)
|
|
||||||
if [[ "${sketchdirname}.ino" != "$sketchname" ]]; then
|
|
||||||
continue
|
|
||||||
fi;
|
|
||||||
if [[ -f "$sketchdir/.test.skip" ]]; then
|
|
||||||
continue
|
|
||||||
fi
|
|
||||||
echo $sketch >> sketches.txt
|
|
||||||
sketchnum=$(($sketchnum + 1))
|
|
||||||
done
|
|
||||||
return $sketchnum
|
|
||||||
}
|
|
||||||
|
|
||||||
function build_pio_sketches() # build_pio_sketches <board> <examples-path> <chunk> <total-chunks>
|
|
||||||
{
|
|
||||||
if [ "$#" -lt 2 ]; then
|
|
||||||
echo "ERROR: Illegal number of parameters"
|
|
||||||
echo "USAGE: build_pio_sketches <board> <examples-path> [<chunk> <total-chunks>]"
|
|
||||||
return 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
local board=$1
|
|
||||||
local examples=$2
|
|
||||||
local chunk_idex=$3
|
|
||||||
local chunks_num=$4
|
|
||||||
|
|
||||||
if [ "$#" -lt 4 ]; then
|
|
||||||
chunk_idex="0"
|
|
||||||
chunks_num="1"
|
|
||||||
fi
|
|
||||||
|
|
||||||
if [ "$chunks_num" -le 0 ]; then
|
|
||||||
echo "ERROR: Chunks count must be positive number"
|
|
||||||
return 1
|
|
||||||
fi
|
|
||||||
if [ "$chunk_idex" -ge "$chunks_num" ]; then
|
|
||||||
echo "ERROR: Chunk index must be less than chunks count"
|
|
||||||
return 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
set +e
|
|
||||||
count_sketches "$examples"
|
|
||||||
local sketchcount=$?
|
|
||||||
set -e
|
|
||||||
local sketches=$(cat sketches.txt)
|
|
||||||
rm -rf sketches.txt
|
|
||||||
|
|
||||||
local chunk_size=$(( $sketchcount / $chunks_num ))
|
|
||||||
local all_chunks=$(( $chunks_num * $chunk_size ))
|
|
||||||
if [ "$all_chunks" -lt "$sketchcount" ]; then
|
|
||||||
chunk_size=$(( $chunk_size + 1 ))
|
|
||||||
fi
|
|
||||||
|
|
||||||
local start_index=$(( $chunk_idex * $chunk_size ))
|
|
||||||
if [ "$sketchcount" -le "$start_index" ]; then
|
|
||||||
echo "Skipping job"
|
|
||||||
return 0
|
|
||||||
fi
|
|
||||||
|
|
||||||
local end_index=$(( $(( $chunk_idex + 1 )) * $chunk_size ))
|
|
||||||
if [ "$end_index" -gt "$sketchcount" ]; then
|
|
||||||
end_index=$sketchcount
|
|
||||||
fi
|
|
||||||
|
|
||||||
local start_num=$(( $start_index + 1 ))
|
|
||||||
echo "Found $sketchcount Sketches";
|
|
||||||
echo "Chunk Count : $chunks_num"
|
|
||||||
echo "Chunk Size : $chunk_size"
|
|
||||||
echo "Start Sketch: $start_num"
|
|
||||||
echo "End Sketch : $end_index"
|
|
||||||
|
|
||||||
local sketchnum=0
|
|
||||||
for sketch in $sketches; do
|
|
||||||
local sketchdir=$(dirname $sketch)
|
|
||||||
local sketchdirname=$(basename $sketchdir)
|
|
||||||
local sketchname=$(basename $sketch)
|
|
||||||
if [ "${sketchdirname}.ino" != "$sketchname" ] \
|
|
||||||
|| [ -f "$sketchdir/.test.skip" ]; then
|
|
||||||
continue
|
|
||||||
fi
|
|
||||||
sketchnum=$(($sketchnum + 1))
|
|
||||||
if [ "$sketchnum" -le "$start_index" ] \
|
|
||||||
|| [ "$sketchnum" -gt "$end_index" ]; then
|
|
||||||
continue
|
|
||||||
fi
|
|
||||||
build_pio_sketch "$board" "$sketch"
|
|
||||||
local result=$?
|
|
||||||
if [ $result -ne 0 ]; then
|
|
||||||
return $result
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
return 0
|
|
||||||
}
|
|
||||||
@@ -1,64 +0,0 @@
|
|||||||
#!/bin/bash
|
|
||||||
|
|
||||||
set -e
|
|
||||||
|
|
||||||
if [ ! -z "$TRAVIS_BUILD_DIR" ]; then
|
|
||||||
export GITHUB_WORKSPACE="$TRAVIS_BUILD_DIR"
|
|
||||||
export GITHUB_REPOSITORY="$TRAVIS_REPO_SLUG"
|
|
||||||
elif [ -z "$GITHUB_WORKSPACE" ]; then
|
|
||||||
export GITHUB_WORKSPACE="$PWD"
|
|
||||||
export GITHUB_REPOSITORY="me-no-dev/ESPAsyncTCP"
|
|
||||||
fi
|
|
||||||
|
|
||||||
CHUNK_INDEX=$1
|
|
||||||
CHUNKS_CNT=$2
|
|
||||||
BUILD_PIO=0
|
|
||||||
if [ "$#" -lt 2 ] || [ "$CHUNKS_CNT" -le 0 ]; then
|
|
||||||
CHUNK_INDEX=0
|
|
||||||
CHUNKS_CNT=1
|
|
||||||
elif [ "$CHUNK_INDEX" -gt "$CHUNKS_CNT" ]; then
|
|
||||||
CHUNK_INDEX=$CHUNKS_CNT
|
|
||||||
elif [ "$CHUNK_INDEX" -eq "$CHUNKS_CNT" ]; then
|
|
||||||
BUILD_PIO=1
|
|
||||||
fi
|
|
||||||
|
|
||||||
if [ "$BUILD_PIO" -eq 0 ]; then
|
|
||||||
# ArduinoIDE Test
|
|
||||||
source ./.github/scripts/install-arduino-ide.sh
|
|
||||||
source ./.github/scripts/install-arduino-core-esp8266.sh
|
|
||||||
|
|
||||||
echo "Installing ESPAsyncTCP ..."
|
|
||||||
cp -rf "$GITHUB_WORKSPACE" "$ARDUINO_USR_PATH/libraries/ESPAsyncTCP"
|
|
||||||
|
|
||||||
FQBN="esp8266com:esp8266:generic:eesz=4M1M,ip=lm2f"
|
|
||||||
build_sketches "$FQBN" "$GITHUB_WORKSPACE/examples"
|
|
||||||
if [ ! "$OS_IS_WINDOWS" == "1" ]; then
|
|
||||||
echo "Installing ESPAsyncWebServer ..."
|
|
||||||
git clone https://github.com/me-no-dev/ESPAsyncWebServer "$ARDUINO_USR_PATH/libraries/ESPAsyncWebServer" > /dev/null 2>&1
|
|
||||||
|
|
||||||
echo "Installing ArduinoJson ..."
|
|
||||||
git clone https://github.com/bblanchon/ArduinoJson "$ARDUINO_USR_PATH/libraries/ArduinoJson" > /dev/null 2>&1
|
|
||||||
|
|
||||||
build_sketches "$FQBN" "$ARDUINO_USR_PATH/libraries/ESPAsyncWebServer/examples"
|
|
||||||
fi
|
|
||||||
else
|
|
||||||
# PlatformIO Test
|
|
||||||
source ./.github/scripts/install-platformio.sh
|
|
||||||
|
|
||||||
echo "Installing ESPAsyncTCP ..."
|
|
||||||
python -m platformio lib --storage-dir "$GITHUB_WORKSPACE" install
|
|
||||||
|
|
||||||
BOARD="esp12e"
|
|
||||||
build_pio_sketches "$BOARD" "$GITHUB_WORKSPACE/examples"
|
|
||||||
|
|
||||||
if [[ "$OSTYPE" != "cygwin" ]] && [[ "$OSTYPE" != "msys" ]] && [[ "$OSTYPE" != "win32" ]]; then
|
|
||||||
echo "Installing ESPAsyncWebServer ..."
|
|
||||||
python -m platformio lib -g install https://github.com/me-no-dev/ESPAsyncWebServer.git > /dev/null 2>&1
|
|
||||||
git clone https://github.com/me-no-dev/ESPAsyncWebServer "$HOME/ESPAsyncWebServer" > /dev/null 2>&1
|
|
||||||
|
|
||||||
echo "Installing ArduinoJson ..."
|
|
||||||
python -m platformio lib -g install https://github.com/bblanchon/ArduinoJson.git > /dev/null 2>&1
|
|
||||||
|
|
||||||
build_pio_sketches "$BOARD" "$HOME/ESPAsyncWebServer/examples"
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
31
lib/ESPAsyncTCP-esphome/.github/stale.yml
vendored
31
lib/ESPAsyncTCP-esphome/.github/stale.yml
vendored
@@ -1,31 +0,0 @@
|
|||||||
# Configuration for probot-stale - https://github.com/probot/stale
|
|
||||||
|
|
||||||
daysUntilStale: 60
|
|
||||||
daysUntilClose: 14
|
|
||||||
limitPerRun: 30
|
|
||||||
staleLabel: stale
|
|
||||||
exemptLabels:
|
|
||||||
- pinned
|
|
||||||
- security
|
|
||||||
- "to be implemented"
|
|
||||||
- "for reference"
|
|
||||||
- "move to PR"
|
|
||||||
- "enhancement"
|
|
||||||
|
|
||||||
only: issues
|
|
||||||
onlyLabels: []
|
|
||||||
exemptProjects: false
|
|
||||||
exemptMilestones: false
|
|
||||||
exemptAssignees: false
|
|
||||||
|
|
||||||
markComment: >
|
|
||||||
[STALE_SET] This issue has been automatically marked as stale because it has not had
|
|
||||||
recent activity. It will be closed in 14 days if no further activity occurs. Thank you
|
|
||||||
for your contributions.
|
|
||||||
|
|
||||||
unmarkComment: >
|
|
||||||
[STALE_CLR] This issue has been removed from the stale queue. Please ensure activity to keep it openin the future.
|
|
||||||
|
|
||||||
closeComment: >
|
|
||||||
[STALE_DEL] This stale issue has been automatically closed. Thank you for your contributions.
|
|
||||||
|
|
||||||
@@ -1,32 +0,0 @@
|
|||||||
name: ESP Async TCP CI
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
- master
|
|
||||||
- release/*
|
|
||||||
pull_request:
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
|
|
||||||
build-pio:
|
|
||||||
name: PlatformIO on ${{ matrix.os }}
|
|
||||||
runs-on: ${{ matrix.os }}
|
|
||||||
strategy:
|
|
||||||
matrix:
|
|
||||||
os: [ubuntu-latest, windows-latest, macOS-latest]
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v3
|
|
||||||
- uses: actions/cache@v3
|
|
||||||
with:
|
|
||||||
path: |
|
|
||||||
~/.cache/pip
|
|
||||||
~/.platformio/.cache
|
|
||||||
key: ${{ runner.os }}-pio
|
|
||||||
- uses: actions/setup-python@v4
|
|
||||||
with:
|
|
||||||
python-version: '3.11'
|
|
||||||
- name: Install PlatformIO Core
|
|
||||||
run: pip install --upgrade platformio
|
|
||||||
- name: Build Tests
|
|
||||||
run: bash ./.github/scripts/on-push.sh 1 1
|
|
||||||
2
lib/ESPAsyncTCP-esphome/.gitignore
vendored
2
lib/ESPAsyncTCP-esphome/.gitignore
vendored
@@ -1,2 +0,0 @@
|
|||||||
|
|
||||||
.DS_Store
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
{"type": "library", "name": "ESPAsyncTCP-esphome", "version": "2.0.0", "spec": {"owner": "esphome", "id": 15476, "name": "ESPAsyncTCP-esphome", "requirements": null, "uri": null}}
|
|
||||||
@@ -1,165 +0,0 @@
|
|||||||
GNU LESSER GENERAL PUBLIC LICENSE
|
|
||||||
Version 3, 29 June 2007
|
|
||||||
|
|
||||||
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
|
|
||||||
Everyone is permitted to copy and distribute verbatim copies
|
|
||||||
of this license document, but changing it is not allowed.
|
|
||||||
|
|
||||||
|
|
||||||
This version of the GNU Lesser General Public License incorporates
|
|
||||||
the terms and conditions of version 3 of the GNU General Public
|
|
||||||
License, supplemented by the additional permissions listed below.
|
|
||||||
|
|
||||||
0. Additional Definitions.
|
|
||||||
|
|
||||||
As used herein, "this License" refers to version 3 of the GNU Lesser
|
|
||||||
General Public License, and the "GNU GPL" refers to version 3 of the GNU
|
|
||||||
General Public License.
|
|
||||||
|
|
||||||
"The Library" refers to a covered work governed by this License,
|
|
||||||
other than an Application or a Combined Work as defined below.
|
|
||||||
|
|
||||||
An "Application" is any work that makes use of an interface provided
|
|
||||||
by the Library, but which is not otherwise based on the Library.
|
|
||||||
Defining a subclass of a class defined by the Library is deemed a mode
|
|
||||||
of using an interface provided by the Library.
|
|
||||||
|
|
||||||
A "Combined Work" is a work produced by combining or linking an
|
|
||||||
Application with the Library. The particular version of the Library
|
|
||||||
with which the Combined Work was made is also called the "Linked
|
|
||||||
Version".
|
|
||||||
|
|
||||||
The "Minimal Corresponding Source" for a Combined Work means the
|
|
||||||
Corresponding Source for the Combined Work, excluding any source code
|
|
||||||
for portions of the Combined Work that, considered in isolation, are
|
|
||||||
based on the Application, and not on the Linked Version.
|
|
||||||
|
|
||||||
The "Corresponding Application Code" for a Combined Work means the
|
|
||||||
object code and/or source code for the Application, including any data
|
|
||||||
and utility programs needed for reproducing the Combined Work from the
|
|
||||||
Application, but excluding the System Libraries of the Combined Work.
|
|
||||||
|
|
||||||
1. Exception to Section 3 of the GNU GPL.
|
|
||||||
|
|
||||||
You may convey a covered work under sections 3 and 4 of this License
|
|
||||||
without being bound by section 3 of the GNU GPL.
|
|
||||||
|
|
||||||
2. Conveying Modified Versions.
|
|
||||||
|
|
||||||
If you modify a copy of the Library, and, in your modifications, a
|
|
||||||
facility refers to a function or data to be supplied by an Application
|
|
||||||
that uses the facility (other than as an argument passed when the
|
|
||||||
facility is invoked), then you may convey a copy of the modified
|
|
||||||
version:
|
|
||||||
|
|
||||||
a) under this License, provided that you make a good faith effort to
|
|
||||||
ensure that, in the event an Application does not supply the
|
|
||||||
function or data, the facility still operates, and performs
|
|
||||||
whatever part of its purpose remains meaningful, or
|
|
||||||
|
|
||||||
b) under the GNU GPL, with none of the additional permissions of
|
|
||||||
this License applicable to that copy.
|
|
||||||
|
|
||||||
3. Object Code Incorporating Material from Library Header Files.
|
|
||||||
|
|
||||||
The object code form of an Application may incorporate material from
|
|
||||||
a header file that is part of the Library. You may convey such object
|
|
||||||
code under terms of your choice, provided that, if the incorporated
|
|
||||||
material is not limited to numerical parameters, data structure
|
|
||||||
layouts and accessors, or small macros, inline functions and templates
|
|
||||||
(ten or fewer lines in length), you do both of the following:
|
|
||||||
|
|
||||||
a) Give prominent notice with each copy of the object code that the
|
|
||||||
Library is used in it and that the Library and its use are
|
|
||||||
covered by this License.
|
|
||||||
|
|
||||||
b) Accompany the object code with a copy of the GNU GPL and this license
|
|
||||||
document.
|
|
||||||
|
|
||||||
4. Combined Works.
|
|
||||||
|
|
||||||
You may convey a Combined Work under terms of your choice that,
|
|
||||||
taken together, effectively do not restrict modification of the
|
|
||||||
portions of the Library contained in the Combined Work and reverse
|
|
||||||
engineering for debugging such modifications, if you also do each of
|
|
||||||
the following:
|
|
||||||
|
|
||||||
a) Give prominent notice with each copy of the Combined Work that
|
|
||||||
the Library is used in it and that the Library and its use are
|
|
||||||
covered by this License.
|
|
||||||
|
|
||||||
b) Accompany the Combined Work with a copy of the GNU GPL and this license
|
|
||||||
document.
|
|
||||||
|
|
||||||
c) For a Combined Work that displays copyright notices during
|
|
||||||
execution, include the copyright notice for the Library among
|
|
||||||
these notices, as well as a reference directing the user to the
|
|
||||||
copies of the GNU GPL and this license document.
|
|
||||||
|
|
||||||
d) Do one of the following:
|
|
||||||
|
|
||||||
0) Convey the Minimal Corresponding Source under the terms of this
|
|
||||||
License, and the Corresponding Application Code in a form
|
|
||||||
suitable for, and under terms that permit, the user to
|
|
||||||
recombine or relink the Application with a modified version of
|
|
||||||
the Linked Version to produce a modified Combined Work, in the
|
|
||||||
manner specified by section 6 of the GNU GPL for conveying
|
|
||||||
Corresponding Source.
|
|
||||||
|
|
||||||
1) Use a suitable shared library mechanism for linking with the
|
|
||||||
Library. A suitable mechanism is one that (a) uses at run time
|
|
||||||
a copy of the Library already present on the user's computer
|
|
||||||
system, and (b) will operate properly with a modified version
|
|
||||||
of the Library that is interface-compatible with the Linked
|
|
||||||
Version.
|
|
||||||
|
|
||||||
e) Provide Installation Information, but only if you would otherwise
|
|
||||||
be required to provide such information under section 6 of the
|
|
||||||
GNU GPL, and only to the extent that such information is
|
|
||||||
necessary to install and execute a modified version of the
|
|
||||||
Combined Work produced by recombining or relinking the
|
|
||||||
Application with a modified version of the Linked Version. (If
|
|
||||||
you use option 4d0, the Installation Information must accompany
|
|
||||||
the Minimal Corresponding Source and Corresponding Application
|
|
||||||
Code. If you use option 4d1, you must provide the Installation
|
|
||||||
Information in the manner specified by section 6 of the GNU GPL
|
|
||||||
for conveying Corresponding Source.)
|
|
||||||
|
|
||||||
5. Combined Libraries.
|
|
||||||
|
|
||||||
You may place library facilities that are a work based on the
|
|
||||||
Library side by side in a single library together with other library
|
|
||||||
facilities that are not Applications and are not covered by this
|
|
||||||
License, and convey such a combined library under terms of your
|
|
||||||
choice, if you do both of the following:
|
|
||||||
|
|
||||||
a) Accompany the combined library with a copy of the same work based
|
|
||||||
on the Library, uncombined with any other library facilities,
|
|
||||||
conveyed under the terms of this License.
|
|
||||||
|
|
||||||
b) Give prominent notice with the combined library that part of it
|
|
||||||
is a work based on the Library, and explaining where to find the
|
|
||||||
accompanying uncombined form of the same work.
|
|
||||||
|
|
||||||
6. Revised Versions of the GNU Lesser General Public License.
|
|
||||||
|
|
||||||
The Free Software Foundation may publish revised and/or new versions
|
|
||||||
of the GNU Lesser General Public License from time to time. Such new
|
|
||||||
versions will be similar in spirit to the present version, but may
|
|
||||||
differ in detail to address new problems or concerns.
|
|
||||||
|
|
||||||
Each version is given a distinguishing version number. If the
|
|
||||||
Library as you received it specifies that a certain numbered version
|
|
||||||
of the GNU Lesser General Public License "or any later version"
|
|
||||||
applies to it, you have the option of following the terms and
|
|
||||||
conditions either of that published version or of any later version
|
|
||||||
published by the Free Software Foundation. If the Library as you
|
|
||||||
received it does not specify a version number of the GNU Lesser
|
|
||||||
General Public License, you may choose any version of the GNU Lesser
|
|
||||||
General Public License ever published by the Free Software Foundation.
|
|
||||||
|
|
||||||
If the Library as you received it specifies that a proxy can decide
|
|
||||||
whether future versions of the GNU Lesser General Public License shall
|
|
||||||
apply, that proxy's public statement of acceptance of any version is
|
|
||||||
permanent authorization for you to choose that version for the
|
|
||||||
Library.
|
|
||||||
@@ -1,33 +0,0 @@
|
|||||||
# ESPAsyncTCP
|
|
||||||
|
|
||||||
A fork of the [AsyncTCP](https://github.com/me-no-dev/AsyncTCP) library by [@me-no-dev](https://github.com/me-no-dev) for [ESPHome](https://esphome.io).
|
|
||||||
|
|
||||||
### Async TCP Library for ESP8266 Arduino
|
|
||||||
|
|
||||||
For ESP32 look [HERE](https://github.com/me-no-dev/AsyncTCP)
|
|
||||||
|
|
||||||
[](https://gitter.im/me-no-dev/ESPAsyncWebServer?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
|
||||||
|
|
||||||
This is a fully asynchronous TCP library, aimed at enabling trouble-free, multi-connection network environment for Espressif's ESP8266 MCUs.
|
|
||||||
|
|
||||||
This library is the base for [ESPAsyncWebServer](https://github.com/me-no-dev/ESPAsyncWebServer)
|
|
||||||
|
|
||||||
## AsyncClient and AsyncServer
|
|
||||||
The base classes on which everything else is built. They expose all possible scenarios, but are really raw and require more skills to use.
|
|
||||||
|
|
||||||
## AsyncPrinter
|
|
||||||
This class can be used to send data like any other ```Print``` interface (```Serial``` for example).
|
|
||||||
The object then can be used outside of the Async callbacks (the loop) and receive asynchronously data using ```onData```. The object can be checked if the underlying ```AsyncClient```is connected, or hook to the ```onDisconnect``` callback.
|
|
||||||
|
|
||||||
## AsyncTCPbuffer
|
|
||||||
This class is really similar to the ```AsyncPrinter```, but it differs in the fact that it can buffer some of the incoming data.
|
|
||||||
|
|
||||||
## SyncClient
|
|
||||||
It is exactly what it sounds like. This is a standard, blocking TCP Client, similar to the one included in ```ESP8266WiFi```
|
|
||||||
|
|
||||||
## Libraries and projects that use AsyncTCP
|
|
||||||
- [ESP Async Web Server](https://github.com/me-no-dev/ESPAsyncWebServer)
|
|
||||||
- [Async MQTT client](https://github.com/marvinroger/async-mqtt-client)
|
|
||||||
- [arduinoWebSockets](https://github.com/Links2004/arduinoWebSockets)
|
|
||||||
- [ESP8266 Smart Home](https://github.com/baruch/esp8266_smart_home)
|
|
||||||
- [KBox Firmware](https://github.com/sarfata/kbox-firmware)
|
|
||||||
@@ -1,62 +0,0 @@
|
|||||||
#include <ESP8266WiFi.h>
|
|
||||||
#include <ESPAsyncTCP.h>
|
|
||||||
|
|
||||||
extern "C" {
|
|
||||||
#include <osapi.h>
|
|
||||||
#include <os_type.h>
|
|
||||||
}
|
|
||||||
|
|
||||||
#include "config.h"
|
|
||||||
|
|
||||||
static os_timer_t intervalTimer;
|
|
||||||
|
|
||||||
static void replyToServer(void* arg) {
|
|
||||||
AsyncClient* client = reinterpret_cast<AsyncClient*>(arg);
|
|
||||||
|
|
||||||
// send reply
|
|
||||||
if (client->space() > 32 && client->canSend()) {
|
|
||||||
char message[32];
|
|
||||||
sprintf(message, "this is from %s", WiFi.localIP().toString().c_str());
|
|
||||||
client->add(message, strlen(message));
|
|
||||||
client->send();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/* event callbacks */
|
|
||||||
static void handleData(void* arg, AsyncClient* client, void *data, size_t len) {
|
|
||||||
Serial.printf("\n data received from %s \n", client->remoteIP().toString().c_str());
|
|
||||||
Serial.write((uint8_t*)data, len);
|
|
||||||
|
|
||||||
os_timer_arm(&intervalTimer, 2000, true); // schedule for reply to server at next 2s
|
|
||||||
}
|
|
||||||
|
|
||||||
void onConnect(void* arg, AsyncClient* client) {
|
|
||||||
Serial.printf("\n client has been connected to %s on port %d \n", SERVER_HOST_NAME, TCP_PORT);
|
|
||||||
replyToServer(client);
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
void setup() {
|
|
||||||
Serial.begin(115200);
|
|
||||||
delay(20);
|
|
||||||
|
|
||||||
// connects to access point
|
|
||||||
WiFi.mode(WIFI_STA);
|
|
||||||
WiFi.begin(SSID, PASSWORD);
|
|
||||||
while (WiFi.status() != WL_CONNECTED) {
|
|
||||||
Serial.print('.');
|
|
||||||
delay(500);
|
|
||||||
}
|
|
||||||
|
|
||||||
AsyncClient* client = new AsyncClient;
|
|
||||||
client->onData(&handleData, client);
|
|
||||||
client->onConnect(&onConnect, client);
|
|
||||||
client->connect(SERVER_HOST_NAME, TCP_PORT);
|
|
||||||
|
|
||||||
os_timer_disarm(&intervalTimer);
|
|
||||||
os_timer_setfn(&intervalTimer, &replyToServer, client);
|
|
||||||
}
|
|
||||||
|
|
||||||
void loop() {
|
|
||||||
|
|
||||||
}
|
|
||||||
@@ -1,23 +0,0 @@
|
|||||||
#ifndef CONFIG_H
|
|
||||||
#define CONFIG_H
|
|
||||||
|
|
||||||
/*
|
|
||||||
* This example demonstrate how to use asynchronous client & server APIs
|
|
||||||
* in order to establish tcp socket connections in client server manner.
|
|
||||||
* server is running (on port 7050) on one ESP, acts as AP, and other clients running on
|
|
||||||
* remaining ESPs acts as STAs. after connection establishment between server and clients
|
|
||||||
* there is a simple message transfer in every 2s. clients connect to server via it's host name
|
|
||||||
* (in this case 'esp_server') with help of DNS service running on server side.
|
|
||||||
*
|
|
||||||
* Note: default MSS for ESPAsyncTCP is 536 byte and defualt ACK timeout is 5s.
|
|
||||||
*/
|
|
||||||
|
|
||||||
#define SSID "ESP-TEST"
|
|
||||||
#define PASSWORD "123456789"
|
|
||||||
|
|
||||||
#define SERVER_HOST_NAME "esp_server"
|
|
||||||
|
|
||||||
#define TCP_PORT 7050
|
|
||||||
#define DNS_PORT 53
|
|
||||||
|
|
||||||
#endif // CONFIG_H
|
|
||||||
@@ -1,73 +0,0 @@
|
|||||||
#include <ESP8266WiFi.h>
|
|
||||||
#include <ESPAsyncTCP.h>
|
|
||||||
#include <DNSServer.h>
|
|
||||||
#include <vector>
|
|
||||||
|
|
||||||
#include "config.h"
|
|
||||||
|
|
||||||
static DNSServer DNS;
|
|
||||||
|
|
||||||
static std::vector<AsyncClient*> clients; // a list to hold all clients
|
|
||||||
|
|
||||||
/* clients events */
|
|
||||||
static void handleError(void* arg, AsyncClient* client, int8_t error) {
|
|
||||||
Serial.printf("\n connection error %s from client %s \n", client->errorToString(error), client->remoteIP().toString().c_str());
|
|
||||||
}
|
|
||||||
|
|
||||||
static void handleData(void* arg, AsyncClient* client, void *data, size_t len) {
|
|
||||||
Serial.printf("\n data received from client %s \n", client->remoteIP().toString().c_str());
|
|
||||||
Serial.write((uint8_t*)data, len);
|
|
||||||
|
|
||||||
// reply to client
|
|
||||||
if (client->space() > 32 && client->canSend()) {
|
|
||||||
char reply[32];
|
|
||||||
sprintf(reply, "this is from %s", SERVER_HOST_NAME);
|
|
||||||
client->add(reply, strlen(reply));
|
|
||||||
client->send();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
static void handleDisconnect(void* arg, AsyncClient* client) {
|
|
||||||
Serial.printf("\n client %s disconnected \n", client->remoteIP().toString().c_str());
|
|
||||||
}
|
|
||||||
|
|
||||||
static void handleTimeOut(void* arg, AsyncClient* client, uint32_t time) {
|
|
||||||
Serial.printf("\n client ACK timeout ip: %s \n", client->remoteIP().toString().c_str());
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/* server events */
|
|
||||||
static void handleNewClient(void* arg, AsyncClient* client) {
|
|
||||||
Serial.printf("\n new client has been connected to server, ip: %s", client->remoteIP().toString().c_str());
|
|
||||||
|
|
||||||
// add to list
|
|
||||||
clients.push_back(client);
|
|
||||||
|
|
||||||
// register events
|
|
||||||
client->onData(&handleData, NULL);
|
|
||||||
client->onError(&handleError, NULL);
|
|
||||||
client->onDisconnect(&handleDisconnect, NULL);
|
|
||||||
client->onTimeout(&handleTimeOut, NULL);
|
|
||||||
}
|
|
||||||
|
|
||||||
void setup() {
|
|
||||||
Serial.begin(115200);
|
|
||||||
delay(20);
|
|
||||||
|
|
||||||
// create access point
|
|
||||||
while (!WiFi.softAP(SSID, PASSWORD, 6, false, 15)) {
|
|
||||||
delay(500);
|
|
||||||
}
|
|
||||||
|
|
||||||
// start dns server
|
|
||||||
if (!DNS.start(DNS_PORT, SERVER_HOST_NAME, WiFi.softAPIP()))
|
|
||||||
Serial.printf("\n failed to start dns service \n");
|
|
||||||
|
|
||||||
AsyncServer* server = new AsyncServer(TCP_PORT); // start listening on tcp port 7050
|
|
||||||
server->onClient(&handleNewClient, server);
|
|
||||||
server->begin();
|
|
||||||
}
|
|
||||||
|
|
||||||
void loop() {
|
|
||||||
DNS.processNextRequest();
|
|
||||||
}
|
|
||||||
@@ -1,23 +0,0 @@
|
|||||||
#ifndef CONFIG_H
|
|
||||||
#define CONFIG_H
|
|
||||||
|
|
||||||
/*
|
|
||||||
* This example demonstrate how to use asynchronous client & server APIs
|
|
||||||
* in order to establish tcp socket connections in client server manner.
|
|
||||||
* server is running (on port 7050) on one ESP, acts as AP, and other clients running on
|
|
||||||
* remaining ESPs acts as STAs. after connection establishment between server and clients
|
|
||||||
* there is a simple message transfer in every 2s. clients connect to server via it's host name
|
|
||||||
* (in this case 'esp_server') with help of DNS service running on server side.
|
|
||||||
*
|
|
||||||
* Note: default MSS for ESPAsyncTCP is 536 byte and defualt ACK timeout is 5s.
|
|
||||||
*/
|
|
||||||
|
|
||||||
#define SSID "ESP-TEST"
|
|
||||||
#define PASSWORD "123456789"
|
|
||||||
|
|
||||||
#define SERVER_HOST_NAME "esp_server"
|
|
||||||
|
|
||||||
#define TCP_PORT 7050
|
|
||||||
#define DNS_PORT 53
|
|
||||||
|
|
||||||
#endif // CONFIG_H
|
|
||||||
@@ -1,54 +0,0 @@
|
|||||||
#ifdef ESP8266
|
|
||||||
#include <ESP8266WiFi.h>
|
|
||||||
#include <ESP8266mDNS.h>
|
|
||||||
#include <ArduinoOTA.h>
|
|
||||||
#else
|
|
||||||
#include <ESP31BWiFi.h>
|
|
||||||
#endif
|
|
||||||
#include "ESPAsyncTCP.h"
|
|
||||||
#include "SyncClient.h"
|
|
||||||
|
|
||||||
const char* ssid = "**********";
|
|
||||||
const char* password = "************";
|
|
||||||
|
|
||||||
void setup(){
|
|
||||||
Serial.begin(115200);
|
|
||||||
WiFi.begin(ssid, password);
|
|
||||||
if (WiFi.waitForConnectResult() != WL_CONNECTED) {
|
|
||||||
Serial.printf("WiFi Failed!\n");
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
Serial.printf("WiFi Connected!\n");
|
|
||||||
Serial.println(WiFi.localIP());
|
|
||||||
#ifdef ESP8266
|
|
||||||
ArduinoOTA.begin();
|
|
||||||
#endif
|
|
||||||
|
|
||||||
SyncClient client;
|
|
||||||
if(!client.connect("www.google.com", 80)){
|
|
||||||
Serial.println("Connect Failed");
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
client.setTimeout(2);
|
|
||||||
if(client.printf("GET / HTTP/1.1\r\nHost: www.google.com\r\nConnection: close\r\n\r\n") > 0){
|
|
||||||
while(client.connected() && client.available() == 0){
|
|
||||||
delay(1);
|
|
||||||
}
|
|
||||||
while(client.available()){
|
|
||||||
Serial.write(client.read());
|
|
||||||
}
|
|
||||||
if(client.connected()){
|
|
||||||
client.stop();
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
client.stop();
|
|
||||||
Serial.println("Send Failed");
|
|
||||||
while(client.connected()) delay(0);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
void loop(){
|
|
||||||
#ifdef ESP8266
|
|
||||||
ArduinoOTA.handle();
|
|
||||||
#endif
|
|
||||||
}
|
|
||||||
@@ -1,22 +0,0 @@
|
|||||||
{
|
|
||||||
"name":"ESPAsyncTCP-esphome",
|
|
||||||
"description":"Asynchronous TCP Library for ESP8266",
|
|
||||||
"keywords":"async,tcp",
|
|
||||||
"authors":
|
|
||||||
{
|
|
||||||
"name": "Hristo Gochkov",
|
|
||||||
"maintainer": true
|
|
||||||
},
|
|
||||||
"repository":
|
|
||||||
{
|
|
||||||
"type": "git",
|
|
||||||
"url": "https://github.com/esphome/ESPAsyncTCP.git"
|
|
||||||
},
|
|
||||||
"version": "2.0.0",
|
|
||||||
"license": "LGPL-3.0",
|
|
||||||
"frameworks": "arduino",
|
|
||||||
"platforms": "espressif8266",
|
|
||||||
"build": {
|
|
||||||
"libCompatMode": 2
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,214 +0,0 @@
|
|||||||
/*
|
|
||||||
Asynchronous TCP library for Espressif MCUs
|
|
||||||
|
|
||||||
Copyright (c) 2016 Hristo Gochkov. All rights reserved.
|
|
||||||
This file is part of the esp8266 core for Arduino environment.
|
|
||||||
|
|
||||||
This library is free software; you can redistribute it and/or
|
|
||||||
modify it under the terms of the GNU Lesser General Public
|
|
||||||
License as published by the Free Software Foundation; either
|
|
||||||
version 2.1 of the License, or (at your option) any later version.
|
|
||||||
|
|
||||||
This library is distributed in the hope that it will be useful,
|
|
||||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
||||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
||||||
Lesser General Public License for more details.
|
|
||||||
|
|
||||||
You should have received a copy of the GNU Lesser General Public
|
|
||||||
License along with this library; if not, write to the Free Software
|
|
||||||
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
|
|
||||||
*/
|
|
||||||
|
|
||||||
#include "AsyncPrinter.h"
|
|
||||||
|
|
||||||
AsyncPrinter::AsyncPrinter()
|
|
||||||
: _client(NULL)
|
|
||||||
, _data_cb(NULL)
|
|
||||||
, _data_arg(NULL)
|
|
||||||
, _close_cb(NULL)
|
|
||||||
, _close_arg(NULL)
|
|
||||||
, _tx_buffer(NULL)
|
|
||||||
, _tx_buffer_size(TCP_MSS)
|
|
||||||
, next(NULL)
|
|
||||||
{}
|
|
||||||
|
|
||||||
AsyncPrinter::AsyncPrinter(AsyncClient *client, size_t txBufLen)
|
|
||||||
: _client(client)
|
|
||||||
, _data_cb(NULL)
|
|
||||||
, _data_arg(NULL)
|
|
||||||
, _close_cb(NULL)
|
|
||||||
, _close_arg(NULL)
|
|
||||||
, _tx_buffer(NULL)
|
|
||||||
, _tx_buffer_size(txBufLen)
|
|
||||||
, next(NULL)
|
|
||||||
{
|
|
||||||
_attachCallbacks();
|
|
||||||
_tx_buffer = new (std::nothrow) cbuf(_tx_buffer_size);
|
|
||||||
if(_tx_buffer == NULL) {
|
|
||||||
panic(); //What should we do?
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
AsyncPrinter::~AsyncPrinter(){
|
|
||||||
_on_close();
|
|
||||||
}
|
|
||||||
|
|
||||||
void AsyncPrinter::onData(ApDataHandler cb, void *arg){
|
|
||||||
_data_cb = cb;
|
|
||||||
_data_arg = arg;
|
|
||||||
}
|
|
||||||
|
|
||||||
void AsyncPrinter::onClose(ApCloseHandler cb, void *arg){
|
|
||||||
_close_cb = cb;
|
|
||||||
_close_arg = arg;
|
|
||||||
}
|
|
||||||
|
|
||||||
int AsyncPrinter::connect(IPAddress ip, uint16_t port){
|
|
||||||
if(_client != NULL && connected())
|
|
||||||
return 0;
|
|
||||||
_client = new (std::nothrow) AsyncClient();
|
|
||||||
if (_client == NULL) {
|
|
||||||
panic();
|
|
||||||
}
|
|
||||||
|
|
||||||
_client->onConnect([](void *obj, AsyncClient *c){ ((AsyncPrinter*)(obj))->_onConnect(c); }, this);
|
|
||||||
if(_client->connect(ip, port)){
|
|
||||||
while(_client && _client->state() < 4)
|
|
||||||
delay(1);
|
|
||||||
return connected();
|
|
||||||
}
|
|
||||||
return 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
int AsyncPrinter::connect(const char *host, uint16_t port){
|
|
||||||
if(_client != NULL && connected())
|
|
||||||
return 0;
|
|
||||||
_client = new (std::nothrow) AsyncClient();
|
|
||||||
if (_client == NULL) {
|
|
||||||
panic();
|
|
||||||
}
|
|
||||||
|
|
||||||
_client->onConnect([](void *obj, AsyncClient *c){ ((AsyncPrinter*)(obj))->_onConnect(c); }, this);
|
|
||||||
if(_client->connect(host, port)){
|
|
||||||
while(_client && _client->state() < 4)
|
|
||||||
delay(1);
|
|
||||||
return connected();
|
|
||||||
}
|
|
||||||
return 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
void AsyncPrinter::_onConnect(AsyncClient *c){
|
|
||||||
(void)c;
|
|
||||||
if(_tx_buffer != NULL){
|
|
||||||
cbuf *b = _tx_buffer;
|
|
||||||
_tx_buffer = NULL;
|
|
||||||
delete b;
|
|
||||||
}
|
|
||||||
_tx_buffer = new (std::nothrow) cbuf(_tx_buffer_size);
|
|
||||||
if(_tx_buffer) {
|
|
||||||
panic();
|
|
||||||
}
|
|
||||||
|
|
||||||
_attachCallbacks();
|
|
||||||
}
|
|
||||||
|
|
||||||
AsyncPrinter::operator bool(){ return connected(); }
|
|
||||||
|
|
||||||
AsyncPrinter & AsyncPrinter::operator=(const AsyncPrinter &other){
|
|
||||||
if(_client != NULL){
|
|
||||||
_client->close(true);
|
|
||||||
_client = NULL;
|
|
||||||
}
|
|
||||||
_tx_buffer_size = other._tx_buffer_size;
|
|
||||||
if(_tx_buffer != NULL){
|
|
||||||
cbuf *b = _tx_buffer;
|
|
||||||
_tx_buffer = NULL;
|
|
||||||
delete b;
|
|
||||||
}
|
|
||||||
_tx_buffer = new (std::nothrow) cbuf(other._tx_buffer_size);
|
|
||||||
if(_tx_buffer == NULL) {
|
|
||||||
panic();
|
|
||||||
}
|
|
||||||
|
|
||||||
_client = other._client;
|
|
||||||
_attachCallbacks();
|
|
||||||
return *this;
|
|
||||||
}
|
|
||||||
|
|
||||||
size_t AsyncPrinter::write(uint8_t data){
|
|
||||||
return write(&data, 1);
|
|
||||||
}
|
|
||||||
|
|
||||||
size_t AsyncPrinter::write(const uint8_t *data, size_t len){
|
|
||||||
if(_tx_buffer == NULL || !connected())
|
|
||||||
return 0;
|
|
||||||
size_t toWrite = 0;
|
|
||||||
size_t toSend = len;
|
|
||||||
while(_tx_buffer->room() < toSend){
|
|
||||||
toWrite = _tx_buffer->room();
|
|
||||||
_tx_buffer->write((const char*)data, toWrite);
|
|
||||||
while(connected() && !_client->canSend())
|
|
||||||
delay(0);
|
|
||||||
if(!connected())
|
|
||||||
return 0; // or len - toSend;
|
|
||||||
_sendBuffer();
|
|
||||||
toSend -= toWrite;
|
|
||||||
}
|
|
||||||
_tx_buffer->write((const char*)(data+(len - toSend)), toSend);
|
|
||||||
while(connected() && !_client->canSend()) delay(0);
|
|
||||||
if(!connected()) return 0; // or len - toSend;
|
|
||||||
_sendBuffer();
|
|
||||||
return len;
|
|
||||||
}
|
|
||||||
|
|
||||||
bool AsyncPrinter::connected(){
|
|
||||||
return (_client != NULL && _client->connected());
|
|
||||||
}
|
|
||||||
|
|
||||||
void AsyncPrinter::close(){
|
|
||||||
if(_client != NULL)
|
|
||||||
_client->close(true);
|
|
||||||
}
|
|
||||||
|
|
||||||
size_t AsyncPrinter::_sendBuffer(){
|
|
||||||
size_t available = _tx_buffer->available();
|
|
||||||
if(!connected() || !_client->canSend() || available == 0)
|
|
||||||
return 0;
|
|
||||||
size_t sendable = _client->space();
|
|
||||||
if(sendable < available)
|
|
||||||
available= sendable;
|
|
||||||
char *out = new (std::nothrow) char[available];
|
|
||||||
if (out == NULL) {
|
|
||||||
panic(); // Connection should be aborted instead
|
|
||||||
}
|
|
||||||
|
|
||||||
_tx_buffer->read(out, available);
|
|
||||||
size_t sent = _client->write(out, available);
|
|
||||||
delete out;
|
|
||||||
return sent;
|
|
||||||
}
|
|
||||||
|
|
||||||
void AsyncPrinter::_onData(void *data, size_t len){
|
|
||||||
if(_data_cb)
|
|
||||||
_data_cb(_data_arg, this, (uint8_t*)data, len);
|
|
||||||
}
|
|
||||||
|
|
||||||
void AsyncPrinter::_on_close(){
|
|
||||||
if(_client != NULL){
|
|
||||||
_client = NULL;
|
|
||||||
}
|
|
||||||
if(_tx_buffer != NULL){
|
|
||||||
cbuf *b = _tx_buffer;
|
|
||||||
_tx_buffer = NULL;
|
|
||||||
delete b;
|
|
||||||
}
|
|
||||||
if(_close_cb)
|
|
||||||
_close_cb(_close_arg, this);
|
|
||||||
}
|
|
||||||
|
|
||||||
void AsyncPrinter::_attachCallbacks(){
|
|
||||||
_client->onPoll([](void *obj, AsyncClient* c){ (void)c; ((AsyncPrinter*)(obj))->_sendBuffer(); }, this);
|
|
||||||
_client->onAck([](void *obj, AsyncClient* c, size_t len, uint32_t time){ (void)c; (void)len; (void)time; ((AsyncPrinter*)(obj))->_sendBuffer(); }, this);
|
|
||||||
_client->onDisconnect([](void *obj, AsyncClient* c){ ((AsyncPrinter*)(obj))->_on_close(); delete c; }, this);
|
|
||||||
_client->onData([](void *obj, AsyncClient* c, void *data, size_t len){ (void)c; ((AsyncPrinter*)(obj))->_onData(data, len); }, this);
|
|
||||||
}
|
|
||||||
@@ -1,73 +0,0 @@
|
|||||||
/*
|
|
||||||
Asynchronous TCP library for Espressif MCUs
|
|
||||||
|
|
||||||
Copyright (c) 2016 Hristo Gochkov. All rights reserved.
|
|
||||||
This file is part of the esp8266 core for Arduino environment.
|
|
||||||
|
|
||||||
This library is free software; you can redistribute it and/or
|
|
||||||
modify it under the terms of the GNU Lesser General Public
|
|
||||||
License as published by the Free Software Foundation; either
|
|
||||||
version 2.1 of the License, or (at your option) any later version.
|
|
||||||
|
|
||||||
This library is distributed in the hope that it will be useful,
|
|
||||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
||||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
||||||
Lesser General Public License for more details.
|
|
||||||
|
|
||||||
You should have received a copy of the GNU Lesser General Public
|
|
||||||
License along with this library; if not, write to the Free Software
|
|
||||||
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
|
|
||||||
*/
|
|
||||||
|
|
||||||
#ifndef ASYNCPRINTER_H_
|
|
||||||
#define ASYNCPRINTER_H_
|
|
||||||
|
|
||||||
#include "Arduino.h"
|
|
||||||
#include "ESPAsyncTCP.h"
|
|
||||||
#include "cbuf.h"
|
|
||||||
|
|
||||||
class AsyncPrinter;
|
|
||||||
|
|
||||||
typedef std::function<void(void*, AsyncPrinter*, uint8_t*, size_t)> ApDataHandler;
|
|
||||||
typedef std::function<void(void*, AsyncPrinter*)> ApCloseHandler;
|
|
||||||
|
|
||||||
class AsyncPrinter: public Print {
|
|
||||||
private:
|
|
||||||
AsyncClient *_client;
|
|
||||||
ApDataHandler _data_cb;
|
|
||||||
void *_data_arg;
|
|
||||||
ApCloseHandler _close_cb;
|
|
||||||
void *_close_arg;
|
|
||||||
cbuf *_tx_buffer;
|
|
||||||
size_t _tx_buffer_size;
|
|
||||||
|
|
||||||
void _onConnect(AsyncClient *c);
|
|
||||||
public:
|
|
||||||
AsyncPrinter *next;
|
|
||||||
|
|
||||||
AsyncPrinter();
|
|
||||||
AsyncPrinter(AsyncClient *client, size_t txBufLen = TCP_MSS);
|
|
||||||
virtual ~AsyncPrinter();
|
|
||||||
|
|
||||||
int connect(IPAddress ip, uint16_t port);
|
|
||||||
int connect(const char *host, uint16_t port);
|
|
||||||
|
|
||||||
void onData(ApDataHandler cb, void *arg);
|
|
||||||
void onClose(ApCloseHandler cb, void *arg);
|
|
||||||
|
|
||||||
operator bool();
|
|
||||||
AsyncPrinter & operator=(const AsyncPrinter &other);
|
|
||||||
|
|
||||||
size_t write(uint8_t data);
|
|
||||||
size_t write(const uint8_t *data, size_t len);
|
|
||||||
|
|
||||||
bool connected();
|
|
||||||
void close();
|
|
||||||
|
|
||||||
size_t _sendBuffer();
|
|
||||||
void _onData(void *data, size_t len);
|
|
||||||
void _on_close();
|
|
||||||
void _attachCallbacks();
|
|
||||||
};
|
|
||||||
|
|
||||||
#endif /* ASYNCPRINTER_H_ */
|
|
||||||
@@ -1,112 +0,0 @@
|
|||||||
#ifndef _DEBUG_PRINT_MACROS_H
|
|
||||||
#define _DEBUG_PRINT_MACROS_H
|
|
||||||
// Some customizable print macros to suite the debug needs de jour.
|
|
||||||
|
|
||||||
// Debug macros
|
|
||||||
// #include <pgmspace.h>
|
|
||||||
// https://stackoverflow.com/questions/8487986/file-macro-shows-full-path
|
|
||||||
// This value is resolved at compile time.
|
|
||||||
#define _FILENAME_ strrchr("/" __FILE__, '/')
|
|
||||||
|
|
||||||
// #define DEBUG_ESP_ASYNC_TCP 1
|
|
||||||
// #define DEBUG_ESP_TCP_SSL 1
|
|
||||||
// #define DEBUG_ESP_PORT Serial
|
|
||||||
|
|
||||||
#if defined(DEBUG_ESP_PORT) && !defined(DEBUG_TIME_STAMP_FMT)
|
|
||||||
#define DEBUG_TIME_STAMP_FMT "%06u.%03u "
|
|
||||||
struct _DEBUG_TIME_STAMP {
|
|
||||||
unsigned dec;
|
|
||||||
unsigned whole;
|
|
||||||
};
|
|
||||||
inline struct _DEBUG_TIME_STAMP debugTimeStamp(void) {
|
|
||||||
struct _DEBUG_TIME_STAMP st;
|
|
||||||
unsigned now = millis() % 1000000000;
|
|
||||||
st.dec = now % 1000;
|
|
||||||
st.whole = now / 1000;
|
|
||||||
return st;
|
|
||||||
}
|
|
||||||
#endif
|
|
||||||
|
|
||||||
#if defined(DEBUG_ESP_PORT) && !defined(DEBUG_ESP_PORT_PRINTF)
|
|
||||||
|
|
||||||
#ifdef __cplusplus
|
|
||||||
#define DEBUG_ESP_PORT_PRINTF(format, ...) DEBUG_ESP_PORT.printf((format), ##__VA_ARGS__)
|
|
||||||
#define DEBUG_ESP_PORT_PRINTF_F(format, ...) DEBUG_ESP_PORT.printf_P(PSTR(format), ##__VA_ARGS__)
|
|
||||||
#define DEBUG_ESP_PORT_FLUSH DEBUG_ESP_PORT.flush
|
|
||||||
#else
|
|
||||||
// Handle debug printing from .c without CPP Stream, Print, ... classes
|
|
||||||
// Cannot handle flash strings in this setting
|
|
||||||
#define DEBUG_ESP_PORT_PRINTF ets_uart_printf
|
|
||||||
#define DEBUG_ESP_PORT_PRINTF_F ets_uart_printf
|
|
||||||
#define DEBUG_ESP_PORT_FLUSH (void)0
|
|
||||||
#endif
|
|
||||||
|
|
||||||
#endif
|
|
||||||
|
|
||||||
#if defined(DEBUG_ESP_PORT) && !defined(DEBUG_GENERIC)
|
|
||||||
#define DEBUG_GENERIC( module, format, ... ) \
|
|
||||||
do { \
|
|
||||||
struct _DEBUG_TIME_STAMP st = debugTimeStamp(); \
|
|
||||||
DEBUG_ESP_PORT_PRINTF( (DEBUG_TIME_STAMP_FMT module " " format), st.whole, st.dec, ##__VA_ARGS__ ); \
|
|
||||||
} while(false)
|
|
||||||
#endif
|
|
||||||
#if defined(DEBUG_ESP_PORT) && !defined(DEBUG_GENERIC_F)
|
|
||||||
#define DEBUG_GENERIC_F( module, format, ... ) \
|
|
||||||
do { \
|
|
||||||
struct _DEBUG_TIME_STAMP st = debugTimeStamp(); \
|
|
||||||
DEBUG_ESP_PORT_PRINTF_F( (DEBUG_TIME_STAMP_FMT module " " format), st.whole, st.dec, ##__VA_ARGS__ ); \
|
|
||||||
} while(false)
|
|
||||||
#endif
|
|
||||||
|
|
||||||
#if defined(DEBUG_GENERIC) && !defined(ASSERT_GENERIC)
|
|
||||||
#define ASSERT_GENERIC( a, module ) \
|
|
||||||
do { \
|
|
||||||
if ( !(a) ) { \
|
|
||||||
DEBUG_GENERIC( module, "%s:%s:%u: ASSERT("#a") failed!\n", __FILE__, __func__, __LINE__); \
|
|
||||||
DEBUG_ESP_PORT_FLUSH(); \
|
|
||||||
} \
|
|
||||||
} while(false)
|
|
||||||
#endif
|
|
||||||
#if defined(DEBUG_GENERIC_F) && !defined(ASSERT_GENERIC_F)
|
|
||||||
#define ASSERT_GENERIC_F( a, module ) \
|
|
||||||
do { \
|
|
||||||
if ( !(a) ) { \
|
|
||||||
DEBUG_GENERIC_F( module, "%s:%s:%u: ASSERT("#a") failed!\n", __FILE__, __func__, __LINE__); \
|
|
||||||
DEBUG_ESP_PORT_FLUSH(); \
|
|
||||||
} \
|
|
||||||
} while(false)
|
|
||||||
#endif
|
|
||||||
|
|
||||||
#ifndef DEBUG_GENERIC
|
|
||||||
#define DEBUG_GENERIC(...) do { (void)0;} while(false)
|
|
||||||
#endif
|
|
||||||
|
|
||||||
#ifndef DEBUG_GENERIC_F
|
|
||||||
#define DEBUG_GENERIC_F(...) do { (void)0;} while(false)
|
|
||||||
#endif
|
|
||||||
|
|
||||||
#ifndef ASSERT_GENERIC
|
|
||||||
#define ASSERT_GENERIC(...) do { (void)0;} while(false)
|
|
||||||
#endif
|
|
||||||
|
|
||||||
#ifndef ASSERT_GENERIC_F
|
|
||||||
#define ASSERT_GENERIC_F(...) do { (void)0;} while(false)
|
|
||||||
#endif
|
|
||||||
|
|
||||||
#ifndef DEBUG_ESP_PRINTF
|
|
||||||
#define DEBUG_ESP_PRINTF( format, ...) DEBUG_GENERIC_F("[%s]", format, &_FILENAME_[1], ##__VA_ARGS__)
|
|
||||||
#endif
|
|
||||||
|
|
||||||
#if defined(DEBUG_ESP_ASYNC_TCP) && !defined(ASYNC_TCP_DEBUG)
|
|
||||||
#define ASYNC_TCP_DEBUG( format, ...) DEBUG_GENERIC_F("[ASYNC_TCP]", format, ##__VA_ARGS__)
|
|
||||||
#endif
|
|
||||||
|
|
||||||
#ifndef ASYNC_TCP_ASSERT
|
|
||||||
#define ASYNC_TCP_ASSERT( a ) ASSERT_GENERIC_F( (a), "[ASYNC_TCP]")
|
|
||||||
#endif
|
|
||||||
|
|
||||||
#if defined(DEBUG_ESP_TCP_SSL) && !defined(TCP_SSL_DEBUG)
|
|
||||||
#define TCP_SSL_DEBUG( format, ...) DEBUG_GENERIC_F("[TCP_SSL]", format, ##__VA_ARGS__)
|
|
||||||
#endif
|
|
||||||
|
|
||||||
#endif //_DEBUG_PRINT_MACROS_H
|
|
||||||
File diff suppressed because it is too large
Load Diff
@@ -1,324 +0,0 @@
|
|||||||
/*
|
|
||||||
Asynchronous TCP library for Espressif MCUs
|
|
||||||
|
|
||||||
Copyright (c) 2016 Hristo Gochkov. All rights reserved.
|
|
||||||
This file is part of the esp8266 core for Arduino environment.
|
|
||||||
|
|
||||||
This library is free software; you can redistribute it and/or
|
|
||||||
modify it under the terms of the GNU Lesser General Public
|
|
||||||
License as published by the Free Software Foundation; either
|
|
||||||
version 2.1 of the License, or (at your option) any later version.
|
|
||||||
|
|
||||||
This library is distributed in the hope that it will be useful,
|
|
||||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
||||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
||||||
Lesser General Public License for more details.
|
|
||||||
|
|
||||||
You should have received a copy of the GNU Lesser General Public
|
|
||||||
License along with this library; if not, write to the Free Software
|
|
||||||
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
|
|
||||||
*/
|
|
||||||
|
|
||||||
#ifndef ASYNCTCP_H_
|
|
||||||
#define ASYNCTCP_H_
|
|
||||||
|
|
||||||
#include <async_config.h>
|
|
||||||
#include "IPAddress.h"
|
|
||||||
#include <functional>
|
|
||||||
#include <memory>
|
|
||||||
|
|
||||||
extern "C" {
|
|
||||||
#include "lwip/init.h"
|
|
||||||
#include "lwip/err.h"
|
|
||||||
#include "lwip/pbuf.h"
|
|
||||||
};
|
|
||||||
|
|
||||||
class AsyncClient;
|
|
||||||
class AsyncServer;
|
|
||||||
class ACErrorTracker;
|
|
||||||
|
|
||||||
#define ASYNC_MAX_ACK_TIME 5000
|
|
||||||
#define ASYNC_WRITE_FLAG_COPY 0x01 //will allocate new buffer to hold the data while sending (else will hold reference to the data given)
|
|
||||||
#define ASYNC_WRITE_FLAG_MORE 0x02 //will not send PSH flag, meaning that there should be more data to be sent before the application should react.
|
|
||||||
|
|
||||||
struct tcp_pcb;
|
|
||||||
struct ip_addr;
|
|
||||||
#if ASYNC_TCP_SSL_ENABLED
|
|
||||||
struct SSL_;
|
|
||||||
typedef struct SSL_ SSL;
|
|
||||||
struct SSL_CTX_;
|
|
||||||
typedef struct SSL_CTX_ SSL_CTX;
|
|
||||||
#endif
|
|
||||||
|
|
||||||
typedef std::function<void(void*, AsyncClient*)> AcConnectHandler;
|
|
||||||
typedef std::function<void(void*, AsyncClient*, size_t len, uint32_t time)> AcAckHandler;
|
|
||||||
typedef std::function<void(void*, AsyncClient*, err_t error)> AcErrorHandler;
|
|
||||||
typedef std::function<void(void*, AsyncClient*, void *data, size_t len)> AcDataHandler;
|
|
||||||
typedef std::function<void(void*, AsyncClient*, struct pbuf *pb)> AcPacketHandler;
|
|
||||||
typedef std::function<void(void*, AsyncClient*, uint32_t time)> AcTimeoutHandler;
|
|
||||||
typedef std::function<void(void*, size_t event)> AsNotifyHandler;
|
|
||||||
|
|
||||||
enum error_events {
|
|
||||||
EE_OK = 0,
|
|
||||||
EE_ABORTED, // Callback or foreground aborted connections
|
|
||||||
EE_ERROR_CB, // Stack initiated aborts via error Callbacks.
|
|
||||||
EE_CONNECTED_CB,
|
|
||||||
EE_RECV_CB,
|
|
||||||
EE_ACCEPT_CB,
|
|
||||||
EE_MAX
|
|
||||||
};
|
|
||||||
// DEBUG_MORE is for gathering more information on which CBs close events are
|
|
||||||
// occuring and count.
|
|
||||||
// #define DEBUG_MORE 1
|
|
||||||
class ACErrorTracker {
|
|
||||||
private:
|
|
||||||
AsyncClient *_client;
|
|
||||||
err_t _close_error;
|
|
||||||
int _errored;
|
|
||||||
#if DEBUG_ESP_ASYNC_TCP
|
|
||||||
size_t _connectionId;
|
|
||||||
#endif
|
|
||||||
#ifdef DEBUG_MORE
|
|
||||||
AsNotifyHandler _error_event_cb;
|
|
||||||
void* _error_event_cb_arg;
|
|
||||||
#endif
|
|
||||||
|
|
||||||
protected:
|
|
||||||
friend class AsyncClient;
|
|
||||||
friend class AsyncServer;
|
|
||||||
#ifdef DEBUG_MORE
|
|
||||||
void onErrorEvent(AsNotifyHandler cb, void *arg);
|
|
||||||
#endif
|
|
||||||
#if DEBUG_ESP_ASYNC_TCP
|
|
||||||
void setConnectionId(size_t id) { _connectionId=id;}
|
|
||||||
size_t getConnectionId(void) { return _connectionId;}
|
|
||||||
#endif
|
|
||||||
void setCloseError(err_t e);
|
|
||||||
void setErrored(size_t errorEvent);
|
|
||||||
err_t getCallbackCloseError(void);
|
|
||||||
void clearClient(void){ if (_client) _client = NULL;}
|
|
||||||
|
|
||||||
public:
|
|
||||||
err_t getCloseError(void) const { return _close_error;}
|
|
||||||
bool hasClient(void) const { return (_client != NULL);}
|
|
||||||
ACErrorTracker(AsyncClient *c);
|
|
||||||
~ACErrorTracker() {}
|
|
||||||
};
|
|
||||||
|
|
||||||
class AsyncClient {
|
|
||||||
protected:
|
|
||||||
friend class AsyncTCPbuffer;
|
|
||||||
friend class AsyncServer;
|
|
||||||
tcp_pcb* _pcb;
|
|
||||||
AcConnectHandler _connect_cb;
|
|
||||||
void* _connect_cb_arg;
|
|
||||||
AcConnectHandler _discard_cb;
|
|
||||||
void* _discard_cb_arg;
|
|
||||||
AcAckHandler _sent_cb;
|
|
||||||
void* _sent_cb_arg;
|
|
||||||
AcErrorHandler _error_cb;
|
|
||||||
void* _error_cb_arg;
|
|
||||||
AcDataHandler _recv_cb;
|
|
||||||
void* _recv_cb_arg;
|
|
||||||
AcPacketHandler _pb_cb;
|
|
||||||
void* _pb_cb_arg;
|
|
||||||
AcTimeoutHandler _timeout_cb;
|
|
||||||
void* _timeout_cb_arg;
|
|
||||||
AcConnectHandler _poll_cb;
|
|
||||||
void* _poll_cb_arg;
|
|
||||||
bool _pcb_busy;
|
|
||||||
#if ASYNC_TCP_SSL_ENABLED
|
|
||||||
bool _pcb_secure;
|
|
||||||
bool _handshake_done;
|
|
||||||
#endif
|
|
||||||
uint32_t _pcb_sent_at;
|
|
||||||
bool _close_pcb;
|
|
||||||
bool _ack_pcb;
|
|
||||||
uint32_t _tx_unacked_len;
|
|
||||||
uint32_t _tx_acked_len;
|
|
||||||
uint32_t _rx_ack_len;
|
|
||||||
uint32_t _rx_last_packet;
|
|
||||||
uint32_t _rx_since_timeout;
|
|
||||||
uint32_t _ack_timeout;
|
|
||||||
uint16_t _connect_port;
|
|
||||||
u8_t _recv_pbuf_flags;
|
|
||||||
std::shared_ptr<ACErrorTracker> _errorTracker;
|
|
||||||
|
|
||||||
void _close();
|
|
||||||
void _connected(std::shared_ptr<ACErrorTracker>& closeAbort, void* pcb, err_t err);
|
|
||||||
void _error(err_t err);
|
|
||||||
#if ASYNC_TCP_SSL_ENABLED
|
|
||||||
void _ssl_error(int8_t err);
|
|
||||||
#endif
|
|
||||||
void _poll(std::shared_ptr<ACErrorTracker>& closeAbort, tcp_pcb* pcb);
|
|
||||||
void _sent(std::shared_ptr<ACErrorTracker>& closeAbort, tcp_pcb* pcb, uint16_t len);
|
|
||||||
#if LWIP_VERSION_MAJOR == 1
|
|
||||||
void _dns_found(struct ip_addr *ipaddr);
|
|
||||||
#else
|
|
||||||
void _dns_found(const ip_addr *ipaddr);
|
|
||||||
#endif
|
|
||||||
static err_t _s_poll(void *arg, struct tcp_pcb *tpcb);
|
|
||||||
static err_t _s_recv(void *arg, struct tcp_pcb *tpcb, struct pbuf *pb, err_t err);
|
|
||||||
static void _s_error(void *arg, err_t err);
|
|
||||||
static err_t _s_sent(void *arg, struct tcp_pcb *tpcb, uint16_t len);
|
|
||||||
static err_t _s_connected(void* arg, void* tpcb, err_t err);
|
|
||||||
#if LWIP_VERSION_MAJOR == 1
|
|
||||||
static void _s_dns_found(const char *name, struct ip_addr *ipaddr, void *arg);
|
|
||||||
#else
|
|
||||||
static void _s_dns_found(const char *name, const ip_addr *ipaddr, void *arg);
|
|
||||||
#endif
|
|
||||||
#if ASYNC_TCP_SSL_ENABLED
|
|
||||||
static void _s_data(void *arg, struct tcp_pcb *tcp, uint8_t * data, size_t len);
|
|
||||||
static void _s_handshake(void *arg, struct tcp_pcb *tcp, SSL *ssl);
|
|
||||||
static void _s_ssl_error(void *arg, struct tcp_pcb *tcp, int8_t err);
|
|
||||||
#endif
|
|
||||||
std::shared_ptr<ACErrorTracker> getACErrorTracker(void) const { return _errorTracker; };
|
|
||||||
void setCloseError(err_t e) const { _errorTracker->setCloseError(e);}
|
|
||||||
|
|
||||||
public:
|
|
||||||
AsyncClient* prev;
|
|
||||||
AsyncClient* next;
|
|
||||||
|
|
||||||
#if ASYNC_TCP_SSL_ENABLED
|
|
||||||
AsyncClient(tcp_pcb* pcb = 0, SSL_CTX * ssl_ctx = NULL);
|
|
||||||
#else
|
|
||||||
AsyncClient(tcp_pcb* pcb = 0);
|
|
||||||
#endif
|
|
||||||
~AsyncClient();
|
|
||||||
|
|
||||||
AsyncClient & operator=(const AsyncClient &other);
|
|
||||||
AsyncClient & operator+=(const AsyncClient &other);
|
|
||||||
|
|
||||||
bool operator==(const AsyncClient &other);
|
|
||||||
|
|
||||||
bool operator!=(const AsyncClient &other) {
|
|
||||||
return !(*this == other);
|
|
||||||
}
|
|
||||||
#if ASYNC_TCP_SSL_ENABLED
|
|
||||||
bool connect(IPAddress ip, uint16_t port, bool secure=false);
|
|
||||||
bool connect(const char* host, uint16_t port, bool secure=false);
|
|
||||||
#else
|
|
||||||
bool connect(IPAddress ip, uint16_t port);
|
|
||||||
bool connect(const char* host, uint16_t port);
|
|
||||||
#endif
|
|
||||||
void close(bool now = false);
|
|
||||||
void stop();
|
|
||||||
void abort();
|
|
||||||
bool free();
|
|
||||||
|
|
||||||
bool canSend();//ack is not pending
|
|
||||||
size_t space();
|
|
||||||
size_t add(const char* data, size_t size, uint8_t apiflags=0);//add for sending
|
|
||||||
bool send();//send all data added with the method above
|
|
||||||
size_t ack(size_t len); //ack data that you have not acked using the method below
|
|
||||||
void ackLater(){ _ack_pcb = false; } //will not ack the current packet. Call from onData
|
|
||||||
bool isRecvPush(){ return !!(_recv_pbuf_flags & PBUF_FLAG_PUSH); }
|
|
||||||
#if DEBUG_ESP_ASYNC_TCP
|
|
||||||
size_t getConnectionId(void) const { return _errorTracker->getConnectionId();}
|
|
||||||
#endif
|
|
||||||
#if ASYNC_TCP_SSL_ENABLED
|
|
||||||
SSL *getSSL();
|
|
||||||
#endif
|
|
||||||
|
|
||||||
size_t write(const char* data);
|
|
||||||
size_t write(const char* data, size_t size, uint8_t apiflags=0); //only when canSend() == true
|
|
||||||
|
|
||||||
uint8_t state();
|
|
||||||
bool connecting();
|
|
||||||
bool connected();
|
|
||||||
bool disconnecting();
|
|
||||||
bool disconnected();
|
|
||||||
bool freeable();//disconnected or disconnecting
|
|
||||||
|
|
||||||
uint16_t getMss();
|
|
||||||
uint32_t getRxTimeout();
|
|
||||||
void setRxTimeout(uint32_t timeout);//no RX data timeout for the connection in seconds
|
|
||||||
uint32_t getAckTimeout();
|
|
||||||
void setAckTimeout(uint32_t timeout);//no ACK timeout for the last sent packet in milliseconds
|
|
||||||
void setNoDelay(bool nodelay);
|
|
||||||
bool getNoDelay();
|
|
||||||
uint16_t getRemotePort();
|
|
||||||
uint16_t getLocalPort();
|
|
||||||
|
|
||||||
IPAddress remoteIP();
|
|
||||||
uint16_t remotePort();
|
|
||||||
IPAddress localIP();
|
|
||||||
uint16_t localPort();
|
|
||||||
|
|
||||||
void onConnect(AcConnectHandler cb, void* arg = 0); //on successful connect
|
|
||||||
void onDisconnect(AcConnectHandler cb, void* arg = 0); //disconnected
|
|
||||||
void onAck(AcAckHandler cb, void* arg = 0); //ack received
|
|
||||||
void onError(AcErrorHandler cb, void* arg = 0); //unsuccessful connect or error
|
|
||||||
void onData(AcDataHandler cb, void* arg = 0); //data received (called if onPacket is not used)
|
|
||||||
void onPacket(AcPacketHandler cb, void* arg = 0); //data received
|
|
||||||
void onTimeout(AcTimeoutHandler cb, void* arg = 0); //ack timeout
|
|
||||||
void onPoll(AcConnectHandler cb, void* arg = 0); //every 125ms when connected
|
|
||||||
void ackPacket(struct pbuf * pb);
|
|
||||||
|
|
||||||
const char * errorToString(err_t error);
|
|
||||||
const char * stateToString();
|
|
||||||
|
|
||||||
void _recv(std::shared_ptr<ACErrorTracker>& closeAbort, tcp_pcb* pcb, pbuf* pb, err_t err);
|
|
||||||
err_t getCloseError(void) const { return _errorTracker->getCloseError();}
|
|
||||||
};
|
|
||||||
|
|
||||||
#if ASYNC_TCP_SSL_ENABLED
|
|
||||||
typedef std::function<int(void* arg, const char *filename, uint8_t **buf)> AcSSlFileHandler;
|
|
||||||
struct pending_pcb;
|
|
||||||
#endif
|
|
||||||
|
|
||||||
|
|
||||||
class AsyncServer {
|
|
||||||
protected:
|
|
||||||
uint16_t _port;
|
|
||||||
IPAddress _addr;
|
|
||||||
bool _noDelay;
|
|
||||||
tcp_pcb* _pcb;
|
|
||||||
AcConnectHandler _connect_cb;
|
|
||||||
void* _connect_cb_arg;
|
|
||||||
#if ASYNC_TCP_SSL_ENABLED
|
|
||||||
struct pending_pcb * _pending;
|
|
||||||
SSL_CTX * _ssl_ctx;
|
|
||||||
AcSSlFileHandler _file_cb;
|
|
||||||
void* _file_cb_arg;
|
|
||||||
#endif
|
|
||||||
#ifdef DEBUG_MORE
|
|
||||||
int _event_count[EE_MAX];
|
|
||||||
#endif
|
|
||||||
|
|
||||||
public:
|
|
||||||
|
|
||||||
AsyncServer(IPAddress addr, uint16_t port);
|
|
||||||
AsyncServer(uint16_t port);
|
|
||||||
~AsyncServer();
|
|
||||||
void onClient(AcConnectHandler cb, void* arg);
|
|
||||||
#if ASYNC_TCP_SSL_ENABLED
|
|
||||||
void onSslFileRequest(AcSSlFileHandler cb, void* arg);
|
|
||||||
void beginSecure(const char *cert, const char *private_key_file, const char *password);
|
|
||||||
#endif
|
|
||||||
void begin();
|
|
||||||
void end();
|
|
||||||
void setNoDelay(bool nodelay);
|
|
||||||
bool getNoDelay();
|
|
||||||
uint8_t status();
|
|
||||||
#ifdef DEBUG_MORE
|
|
||||||
int getEventCount(size_t ee) const { return _event_count[ee];}
|
|
||||||
#endif
|
|
||||||
protected:
|
|
||||||
err_t _accept(tcp_pcb* newpcb, err_t err);
|
|
||||||
static err_t _s_accept(void *arg, tcp_pcb* newpcb, err_t err);
|
|
||||||
#ifdef DEBUG_MORE
|
|
||||||
int incEventCount(size_t ee) { return ++_event_count[ee];}
|
|
||||||
#endif
|
|
||||||
#if ASYNC_TCP_SSL_ENABLED
|
|
||||||
int _cert(const char *filename, uint8_t **buf);
|
|
||||||
err_t _poll(tcp_pcb* pcb);
|
|
||||||
err_t _recv(tcp_pcb *pcb, struct pbuf *pb, err_t err);
|
|
||||||
static int _s_cert(void *arg, const char *filename, uint8_t **buf);
|
|
||||||
static err_t _s_poll(void *arg, struct tcp_pcb *tpcb);
|
|
||||||
static err_t _s_recv(void *arg, struct tcp_pcb *tpcb, struct pbuf *pb, err_t err);
|
|
||||||
#endif
|
|
||||||
};
|
|
||||||
|
|
||||||
|
|
||||||
#endif /* ASYNCTCP_H_ */
|
|
||||||
@@ -1,555 +0,0 @@
|
|||||||
/**
|
|
||||||
* @file ESPAsyncTCPbuffer.cpp
|
|
||||||
* @date 22.01.2016
|
|
||||||
* @author Markus Sattler
|
|
||||||
*
|
|
||||||
* Copyright (c) 2015 Markus Sattler. All rights reserved.
|
|
||||||
* This file is part of the Asynv TCP for ESP.
|
|
||||||
*
|
|
||||||
* This library is free software; you can redistribute it and/or
|
|
||||||
* modify it under the terms of the GNU Lesser General Public
|
|
||||||
* License as published by the Free Software Foundation; either
|
|
||||||
* version 2.1 of the License, or (at your option) any later version.
|
|
||||||
*
|
|
||||||
* This library is distributed in the hope that it will be useful,
|
|
||||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
||||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
||||||
* Lesser General Public License for more details.
|
|
||||||
*
|
|
||||||
* You should have received a copy of the GNU Lesser General Public
|
|
||||||
* License along with this library; if not, write to the Free Software
|
|
||||||
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
|
|
||||||
|
|
||||||
#include <Arduino.h>
|
|
||||||
#include <debug.h>
|
|
||||||
|
|
||||||
#include "ESPAsyncTCPbuffer.h"
|
|
||||||
|
|
||||||
|
|
||||||
AsyncTCPbuffer::AsyncTCPbuffer(AsyncClient* client) {
|
|
||||||
if(client == NULL) {
|
|
||||||
DEBUG_ASYNC_TCP("[A-TCP] client is null!!!\n");
|
|
||||||
panic();
|
|
||||||
}
|
|
||||||
|
|
||||||
_client = client;
|
|
||||||
_TXbufferWrite = new (std::nothrow) cbuf(TCP_MSS);
|
|
||||||
_TXbufferRead = _TXbufferWrite;
|
|
||||||
_RXbuffer = new (std::nothrow) cbuf(100);
|
|
||||||
_RXmode = ATB_RX_MODE_FREE;
|
|
||||||
_rxSize = 0;
|
|
||||||
_rxTerminator = 0x00;
|
|
||||||
_rxReadBytesPtr = NULL;
|
|
||||||
_rxReadStringPtr = NULL;
|
|
||||||
_cbDisconnect = NULL;
|
|
||||||
|
|
||||||
_cbRX = NULL;
|
|
||||||
_cbDone = NULL;
|
|
||||||
_attachCallbacks();
|
|
||||||
}
|
|
||||||
|
|
||||||
AsyncTCPbuffer::~AsyncTCPbuffer() {
|
|
||||||
if(_client) {
|
|
||||||
_client->close();
|
|
||||||
}
|
|
||||||
|
|
||||||
if(_RXbuffer) {
|
|
||||||
delete _RXbuffer;
|
|
||||||
_RXbuffer = NULL;
|
|
||||||
}
|
|
||||||
|
|
||||||
if(_TXbufferWrite) {
|
|
||||||
// will be deleted in _TXbufferRead chain
|
|
||||||
_TXbufferWrite = NULL;
|
|
||||||
}
|
|
||||||
|
|
||||||
if(_TXbufferRead) {
|
|
||||||
cbuf * next = _TXbufferRead->next;
|
|
||||||
delete _TXbufferRead;
|
|
||||||
while(next != NULL) {
|
|
||||||
_TXbufferRead = next;
|
|
||||||
next = _TXbufferRead->next;
|
|
||||||
delete _TXbufferRead;
|
|
||||||
}
|
|
||||||
_TXbufferRead = NULL;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
size_t AsyncTCPbuffer::write(String & data) {
|
|
||||||
return write(data.c_str(), data.length());
|
|
||||||
}
|
|
||||||
|
|
||||||
size_t AsyncTCPbuffer::write(uint8_t data) {
|
|
||||||
return write(&data, 1);
|
|
||||||
}
|
|
||||||
|
|
||||||
size_t AsyncTCPbuffer::write(const char* data) {
|
|
||||||
return write((const uint8_t *) data, strlen(data));
|
|
||||||
}
|
|
||||||
|
|
||||||
size_t AsyncTCPbuffer::write(const char *data, size_t len) {
|
|
||||||
return write((const uint8_t *) data, len);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* write data in to buffer and try to send the data
|
|
||||||
* @param data
|
|
||||||
* @param len
|
|
||||||
* @return
|
|
||||||
*/
|
|
||||||
size_t AsyncTCPbuffer::write(const uint8_t *data, size_t len) {
|
|
||||||
if(_TXbufferWrite == NULL || _client == NULL || !_client->connected() || data == NULL || len == 0) {
|
|
||||||
return 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
size_t bytesLeft = len;
|
|
||||||
while(bytesLeft) {
|
|
||||||
size_t w = _TXbufferWrite->write((const char*) data, bytesLeft);
|
|
||||||
bytesLeft -= w;
|
|
||||||
data += w;
|
|
||||||
_sendBuffer();
|
|
||||||
|
|
||||||
// add new buffer since we have more data
|
|
||||||
if(_TXbufferWrite->full() && bytesLeft > 0) {
|
|
||||||
|
|
||||||
// to less ram!!!
|
|
||||||
if(ESP.getFreeHeap() < 4096) {
|
|
||||||
DEBUG_ASYNC_TCP("[A-TCP] run out of Heap can not send all Data!\n");
|
|
||||||
return (len - bytesLeft);
|
|
||||||
}
|
|
||||||
|
|
||||||
cbuf * next = new (std::nothrow) cbuf(TCP_MSS);
|
|
||||||
if(next == NULL) {
|
|
||||||
DEBUG_ASYNC_TCP("[A-TCP] run out of Heap!\n");
|
|
||||||
panic();
|
|
||||||
} else {
|
|
||||||
DEBUG_ASYNC_TCP("[A-TCP] new cbuf\n");
|
|
||||||
}
|
|
||||||
|
|
||||||
// add new buffer to chain (current cbuf)
|
|
||||||
_TXbufferWrite->next = next;
|
|
||||||
|
|
||||||
// move ptr for next data
|
|
||||||
_TXbufferWrite = next;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return len;
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* wait until all data has send out
|
|
||||||
*/
|
|
||||||
void AsyncTCPbuffer::flush() {
|
|
||||||
while(!_TXbufferWrite->empty()) {
|
|
||||||
while(connected() && !_client->canSend()) {
|
|
||||||
delay(0);
|
|
||||||
}
|
|
||||||
if(!connected())
|
|
||||||
return;
|
|
||||||
_sendBuffer();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
void AsyncTCPbuffer::noCallback() {
|
|
||||||
_RXmode = ATB_RX_MODE_NONE;
|
|
||||||
}
|
|
||||||
|
|
||||||
void AsyncTCPbuffer::readStringUntil(char terminator, String * str, AsyncTCPbufferDoneCb done) {
|
|
||||||
if(_client == NULL) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
DEBUG_ASYNC_TCP("[A-TCP] readStringUntil terminator: %02X\n", terminator);
|
|
||||||
_RXmode = ATB_RX_MODE_NONE;
|
|
||||||
_cbDone = done;
|
|
||||||
_rxReadStringPtr = str;
|
|
||||||
_rxTerminator = terminator;
|
|
||||||
_rxSize = 0;
|
|
||||||
_RXmode = ATB_RX_MODE_TERMINATOR_STRING;
|
|
||||||
}
|
|
||||||
|
|
||||||
/*
|
|
||||||
void AsyncTCPbuffer::readBytesUntil(char terminator, char *buffer, size_t length, AsyncTCPbufferDoneCb done) {
|
|
||||||
_RXmode = ATB_RX_MODE_NONE;
|
|
||||||
_cbDone = done;
|
|
||||||
_rxReadBytesPtr = (uint8_t *) buffer;
|
|
||||||
_rxTerminator = terminator;
|
|
||||||
_rxSize = length;
|
|
||||||
_RXmode = ATB_RX_MODE_TERMINATOR;
|
|
||||||
_handleRxBuffer(NULL, 0);
|
|
||||||
}
|
|
||||||
|
|
||||||
void AsyncTCPbuffer::readBytesUntil(char terminator, uint8_t *buffer, size_t length, AsyncTCPbufferDoneCb done) {
|
|
||||||
readBytesUntil(terminator, (char *) buffer, length, done);
|
|
||||||
}
|
|
||||||
*/
|
|
||||||
|
|
||||||
void AsyncTCPbuffer::readBytes(char *buffer, size_t length, AsyncTCPbufferDoneCb done) {
|
|
||||||
if(_client == NULL) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
DEBUG_ASYNC_TCP("[A-TCP] readBytes length: %d\n", length);
|
|
||||||
_RXmode = ATB_RX_MODE_NONE;
|
|
||||||
_cbDone = done;
|
|
||||||
_rxReadBytesPtr = (uint8_t *) buffer;
|
|
||||||
_rxSize = length;
|
|
||||||
_RXmode = ATB_RX_MODE_READ_BYTES;
|
|
||||||
}
|
|
||||||
|
|
||||||
void AsyncTCPbuffer::readBytes(uint8_t *buffer, size_t length, AsyncTCPbufferDoneCb done) {
|
|
||||||
readBytes((char *) buffer, length, done);
|
|
||||||
}
|
|
||||||
|
|
||||||
void AsyncTCPbuffer::onData(AsyncTCPbufferDataCb cb) {
|
|
||||||
if(_client == NULL) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
DEBUG_ASYNC_TCP("[A-TCP] onData\n");
|
|
||||||
_RXmode = ATB_RX_MODE_NONE;
|
|
||||||
_cbDone = NULL;
|
|
||||||
_cbRX = cb;
|
|
||||||
_RXmode = ATB_RX_MODE_FREE;
|
|
||||||
}
|
|
||||||
|
|
||||||
void AsyncTCPbuffer::onDisconnect(AsyncTCPbufferDisconnectCb cb) {
|
|
||||||
_cbDisconnect = cb;
|
|
||||||
}
|
|
||||||
|
|
||||||
IPAddress AsyncTCPbuffer::remoteIP() {
|
|
||||||
if(!_client) {
|
|
||||||
return IPAddress(0U);
|
|
||||||
}
|
|
||||||
return _client->remoteIP();
|
|
||||||
}
|
|
||||||
|
|
||||||
uint16_t AsyncTCPbuffer::remotePort() {
|
|
||||||
if(!_client) {
|
|
||||||
return 0;
|
|
||||||
}
|
|
||||||
return _client->remotePort();
|
|
||||||
}
|
|
||||||
|
|
||||||
bool AsyncTCPbuffer::connected() {
|
|
||||||
if(!_client) {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
return _client->connected();
|
|
||||||
}
|
|
||||||
|
|
||||||
void AsyncTCPbuffer::stop() {
|
|
||||||
|
|
||||||
if(!_client) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
_client->stop();
|
|
||||||
_client = NULL;
|
|
||||||
|
|
||||||
if(_cbDone) {
|
|
||||||
switch(_RXmode) {
|
|
||||||
case ATB_RX_MODE_READ_BYTES:
|
|
||||||
case ATB_RX_MODE_TERMINATOR:
|
|
||||||
case ATB_RX_MODE_TERMINATOR_STRING:
|
|
||||||
_RXmode = ATB_RX_MODE_NONE;
|
|
||||||
_cbDone(false, NULL);
|
|
||||||
break;
|
|
||||||
default:
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
_RXmode = ATB_RX_MODE_NONE;
|
|
||||||
}
|
|
||||||
|
|
||||||
void AsyncTCPbuffer::close() {
|
|
||||||
stop();
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
///--------------------------------
|
|
||||||
|
|
||||||
/**
|
|
||||||
* attachCallbacks to AsyncClient class
|
|
||||||
*/
|
|
||||||
void AsyncTCPbuffer::_attachCallbacks() {
|
|
||||||
if(!_client) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
DEBUG_ASYNC_TCP("[A-TCP] attachCallbacks\n");
|
|
||||||
|
|
||||||
_client->onPoll([](void *obj, AsyncClient* c) {
|
|
||||||
(void)c;
|
|
||||||
AsyncTCPbuffer* b = ((AsyncTCPbuffer*)(obj));
|
|
||||||
if((b->_TXbufferRead != NULL) && !b->_TXbufferRead->empty()) {
|
|
||||||
b->_sendBuffer();
|
|
||||||
}
|
|
||||||
// if(!b->_RXbuffer->empty()) {
|
|
||||||
// b->_handleRxBuffer(NULL, 0);
|
|
||||||
// }
|
|
||||||
}, this);
|
|
||||||
|
|
||||||
_client->onAck([](void *obj, AsyncClient* c, size_t len, uint32_t time) {
|
|
||||||
(void)c;
|
|
||||||
(void)len;
|
|
||||||
(void)time;
|
|
||||||
DEBUG_ASYNC_TCP("[A-TCP] onAck\n");
|
|
||||||
((AsyncTCPbuffer*)(obj))->_sendBuffer();
|
|
||||||
}, this);
|
|
||||||
|
|
||||||
_client->onDisconnect([](void *obj, AsyncClient* c) {
|
|
||||||
DEBUG_ASYNC_TCP("[A-TCP] onDisconnect\n");
|
|
||||||
AsyncTCPbuffer* b = ((AsyncTCPbuffer*)(obj));
|
|
||||||
b->_client = NULL;
|
|
||||||
bool del = true;
|
|
||||||
if(b->_cbDisconnect) {
|
|
||||||
del = b->_cbDisconnect(b);
|
|
||||||
}
|
|
||||||
delete c;
|
|
||||||
if(del) {
|
|
||||||
delete b;
|
|
||||||
}
|
|
||||||
}, this);
|
|
||||||
|
|
||||||
_client->onData([](void *obj, AsyncClient* c, void *buf, size_t len) {
|
|
||||||
(void)c;
|
|
||||||
AsyncTCPbuffer* b = ((AsyncTCPbuffer*)(obj));
|
|
||||||
b->_rxData((uint8_t *)buf, len);
|
|
||||||
}, this);
|
|
||||||
|
|
||||||
_client->onTimeout([](void *obj, AsyncClient* c, uint32_t time){
|
|
||||||
(void)obj;
|
|
||||||
(void)time;
|
|
||||||
DEBUG_ASYNC_TCP("[A-TCP] onTimeout\n");
|
|
||||||
c->close();
|
|
||||||
}, this);
|
|
||||||
|
|
||||||
DEBUG_ASYNC_TCP("[A-TCP] attachCallbacks Done.\n");
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* send TX buffer if possible
|
|
||||||
*/
|
|
||||||
void AsyncTCPbuffer::_sendBuffer() {
|
|
||||||
//DEBUG_ASYNC_TCP("[A-TCP] _sendBuffer...\n");
|
|
||||||
size_t available = _TXbufferRead->available();
|
|
||||||
if(available == 0 || _client == NULL || !_client->connected() || !_client->canSend()) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
while(connected() && (_client->space() > 0) && (_TXbufferRead->available() > 0) && _client->canSend()) {
|
|
||||||
|
|
||||||
available = _TXbufferRead->available();
|
|
||||||
|
|
||||||
if(available > _client->space()) {
|
|
||||||
available = _client->space();
|
|
||||||
}
|
|
||||||
|
|
||||||
char *out = new (std::nothrow) char[available];
|
|
||||||
if(out == NULL) {
|
|
||||||
DEBUG_ASYNC_TCP("[A-TCP] to less heap, try later.\n");
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
// read data from buffer
|
|
||||||
_TXbufferRead->peek(out, available);
|
|
||||||
|
|
||||||
// send data
|
|
||||||
size_t send = _client->write((const char*) out, available);
|
|
||||||
if(send != available) {
|
|
||||||
DEBUG_ASYNC_TCP("[A-TCP] write failed send: %d available: %d \n", send, available);
|
|
||||||
if(!connected()) {
|
|
||||||
DEBUG_ASYNC_TCP("[A-TCP] incomplete transfer, connection lost.\n");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// remove really send data from buffer
|
|
||||||
_TXbufferRead->remove(send);
|
|
||||||
|
|
||||||
// if buffer is empty and there is a other buffer in chain delete the empty one
|
|
||||||
if(_TXbufferRead->available() == 0 && _TXbufferRead->next != NULL) {
|
|
||||||
cbuf * old = _TXbufferRead;
|
|
||||||
_TXbufferRead = _TXbufferRead->next;
|
|
||||||
delete old;
|
|
||||||
DEBUG_ASYNC_TCP("[A-TCP] delete cbuf\n");
|
|
||||||
}
|
|
||||||
|
|
||||||
delete out;
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* called on incoming data
|
|
||||||
* @param buf
|
|
||||||
* @param len
|
|
||||||
*/
|
|
||||||
void AsyncTCPbuffer::_rxData(uint8_t *buf, size_t len) {
|
|
||||||
if(!_client || !_client->connected()) {
|
|
||||||
DEBUG_ASYNC_TCP("[A-TCP] not connected!\n");
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
if(!_RXbuffer) {
|
|
||||||
DEBUG_ASYNC_TCP("[A-TCP] _rxData no _RXbuffer!\n");
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
DEBUG_ASYNC_TCP("[A-TCP] _rxData len: %d RXmode: %d\n", len, _RXmode);
|
|
||||||
|
|
||||||
size_t handled = 0;
|
|
||||||
|
|
||||||
if(_RXmode != ATB_RX_MODE_NONE) {
|
|
||||||
handled = _handleRxBuffer((uint8_t *) buf, len);
|
|
||||||
buf += handled;
|
|
||||||
len -= handled;
|
|
||||||
|
|
||||||
// handle as much as possible before using the buffer
|
|
||||||
if(_RXbuffer->empty()) {
|
|
||||||
while(_RXmode != ATB_RX_MODE_NONE && handled != 0 && len > 0) {
|
|
||||||
handled = _handleRxBuffer(buf, len);
|
|
||||||
buf += handled;
|
|
||||||
len -= handled;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if(len > 0) {
|
|
||||||
|
|
||||||
if(_RXbuffer->room() < len) {
|
|
||||||
// to less space
|
|
||||||
DEBUG_ASYNC_TCP("[A-TCP] _rxData buffer full try resize\n");
|
|
||||||
_RXbuffer->resizeAdd((len + _RXbuffer->room()));
|
|
||||||
|
|
||||||
if(_RXbuffer->room() < len) {
|
|
||||||
DEBUG_ASYNC_TCP("[A-TCP] _rxData buffer to full can only handle %d!!!\n", _RXbuffer->room());
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
_RXbuffer->write((const char *) (buf), len);
|
|
||||||
}
|
|
||||||
|
|
||||||
if(!_RXbuffer->empty() && _RXmode != ATB_RX_MODE_NONE) {
|
|
||||||
// handle as much as possible data in buffer
|
|
||||||
handled = _handleRxBuffer(NULL, 0);
|
|
||||||
while(_RXmode != ATB_RX_MODE_NONE && handled != 0) {
|
|
||||||
handled = _handleRxBuffer(NULL, 0);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// clean up ram
|
|
||||||
if(_RXbuffer->empty() && _RXbuffer->room() != 100) {
|
|
||||||
_RXbuffer->resize(100);
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
size_t AsyncTCPbuffer::_handleRxBuffer(uint8_t *buf, size_t len) {
|
|
||||||
if(!_client || !_client->connected() || _RXbuffer == NULL) {
|
|
||||||
return 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
DEBUG_ASYNC_TCP("[A-TCP] _handleRxBuffer len: %d RXmode: %d\n", len, _RXmode);
|
|
||||||
|
|
||||||
size_t BufferAvailable = _RXbuffer->available();
|
|
||||||
size_t r = 0;
|
|
||||||
|
|
||||||
if(_RXmode == ATB_RX_MODE_NONE) {
|
|
||||||
return 0;
|
|
||||||
} else if(_RXmode == ATB_RX_MODE_FREE) {
|
|
||||||
if(_cbRX == NULL) {
|
|
||||||
return 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
if(BufferAvailable > 0) {
|
|
||||||
uint8_t * b = new (std::nothrow) uint8_t[BufferAvailable];
|
|
||||||
if(b == NULL){
|
|
||||||
panic(); //TODO: What action should this be ?
|
|
||||||
}
|
|
||||||
_RXbuffer->peek((char *) b, BufferAvailable);
|
|
||||||
r = _cbRX(b, BufferAvailable);
|
|
||||||
_RXbuffer->remove(r);
|
|
||||||
}
|
|
||||||
|
|
||||||
if(r == BufferAvailable && buf && (len > 0)) {
|
|
||||||
return _cbRX(buf, len);
|
|
||||||
} else {
|
|
||||||
return 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
} else if(_RXmode == ATB_RX_MODE_READ_BYTES) {
|
|
||||||
if(_rxReadBytesPtr == NULL || _cbDone == NULL) {
|
|
||||||
return 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
size_t newReadCount = 0;
|
|
||||||
|
|
||||||
if(BufferAvailable) {
|
|
||||||
r = _RXbuffer->read((char *) _rxReadBytesPtr, _rxSize);
|
|
||||||
_rxSize -= r;
|
|
||||||
_rxReadBytesPtr += r;
|
|
||||||
}
|
|
||||||
|
|
||||||
if(_RXbuffer->empty() && (len > 0) && buf) {
|
|
||||||
r = len;
|
|
||||||
if(r > _rxSize) {
|
|
||||||
r = _rxSize;
|
|
||||||
}
|
|
||||||
memcpy(_rxReadBytesPtr, buf, r);
|
|
||||||
_rxReadBytesPtr += r;
|
|
||||||
_rxSize -= r;
|
|
||||||
newReadCount += r;
|
|
||||||
}
|
|
||||||
|
|
||||||
if(_rxSize == 0) {
|
|
||||||
_RXmode = ATB_RX_MODE_NONE;
|
|
||||||
_cbDone(true, NULL);
|
|
||||||
}
|
|
||||||
|
|
||||||
// add left over bytes to Buffer
|
|
||||||
return newReadCount;
|
|
||||||
|
|
||||||
} else if(_RXmode == ATB_RX_MODE_TERMINATOR) {
|
|
||||||
// TODO implement read terminator non string
|
|
||||||
|
|
||||||
} else if(_RXmode == ATB_RX_MODE_TERMINATOR_STRING) {
|
|
||||||
if(_rxReadStringPtr == NULL || _cbDone == NULL) {
|
|
||||||
return 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
// handle Buffer
|
|
||||||
if(BufferAvailable > 0) {
|
|
||||||
while(!_RXbuffer->empty()) {
|
|
||||||
char c = _RXbuffer->read();
|
|
||||||
if(c == _rxTerminator || c == 0x00) {
|
|
||||||
_RXmode = ATB_RX_MODE_NONE;
|
|
||||||
_cbDone(true, _rxReadStringPtr);
|
|
||||||
return 0;
|
|
||||||
} else {
|
|
||||||
(*_rxReadStringPtr) += c;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if(_RXbuffer->empty() && (len > 0) && buf) {
|
|
||||||
size_t newReadCount = 0;
|
|
||||||
while(newReadCount < len) {
|
|
||||||
char c = (char) *buf;
|
|
||||||
buf++;
|
|
||||||
newReadCount++;
|
|
||||||
if(c == _rxTerminator || c == 0x00) {
|
|
||||||
_RXmode = ATB_RX_MODE_NONE;
|
|
||||||
_cbDone(true, _rxReadStringPtr);
|
|
||||||
return newReadCount;
|
|
||||||
} else {
|
|
||||||
(*_rxReadStringPtr) += c;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return newReadCount;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return 0;
|
|
||||||
}
|
|
||||||
@@ -1,118 +0,0 @@
|
|||||||
/**
|
|
||||||
* @file ESPAsyncTCPbuffer.h
|
|
||||||
* @date 22.01.2016
|
|
||||||
* @author Markus Sattler
|
|
||||||
*
|
|
||||||
* Copyright (c) 2015 Markus Sattler. All rights reserved.
|
|
||||||
* This file is part of the Asynv TCP for ESP.
|
|
||||||
*
|
|
||||||
* This library is free software; you can redistribute it and/or
|
|
||||||
* modify it under the terms of the GNU Lesser General Public
|
|
||||||
* License as published by the Free Software Foundation; either
|
|
||||||
* version 2.1 of the License, or (at your option) any later version.
|
|
||||||
*
|
|
||||||
* This library is distributed in the hope that it will be useful,
|
|
||||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
||||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
||||||
* Lesser General Public License for more details.
|
|
||||||
*
|
|
||||||
* You should have received a copy of the GNU Lesser General Public
|
|
||||||
* License along with this library; if not, write to the Free Software
|
|
||||||
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
|
|
||||||
#ifndef ESPASYNCTCPBUFFER_H_
|
|
||||||
#define ESPASYNCTCPBUFFER_H_
|
|
||||||
|
|
||||||
//#define DEBUG_ASYNC_TCP(...) while(((U0S >> USTXC) & 0x7F) != 0x00); os_printf( __VA_ARGS__ ); while(((U0S >> USTXC) & 0x7F) != 0x00)
|
|
||||||
//#define DEBUG_ASYNC_TCP ASYNC_TCP_DEBUG
|
|
||||||
#ifndef DEBUG_ASYNC_TCP
|
|
||||||
#define DEBUG_ASYNC_TCP(...)
|
|
||||||
#endif
|
|
||||||
|
|
||||||
#include <Arduino.h>
|
|
||||||
#include <cbuf.h>
|
|
||||||
|
|
||||||
#include "ESPAsyncTCP.h"
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
typedef enum {
|
|
||||||
ATB_RX_MODE_NONE,
|
|
||||||
ATB_RX_MODE_FREE,
|
|
||||||
ATB_RX_MODE_READ_BYTES,
|
|
||||||
ATB_RX_MODE_TERMINATOR,
|
|
||||||
ATB_RX_MODE_TERMINATOR_STRING
|
|
||||||
} atbRxMode_t;
|
|
||||||
|
|
||||||
class AsyncTCPbuffer: public Print {
|
|
||||||
|
|
||||||
public:
|
|
||||||
|
|
||||||
typedef std::function<size_t(uint8_t * payload, size_t length)> AsyncTCPbufferDataCb;
|
|
||||||
typedef std::function<void(bool ok, void * ret)> AsyncTCPbufferDoneCb;
|
|
||||||
typedef std::function<bool(AsyncTCPbuffer * obj)> AsyncTCPbufferDisconnectCb;
|
|
||||||
|
|
||||||
AsyncTCPbuffer(AsyncClient* c);
|
|
||||||
virtual ~AsyncTCPbuffer();
|
|
||||||
|
|
||||||
size_t write(String & data);
|
|
||||||
size_t write(uint8_t data);
|
|
||||||
size_t write(const char* data);
|
|
||||||
size_t write(const char *data, size_t len);
|
|
||||||
size_t write(const uint8_t *data, size_t len);
|
|
||||||
|
|
||||||
void flush();
|
|
||||||
|
|
||||||
void noCallback();
|
|
||||||
|
|
||||||
void readStringUntil(char terminator, String * str, AsyncTCPbufferDoneCb done);
|
|
||||||
|
|
||||||
// TODO implement read terminator non string
|
|
||||||
//void readBytesUntil(char terminator, char *buffer, size_t length, AsyncTCPbufferDoneCb done);
|
|
||||||
//void readBytesUntil(char terminator, uint8_t *buffer, size_t length, AsyncTCPbufferDoneCb done);
|
|
||||||
|
|
||||||
void readBytes(char *buffer, size_t length, AsyncTCPbufferDoneCb done);
|
|
||||||
void readBytes(uint8_t *buffer, size_t length, AsyncTCPbufferDoneCb done);
|
|
||||||
|
|
||||||
// TODO implement
|
|
||||||
// void setTimeout(size_t timeout);
|
|
||||||
|
|
||||||
void onData(AsyncTCPbufferDataCb cb);
|
|
||||||
void onDisconnect(AsyncTCPbufferDisconnectCb cb);
|
|
||||||
|
|
||||||
IPAddress remoteIP();
|
|
||||||
uint16_t remotePort();
|
|
||||||
IPAddress localIP();
|
|
||||||
uint16_t localPort();
|
|
||||||
|
|
||||||
bool connected();
|
|
||||||
|
|
||||||
void stop();
|
|
||||||
void close();
|
|
||||||
|
|
||||||
protected:
|
|
||||||
AsyncClient* _client;
|
|
||||||
cbuf * _TXbufferRead;
|
|
||||||
cbuf * _TXbufferWrite;
|
|
||||||
cbuf * _RXbuffer;
|
|
||||||
atbRxMode_t _RXmode;
|
|
||||||
size_t _rxSize;
|
|
||||||
char _rxTerminator;
|
|
||||||
uint8_t * _rxReadBytesPtr;
|
|
||||||
String * _rxReadStringPtr;
|
|
||||||
|
|
||||||
AsyncTCPbufferDataCb _cbRX;
|
|
||||||
AsyncTCPbufferDoneCb _cbDone;
|
|
||||||
AsyncTCPbufferDisconnectCb _cbDisconnect;
|
|
||||||
|
|
||||||
void _attachCallbacks();
|
|
||||||
void _sendBuffer();
|
|
||||||
void _on_close();
|
|
||||||
void _rxData(uint8_t *buf, size_t len);
|
|
||||||
size_t _handleRxBuffer(uint8_t *buf, size_t len);
|
|
||||||
|
|
||||||
};
|
|
||||||
|
|
||||||
#endif /* ESPASYNCTCPBUFFER_H_ */
|
|
||||||
@@ -1,414 +0,0 @@
|
|||||||
/*
|
|
||||||
Asynchronous TCP library for Espressif MCUs
|
|
||||||
|
|
||||||
Copyright (c) 2016 Hristo Gochkov. All rights reserved.
|
|
||||||
This file is part of the esp8266 core for Arduino environment.
|
|
||||||
|
|
||||||
This library is free software; you can redistribute it and/or
|
|
||||||
modify it under the terms of the GNU Lesser General Public
|
|
||||||
License as published by the Free Software Foundation; either
|
|
||||||
version 2.1 of the License, or (at your option) any later version.
|
|
||||||
|
|
||||||
This library is distributed in the hope that it will be useful,
|
|
||||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
||||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
||||||
Lesser General Public License for more details.
|
|
||||||
|
|
||||||
You should have received a copy of the GNU Lesser General Public
|
|
||||||
License along with this library; if not, write to the Free Software
|
|
||||||
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
|
|
||||||
*/
|
|
||||||
#include "Arduino.h"
|
|
||||||
#include "SyncClient.h"
|
|
||||||
#include "ESPAsyncTCP.h"
|
|
||||||
#include "cbuf.h"
|
|
||||||
#include <interrupts.h>
|
|
||||||
|
|
||||||
#define DEBUG_ESP_SYNC_CLIENT
|
|
||||||
#if defined(DEBUG_ESP_SYNC_CLIENT) && !defined(SYNC_CLIENT_DEBUG)
|
|
||||||
#define SYNC_CLIENT_DEBUG( format, ...) DEBUG_GENERIC_P("[SYNC_CLIENT]", format, ##__VA_ARGS__)
|
|
||||||
#endif
|
|
||||||
#ifndef SYNC_CLIENT_DEBUG
|
|
||||||
#define SYNC_CLIENT_DEBUG(...) do { (void)0;} while(false)
|
|
||||||
#endif
|
|
||||||
|
|
||||||
/*
|
|
||||||
Without LWIP_NETIF_TX_SINGLE_PBUF, all tcp_writes default to "no copy".
|
|
||||||
Referenced data must be preserved and free-ed from the specified tcp_sent()
|
|
||||||
callback. Alternative, tcp_writes need to use the TCP_WRITE_FLAG_COPY
|
|
||||||
attribute.
|
|
||||||
*/
|
|
||||||
static_assert(LWIP_NETIF_TX_SINGLE_PBUF, "Required, tcp_write() must always copy.");
|
|
||||||
|
|
||||||
SyncClient::SyncClient(size_t txBufLen)
|
|
||||||
: _client(NULL)
|
|
||||||
, _tx_buffer(NULL)
|
|
||||||
, _tx_buffer_size(txBufLen)
|
|
||||||
, _rx_buffer(NULL)
|
|
||||||
, _ref(NULL)
|
|
||||||
{
|
|
||||||
ref();
|
|
||||||
}
|
|
||||||
|
|
||||||
SyncClient::SyncClient(AsyncClient *client, size_t txBufLen)
|
|
||||||
: _client(client)
|
|
||||||
, _tx_buffer(new (std::nothrow) cbuf(txBufLen))
|
|
||||||
, _tx_buffer_size(txBufLen)
|
|
||||||
, _rx_buffer(NULL)
|
|
||||||
, _ref(NULL)
|
|
||||||
{
|
|
||||||
if(ref() > 0 && _client != NULL)
|
|
||||||
_attachCallbacks();
|
|
||||||
}
|
|
||||||
|
|
||||||
SyncClient::~SyncClient(){
|
|
||||||
if (0 == unref())
|
|
||||||
_release();
|
|
||||||
}
|
|
||||||
|
|
||||||
void SyncClient::_release(){
|
|
||||||
if(_client != NULL){
|
|
||||||
_client->onData(NULL, NULL);
|
|
||||||
_client->onAck(NULL, NULL);
|
|
||||||
_client->onPoll(NULL, NULL);
|
|
||||||
_client->abort();
|
|
||||||
_client = NULL;
|
|
||||||
}
|
|
||||||
if(_tx_buffer != NULL){
|
|
||||||
cbuf *b = _tx_buffer;
|
|
||||||
_tx_buffer = NULL;
|
|
||||||
delete b;
|
|
||||||
}
|
|
||||||
while(_rx_buffer != NULL){
|
|
||||||
cbuf *b = _rx_buffer;
|
|
||||||
_rx_buffer = _rx_buffer->next;
|
|
||||||
delete b;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
int SyncClient::ref(){
|
|
||||||
if(_ref == NULL){
|
|
||||||
_ref = new (std::nothrow) int;
|
|
||||||
if(_ref != NULL)
|
|
||||||
*_ref = 0;
|
|
||||||
else
|
|
||||||
return -1;
|
|
||||||
}
|
|
||||||
return (++*_ref);
|
|
||||||
}
|
|
||||||
|
|
||||||
int SyncClient::unref(){
|
|
||||||
int count = -1;
|
|
||||||
if (_ref != NULL) {
|
|
||||||
count = --*_ref;
|
|
||||||
if (0 == count) {
|
|
||||||
delete _ref;
|
|
||||||
_ref = NULL;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return count;
|
|
||||||
}
|
|
||||||
|
|
||||||
#if ASYNC_TCP_SSL_ENABLED
|
|
||||||
int SyncClient::_connect(const IPAddress& ip, uint16_t port, bool secure){
|
|
||||||
#else
|
|
||||||
int SyncClient::_connect(const IPAddress& ip, uint16_t port){
|
|
||||||
#endif
|
|
||||||
if(connected())
|
|
||||||
return 0;
|
|
||||||
if(_client != NULL)
|
|
||||||
delete _client;
|
|
||||||
|
|
||||||
_client = new (std::nothrow) AsyncClient();
|
|
||||||
if (_client == NULL)
|
|
||||||
return 0;
|
|
||||||
|
|
||||||
_client->onConnect([](void *obj, AsyncClient *c){ ((SyncClient*)(obj))->_onConnect(c); }, this);
|
|
||||||
_attachCallbacks_Disconnect();
|
|
||||||
#if ASYNC_TCP_SSL_ENABLED
|
|
||||||
if(_client->connect(ip, port, secure)){
|
|
||||||
#else
|
|
||||||
if(_client->connect(ip, port)){
|
|
||||||
#endif
|
|
||||||
while(_client != NULL && !_client->connected() && !_client->disconnecting())
|
|
||||||
delay(1);
|
|
||||||
return connected();
|
|
||||||
}
|
|
||||||
return 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
#if ASYNC_TCP_SSL_ENABLED
|
|
||||||
int SyncClient::connect(const char *host, uint16_t port, bool secure){
|
|
||||||
#else
|
|
||||||
int SyncClient::connect(const char *host, uint16_t port){
|
|
||||||
#endif
|
|
||||||
if(connected())
|
|
||||||
return 0;
|
|
||||||
if(_client != NULL)
|
|
||||||
delete _client;
|
|
||||||
|
|
||||||
_client = new (std::nothrow) AsyncClient();
|
|
||||||
if (_client == NULL)
|
|
||||||
return 0;
|
|
||||||
|
|
||||||
_client->onConnect([](void *obj, AsyncClient *c){ ((SyncClient*)(obj))->_onConnect(c); }, this);
|
|
||||||
_attachCallbacks_Disconnect();
|
|
||||||
#if ASYNC_TCP_SSL_ENABLED
|
|
||||||
if(_client->connect(host, port, secure)){
|
|
||||||
#else
|
|
||||||
if(_client->connect(host, port)){
|
|
||||||
#endif
|
|
||||||
while(_client != NULL && !_client->connected() && !_client->disconnecting())
|
|
||||||
delay(1);
|
|
||||||
return connected();
|
|
||||||
}
|
|
||||||
return 0;
|
|
||||||
}
|
|
||||||
//#define SYNCCLIENT_NEW_OPERATOR_EQUAL
|
|
||||||
#ifdef SYNCCLIENT_NEW_OPERATOR_EQUAL
|
|
||||||
/*
|
|
||||||
New behavior for operator=
|
|
||||||
|
|
||||||
Allow for the object to be placed on a queue and transfered to a new container
|
|
||||||
with buffers still in tact. Avoiding receive data drops. Transfers rx and tx
|
|
||||||
buffers. Supports return by value.
|
|
||||||
|
|
||||||
Note, this is optional, the old behavior is the default.
|
|
||||||
|
|
||||||
*/
|
|
||||||
SyncClient & SyncClient::operator=(const SyncClient &other){
|
|
||||||
int *rhsref = other._ref;
|
|
||||||
++*rhsref; // Just in case the left and right side are the same object with different containers
|
|
||||||
if (0 == unref())
|
|
||||||
_release();
|
|
||||||
_ref = other._ref;
|
|
||||||
ref();
|
|
||||||
--*rhsref;
|
|
||||||
// Why do I not test _tx_buffer for != NULL and free?
|
|
||||||
// I allow for the lh target container, to be a copy of an active
|
|
||||||
// connection. Thus we are just reusing the container.
|
|
||||||
// The above unref() handles releaseing the previous client of the container.
|
|
||||||
_tx_buffer_size = other._tx_buffer_size;
|
|
||||||
_tx_buffer = other._tx_buffer;
|
|
||||||
_client = other._client;
|
|
||||||
if (_client != NULL && _tx_buffer == NULL)
|
|
||||||
_tx_buffer = new (std::nothrow) cbuf(_tx_buffer_size);
|
|
||||||
|
|
||||||
_rx_buffer = other._rx_buffer;
|
|
||||||
if(_client)
|
|
||||||
_attachCallbacks();
|
|
||||||
return *this;
|
|
||||||
}
|
|
||||||
#else // ! SYNCCLIENT_NEW_OPERATOR_EQUAL
|
|
||||||
// This is the origianl logic with null checks
|
|
||||||
SyncClient & SyncClient::operator=(const SyncClient &other){
|
|
||||||
if(_client != NULL){
|
|
||||||
_client->abort();
|
|
||||||
_client->free();
|
|
||||||
_client = NULL;
|
|
||||||
}
|
|
||||||
_tx_buffer_size = other._tx_buffer_size;
|
|
||||||
if(_tx_buffer != NULL){
|
|
||||||
cbuf *b = _tx_buffer;
|
|
||||||
_tx_buffer = NULL;
|
|
||||||
delete b;
|
|
||||||
}
|
|
||||||
while(_rx_buffer != NULL){
|
|
||||||
cbuf *b = _rx_buffer;
|
|
||||||
_rx_buffer = b->next;
|
|
||||||
delete b;
|
|
||||||
}
|
|
||||||
if(other._client != NULL)
|
|
||||||
_tx_buffer = new (std::nothrow) cbuf(other._tx_buffer_size);
|
|
||||||
|
|
||||||
_client = other._client;
|
|
||||||
if(_client)
|
|
||||||
_attachCallbacks();
|
|
||||||
|
|
||||||
return *this;
|
|
||||||
}
|
|
||||||
#endif
|
|
||||||
|
|
||||||
void SyncClient::setTimeout(uint32_t seconds){
|
|
||||||
if(_client != NULL)
|
|
||||||
_client->setRxTimeout(seconds);
|
|
||||||
}
|
|
||||||
|
|
||||||
uint8_t SyncClient::status(){
|
|
||||||
if(_client == NULL)
|
|
||||||
return 0;
|
|
||||||
return _client->state();
|
|
||||||
}
|
|
||||||
|
|
||||||
uint8_t SyncClient::connected(){
|
|
||||||
return (_client != NULL && _client->connected());
|
|
||||||
}
|
|
||||||
|
|
||||||
bool SyncClient::stop(unsigned int maxWaitMs){
|
|
||||||
(void)maxWaitMs;
|
|
||||||
if(_client != NULL)
|
|
||||||
_client->close(true);
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
|
|
||||||
size_t SyncClient::_sendBuffer(){
|
|
||||||
if(_client == NULL || _tx_buffer == NULL)
|
|
||||||
return 0;
|
|
||||||
size_t available = _tx_buffer->available();
|
|
||||||
if(!connected() || !_client->canSend() || available == 0)
|
|
||||||
return 0;
|
|
||||||
size_t sendable = _client->space();
|
|
||||||
if(sendable < available)
|
|
||||||
available= sendable;
|
|
||||||
char *out = new (std::nothrow) char[available];
|
|
||||||
if(out == NULL)
|
|
||||||
return 0;
|
|
||||||
|
|
||||||
_tx_buffer->read(out, available);
|
|
||||||
size_t sent = _client->write(out, available);
|
|
||||||
delete[] out;
|
|
||||||
return sent;
|
|
||||||
}
|
|
||||||
|
|
||||||
void SyncClient::_onData(void *data, size_t len){
|
|
||||||
_client->ackLater();
|
|
||||||
cbuf *b = new (std::nothrow) cbuf(len+1);
|
|
||||||
if(b != NULL){
|
|
||||||
b->write((const char *)data, len);
|
|
||||||
if(_rx_buffer == NULL)
|
|
||||||
_rx_buffer = b;
|
|
||||||
else {
|
|
||||||
cbuf *p = _rx_buffer;
|
|
||||||
while(p->next != NULL)
|
|
||||||
p = p->next;
|
|
||||||
p->next = b;
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
// We ran out of memory. This fail causes lost receive data.
|
|
||||||
// The connection should be closed in a manner that conveys something
|
|
||||||
// bad/abnormal has happened to the connection. Hence, we abort the
|
|
||||||
// connection to avoid possible data corruption.
|
|
||||||
// Note, callbacks maybe called.
|
|
||||||
_client->abort();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
void SyncClient::_onDisconnect(){
|
|
||||||
if(_client != NULL){
|
|
||||||
_client = NULL;
|
|
||||||
}
|
|
||||||
if(_tx_buffer != NULL){
|
|
||||||
cbuf *b = _tx_buffer;
|
|
||||||
_tx_buffer = NULL;
|
|
||||||
delete b;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
void SyncClient::_onConnect(AsyncClient *c){
|
|
||||||
_client = c;
|
|
||||||
if(_tx_buffer != NULL){
|
|
||||||
cbuf *b = _tx_buffer;
|
|
||||||
_tx_buffer = NULL;
|
|
||||||
delete b;
|
|
||||||
}
|
|
||||||
_tx_buffer = new (std::nothrow) cbuf(_tx_buffer_size);
|
|
||||||
_attachCallbacks_AfterConnected();
|
|
||||||
}
|
|
||||||
|
|
||||||
void SyncClient::_attachCallbacks(){
|
|
||||||
_attachCallbacks_Disconnect();
|
|
||||||
_attachCallbacks_AfterConnected();
|
|
||||||
}
|
|
||||||
|
|
||||||
void SyncClient::_attachCallbacks_AfterConnected(){
|
|
||||||
_client->onAck([](void *obj, AsyncClient* c, size_t len, uint32_t time){ (void)c; (void)len; (void)time; ((SyncClient*)(obj))->_sendBuffer(); }, this);
|
|
||||||
_client->onData([](void *obj, AsyncClient* c, void *data, size_t len){ (void)c; ((SyncClient*)(obj))->_onData(data, len); }, this);
|
|
||||||
_client->onTimeout([](void *obj, AsyncClient* c, uint32_t time){ (void)obj; (void)time; c->close(); }, this);
|
|
||||||
}
|
|
||||||
|
|
||||||
void SyncClient::_attachCallbacks_Disconnect(){
|
|
||||||
_client->onDisconnect([](void *obj, AsyncClient* c){ ((SyncClient*)(obj))->_onDisconnect(); delete c; }, this);
|
|
||||||
}
|
|
||||||
|
|
||||||
size_t SyncClient::write(uint8_t data){
|
|
||||||
return write(&data, 1);
|
|
||||||
}
|
|
||||||
|
|
||||||
size_t SyncClient::write(const uint8_t *data, size_t len){
|
|
||||||
if(_tx_buffer == NULL || !connected()){
|
|
||||||
return 0;
|
|
||||||
}
|
|
||||||
size_t toWrite = 0;
|
|
||||||
size_t toSend = len;
|
|
||||||
while(_tx_buffer->room() < toSend){
|
|
||||||
toWrite = _tx_buffer->room();
|
|
||||||
_tx_buffer->write((const char*)data, toWrite);
|
|
||||||
while(connected() && !_client->canSend())
|
|
||||||
delay(0);
|
|
||||||
if(!connected())
|
|
||||||
return 0;
|
|
||||||
_sendBuffer();
|
|
||||||
toSend -= toWrite;
|
|
||||||
}
|
|
||||||
_tx_buffer->write((const char*)(data+(len - toSend)), toSend);
|
|
||||||
if(connected() && _client->canSend())
|
|
||||||
_sendBuffer();
|
|
||||||
return len;
|
|
||||||
}
|
|
||||||
|
|
||||||
int SyncClient::available(){
|
|
||||||
if(_rx_buffer == NULL) return 0;
|
|
||||||
size_t a = 0;
|
|
||||||
cbuf *b = _rx_buffer;
|
|
||||||
while(b != NULL){
|
|
||||||
a += b->available();
|
|
||||||
b = b->next;
|
|
||||||
}
|
|
||||||
return a;
|
|
||||||
}
|
|
||||||
|
|
||||||
int SyncClient::peek(){
|
|
||||||
if(_rx_buffer == NULL) return -1;
|
|
||||||
return _rx_buffer->peek();
|
|
||||||
}
|
|
||||||
|
|
||||||
int SyncClient::read(uint8_t *data, size_t len){
|
|
||||||
if(_rx_buffer == NULL) return -1;
|
|
||||||
|
|
||||||
size_t readSoFar = 0;
|
|
||||||
while(_rx_buffer != NULL && (len - readSoFar) >= _rx_buffer->available()){
|
|
||||||
cbuf *b = _rx_buffer;
|
|
||||||
_rx_buffer = _rx_buffer->next;
|
|
||||||
size_t toRead = b->available();
|
|
||||||
readSoFar += b->read((char*)(data+readSoFar), toRead);
|
|
||||||
if(connected()){
|
|
||||||
_client->ack(b->size() - 1);
|
|
||||||
}
|
|
||||||
delete b;
|
|
||||||
}
|
|
||||||
if(_rx_buffer != NULL && readSoFar < len){
|
|
||||||
readSoFar += _rx_buffer->read((char*)(data+readSoFar), (len - readSoFar));
|
|
||||||
}
|
|
||||||
return readSoFar;
|
|
||||||
}
|
|
||||||
|
|
||||||
int SyncClient::read(){
|
|
||||||
uint8_t res = 0;
|
|
||||||
if(read(&res, 1) != 1)
|
|
||||||
return -1;
|
|
||||||
return res;
|
|
||||||
}
|
|
||||||
|
|
||||||
bool SyncClient::flush(unsigned int maxWaitMs){
|
|
||||||
(void)maxWaitMs;
|
|
||||||
if(_tx_buffer == NULL || !connected())
|
|
||||||
return false;
|
|
||||||
if(_tx_buffer->available()){
|
|
||||||
while(connected() && !_client->canSend())
|
|
||||||
delay(0);
|
|
||||||
if(_client == NULL || _tx_buffer == NULL)
|
|
||||||
return false;
|
|
||||||
_sendBuffer();
|
|
||||||
}
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user