Skip to content

Commit e26e499

Browse files
authored
Merge branch 'master' into master
2 parents a3cac65 + cceebb5 commit e26e499

File tree

241 files changed

+11911
-3290
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

241 files changed

+11911
-3290
lines changed

.github/workflows/build_py_tools.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ jobs:
2222
fetch-depth: 2
2323
ref: ${{ github.event.pull_request.head.ref }}
2424
- name: Verify Python Tools Changed
25-
uses: tj-actions/changed-files@v36
25+
uses: tj-actions/changed-files@v41
2626
id: verify-changed-files
2727
with:
2828
fetch_depth: '2'

.github/workflows/docs.yml renamed to .github/workflows/docs_build.yml

+12-6
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: ReadTheDocs CI
1+
name: Documentation Build and Deploy CI
22

33
on:
44
push:
@@ -7,16 +7,16 @@ on:
77
- release/*
88
paths:
99
- 'docs/**'
10-
- '.github/workflows/docs.yml'
10+
- '.github/workflows/docs_build.yml'
1111
pull_request:
1212
paths:
1313
- 'docs/**'
14-
- '.github/workflows/docs.yml'
14+
- '.github/workflows/docs_build.yml'
1515

1616
jobs:
1717

1818
build-docs:
19-
name: Build ReadTheDocs
19+
name: Build ESP-Docs
2020
runs-on: ubuntu-22.04
2121
defaults:
2222
run:
@@ -34,5 +34,11 @@ jobs:
3434
sudo apt install python3-pip python3-setuptools
3535
# GitHub CI installs pip3 and setuptools outside the path.
3636
# Update the path to include them and run.
37-
PATH=/home/runner/.local/bin:$PATH pip3 install --user -r ./docs/requirements.txt
38-
cd ./docs && PATH=/home/runner/.local/bin:$PATH SPHINXOPTS="-W" make html
37+
cd ./docs
38+
PATH=/home/runner/.local/bin:$PATH pip3 install -r requirements.txt --prefer-binary
39+
PATH=/home/runner/.local/bin:$PATH SPHINXOPTS="-W" build-docs -l en
40+
- name: Archive Docs
41+
uses: actions/upload-artifact@v2
42+
with:
43+
name: docs
44+
path: docs

.github/workflows/docs_deploy.yml

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: Documentation Build and Production Deploy CI
2+
3+
on:
4+
release:
5+
types: [published]
6+
push:
7+
branches:
8+
- release/*
9+
- master
10+
paths:
11+
- 'docs/**'
12+
- '.github/workflows/docs_deploy.yml'
13+
14+
jobs:
15+
16+
deploy-prod-docs:
17+
name: Deploy Documentation on Production
18+
runs-on: ubuntu-22.04
19+
defaults:
20+
run:
21+
shell: bash
22+
steps:
23+
- uses: actions/checkout@v3
24+
with:
25+
submodules: true
26+
- uses: actions/setup-python@v4
27+
with:
28+
python-version: '3.10'
29+
- name: Deploy Documentation
30+
env:
31+
# Deploy to production server
32+
# DOCS_BUILD_DIR: "./docs/_build/"
33+
DOCS_DEPLOY_PRIVATEKEY: ${{ secrets.DOCS_KEY }}
34+
DOCS_DEPLOY_PATH: ${{ secrets.DOCS_PATH }}
35+
DOCS_DEPLOY_SERVER: ${{ secrets.DOCS_SERVER }}
36+
DOCS_DEPLOY_SERVER_USER: ${{ secrets.DOCS_USER }}
37+
DOCS_DEPLOY_URL_BASE: ${{ secrets.DOCS_URL }}
38+
run: |
39+
sudo apt update
40+
sudo apt install python3-pip python3-setuptools
41+
source ./docs/utils.sh
42+
add_doc_server_ssh_keys $DOCS_DEPLOY_PRIVATEKEY $DOCS_DEPLOY_SERVER $DOCS_DEPLOY_SERVER_USER
43+
export GIT_VER=$(git describe --always)
44+
echo "PIP install requirements..."
45+
pip3 install --user -r ./docs/requirements.txt
46+
echo "Building the Docs..."
47+
cd ./docs && build-docs -l en
48+
echo "Deploy the Docs..."
49+
export DOCS_BUILD_DIR=$GITHUB_WORKSPACE/docs/
50+
cd $GITHUB_WORKSPACE/docs
51+
deploy-docs

CMakeLists.txt

+2-1
Original file line numberDiff line numberDiff line change
@@ -50,13 +50,14 @@ set(CORE_SRCS
5050
cores/esp32/Esp.cpp
5151
cores/esp32/FunctionalInterrupt.cpp
5252
cores/esp32/HardwareSerial.cpp
53+
cores/esp32/HEXBuilder.cpp
5354
cores/esp32/IPAddress.cpp
54-
cores/esp32/IPv6Address.cpp
5555
cores/esp32/libb64/cdecode.c
5656
cores/esp32/libb64/cencode.c
5757
cores/esp32/main.cpp
5858
cores/esp32/MD5Builder.cpp
5959
cores/esp32/Print.cpp
60+
cores/esp32/SHA1Builder.cpp
6061
cores/esp32/stdlib_noniso.c
6162
cores/esp32/Stream.cpp
6263
cores/esp32/StreamString.cpp

README.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# Arduino core for the ESP32, ESP32-S2, ESP32-S3, ESP32-C3, ESP32-C6 and ESP32-H2
22

3-
![Build Status](https://github.com/espressif/arduino-esp32/workflows/ESP32%20Arduino%20CI/badge.svg) [![Documentation Status](https://readthedocs.com/projects/espressif-arduino-esp32/badge/?version=latest)](https://docs.espressif.com/projects/arduino-esp32/en/latest/?badge=latest)
4-
[![External Libraries Test](https://github.com/espressif/arduino-esp32/actions/workflows/lib.yml/badge.svg?branch=master&event=schedule)](https://github.com/espressif/arduino-esp32/actions/workflows/lib.yml?link=http://https://github.com/espressif/arduino-esp32/blob/master/LIBRARIES_TEST.md)
3+
![Build Status](https://github.com/espressif/arduino-esp32/workflows/ESP32%20Arduino%20CI/badge.svg) [![External Libraries Test](https://github.com/espressif/arduino-esp32/actions/workflows/lib.yml/badge.svg?branch=master&event=schedule)](https://github.com/espressif/arduino-esp32/actions/workflows/lib.yml?link=http://https://github.com/espressif/arduino-esp32/blob/master/LIBRARIES_TEST.md)
54

65
### Need help or have a question? Join the chat at [Gitter](https://gitter.im/espressif/arduino-esp32) or [open a new Discussion](https://github.com/espressif/arduino-esp32/discussions)
76

@@ -37,6 +36,10 @@ You can use the [Arduino-ESP32 Online Documentation](https://docs.espressif.com/
3736

3837
---
3938

39+
**APIs compatibility with ESP8266 and Arduino-CORE (Arduino.cc) is explained [here](https://docs.espressif.com/projects/arduino-esp32/en/latest/libraries.html#apis).**
40+
41+
---
42+
4043
* [Getting Started](https://docs.espressif.com/projects/arduino-esp32/en/latest/getting_started.html)
4144
* [Installing (Windows, Linux and macOS)](https://docs.espressif.com/projects/arduino-esp32/en/latest/installing.html)
4245
* [Libraries](https://docs.espressif.com/projects/arduino-esp32/en/latest/libraries.html)

0 commit comments

Comments
 (0)