Skip to content

Commit 08b6363

Browse files
authored
Merge branch 'master' into feature/idf_component_ci_and_ver_check
2 parents bb1c169 + d8a99ed commit 08b6363

File tree

4,319 files changed

+725023
-44932
lines changed

Some content is hidden

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

4,319 files changed

+725023
-44932
lines changed

Diff for: .github/ISSUE_TEMPLATE/Feature-request.yml

+62
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
name: Feature request
2+
description: Suggest an idea for this project
3+
labels: ["Type: Feature request"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
* We welcome any ideas or feature requests! It is helpful if you can explain exactly why the feature would be useful.
9+
* There are usually some outstanding feature requests in the [existing issues list](https://github.com/espressif/arduino-esp32/issues?q=is%3Aopen+is%3Aissue+label%3A%22Type%3A+Feature+request%22), feel free to add comments to them.
10+
* If you would like to contribute, please read the [contributions guide](https://docs.espressif.com/projects/arduino-esp32/en/latest/contributing.html).
11+
- type: input
12+
id: Area
13+
attributes:
14+
label: Related area
15+
description: Please briefly explain the area of your Feature Request.
16+
placeholder: eg. Board support, specific Peripheral, BT, Wifi...
17+
validations:
18+
required: true
19+
- type: input
20+
id: HW
21+
attributes:
22+
label: Hardware specification
23+
description: Please provide if your proposal depends on specific Hardware.
24+
placeholder: eg. Support for ESP32 DevKitC, ESP32-C3 DevKitM...
25+
validations:
26+
required: true
27+
- type: textarea
28+
id: problem-related
29+
attributes:
30+
label: Is your feature request related to a problem?
31+
description: Please provide a clear and concise description of what the problem is. Add relevant issue link.
32+
placeholder: ex. I'm facing the issue/missing function...
33+
validations:
34+
required: true
35+
- type: textarea
36+
id: solution
37+
attributes:
38+
label: Describe the solution you'd like
39+
description: Please provide a clear and concise description of what you want to happen.
40+
placeholder: ex. When using this function...
41+
validations:
42+
required: true
43+
- type: textarea
44+
id: alternatives
45+
attributes:
46+
label: Describe alternatives you've considered
47+
description: Please provide a clear and concise description of any alternative solutions or features you've considered.
48+
placeholder: ex. Choosing other approach wouldn't work, because...
49+
- type: textarea
50+
id: context
51+
attributes:
52+
label: Additional context
53+
description: Please add any other context or screenshots about the feature request here.
54+
placeholder: ex. This would work only when ...
55+
- type: checkboxes
56+
id: confirmation
57+
attributes:
58+
label: I have checked existing list of Feature requests and the Contribution Guide
59+
description: You agree to check all the resources above before opening a new Feature request.
60+
options:
61+
- label: I confirm I have checked existing list of Feature requests and Contribution Guide.
62+
required: true

Diff for: .github/ISSUE_TEMPLATE/Issue-report.yml

+132
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
name: Issue report
2+
description: Report any problem here
3+
labels: ["Status: Awaiting triage"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
* Before reporting a new issue please check and search in [List of existing issues](https://github.com/espressif/arduino-esp32/issues?q=is%3Aissue)
9+
* Please check [Online Documentation](https://docs.espressif.com/projects/arduino-esp32/en/latest/index.html)
10+
* Take a look on [Troubleshooting guide](https://docs.espressif.com/projects/arduino-esp32/en/latest/troubleshooting.html)
11+
* If still experiencing the issue, please provide as many details as possible below about your hardware, computer setup and code.
12+
- type: input
13+
id: Board
14+
attributes:
15+
label: Board
16+
description: On which Board does this issue occur?
17+
placeholder: eg. ESP32 Dev Module, ESP32-S2, LilyGo TTGO LoRa32...
18+
validations:
19+
required: true
20+
- type: textarea
21+
id: devboard
22+
attributes:
23+
label: Device Description
24+
description: What development board or other hardware is the chip attached to?
25+
placeholder: ex. DevKitC, plain module on breadboard, etc. If your hardware is custom or unusual, please attach a photo.
26+
validations:
27+
required: true
28+
- type: textarea
29+
id: other-hw
30+
attributes:
31+
label: Hardware Configuration
32+
description: Is anything else attached to the development board?
33+
placeholder: ex. GPIO 18 & 19 are connected to I2C devices.
34+
validations:
35+
required: true
36+
- type: dropdown
37+
id: version
38+
attributes:
39+
label: Version
40+
description: What version of Arduino ESP32 are you running? If possible, consider updating to the latest version.
41+
options:
42+
- latest master (checkout manually)
43+
- latest development Release Candidate (RC-X)
44+
- v2.0.2
45+
- v2.0.1
46+
- v2.0.0
47+
- v1.0.6
48+
- other
49+
validations:
50+
required: true
51+
- type: input
52+
id: IDE
53+
attributes:
54+
label: IDE Name
55+
description: What IDE are you using?
56+
placeholder: eg. Arduino IDE, PlatformIO, Sloeber...
57+
validations:
58+
required: true
59+
- type: input
60+
id: os
61+
attributes:
62+
label: Operating System
63+
description: On which OS does this issue occur?
64+
placeholder: ex. macOS 12.1, Windows 10...
65+
validations:
66+
required: true
67+
- type: input
68+
id: Flash
69+
attributes:
70+
label: Flash frequency
71+
description: What flash frequency is used?
72+
placeholder: eg. 40Mhz
73+
validations:
74+
required: true
75+
- type: dropdown
76+
id: PSRAM
77+
attributes:
78+
label: PSRAM enabled
79+
description: Is PSRAM enabled?
80+
options:
81+
- 'yes'
82+
- 'no'
83+
validations:
84+
required: true
85+
- type: input
86+
id: Upload
87+
attributes:
88+
label: Upload speed
89+
description: What upload speed is used?
90+
placeholder: eg. 115200
91+
validations:
92+
required: true
93+
- type: textarea
94+
id: Description
95+
attributes:
96+
label: Description
97+
description: Please describe your problem here and expected behaviour
98+
placeholder: ex. Can't connect/weird behaviour/wrong function/missing parameter..
99+
validations:
100+
required: true
101+
- type: textarea
102+
id: sketch
103+
attributes:
104+
label: Sketch
105+
description: Please provide full minimal sketch/code which can be run to reproduce your issue
106+
placeholder: ex. Related part of the code to replicate the issue
107+
render: cpp
108+
validations:
109+
required: true
110+
- type: textarea
111+
id: Debug
112+
attributes:
113+
label: Debug Message
114+
description: Please provide a debug message or error message. If you have a Guru Meditation Error or Backtrace, please decode it with [ExceptionDecoder](https://github.com/me-no-dev/EspExceptionDecoder)
115+
placeholder: Enable Core debug level - Debug on tools menu of Arduino IDE, then put the serial output here.
116+
render: plain
117+
validations:
118+
required: true
119+
- type: textarea
120+
id: other-remarks
121+
attributes:
122+
label: Other Steps to Reproduce
123+
description: Is there any other information you can think of which will help us reproduce this problem? Any additional info can be added as well.
124+
placeholder: ex. I also tried on other OS, HW...it works correctly on that setup.
125+
- type: checkboxes
126+
id: confirmation
127+
attributes:
128+
label: I have checked existing issues, online documentation and the Troubleshooting Guide
129+
description: You agree to check all the resources above before opening a new issue.
130+
options:
131+
- label: I confirm I have checked existing issues, online documentation and Troubleshooting guide.
132+
required: true

Diff for: .github/ISSUE_TEMPLATE/bug_report.md

-54
This file was deleted.

Diff for: .github/ISSUE_TEMPLATE/config.yml

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Arduino ESP32 Gitter Channel
4+
url: https://gitter.im/espressif/arduino-esp32
5+
about: Community channel for questions and help
6+
- name: ESP32 Forum - Arduino
7+
url: https://esp32.com/viewforum.php?f=19
8+
about: Official Forum for questions

Diff for: .github/PULL_REQUEST_TEMPLATE.md

+18-11
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,23 @@
1-
----------------------------------------------------------------------------------------------------------------------------------------------------
2-
This entire section can be deleted if all items are checked.
3-
4-
*By completing this PR sufficiently, you help us to improve the quality of Release Notes*
1+
*By completing this PR sufficiently, you help us to review this Pull Request quicker and also help improve the quality of Release Notes*
52

63
### Checklist
4+
1. [ ] Please provide specific title of the PR describing the change, including the component name (*eg. „Update of Documentation link on Readme.md“*)
5+
2. [ ] Please provide related links (*eg. Issue which will be closed by this Pull Request*)
6+
3. [ ] Please **update relevant Documentation** if applicable
7+
4. [ ] Please check [Contributing guide](https://docs.espressif.com/projects/arduino-esp32/en/latest/contributing.html)
8+
9+
*This entire section above can be deleted if all items are checked.*
10+
11+
-----------
12+
## Description of Change
13+
Please describe your proposed Pull Request and it's impact.
14+
15+
## Tests scenarios
16+
Please describe on what Hardware and Software combinations you have tested this Pull Request and how.
717

8-
1. [ ] Please provide specific title of the PR describing the change, including the component name (eg."Update of Documentation link on Readme.md")
9-
2. [ ] Please provide related links (eg. Issue, other Project, submodule PR..)
10-
----------------------------------------------------------------------------------------------------------------------------------------------------
18+
(*eg. I have tested my Pull Request on Arduino-esp32 core v2.0.2 with ESP32 and ESP32-S2 Board with this scenario*)
1119

12-
## Summary
13-
Please describe your proposed PR and what it contains.
20+
## Related links
21+
Please provide links to related issue, PRs etc.
1422

15-
## Impact
16-
Please describe impact of your PR and it's function.
23+
(*eg. Closes #number of issue*)

Diff for: .github/scripts/check-cmakelists.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#!/bin/bash
22
#
3-
# This script is for Travis. It checks all non-examples source files in libraries/ and cores/ are listed in
3+
# This script is used in the CI workflow. It checks all non-examples source files in libraries/ and cores/ are listed in
44
# CMakeLists.txt for the cmake-based IDF component
55
#
66
# If you see an error running this script, edit CMakeLists.txt and add any new source files into your PR

Diff for: .github/scripts/install-arduino-core-esp32.sh

+25-25
Original file line numberDiff line numberDiff line change
@@ -2,35 +2,35 @@
22

33
export ARDUINO_ESP32_PATH="$ARDUINO_USR_PATH/hardware/espressif/esp32"
44
if [ ! -d "$ARDUINO_ESP32_PATH" ]; then
5-
echo "Installing ESP32 Arduino Core ..."
6-
script_init_path="$PWD"
7-
mkdir -p "$ARDUINO_USR_PATH/hardware/espressif"
8-
cd "$ARDUINO_USR_PATH/hardware/espressif"
5+
echo "Installing ESP32 Arduino Core ..."
6+
script_init_path="$PWD"
7+
mkdir -p "$ARDUINO_USR_PATH/hardware/espressif"
8+
cd "$ARDUINO_USR_PATH/hardware/espressif"
99

10-
echo "Installing Python Serial ..."
11-
pip install pyserial > /dev/null
10+
echo "Installing Python Serial ..."
11+
pip install pyserial > /dev/null
1212

13-
if [ "$OS_IS_WINDOWS" == "1" ]; then
14-
echo "Installing Python Requests ..."
15-
pip install requests > /dev/null
16-
fi
13+
if [ "$OS_IS_WINDOWS" == "1" ]; then
14+
echo "Installing Python Requests ..."
15+
pip install requests > /dev/null
16+
fi
1717

18-
if [ "$GITHUB_REPOSITORY" == "espressif/arduino-esp32" ]; then
19-
echo "Linking Core..."
20-
ln -s $GITHUB_WORKSPACE esp32
21-
else
22-
echo "Cloning Core Repository..."
23-
git clone https://github.com/espressif/arduino-esp32.git esp32 > /dev/null 2>&1
24-
fi
18+
if [ ! -z "$GITHUB_REPOSITORY" ]; then
19+
echo "Linking Core..."
20+
ln -s $GITHUB_WORKSPACE esp32
21+
else
22+
echo "Cloning Core Repository..."
23+
git clone https://github.com/espressif/arduino-esp32.git esp32 > /dev/null 2>&1
24+
fi
2525

26-
#echo "Updating Submodules ..."
27-
cd esp32
28-
#git submodule update --init --recursive > /dev/null 2>&1
26+
#echo "Updating Submodules ..."
27+
cd esp32
28+
#git submodule update --init --recursive > /dev/null 2>&1
2929

30-
echo "Installing Platform Tools ..."
31-
cd tools && python get.py
32-
cd $script_init_path
30+
echo "Installing Platform Tools ..."
31+
cd tools && python get.py
32+
cd $script_init_path
3333

34-
echo "ESP32 Arduino has been installed in '$ARDUINO_ESP32_PATH'"
35-
echo ""
34+
echo "ESP32 Arduino has been installed in '$ARDUINO_ESP32_PATH'"
35+
echo ""
3636
fi

0 commit comments

Comments
 (0)