From ec07892b32e852dd0050e0dcf37eaeace5dcecf9 Mon Sep 17 00:00:00 2001 From: Lucas Saavedra Vaz <32426024+lucasssvaz@users.noreply.github.com> Date: Wed, 18 Dec 2024 09:57:04 -0300 Subject: [PATCH 1/7] docs(3rd-party): Add section for third party tools --- docs/en/index.rst | 1 + docs/en/third_party_tools.rst | 16 ++++++++++++ docs/en/thirdparty/pioarduino.rst | 16 ++++++++++++ docs/en/thirdparty/wokwi.rst | 42 +++++++++++++++++++++++++++++++ 4 files changed, 75 insertions(+) create mode 100644 docs/en/third_party_tools.rst create mode 100644 docs/en/thirdparty/pioarduino.rst create mode 100644 docs/en/thirdparty/wokwi.rst diff --git a/docs/en/index.rst b/docs/en/index.rst index 40b3251c912..1314a8fc78d 100644 --- a/docs/en/index.rst +++ b/docs/en/index.rst @@ -16,6 +16,7 @@ Here you will find all the relevant information about the project. Guides Tutorials Advanced Utilities + Third Party Tools Migration Guides FAQ Troubleshooting diff --git a/docs/en/third_party_tools.rst b/docs/en/third_party_tools.rst new file mode 100644 index 00000000000..f419f5d4724 --- /dev/null +++ b/docs/en/third_party_tools.rst @@ -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 + Wokwi diff --git a/docs/en/thirdparty/pioarduino.rst b/docs/en/thirdparty/pioarduino.rst new file mode 100644 index 00000000000..1eeec566964 --- /dev/null +++ b/docs/en/thirdparty/pioarduino.rst @@ -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 `_. + + diff --git a/docs/en/thirdparty/wokwi.rst b/docs/en/thirdparty/wokwi.rst new file mode 100644 index 00000000000..b3a4bf108d0 --- /dev/null +++ b/docs/en/thirdparty/wokwi.rst @@ -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 `_. + +Learn more +---------- + +For more information, please refer to the `official Wokwi website `_ and the `Wokwi documentation `_. From d8b1cc70c664a84cd64d9231fa41ce432d995d24 Mon Sep 17 00:00:00 2001 From: Lucas Saavedra Vaz <32426024+lucasssvaz@users.noreply.github.com> Date: Wed, 18 Dec 2024 09:57:36 -0300 Subject: [PATCH 2/7] fix(docs): Fix dependencies in Python 3.13 --- docs/requirements.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/requirements.txt b/docs/requirements.txt index 505feb2e764..d3017fb5adc 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -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 From 9ec03da01142f4a74d446e2b656230dc10be6443 Mon Sep 17 00:00:00 2001 From: Lucas Saavedra Vaz <32426024+lucasssvaz@users.noreply.github.com> Date: Wed, 18 Dec 2024 11:18:40 -0300 Subject: [PATCH 3/7] fix(typo): Fix docs typo --- docs/en/thirdparty/wokwi.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/thirdparty/wokwi.rst b/docs/en/thirdparty/wokwi.rst index b3a4bf108d0..985ad403db3 100644 --- a/docs/en/thirdparty/wokwi.rst +++ b/docs/en/thirdparty/wokwi.rst @@ -13,7 +13,7 @@ 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: +The advantages of using Wokwi include: - 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. From 32a9746a25c93f93cf9583e07cb04fd45d7e7381 Mon Sep 17 00:00:00 2001 From: Lucas Saavedra Vaz <32426024+lucasssvaz@users.noreply.github.com> Date: Wed, 18 Dec 2024 12:54:00 -0300 Subject: [PATCH 4/7] docs(3rd-party): Re-write some phrases --- docs/en/third_party_tools.rst | 4 ++-- docs/en/thirdparty/pioarduino.rst | 2 +- docs/en/thirdparty/wokwi.rst | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/en/third_party_tools.rst b/docs/en/third_party_tools.rst index f419f5d4724..120d0c2e5ce 100644 --- a/docs/en/third_party_tools.rst +++ b/docs/en/third_party_tools.rst @@ -5,8 +5,8 @@ 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. + These tools are **not maintained by the ESP32 Arduino Core team**, so we cannot provide support or guarantee that they will work as expected. + Each tool documentation should be provided and maintained by the community. .. toctree:: :maxdepth: 1 diff --git a/docs/en/thirdparty/pioarduino.rst b/docs/en/thirdparty/pioarduino.rst index 1eeec566964..ac5d4a736c6 100644 --- a/docs/en/thirdparty/pioarduino.rst +++ b/docs/en/thirdparty/pioarduino.rst @@ -3,7 +3,7 @@ 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. + 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! diff --git a/docs/en/thirdparty/wokwi.rst b/docs/en/thirdparty/wokwi.rst index 985ad403db3..56f104e7ce8 100644 --- a/docs/en/thirdparty/wokwi.rst +++ b/docs/en/thirdparty/wokwi.rst @@ -3,7 +3,7 @@ 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. + 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! From cd91c0940e56ce623bbe9fcf3be081974b6d6449 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci-lite[bot]" <117423508+pre-commit-ci-lite[bot]@users.noreply.github.com> Date: Sat, 21 Dec 2024 18:59:23 +0000 Subject: [PATCH 5/7] ci(pre-commit): Apply automatic fixes --- docs/en/thirdparty/pioarduino.rst | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/en/thirdparty/pioarduino.rst b/docs/en/thirdparty/pioarduino.rst index ac5d4a736c6..49af583befa 100644 --- a/docs/en/thirdparty/pioarduino.rst +++ b/docs/en/thirdparty/pioarduino.rst @@ -12,5 +12,3 @@ About ----- For more information, please refer to the `official documentation `_. - - From b4d741bc8b42bdeb0671e71994204708a87391bf Mon Sep 17 00:00:00 2001 From: Lucas Saavedra Vaz <32426024+lucasssvaz@users.noreply.github.com> Date: Sat, 21 Dec 2024 16:15:24 -0300 Subject: [PATCH 6/7] fix(naming): Rename files --- docs/en/{thirdparty => third_party}/pioarduino.rst | 0 docs/en/{thirdparty => third_party}/wokwi.rst | 0 docs/en/third_party_tools.rst | 4 ++-- 3 files changed, 2 insertions(+), 2 deletions(-) rename docs/en/{thirdparty => third_party}/pioarduino.rst (100%) rename docs/en/{thirdparty => third_party}/wokwi.rst (100%) diff --git a/docs/en/thirdparty/pioarduino.rst b/docs/en/third_party/pioarduino.rst similarity index 100% rename from docs/en/thirdparty/pioarduino.rst rename to docs/en/third_party/pioarduino.rst diff --git a/docs/en/thirdparty/wokwi.rst b/docs/en/third_party/wokwi.rst similarity index 100% rename from docs/en/thirdparty/wokwi.rst rename to docs/en/third_party/wokwi.rst diff --git a/docs/en/third_party_tools.rst b/docs/en/third_party_tools.rst index 120d0c2e5ce..fd8fd92ae0c 100644 --- a/docs/en/third_party_tools.rst +++ b/docs/en/third_party_tools.rst @@ -12,5 +12,5 @@ Here you will find documentation pages for third party tools that can be used wi :maxdepth: 1 :caption: Contents: - pioarduino - Wokwi + pioarduino + Wokwi From ebec20e1b33175ff0608ccce90fa444fb5d9e458 Mon Sep 17 00:00:00 2001 From: Lucas Saavedra Vaz <32426024+lucasssvaz@users.noreply.github.com> Date: Sat, 21 Dec 2024 16:16:56 -0300 Subject: [PATCH 7/7] fix(spelling): Fix spelling mistake --- docs/en/third_party/wokwi.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/third_party/wokwi.rst b/docs/en/third_party/wokwi.rst index 56f104e7ce8..0a6eb9d0992 100644 --- a/docs/en/third_party/wokwi.rst +++ b/docs/en/third_party/wokwi.rst @@ -24,7 +24,7 @@ The advantages of using Wokwi include: 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. +- Wi-Fi 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)