Skip to content

Commit e01fb70

Browse files
pedrominatelpedrominatel
authored
Merge branch 'master' into docs/suppoerted_ide
2 parents 9a2e3fa + 3a96fc0 commit e01fb70

File tree

2,141 files changed

+130587
-63405
lines changed

Some content is hidden

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

2,141 files changed

+130587
-63405
lines changed

‎.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

‎.github/ISSUE_TEMPLATE/Issue-report.yml

+131
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,131 @@
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
43+
- v2.0.2
44+
- v2.0.1
45+
- v2.0.0
46+
- v1.0.6
47+
- other
48+
validations:
49+
required: true
50+
- type: input
51+
id: IDE
52+
attributes:
53+
label: IDE Name
54+
description: What IDE are you using?
55+
placeholder: eg. Arduino IDE, PlatformIO, IDF component...
56+
validations:
57+
required: true
58+
- type: input
59+
id: os
60+
attributes:
61+
label: Operating System
62+
description: On which OS does this issue occur?
63+
placeholder: ex. macOS 12.1, Windows 10...
64+
validations:
65+
required: true
66+
- type: input
67+
id: Flash
68+
attributes:
69+
label: Flash frequency
70+
description: What flash frequency is used?
71+
placeholder: eg. 40Mhz
72+
validations:
73+
required: true
74+
- type: dropdown
75+
id: PSRAM
76+
attributes:
77+
label: PSRAM enabled
78+
description: Is PSRAM enabled?
79+
options:
80+
- 'yes'
81+
- 'no'
82+
validations:
83+
required: true
84+
- type: input
85+
id: Upload
86+
attributes:
87+
label: Upload speed
88+
description: What upload speed is used?
89+
placeholder: eg. 115200
90+
validations:
91+
required: true
92+
- type: textarea
93+
id: Description
94+
attributes:
95+
label: Description
96+
description: Please describe your problem here and expected behaviour
97+
placeholder: ex. Can't connect/weird behaviour/wrong function/missing parameter..
98+
validations:
99+
required: true
100+
- type: textarea
101+
id: sketch
102+
attributes:
103+
label: Sketch
104+
description: Please provide your sketch/code which was run
105+
placeholder: ex. related part of the code
106+
render: cpp
107+
validations:
108+
required: true
109+
- type: textarea
110+
id: Debug
111+
attributes:
112+
label: Debug Message
113+
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)
114+
placeholder: Enable Core debug level - Debug on tools menu of Arduino IDE, then put the serial output here.
115+
render: plain
116+
validations:
117+
required: true
118+
- type: textarea
119+
id: other-remarks
120+
attributes:
121+
label: Other Steps to Reproduce
122+
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.
123+
placeholder: ex. I also tried on other OS, HW...it works correctly on that setup.
124+
- type: checkboxes
125+
id: confirmation
126+
attributes:
127+
label: I have checked existing issues, online documentation and the Troubleshooting Guide
128+
description: You agree to check all the resources above before opening a new issue.
129+
options:
130+
- label: I confirm I have checked existing issues, online documentation and Troubleshooting guide.
131+
required: true

‎.github/ISSUE_TEMPLATE/bug_report.md

-54
This file was deleted.

‎.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

‎.github/PULL_REQUEST_TEMPLATE.md

+8-6
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,18 @@
1-
----------------------------------------------------------------------------------------------------------------------------------------------------
2-
This entire section can be deleted if all items are checked.
3-
41
*By completing this PR sufficiently, you help us to improve the quality of Release Notes*
52

63
### Checklist
7-
8-
1. [ ] Please provide specific title of the PR describing the change, including the component name (eg."Update of Documentation link on Readme.md")
4+
1. [ ] Please provide specific title of the PR describing the change, including the component name (eg. *„Update of Documentation link on Readme.md“*)
95
2. [ ] Please provide related links (eg. Issue, other Project, submodule PR..)
10-
----------------------------------------------------------------------------------------------------------------------------------------------------
6+
3. [ ] Please check [Contributing guide](https://docs.espressif.com/projects/arduino-esp32/en/latest/contributing.html)
117

8+
*This entire section above can be deleted if all items are checked.*
9+
10+
-----------
1211
## Summary
1312
Please describe your proposed PR and what it contains.
1413

1514
## Impact
1615
Please describe impact of your PR and it's function.
16+
17+
## Related links
18+
Please provide links to related issue, PRs etc.

‎.github/scripts/check-cmakelists.sh

+2-2
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
@@ -15,7 +15,7 @@ git submodule update --init --recursive
1515
REPO_SRCS=`find cores/esp32/ libraries/ -name 'examples' -prune -o -name '*.c' -print -o -name '*.cpp' -print | sort`
1616

1717
# find all source files named in CMakeLists.txt COMPONENT_SRCS
18-
CMAKE_SRCS=`cmake --trace-expand -C CMakeLists.txt 2>&1 | grep set\(srcs | cut -d'(' -f3 | sed 's/ )//' | sed 's/srcs //' | tr ' ;' '\n' | sort`
18+
CMAKE_SRCS=`cmake --trace-expand -P CMakeLists.txt 2>&1 | grep set\(srcs | cut -d'(' -f3 | sed 's/ )//' | sed 's/srcs //' | tr ' ;' '\n' | sort`
1919

2020
if ! diff -u0 --label "Repo Files" --label "srcs" <(echo "$REPO_SRCS") <(echo "$CMAKE_SRCS"); then
2121
echo "Source files in repo (-) and source files in CMakeLists.txt (+) don't match"

‎.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)