feat(esp32): Server Side Events (SSE)

.github/ISSUE_TEMPLATE/Issue-report.yml

@@ -41,6 +41,17 @@ body:
       options:
         - latest master (checkout manually)
         - latest development Release Candidate (RC-X)
+        - v2.0.14
+        - v2.0.13
+        - v2.0.12
+        - v2.0.11
+        - v2.0.10
+        - v2.0.9
+        - v2.0.8
+        - v2.0.7
+        - v2.0.6
+        - v2.0.5 
+        - v2.0.4
         - v2.0.3
         - v2.0.2
         - v2.0.1

.github/PULL_REQUEST_TEMPLATE.md

@@ -5,6 +5,7 @@
 2. [ ] Please provide related links (*eg. Issue which will be closed by this Pull Request*)
 3. [ ] Please **update relevant Documentation** if applicable
 4. [ ] Please check [Contributing guide](https://docs.espressif.com/projects/arduino-esp32/en/latest/contributing.html)
+5. [ ] Please **confirm option to "Allow edits and access to secrets by maintainers"** when opening a Pull Request
 
 *This entire section above can be deleted if all items are checked.*
 

.github/pytools/Sign-File.ps1

@@ -0,0 +1,78 @@
+[CmdletBinding()]
+param (
+    [Parameter()]
+    [String]
+    $Path
+)
+
+
+function FindSignTool {
+    $SignTool = "signtool.exe"
+    if (Get-Command $SignTool -ErrorAction SilentlyContinue) {
+        return $SignTool
+    }
+    $SignTool = "${env:ProgramFiles(x86)}\Windows Kits\10\bin\x64\signtool.exe"
+    if (Test-Path -Path $SignTool -PathType Leaf) {
+        return $SignTool
+    }
+    $SignTool = "${env:ProgramFiles(x86)}\Windows Kits\10\bin\x86\signtool.exe"
+    if (Test-Path -Path $SignTool -PathType Leaf) {
+        return $SignTool
+    }
+    $sdkVers = "10.0.22000.0", "10.0.20348.0", "10.0.19041.0", "10.0.17763.0"
+    Foreach ($ver in $sdkVers)
+    {
+        $SignTool = "${env:ProgramFiles(x86)}\Windows Kits\10\bin\${ver}\x64\signtool.exe"
+        if (Test-Path -Path $SignTool -PathType Leaf) {
+            return $SignTool
+        }
+    }
+    "signtool.exe not found"
+    Exit 1
+}
+
+function SignEsptool {
+    param(
+        [Parameter()]
+        [String]
+        $Path
+    )
+
+    $SignTool = FindSignTool
+    "Using: $SignTool"
+    $CertificateFile = [system.io.path]::GetTempPath() + "certificate.pfx"
+
+    if ($null -eq $env:CERTIFICATE) {
+        "CERTIFICATE variable not set, unable to sign the file"
+        Exit 1
+    }
+
+    if ("" -eq $env:CERTIFICATE) {
+        "CERTIFICATE variable is empty, unable to sign the file"
+        Exit 1
+    }
+
+    $SignParameters = @("sign", "/tr", 'http://timestamp.digicert.com', "/td", "SHA256", "/f", $CertificateFile, "/fd", "SHA256")
+    if ($env:CERTIFICATE_PASSWORD) {
+        "CERTIFICATE_PASSWORD detected, using the password"
+        $SignParameters += "/p"
+        $SignParameters += $env:CERTIFICATE_PASSWORD
+    }
+    $SignParameters += $Path
+
+    [byte[]]$CertificateBytes = [convert]::FromBase64String($env:CERTIFICATE)
+    [IO.File]::WriteAllBytes($CertificateFile, $CertificateBytes)
+
+    &$SignTool $SignParameters
+
+    if (0 -eq $LASTEXITCODE) {
+        Remove-Item $CertificateFile
+    } else {
+        Remove-Item $CertificateFile
+        "Signing failed"
+        Exit 1
+    }
+
+}
+
+SignEsptool ${Path}

.github/scripts/find_all_boards.sh

@@ -0,0 +1,35 @@
+#!/bin/bash
+
+# Get all boards
+boards_array=()
+
+for line in `grep '.tarch=' boards.txt`; do
+    board_name=$(echo "$line" | cut -d '.' -f1 | cut -d '#' -f1)
+    boards_array+=("espressif:esp32:$board_name")
+    echo "Added 'espressif:esp32:$board_name' to array"
+done
+
+# Create JSON like string with all boards found and pass it to env variable
+board_count=${#boards_array[@]}
+echo "Boards found: $board_count"
+echo "BOARD-COUNT=$board_count" >> $GITHUB_ENV
+
+if [ $board_count -gt 0 ]
+then
+    json_matrix='['
+    for board in ${boards_array[@]}
+    do
+        json_matrix+='"'$board'"'
+        if [ $board_count -gt 1 ]
+        then
+            json_matrix+=","
+        fi
+        board_count=$(($board_count - 1))
+    done
+    json_matrix+=']'
+
+    echo $json_matrix
+    echo "FQBNS=${json_matrix}" >> $GITHUB_ENV
+else
+    echo "FQBNS=" >> $GITHUB_ENV
+fi

.github/scripts/find_new_boards.sh

@@ -0,0 +1,90 @@
+#!/bin/bash
+
+# Get inputs from command
+owner_repository=$1
+pr_number=$2
+
+url="https://api.github.com/repos/$owner_repository/pulls/$pr_number/files"
+echo $url
+
+# Get changes in boards.txt file from PR
+Patch=$(curl $url | jq -r '.[] | select(.filename == "boards.txt") | .patch ')
+
+# Extract only changed lines number and count
+substring_patch=$(echo "$Patch" | grep -o '@@[^@]*@@')
+
+params_array=()
+
+IFS=$'\n' read -d '' -ra params <<< $(echo "$substring_patch" | grep -oE '[-+][0-9]+,[0-9]+')
+
+for param in "${params[@]}"
+do
+    echo "The parameter is $param"
+    params_array+=("$param")
+done
+
+boards_array=()
+previous_board=""
+file="boards.txt"
+
+# Loop through boards.txt file and extract all boards that were added
+for (( c=0; c<${#params_array[@]}; c+=2 ))
+do
+    deletion_count=$( echo "${params_array[c]}" | cut -d',' -f2 | cut -d' ' -f1 )
+    addition_line=$( echo "${params_array[c+1]}" | cut -d'+' -f2 | cut -d',' -f1 )
+    addition_count=$( echo "${params_array[c+1]}" | cut -d'+' -f2 | cut -d',' -f2 | cut -d' ' -f1 )
+    addition_end=$(($addition_line+$addition_count))
+
+    addition_line=$(($addition_line + 3))
+    addition_end=$(($addition_end - $deletion_count))
+
+    echo $addition_line
+    echo $addition_end
+
+    i=0
+
+    while read -r line
+    do
+    i=$((i+1))
+    if [ $i -lt $addition_line ]
+    then
+    continue
+    elif [ $i -gt $addition_end ]
+    then
+    break
+    fi
+    board_name=$(echo "$line" | cut -d '.' -f1 | cut -d '#' -f1)
+    if [ "$board_name" != "" ]
+    then
+        if [ "$board_name" != "$previous_board" ]
+        then
+            boards_array+=("espressif:esp32:$board_name")
+            previous_board="$board_name"
+            echo "Added 'espressif:esp32:$board_name' to array"
+        fi
+    fi
+    done < "$file"
+done
+
+# Create JSON like string with all boards found and pass it to env variable
+board_count=${#boards_array[@]}
+
+if [ $board_count -gt 0 ]
+then
+    json_matrix='{"fqbn": ['
+    for board in ${boards_array[@]}
+    do
+        json_matrix+='"'$board'"'
+        if [ $board_count -gt 1 ]
+        then
+            json_matrix+=","
+        fi
+        board_count=$(($board_count - 1))
+    done
+    json_matrix+=']}'
+
+    echo $json_matrix
+    echo "FQBNS=${json_matrix}" >> $GITHUB_ENV
+else
+    echo "FQBNS=" >> $GITHUB_ENV
+fi

.github/scripts/install-arduino-cli.sh

@@ -0,0 +1,46 @@
+#!/bin/bash
+
+OSBITS=`arch`
+if [[ "$OSTYPE" == "linux"* ]]; then
+    export OS_IS_LINUX="1"
+    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"
+    OS_NAME="macosx"
+elif [[ "$OSTYPE" == "cygwin" ]] || [[ "$OSTYPE" == "msys" ]] || [[ "$OSTYPE" == "win32" ]]; then
+    export OS_IS_WINDOWS="1"
+    OS_NAME="windows"
+else
+    OS_NAME="$OSTYPE-$OSBITS"
+    echo "Unknown OS '$OS_NAME'"
+    exit 1
+fi
+export OS_NAME
+
+if [ "$OS_IS_MACOS" == "1" ]; then
+    export ARDUINO_IDE_PATH="$HOME/bin"
+    export ARDUINO_USR_PATH="$HOME/Documents/Arduino"
+elif [ "$OS_IS_WINDOWS" == "1" ]; then
+    export ARDUINO_IDE_PATH="$HOME/bin"
+    export ARDUINO_USR_PATH="$HOME/Documents/Arduino"
+else
+    export ARDUINO_IDE_PATH="$HOME/bin"
+    export ARDUINO_USR_PATH="$HOME/Arduino"
+fi
+
+if [ ! -d "$ARDUINO_IDE_PATH" ] || [ ! -f "$ARDUINO_IDE_PATH/arduino-cli" ]; then
+    echo "Installing Arduino CLI on $OS_NAME ..."
+    mkdir -p "$ARDUINO_IDE_PATH"
+    curl -fsSL https://raw.githubusercontent.com/arduino/arduino-cli/master/install.sh | BINDIR="$ARDUINO_IDE_PATH" sh
+fi
+

.github/scripts/install-platformio-esp32.sh

@@ -3,8 +3,8 @@
 export PLATFORMIO_ESP32_PATH="$HOME/.platformio/packages/framework-arduinoespressif32"
 PLATFORMIO_ESP32_URL="https://github.com/platformio/platform-espressif32.git"
 
-TOOLCHAIN_VERSION="8.4.0+2021r2-patch3"
-ESPTOOLPY_VERSION="~1.30100.0"
+TOOLCHAIN_VERSION="12.2.0+20230208"
+ESPTOOLPY_VERSION="~1.40501.0"
 ESPRESSIF_ORGANIZATION_NAME="espressif"
 
 echo "Installing Python Wheel ..."
@@ -30,9 +30,15 @@ replace_script+="data['packages']['toolchain-riscv32-esp']['owner']='$ESPRESSIF_
 # Update versions to use the upstream
 replace_script+="data['packages']['toolchain-xtensa-esp32']['version']='$TOOLCHAIN_VERSION';"
 replace_script+="data['packages']['toolchain-xtensa-esp32s2']['version']='$TOOLCHAIN_VERSION';"
+replace_script+="data['packages']['toolchain-xtensa-esp32s3']['version']='$TOOLCHAIN_VERSION';"
 replace_script+="data['packages']['toolchain-riscv32-esp']['version']='$TOOLCHAIN_VERSION';"
-# Add ESP32-S3 Toolchain
-replace_script+="data['packages'].update({'toolchain-xtensa-esp32s3':{'type':'toolchain','optional':True,'owner':'$ESPRESSIF_ORGANIZATION_NAME','version':'$TOOLCHAIN_VERSION'}});"
+# Add new "framework-arduinoespressif32-libs" package
+# Read "package_esp32_index.template.json" to extract a url to a zip package for "esp32-arduino-libs"
+replace_script+="fpackage=open(os.path.join('package', 'package_esp32_index.template.json'), 'r+');"
+replace_script+="package_data=json.load(fpackage);"
+replace_script+="fpackage.close();"
+replace_script+="libs_package_archive_url=next(next(system['url'] for system in tool['systems'] if system['host'] == 'x86_64-pc-linux-gnu') for tool in package_data['packages'][0]['tools'] if tool['name'] == 'esp32-arduino-libs');"
+replace_script+="data['packages'].update({'framework-arduinoespressif32-libs':{'type':'framework','optional':False,'version':libs_package_archive_url}});"
 replace_script+="data['packages']['toolchain-xtensa-esp32'].update({'optional':False});"
 # esptool.py may require an upstream version (for now platformio is the owner)
 replace_script+="data['packages']['tool-esptoolpy']['version']='$ESPTOOLPY_VERSION';"