Skip to content

Commit 089cbab

Browse files
docs(3rd-party): Add section for third party tools (#10749)
* docs(3rd-party): Add section for third party tools * fix(docs): Fix dependencies in Python 3.13 * fix(typo): Fix docs typo * docs(3rd-party): Re-write some phrases * ci(pre-commit): Apply automatic fixes * fix(naming): Rename files * fix(spelling): Fix spelling mistake --------- Co-authored-by: pre-commit-ci-lite[bot] <117423508+pre-commit-ci-lite[bot]@users.noreply.github.com>
1 parent 5c41881 commit 089cbab

File tree

5 files changed

+74
-0
lines changed

5 files changed

+74
-0
lines changed

Diff for: docs/en/index.rst

+1
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ Here you will find all the relevant information about the project.
1616
Guides <guides/guides>
1717
Tutorials <tutorials/tutorials>
1818
Advanced Utilities <advanced_utils>
19+
Third Party Tools <third_party_tools>
1920
Migration Guides <migration_guides/migration_guides>
2021
FAQ <faq>
2122
Troubleshooting <troubleshooting>

Diff for: docs/en/third_party/pioarduino.rst

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
#######################################################
2+
pioarduino - (p)eople (i)nitiated (o)ptimized (arduino)
3+
#######################################################
4+
5+
.. warning::
6+
This tool is **not maintained by the ESP32 Arduino Core team**, so we cannot provide support or guarantee that it will work as expected.
7+
8+
.. note::
9+
This is a work in progress documentation and we will appreciate your help! We are looking for contributors!
10+
11+
About
12+
-----
13+
14+
For more information, please refer to the `official documentation <https://github.com/pioarduino/platform-espressif32>`_.

Diff for: docs/en/third_party/wokwi.rst

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
#####
2+
Wokwi
3+
#####
4+
5+
.. warning::
6+
This tool is **not maintained by the ESP32 Arduino Core team**, so we cannot provide support or guarantee that it will work as expected.
7+
8+
.. note::
9+
This is a work in progress documentation and we will appreciate your help! We are looking for contributors!
10+
11+
About
12+
-----
13+
14+
Wokwi is an online Electronics simulator. You can use it to simulate Arduino, ESP32, and many other popular boards, parts and sensors.
15+
16+
The advantages of using Wokwi include:
17+
18+
- Immediate start: No need to wait for components or download large software. Everything required is available in your browser, enabling you to begin coding your IoT project within seconds.
19+
- Safe experimentation: Virtual hardware cannot be damaged, allowing users to experiment freely without the risk of destroying components. Mistakes can be easily undone.
20+
- Easy collaboration: Sharing a link to your Wokwi project facilitates obtaining help and feedback from others.
21+
- Code reliability: Helps in distinguishing between hardware and software issues, thereby increasing confidence in your code.
22+
- Unlimited resources: Access to an unlimited number of parts without concerns about cost or availability.
23+
- Supportive community: A maker-friendly environment where users can share projects, seek assistance, and find inspiration.
24+
25+
Unique features provided by Wokwi:
26+
27+
- Wi-Fi simulation - Connect your simulated project to the internet. You can use MQTT, HTTP, NTP, and many other network protocols.
28+
- Virtual Logic Analyzer - Capture digital signals in your simulation (e.g. UART, I2C, SPI) and analyze them on your computer.
29+
- Advanced debugging with GDB - Powerful Arduino debugger for advanced users.
30+
- SD card simulation - Store and retrieve files and directories from your code. Paying users can also upload binary files (such as images)
31+
- Chips API - Create your own custom chips and parts, and share them with the community.
32+
- Visual Studio Code integration - Simulate your embedded projects directly from VS Code.
33+
34+
Pricing
35+
-------
36+
37+
Wokwi is free for personal use. For commercial users and professionals, please check out the paid plans in the `pricing page <https://wokwi.com/pricing>`_.
38+
39+
Learn more
40+
----------
41+
42+
For more information, please refer to the `official Wokwi website <https://wokwi.com>`_ and the `Wokwi documentation <https://docs.wokwi.com>`_.

Diff for: docs/en/third_party_tools.rst

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
#################
2+
Third Party Tools
3+
#################
4+
5+
Here you will find documentation pages for third party tools that can be used with the ESP32 Arduino Core.
6+
7+
.. warning::
8+
These tools are **not maintained by the ESP32 Arduino Core team**, so we cannot provide support or guarantee that they will work as expected.
9+
Each tool documentation should be provided and maintained by the community.
10+
11+
.. toctree::
12+
:maxdepth: 1
13+
:caption: Contents:
14+
15+
pioarduino <third_party/pioarduino>
16+
Wokwi <third_party/wokwi>

Diff for: docs/requirements.txt

+1
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,4 @@ esp-docs>=1.4.0
22
sphinx-copybutton==0.5.0
33
sphinx-tabs==3.2.0
44
numpydoc==1.5.0
5+
standard-imghdr==3.13.0

0 commit comments

Comments
 (0)