From 9e86463b17a01147429851751412d793be326e73 Mon Sep 17 00:00:00 2001 From: Jason2866 <24528715+Jason2866@users.noreply.github.com> Date: Thu, 18 Jul 2024 12:37:30 +0200 Subject: [PATCH 1/9] Add Info for pioarduino community version --- docs/en/installing.rst | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/docs/en/installing.rst b/docs/en/installing.rst index 491e8f6d8a4..cc0805aafe5 100644 --- a/docs/en/installing.rst +++ b/docs/en/installing.rst @@ -85,7 +85,7 @@ PlatformIO can be used in two flavors: To install PlatformIO, you can follow this Getting Started, provided at `docs.platformio.org`_. -Using the stable code +Using the stable code 2.0.x ********************* .. note:: @@ -122,20 +122,19 @@ Create a new project and select one of the available boards. You can change afte board = esp32-c3-devkitm-1 framework = arduino -How to update to the latest code +How to update to the stable code based on 3.0.x ******************************** -To test the latest Arduino ESP32, you need to change your project *platformio.ini* accordingly. -The following configuration uses the upstream version of the Espressif development platform and the latest Arduino core directly from the Espressif GitHub repository: +To use the actual Arduino ESP32, you need to change your project *platformio.ini* accordingly. +The following configuration uses the not official Platformio community version pioarduino and the latest Arduino core from the pioarduino GitHub repository: .. code-block:: bash [env:esp32-c3-devkitm-1] - platform = https://github.com/platformio/platform-espressif32.git + platform = https://github.com/pioarduino/platform-espressif32/releases/download/51.03.03/platform-espressif32.zip board = esp32-c3-devkitm-1 framework = arduino - platform_packages = - framework-arduinoespressif32 @ https://github.com/espressif/arduino-esp32#master + To get more information about PlatformIO, see the following links: From d38e749baf6667695ae1534e783fe891b7baa0f0 Mon Sep 17 00:00:00 2001 From: Jason2866 <24528715+Jason2866@users.noreply.github.com> Date: Thu, 18 Jul 2024 12:51:39 +0200 Subject: [PATCH 2/9] remove Platformio from community sentence --- docs/en/installing.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/installing.rst b/docs/en/installing.rst index cc0805aafe5..fa1eca4820c 100644 --- a/docs/en/installing.rst +++ b/docs/en/installing.rst @@ -126,7 +126,7 @@ How to update to the stable code based on 3.0.x ******************************** To use the actual Arduino ESP32, you need to change your project *platformio.ini* accordingly. -The following configuration uses the not official Platformio community version pioarduino and the latest Arduino core from the pioarduino GitHub repository: +The following configuration uses the community version pioarduino and the latest Arduino core from the pioarduino GitHub repository: .. code-block:: bash From f390c0e8c8aa12c7f72d54e480c1f3d3148c8bce Mon Sep 17 00:00:00 2001 From: Jason2866 <24528715+Jason2866@users.noreply.github.com> Date: Thu, 18 Jul 2024 12:54:53 +0200 Subject: [PATCH 3/9] move Platformio Info section --- docs/en/installing.rst | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/en/installing.rst b/docs/en/installing.rst index fa1eca4820c..3f8b3b8a779 100644 --- a/docs/en/installing.rst +++ b/docs/en/installing.rst @@ -85,6 +85,17 @@ PlatformIO can be used in two flavors: To install PlatformIO, you can follow this Getting Started, provided at `docs.platformio.org`_. +To get more information about PlatformIO, see the following links: + +- `PlatformIO Core (CLI) `_ + +- `PlatformIO Home `_ + +- `Tutorials and Examples `_ + +- `Library Management `_ + + Using the stable code 2.0.x ********************* @@ -137,17 +148,6 @@ The following configuration uses the community version pioarduino and the latest -To get more information about PlatformIO, see the following links: - -- `PlatformIO Core (CLI) `_ - -- `PlatformIO Home `_ - -- `Tutorials and Examples `_ - -- `Library Management `_ - - Windows (manual installation) ----------------------------- From cc8e91c96f61cf9fdb3582726ccc5bd44a8bd910 Mon Sep 17 00:00:00 2001 From: Jason2866 <24528715+Jason2866@users.noreply.github.com> Date: Fri, 19 Jul 2024 10:37:50 +0200 Subject: [PATCH 4/9] try to fix styling issues --- docs/en/installing.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/en/installing.rst b/docs/en/installing.rst index 3f8b3b8a779..acfa4c771b2 100644 --- a/docs/en/installing.rst +++ b/docs/en/installing.rst @@ -97,7 +97,7 @@ To get more information about PlatformIO, see the following links: Using the stable code 2.0.x -********************* +--------------------------- .. note:: A detailed overview of supported development boards, examples and frameworks can be found on `the official Espressif32 dev-platform page `_ in the PlatformIO Registry. @@ -134,7 +134,7 @@ Create a new project and select one of the available boards. You can change afte framework = arduino How to update to the stable code based on 3.0.x -******************************** +----------------------------------------------- To use the actual Arduino ESP32, you need to change your project *platformio.ini* accordingly. The following configuration uses the community version pioarduino and the latest Arduino core from the pioarduino GitHub repository: From bbe5f3e0100b0194ca7f653a1651a502eceb08a2 Mon Sep 17 00:00:00 2001 From: Jason2866 <24528715+Jason2866@users.noreply.github.com> Date: Tue, 23 Jul 2024 14:55:16 +0200 Subject: [PATCH 5/9] pin Pio version and correct github source for Arduino 3.0.x --- docs/en/installing.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/en/installing.rst b/docs/en/installing.rst index acfa4c771b2..777b4ae15b8 100644 --- a/docs/en/installing.rst +++ b/docs/en/installing.rst @@ -111,7 +111,7 @@ Create a new project and select one of the available boards. You can change afte .. code-block:: bash [env:esp32dev] - platform = espressif32 + platform = espressif32@6.7.0 board = esp32dev framework = arduino @@ -120,7 +120,7 @@ Create a new project and select one of the available boards. You can change afte .. code-block:: bash [env:esp32-s2-saola-1] - platform = espressif32 + platform = espressif32@6.7.0 board = esp32-s2-saola-1 framework = arduino @@ -129,15 +129,15 @@ Create a new project and select one of the available boards. You can change afte .. code-block:: bash [env:esp32-c3-devkitm-1] - platform = espressif32 + platform = espressif32@6.7.0 board = esp32-c3-devkitm-1 framework = arduino How to update to the stable code based on 3.0.x ----------------------------------------------- -To use the actual Arduino ESP32, you need to change your project *platformio.ini* accordingly. -The following configuration uses the community version pioarduino and the latest Arduino core from the pioarduino GitHub repository: +To use the latest supported Arduino ESP32, you need to change your project *platformio.ini* accordingly. +The following configuration uses the community version ``pioarduino`` and the latest release Arduino core from the ``espressif`` GitHub repository: .. code-block:: bash From af7806788449a52bb07dc5b62fc0717e775bcc4a Mon Sep 17 00:00:00 2001 From: Jason2866 <24528715+Jason2866@users.noreply.github.com> Date: Wed, 24 Jul 2024 13:56:12 +0200 Subject: [PATCH 6/9] 'For' instead of 'To' --- docs/en/installing.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/installing.rst b/docs/en/installing.rst index 777b4ae15b8..f961c251b8a 100644 --- a/docs/en/installing.rst +++ b/docs/en/installing.rst @@ -85,7 +85,7 @@ PlatformIO can be used in two flavors: To install PlatformIO, you can follow this Getting Started, provided at `docs.platformio.org`_. -To get more information about PlatformIO, see the following links: +For more information about PlatformIO, see the following links: - `PlatformIO Core (CLI) `_ From 4ef3ef310014f16923e4244df6af2dd7eab1350b Mon Sep 17 00:00:00 2001 From: Jason2866 <24528715+Jason2866@users.noreply.github.com> Date: Wed, 24 Jul 2024 13:59:53 +0200 Subject: [PATCH 7/9] add example Note --- docs/en/installing.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/en/installing.rst b/docs/en/installing.rst index f961c251b8a..edf711bd35d 100644 --- a/docs/en/installing.rst +++ b/docs/en/installing.rst @@ -139,6 +139,7 @@ How to update to the stable code based on 3.0.x To use the latest supported Arduino ESP32, you need to change your project *platformio.ini* accordingly. The following configuration uses the community version ``pioarduino`` and the latest release Arduino core from the ``espressif`` GitHub repository: +.. note:: This is only an example. Make sure to check the latest available version in `pioarduino's repository `_. .. code-block:: bash [env:esp32-c3-devkitm-1] From dfa625c85b01c77236acc38e37b269afe22f8165 Mon Sep 17 00:00:00 2001 From: Jason2866 <24528715+Jason2866@users.noreply.github.com> Date: Fri, 2 Aug 2024 13:55:12 +0200 Subject: [PATCH 8/9] Update to core 3.0.4 --- docs/en/installing.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/installing.rst b/docs/en/installing.rst index edf711bd35d..c560d643d0e 100644 --- a/docs/en/installing.rst +++ b/docs/en/installing.rst @@ -143,7 +143,7 @@ The following configuration uses the community version ``pioarduino`` and the la .. code-block:: bash [env:esp32-c3-devkitm-1] - platform = https://github.com/pioarduino/platform-espressif32/releases/download/51.03.03/platform-espressif32.zip + platform = https://github.com/pioarduino/platform-espressif32/releases/download/51.03.04/platform-espressif32.zip board = esp32-c3-devkitm-1 framework = arduino From e4f645c3c43452185d12517e91042a05b2267675 Mon Sep 17 00:00:00 2001 From: Jason2866 <24528715+Jason2866@users.noreply.github.com> Date: Wed, 18 Sep 2024 20:49:40 +0200 Subject: [PATCH 9/9] Update to core 3.0.5 --- docs/en/installing.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/en/installing.rst b/docs/en/installing.rst index c560d643d0e..979a576f2db 100644 --- a/docs/en/installing.rst +++ b/docs/en/installing.rst @@ -111,7 +111,7 @@ Create a new project and select one of the available boards. You can change afte .. code-block:: bash [env:esp32dev] - platform = espressif32@6.7.0 + platform = espressif32@6.8.1 board = esp32dev framework = arduino @@ -120,7 +120,7 @@ Create a new project and select one of the available boards. You can change afte .. code-block:: bash [env:esp32-s2-saola-1] - platform = espressif32@6.7.0 + platform = espressif32@6.8.1 board = esp32-s2-saola-1 framework = arduino @@ -129,7 +129,7 @@ Create a new project and select one of the available boards. You can change afte .. code-block:: bash [env:esp32-c3-devkitm-1] - platform = espressif32@6.7.0 + platform = espressif32@6.8.1 board = esp32-c3-devkitm-1 framework = arduino @@ -143,7 +143,7 @@ The following configuration uses the community version ``pioarduino`` and the la .. code-block:: bash [env:esp32-c3-devkitm-1] - platform = https://github.com/pioarduino/platform-espressif32/releases/download/51.03.04/platform-espressif32.zip + platform = https://github.com/pioarduino/platform-espressif32/releases/download/51.03.05/platform-espressif32.zip board = esp32-c3-devkitm-1 framework = arduino