Skip to content

Commit

Permalink
docs(3rd-party): Add section for third party tools
Browse files Browse the repository at this point in the history
  • Loading branch information
lucasssvaz committed Dec 18, 2024
1 parent 6bf6df2 commit 23078b7
Show file tree
Hide file tree
Showing 4 changed files with 75 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/en/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ Here you will find all the relevant information about the project.
Guides <guides/guides>
Tutorials <tutorials/tutorials>
Advanced Utilities <advanced_utils>
Third Party Tools <third_party_tools>
Migration Guides <migration_guides/migration_guides>
FAQ <faq>
Troubleshooting <troubleshooting>
Expand Down
16 changes: 16 additions & 0 deletions docs/en/third_party_tools.rst
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>
16 changes: 16 additions & 0 deletions docs/en/thirdparty/pioarduino.rst
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>`_.


42 changes: 42 additions & 0 deletions docs/en/thirdparty/wokwi.rst
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>`_.

0 comments on commit 23078b7

Please sign in to comment.