-
Notifications
You must be signed in to change notification settings - Fork 7.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs(3rd-party): Add section for third party tools #10748
Closed
Closed
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
################# | ||
Third Party Tools | ||
################# | ||
|
||
Here you will find documentation pages for third party tools that can be used with the ESP32 Arduino Core. | ||
|
||
.. warning:: | ||
Note that these tools are **not maintained by the ESP32 Arduino Core team**, so we cannot provide support or guarantee that they will work as expected. | ||
Documentation for these tools should be provided and maintained by the community. | ||
|
||
.. toctree:: | ||
:maxdepth: 1 | ||
:caption: Contents: | ||
|
||
pioarduino <thirdparty/pioarduino> | ||
Wokwi <thirdparty/wokwi> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
####################################################### | ||
pioarduino - (p)eople (i)nitiated (o)ptimized (arduino) | ||
####################################################### | ||
|
||
.. warning:: | ||
Note that this tool is **not maintained by the ESP32 Arduino Core team**, so we cannot provide support or guarantee that it will work as expected. | ||
|
||
.. note:: | ||
This is a work in progress documentation and we will appreciate your help! We are looking for contributors! | ||
|
||
About | ||
----- | ||
|
||
For more information, please refer to the `official documentation <https://github.com/pioarduino/platform-espressif32>`_. | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
##### | ||
Wokwi | ||
##### | ||
|
||
.. warning:: | ||
Note that this tool is **not maintained by the ESP32 Arduino Core team**, so we cannot provide support or guarantee that it will work as expected. | ||
|
||
.. note:: | ||
This is a work in progress documentation and we will appreciate your help! We are looking for contributors! | ||
|
||
About | ||
----- | ||
|
||
Wokwi is an online Electronics simulator. You can use it to simulate Arduino, ESP32, and many other popular boards, parts and sensors. | ||
|
||
The advantages of using Wokwi inlcude: | ||
|
||
- 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. | ||
- Safe experimentation: Virtual hardware cannot be damaged, allowing users to experiment freely without the risk of destroying components. Mistakes can be easily undone. | ||
- Easy collaboration: Sharing a link to your Wokwi project facilitates obtaining help and feedback from others. | ||
- Code reliability: Helps in distinguishing between hardware and software issues, thereby increasing confidence in your code. | ||
- Unlimited resources: Access to an unlimited number of parts without concerns about cost or availability. | ||
- Supportive community: A maker-friendly environment where users can share projects, seek assistance, and find inspiration. | ||
|
||
Unique features provided by Wokwi: | ||
|
||
- WiFi simulation - Connect your simulated project to the internet. You can use MQTT, HTTP, NTP, and many other network protocols. | ||
- Virtual Logic Analyzer - Capture digital signals in your simulation (e.g. UART, I2C, SPI) and analyze them on your computer. | ||
- Advanced debugging with GDB - Powerful Arduino debugger for advanced users. | ||
- SD card simulation - Store and retrieve files and directories from your code. Paying users can also upload binary files (such as images) | ||
- Chips API - Create your own custom chips and parts, and share them with the community. | ||
- Visual Studio Code integration - Simulate your embedded projects directly from VS Code. | ||
|
||
Pricing | ||
------- | ||
|
||
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>`_. | ||
|
||
Learn more | ||
---------- | ||
|
||
For more information, please refer to the `official Wokwi website <https://wokwi.com>`_ and the `Wokwi documentation <https://docs.wokwi.com>`_. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,3 +2,4 @@ esp-docs>=1.4.0 | |
sphinx-copybutton==0.5.0 | ||
sphinx-tabs==3.2.0 | ||
numpydoc==1.5.0 | ||
standard-imghdr==3.13.0 |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.