diff --git a/examples/arduino-blink/README.md b/examples/arduino-blink/README.md new file mode 100644 index 0000000..1573f15 --- /dev/null +++ b/examples/arduino-blink/README.md @@ -0,0 +1,27 @@ +How to build PlatformIO based project +===================================== + +1. [Install PlatformIO Core](http://docs.platformio.org/page/core.html) +2. Download [development platform with examples](https://github.com/platformio/platform-espressif32/archive/develop.zip) +3. Extract ZIP archive +4. Run these commands: + +```shell +# Change directory to example +$ cd platform-espressif32/examples/arduino-blink + +# Build project +$ pio run + +# Upload firmware +$ pio run --target upload + +# Build specific environment +$ pio run -e esp32dev + +# Upload firmware for the specific environment +$ pio run -e esp32dev --target upload + +# Clean build files +$ pio run --target clean +``` \ No newline at end of file diff --git a/examples/arduino-blink/README.rst b/examples/arduino-blink/README.rst deleted file mode 100644 index e6d8784..0000000 --- a/examples/arduino-blink/README.rst +++ /dev/null @@ -1,38 +0,0 @@ -.. Copyright 2014-present PlatformIO - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - -How to build PlatformIO based project -===================================== - -1. `Install PlatformIO Core `_ -2. Download `development platform with examples `_ -3. Extract ZIP archive -4. Run these commands: - -.. code-block:: bash - - # Change directory to example - > cd platform-espressif32/examples/arduino-blink - - # Build project - > platformio run - - # Upload firmware - > platformio run --target upload - - # Build specific environment - > platformio run -e esp32dev - - # Upload firmware for the specific environment - > platformio run -e esp32dev --target upload - - # Clean build files - > platformio run --target clean diff --git a/examples/arduino-briki-internal-libs/README.md b/examples/arduino-briki-internal-libs/README.md new file mode 100644 index 0000000..97c25a7 --- /dev/null +++ b/examples/arduino-briki-internal-libs/README.md @@ -0,0 +1,27 @@ +How to build PlatformIO based project +===================================== + +1. [Install PlatformIO Core](http://docs.platformio.org/page/core.html) +2. Download [development platform with examples](https://github.com/platformio/platform-espressif32/archive/develop.zip) +3. Extract ZIP archive +4. Run these commands: + +```shell +# Change directory to example +$ cd platform-espressif32/examples/arduino-briki-internal-libs + +# Build project +$ pio run + +# Upload firmware +$ pio run --target upload + +# Build specific environment +$ pio run -e briki_abc_esp32 + +# Upload firmware for the specific environment +$ pio run -e briki_abc_esp32 --target upload + +# Clean build files +$ pio run --target clean +``` \ No newline at end of file diff --git a/examples/arduino-briki-internal-libs/README.rst b/examples/arduino-briki-internal-libs/README.rst deleted file mode 100644 index ce3a35e..0000000 --- a/examples/arduino-briki-internal-libs/README.rst +++ /dev/null @@ -1,38 +0,0 @@ -.. Copyright 2014-present PlatformIO - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - -How to build PlatformIO based project -===================================== - -1. `Install PlatformIO Core `_ -2. Download `development platform with examples `_ -3. Extract ZIP archive -4. Run these commands: - -.. code-block:: bash - - # Change directory to example - > cd platform-espressif32/examples/arduino-briki-internal-libs - - # Build project - > platformio run - - # Upload firmware - > platformio run --target upload - - # Build specific environment - > platformio run -e briki_abc_esp32 - - # Upload firmware for the specific environment - > platformio run -e briki_abc_esp32 --target upload - - # Clean build files - > platformio run --target clean diff --git a/examples/arduino-wifiscan/README.md b/examples/arduino-wifiscan/README.md new file mode 100644 index 0000000..785231d --- /dev/null +++ b/examples/arduino-wifiscan/README.md @@ -0,0 +1,27 @@ +How to build PlatformIO based project +===================================== + +1. [Install PlatformIO Core](http://docs.platformio.org/page/core.html) +2. Download [development platform with examples](https://github.com/platformio/platform-espressif32/archive/develop.zip) +3. Extract ZIP archive +4. Run these commands: + +```shell +# Change directory to example +$ cd platform-espressif32/examples/arduino-wifiscan + +# Build project +$ pio run + +# Upload firmware +$ pio run --target upload + +# Build specific environment +$ pio run -e quantum + +# Upload firmware for the specific environment +$ pio run -e quantum --target upload + +# Clean build files +$ pio run --target clean +``` \ No newline at end of file diff --git a/examples/arduino-wifiscan/README.rst b/examples/arduino-wifiscan/README.rst deleted file mode 100644 index 48bf203..0000000 --- a/examples/arduino-wifiscan/README.rst +++ /dev/null @@ -1,38 +0,0 @@ -.. Copyright 2014-present PlatformIO - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - -How to build PlatformIO based project -===================================== - -1. `Install PlatformIO Core `_ -2. Download `development platform with examples `_ -3. Extract ZIP archive -4. Run these commands: - -.. code-block:: bash - - # Change directory to example - > cd platform-espressif32/examples/arduino-wifiscan - - # Build project - > platformio run - - # Upload firmware - > platformio run --target upload - - # Build specific environment - > platformio run -e quantum - - # Upload firmware for the specific environment - > platformio run -e quantum --target upload - - # Clean build files - > platformio run --target clean diff --git a/examples/espidf-arduino-blink/README.md b/examples/espidf-arduino-blink/README.md new file mode 100644 index 0000000..fe5ffee --- /dev/null +++ b/examples/espidf-arduino-blink/README.md @@ -0,0 +1,27 @@ +How to build PlatformIO based project +===================================== + +1. [Install PlatformIO Core](http://docs.platformio.org/page/core.html) +2. Download [development platform with examples](https://github.com/platformio/platform-espressif32/archive/develop.zip) +3. Extract ZIP archive +4. Run these commands: + +```shell +# Change directory to example +$ cd platform-espressif32/examples/espidf-arduino-blink + +# Build project +$ pio run + +# Upload firmware +$ pio run --target upload + +# Build specific environment +$ pio run -e esp32dev + +# Upload firmware for the specific environment +$ pio run -e esp32dev --target upload + +# Clean build files +$ pio run --target clean +``` \ No newline at end of file diff --git a/examples/espidf-arduino-blink/README.rst b/examples/espidf-arduino-blink/README.rst deleted file mode 100644 index 687b33c..0000000 --- a/examples/espidf-arduino-blink/README.rst +++ /dev/null @@ -1,38 +0,0 @@ -.. Copyright 2014-present PlatformIO - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - -How to build PlatformIO based project -===================================== - -1. `Install PlatformIO Core `_ -2. Download `development platform with examples `_ -3. Extract ZIP archive -4. Run these commands: - -.. code-block:: bash - - # Change directory to example - > cd platform-espressif32/examples/espidf-arduino-blink - - # Build project - > platformio run - - # Upload firmware - > platformio run --target upload - - # Build specific environment - > platformio run -e esp32dev - - # Upload firmware for the specific environment - > platformio run -e esp32dev --target upload - - # Clean build files - > platformio run --target clean diff --git a/examples/espidf-arduino-wifiscan/README.md b/examples/espidf-arduino-wifiscan/README.md new file mode 100644 index 0000000..f858f3a --- /dev/null +++ b/examples/espidf-arduino-wifiscan/README.md @@ -0,0 +1,27 @@ +How to build PlatformIO based project +===================================== + +1. [Install PlatformIO Core](http://docs.platformio.org/page/core.html) +2. Download [development platform with examples](https://github.com/platformio/platform-espressif32/archive/develop.zip) +3. Extract ZIP archive +4. Run these commands: + +```shell +# Change directory to example +$ cd platform-espressif32/examples/espidf-arduino-wifiscan + +# Build project +$ pio run + +# Upload firmware +$ pio run --target upload + +# Build specific environment +$ pio run -e esp32dev + +# Upload firmware for the specific environment +$ pio run -e esp32dev --target upload + +# Clean build files +$ pio run --target clean +``` \ No newline at end of file diff --git a/examples/espidf-arduino-wifiscan/README.rst b/examples/espidf-arduino-wifiscan/README.rst deleted file mode 100644 index cf87a34..0000000 --- a/examples/espidf-arduino-wifiscan/README.rst +++ /dev/null @@ -1,38 +0,0 @@ -.. Copyright 2014-present PlatformIO - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - -How to build PlatformIO based project -===================================== - -1. `Install PlatformIO Core `_ -2. Download `development platform with examples `_ -3. Extract ZIP archive -4. Run these commands: - -.. code-block:: bash - - # Change directory to example - > cd platform-espressif32/examples/espidf-arduino-wifiscan - - # Build project - > platformio run - - # Upload firmware - > platformio run --target upload - - # Build specific environment - > platformio run -e esp32dev - - # Upload firmware for the specific environment - > platformio run -e esp32dev --target upload - - # Clean build files - > platformio run --target clean diff --git a/examples/espidf-aws-iot/README.md b/examples/espidf-aws-iot/README.md new file mode 100644 index 0000000..40a8ccf --- /dev/null +++ b/examples/espidf-aws-iot/README.md @@ -0,0 +1,22 @@ +How to build PlatformIO based project +===================================== + +1. [Install PlatformIO Core](http://docs.platformio.org/page/core.html) +2. Download [development platform with examples](https://github.com/platformio/platform-espressif32/archive/develop.zip) +3. Extract ZIP archive +4. Run these commands: + +```shell + +# Change directory to example +$ cd platform-espressif32/examples/espidf-aws-iot + +# Build project +$ pio run + +# Upload firmware +$ pio run --target upload + +# Clean build files +$ pio run --target clean +``` \ No newline at end of file diff --git a/examples/espidf-aws-iot/README.rst b/examples/espidf-aws-iot/README.rst deleted file mode 100644 index d8417bd..0000000 --- a/examples/espidf-aws-iot/README.rst +++ /dev/null @@ -1,32 +0,0 @@ -.. Copyright 2014-present PlatformIO - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - -How to build PlatformIO based project -===================================== - -1. `Install PlatformIO Core `_ -2. Download `development platform with examples `_ -3. Extract ZIP archive -4. Run these commands: - -.. code-block:: bash - - # Change directory to example - > cd platform-espressif32/examples/espidf-aws-iot - - # Build project - > platformio run - - # Upload firmware - > platformio run --target upload - - # Clean build files - > platformio run --target clean diff --git a/examples/espidf-ble-eddystone/README.md b/examples/espidf-ble-eddystone/README.md new file mode 100644 index 0000000..85cd583 --- /dev/null +++ b/examples/espidf-ble-eddystone/README.md @@ -0,0 +1,27 @@ +How to build PlatformIO based project +===================================== + +1. [Install PlatformIO Core](http://docs.platformio.org/page/core.html) +2. Download [development platform with examples](https://github.com/platformio/platform-espressif32/archive/develop.zip) +3. Extract ZIP archive +4. Run these commands: + +```shell +# Change directory to example +$ cd platform-espressif32/examples/espidf-ble-eddystone + +# Build project +$ pio run + +# Upload firmware +$ pio run --target upload + +# Build specific environment +$ pio run -e esp32dev + +# Upload firmware for the specific environment +$ pio run -e esp32dev --target upload + +# Clean build files +$ pio run --target clean +``` \ No newline at end of file diff --git a/examples/espidf-ble-eddystone/README.rst b/examples/espidf-ble-eddystone/README.rst deleted file mode 100644 index 1335091..0000000 --- a/examples/espidf-ble-eddystone/README.rst +++ /dev/null @@ -1,38 +0,0 @@ -.. Copyright 2014-present PlatformIO - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - -How to build PlatformIO based project -===================================== - -1. `Install PlatformIO Core `_ -2. Download `development platform with examples `_ -3. Extract ZIP archive -4. Run these commands: - -.. code-block:: bash - - # Change directory to example - > cd platform-espressif32/examples/espidf-ble-eddystone - - # Build project - > platformio run - - # Upload firmware - > platformio run --target upload - - # Build specific environment - > platformio run -e esp32dev - - # Upload firmware for the specific environment - > platformio run -e esp32dev --target upload - - # Clean build files - > platformio run --target clean diff --git a/examples/espidf-blink/README.md b/examples/espidf-blink/README.md new file mode 100644 index 0000000..7d32f61 --- /dev/null +++ b/examples/espidf-blink/README.md @@ -0,0 +1,27 @@ +How to build PlatformIO based project +===================================== + +1. [Install PlatformIO Core](http://docs.platformio.org/page/core.html) +2. Download [development platform with examples](https://github.com/platformio/platform-espressif32/archive/develop.zip) +3. Extract ZIP archive +4. Run these commands: + +```shell +# Change directory to example +$ cd platform-espressif32/examples/espidf-blink + +# Build project +$ pio run + +# Upload firmware +$ pio run --target upload + +# Build specific environment +$ pio run -e esp32dev + +# Upload firmware for the specific environment +$ pio run -e esp32dev --target upload + +# Clean build files +$ pio run --target clean +``` \ No newline at end of file diff --git a/examples/espidf-blink/README.rst b/examples/espidf-blink/README.rst deleted file mode 100644 index c9514f0..0000000 --- a/examples/espidf-blink/README.rst +++ /dev/null @@ -1,38 +0,0 @@ -.. Copyright 2014-present PlatformIO - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - -How to build PlatformIO based project -===================================== - -1. `Install PlatformIO Core `_ -2. Download `development platform with examples `_ -3. Extract ZIP archive -4. Run these commands: - -.. code-block:: bash - - # Change directory to example - > cd platform-espressif32/examples/espidf-blink - - # Build project - > platformio run - - # Upload firmware - > platformio run --target upload - - # Build specific environment - > platformio run -e esp32dev - - # Upload firmware for the specific environment - > platformio run -e esp32dev --target upload - - # Clean build files - > platformio run --target clean diff --git a/examples/espidf-coap-server/README.md b/examples/espidf-coap-server/README.md new file mode 100644 index 0000000..63d4ec6 --- /dev/null +++ b/examples/espidf-coap-server/README.md @@ -0,0 +1,27 @@ +How to build PlatformIO based project +===================================== + +1. [Install PlatformIO Core](http://docs.platformio.org/page/core.html) +2. Download [development platform with examples](https://github.com/platformio/platform-espressif32/archive/develop.zip) +3. Extract ZIP archive +4. Run these commands: + +```shell +# Change directory to example +$ cd platform-espressif32/examples/espidf-coap-server + +# Build project +$ pio run + +# Upload firmware +$ pio run --target upload + +# Build specific environment +$ pio run -e esp32dev + +# Upload firmware for the specific environment +$ pio run -e esp32dev --target upload + +# Clean build files +$ pio run --target clean +``` \ No newline at end of file diff --git a/examples/espidf-coap-server/README.rst b/examples/espidf-coap-server/README.rst deleted file mode 100644 index 95412d8..0000000 --- a/examples/espidf-coap-server/README.rst +++ /dev/null @@ -1,38 +0,0 @@ -.. Copyright 2014-present PlatformIO - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - -How to build PlatformIO based project -===================================== - -1. `Install PlatformIO Core `_ -2. Download `development platform with examples `_ -3. Extract ZIP archive -4. Run these commands: - -.. code-block:: bash - - # Change directory to example - > cd platform-espressif32/examples/espidf-coap-server - - # Build project - > platformio run - - # Upload firmware - > platformio run --target upload - - # Build specific environment - > platformio run -e esp32dev - - # Upload firmware for the specific environment - > platformio run -e esp32dev --target upload - - # Clean build files - > platformio run --target clean diff --git a/examples/espidf-exceptions/README.md b/examples/espidf-exceptions/README.md new file mode 100644 index 0000000..fdec36f --- /dev/null +++ b/examples/espidf-exceptions/README.md @@ -0,0 +1,27 @@ +How to build PlatformIO based project +===================================== + +1. [Install PlatformIO Core](http://docs.platformio.org/page/core.html) +2. Download [development platform with examples](https://github.com/platformio/platform-espressif32/archive/develop.zip) +3. Extract ZIP archive +4. Run these commands: + +```shell +# Change directory to example +$ cd platform-espressif32/examples/espidf-exceptions + +# Build project +$ pio run + +# Upload firmware +$ pio run --target upload + +# Build specific environment +$ pio run -e esp32dev + +# Upload firmware for the specific environment +$ pio run -e esp32dev --target upload + +# Clean build files +$ pio run --target clean +``` \ No newline at end of file diff --git a/examples/espidf-exceptions/README.rst b/examples/espidf-exceptions/README.rst deleted file mode 100644 index c8e1759..0000000 --- a/examples/espidf-exceptions/README.rst +++ /dev/null @@ -1,38 +0,0 @@ -.. Copyright 2014-present PlatformIO - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - -How to build PlatformIO based project -===================================== - -1. `Install PlatformIO Core `_ -2. Download `development platform with examples `_ -3. Extract ZIP archive -4. Run these commands: - -.. code-block:: bash - - # Change directory to example - > cd platform-espressif32/examples/espidf-exceptions - - # Build project - > platformio run - - # Upload firmware - > platformio run --target upload - - # Build specific environment - > platformio run -e esp32dev - - # Upload firmware for the specific environment - > platformio run -e esp32dev --target upload - - # Clean build files - > platformio run --target clean diff --git a/examples/espidf-hello-world/README.md b/examples/espidf-hello-world/README.md new file mode 100644 index 0000000..4bad31e --- /dev/null +++ b/examples/espidf-hello-world/README.md @@ -0,0 +1,27 @@ +How to build PlatformIO based project +===================================== + +1. [Install PlatformIO Core](http://docs.platformio.org/page/core.html) +2. Download [development platform with examples](https://github.com/platformio/platform-espressif32/archive/develop.zip) +3. Extract ZIP archive +4. Run these commands: + +```shell +# Change directory to example +$ cd platform-espressif32/examples/espidf-hello-world + +# Build project +$ pio run + +# Upload firmware +$ pio run --target upload + +# Build specific environment +$ pio run -e esp32dev + +# Upload firmware for the specific environment +$ pio run -e esp32dev --target upload + +# Clean build files +$ pio run --target clean +``` \ No newline at end of file diff --git a/examples/espidf-hello-world/README.rst b/examples/espidf-hello-world/README.rst deleted file mode 100644 index 0dd0bcc..0000000 --- a/examples/espidf-hello-world/README.rst +++ /dev/null @@ -1,38 +0,0 @@ -.. Copyright 2014-present PlatformIO - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - -How to build PlatformIO based project -===================================== - -1. `Install PlatformIO Core `_ -2. Download `development platform with examples `_ -3. Extract ZIP archive -4. Run these commands: - -.. code-block:: bash - - # Change directory to example - > cd platform-espressif32/examples/espidf-hello-world - - # Build project - > platformio run - - # Upload firmware - > platformio run --target upload - - # Build specific environment - > platformio run -e esp32dev - - # Upload firmware for the specific environment - > platformio run -e esp32dev --target upload - - # Clean build files - > platformio run --target clean diff --git a/examples/espidf-http-request/README.md b/examples/espidf-http-request/README.md new file mode 100644 index 0000000..50c6665 --- /dev/null +++ b/examples/espidf-http-request/README.md @@ -0,0 +1,27 @@ +How to build PlatformIO based project +===================================== + +1. [Install PlatformIO Core](http://docs.platformio.org/page/core.html) +2. Download [development platform with examples](https://github.com/platformio/platform-espressif32/archive/develop.zip) +3. Extract ZIP archive +4. Run these commands: + +```shell +# Change directory to example +$ cd platform-espressif32/examples/espidf-http-request + +# Build project +$ pio run + +# Upload firmware +$ pio run --target upload + +# Build specific environment +$ pio run -e quantum + +# Upload firmware for the specific environment +$ pio run -e quantum --target upload + +# Clean build files +$ pio run --target clean +``` \ No newline at end of file diff --git a/examples/espidf-http-request/README.rst b/examples/espidf-http-request/README.rst deleted file mode 100644 index 0942be4..0000000 --- a/examples/espidf-http-request/README.rst +++ /dev/null @@ -1,38 +0,0 @@ -.. Copyright 2014-present PlatformIO - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - -How to build PlatformIO based project -===================================== - -1. `Install PlatformIO Core `_ -2. Download `development platform with examples `_ -3. Extract ZIP archive -4. Run these commands: - -.. code-block:: bash - - # Change directory to example - > cd platform-espressif32/examples/espidf-http-request - - # Build project - > platformio run - - # Upload firmware - > platformio run --target upload - - # Build specific environment - > platformio run -e quantum - - # Upload firmware for the specific environment - > platformio run -e quantum --target upload - - # Clean build files - > platformio run --target clean diff --git a/examples/espidf-peripherals-uart/README.md b/examples/espidf-peripherals-uart/README.md new file mode 100644 index 0000000..6df9193 --- /dev/null +++ b/examples/espidf-peripherals-uart/README.md @@ -0,0 +1,27 @@ +How to build PlatformIO based project +===================================== + +1. [Install PlatformIO Core](http://docs.platformio.org/page/core.html) +2. Download [development platform with examples](https://github.com/platformio/platform-espressif32/archive/develop.zip) +3. Extract ZIP archive +4. Run these commands: + +```shell +# Change directory to example +$ cd platform-espressif32/examples/espidf-peripherals-uart + +# Build project +$ pio run + +# Upload firmware +$ pio run --target upload + +# Build specific environment +$ pio run -e esp32dev + +# Upload firmware for the specific environment +$ pio run -e esp32dev --target upload + +# Clean build files +$ pio run --target clean +``` \ No newline at end of file diff --git a/examples/espidf-peripherals-uart/README.rst b/examples/espidf-peripherals-uart/README.rst deleted file mode 100644 index b3a999f..0000000 --- a/examples/espidf-peripherals-uart/README.rst +++ /dev/null @@ -1,38 +0,0 @@ -.. Copyright 2014-present PlatformIO - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - -How to build PlatformIO based project -===================================== - -1. `Install PlatformIO Core `_ -2. Download `development platform with examples `_ -3. Extract ZIP archive -4. Run these commands: - -.. code-block:: bash - - # Change directory to example - > cd platform-espressif32/examples/espidf-peripherals-uart - - # Build project - > platformio run - - # Upload firmware - > platformio run --target upload - - # Build specific environment - > platformio run -e esp32dev - - # Upload firmware for the specific environment - > platformio run -e esp32dev --target upload - - # Clean build files - > platformio run --target clean diff --git a/examples/espidf-peripherals-usb/README.md b/examples/espidf-peripherals-usb/README.md new file mode 100644 index 0000000..3a9f308 --- /dev/null +++ b/examples/espidf-peripherals-usb/README.md @@ -0,0 +1,21 @@ +How to build PlatformIO based project +===================================== + +1. [Install PlatformIO Core](http://docs.platformio.org/page/core.html) +2. Download [development platform with examples](https://github.com/platformio/platform-espressif32/archive/develop.zip) +3. Extract ZIP archive +4. Run these commands: + +```shell +# Change directory to example +$ cd platform-espressif32/examples/espidf-peripherals-usb + +# Build project +$ pio run + +# Upload firmware +$ pio run --target upload + +# Clean build files +$ pio run --target clean +``` diff --git a/examples/espidf-peripherals-usb/README.rst b/examples/espidf-peripherals-usb/README.rst deleted file mode 100644 index b6d181b..0000000 --- a/examples/espidf-peripherals-usb/README.rst +++ /dev/null @@ -1,32 +0,0 @@ -.. Copyright 2014-present PlatformIO - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - -How to build PlatformIO based project -===================================== - -1. `Install PlatformIO Core `_ -2. Download `development platform with examples `_ -3. Extract ZIP archive -4. Run these commands: - -.. code-block:: bash - - # Change directory to example - > cd platform-espressif32/examples/espidf-peripherals-usb - - # Build project - > platformio run - - # Upload firmware - > platformio run --target upload - - # Clean build files - > platformio run --target clean diff --git a/examples/espidf-storage-sdcard/README.md b/examples/espidf-storage-sdcard/README.md new file mode 100644 index 0000000..e2f4765 --- /dev/null +++ b/examples/espidf-storage-sdcard/README.md @@ -0,0 +1,27 @@ +How to build PlatformIO based project +===================================== + +1. [Install PlatformIO Core](http://docs.platformio.org/page/core.html) +2. Download [development platform with examples](https://github.com/platformio/platform-espressif32/archive/develop.zip) +3. Extract ZIP archive +4. Run these commands: + +```shell +# Change directory to example +$ cd platform-espressif32/examples/espidf-storage-sdcard + +# Build project +$ pio run + +# Upload firmware +$ pio run --target upload + +# Build specific environment +$ pio run -e esp32dev + +# Upload firmware for the specific environment +$ pio run -e esp32dev --target upload + +# Clean build files +$ pio run --target clean +``` diff --git a/examples/espidf-storage-sdcard/README.rst b/examples/espidf-storage-sdcard/README.rst deleted file mode 100644 index 2f296fc..0000000 --- a/examples/espidf-storage-sdcard/README.rst +++ /dev/null @@ -1,38 +0,0 @@ -.. Copyright 2014-present PlatformIO - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - -How to build PlatformIO based project -===================================== - -1. `Install PlatformIO Core `_ -2. Download `development platform with examples `_ -3. Extract ZIP archive -4. Run these commands: - -.. code-block:: bash - - # Change directory to example - > cd platform-espressif32/examples/espidf-storage-sdcard - - # Build project - > platformio run - - # Upload firmware - > platformio run --target upload - - # Build specific environment - > platformio run -e esp32dev - - # Upload firmware for the specific environment - > platformio run -e esp32dev --target upload - - # Clean build files - > platformio run --target clean diff --git a/examples/espidf-storage-spiffs/README.md b/examples/espidf-storage-spiffs/README.md new file mode 100644 index 0000000..81c1f0e --- /dev/null +++ b/examples/espidf-storage-spiffs/README.md @@ -0,0 +1,24 @@ +How to build PlatformIO based project +===================================== + +1. [Install PlatformIO Core](http://docs.platformio.org/page/core.html) +2. Download [development platform with examples](https://github.com/platformio/platform-espressif32/archive/develop.zip) +3. Extract ZIP archive +4. Run these commands: + +```shell +# Change directory to example +$ cd platform-espressif32/examples/espidf-storage-spiffs + +# Build project +$ pio run + +# Upload firmware +$ pio run --target upload + +# Upload SPIFFS image +$ pio run --target uploadfs + +# Clean build files +$ pio run --target clean +``` diff --git a/examples/espidf-storage-spiffs/README.rst b/examples/espidf-storage-spiffs/README.rst deleted file mode 100644 index 25efc94..0000000 --- a/examples/espidf-storage-spiffs/README.rst +++ /dev/null @@ -1,35 +0,0 @@ -.. Copyright 2014-present PlatformIO - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - -How to build PlatformIO based project -===================================== - -1. `Install PlatformIO Core `_ -2. Download `development platform with examples `_ -3. Extract ZIP archive -4. Run these commands: - -.. code-block:: bash - - # Change directory to example - > cd platform-espressif32/examples/espidf-storage-spiffs - - # Build project - > platformio run - - # Upload firmware - > platformio run --target upload - - # Upload SPIFFS image - > platformio run --target uploadfs - - # Clean build files - > platformio run --target clean diff --git a/examples/espidf-ulp-adc/README.md b/examples/espidf-ulp-adc/README.md new file mode 100644 index 0000000..465d156 --- /dev/null +++ b/examples/espidf-ulp-adc/README.md @@ -0,0 +1,27 @@ +How to build PlatformIO based project +===================================== + +1. [Install PlatformIO Core](http://docs.platformio.org/page/core.html) +2. Download [development platform with examples](https://github.com/platformio/platform-espressif32/archive/develop.zip) +3. Extract ZIP archive +4. Run these commands: + +```shell +# Change directory to example +$ cd platform-espressif32/examples/espidf-ulp-adc + +# Build project +$ pio run + +# Upload firmware +$ pio run --target upload + +# Build specific environment +$ pio run -e esp32dev + +# Upload firmware for the specific environment +$ pio run -e esp32dev --target upload + +# Clean build files +$ pio run --target clean +``` diff --git a/examples/espidf-ulp-adc/README.rst b/examples/espidf-ulp-adc/README.rst deleted file mode 100644 index 0a284cb..0000000 --- a/examples/espidf-ulp-adc/README.rst +++ /dev/null @@ -1,38 +0,0 @@ -.. Copyright 2014-present PlatformIO - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - -How to build PlatformIO based project -===================================== - -1. `Install PlatformIO Core `_ -2. Download `development platform with examples `_ -3. Extract ZIP archive -4. Run these commands: - -.. code-block:: bash - - # Change directory to example - > cd platform-espressif32/examples/espidf-ulp-adc - - # Build project - > platformio run - - # Upload firmware - > platformio run --target upload - - # Build specific environment - > platformio run -e esp32dev - - # Upload firmware for the specific environment - > platformio run -e esp32dev --target upload - - # Clean build files - > platformio run --target clean diff --git a/examples/espidf-ulp-pulse/README.md b/examples/espidf-ulp-pulse/README.md new file mode 100644 index 0000000..d6ca4f9 --- /dev/null +++ b/examples/espidf-ulp-pulse/README.md @@ -0,0 +1,27 @@ +How to build PlatformIO based project +===================================== + +1. [Install PlatformIO Core](http://docs.platformio.org/page/core.html) +2. Download [development platform with examples](https://github.com/platformio/platform-espressif32/archive/develop.zip) +3. Extract ZIP archive +4. Run these commands: + +```shell +# Change directory to example +$ cd platform-espressif32/examples/espidf-ulp-pulse + +# Build project +$ pio run + +# Upload firmware +$ pio run --target upload + +# Build specific environment +$ pio run -e esp32dev + +# Upload firmware for the specific environment +$ pio run -e esp32dev --target upload + +# Clean build files +$ pio run --target clean +``` diff --git a/examples/espidf-ulp-pulse/README.rst b/examples/espidf-ulp-pulse/README.rst deleted file mode 100644 index ec7495b..0000000 --- a/examples/espidf-ulp-pulse/README.rst +++ /dev/null @@ -1,38 +0,0 @@ -.. Copyright 2014-present PlatformIO - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - -How to build PlatformIO based project -===================================== - -1. `Install PlatformIO Core `_ -2. Download `development platform with examples `_ -3. Extract ZIP archive -4. Run these commands: - -.. code-block:: bash - - # Change directory to example - > cd platform-espressif32/examples/espidf-ulp-pulse - - # Build project - > platformio run - - # Upload firmware - > platformio run --target upload - - # Build specific environment - > platformio run -e esp32dev - - # Upload firmware for the specific environment - > platformio run -e esp32dev --target upload - - # Clean build files - > platformio run --target clean diff --git a/examples/pumbaa-blink/README.md b/examples/pumbaa-blink/README.md new file mode 100755 index 0000000..1de389c --- /dev/null +++ b/examples/pumbaa-blink/README.md @@ -0,0 +1,18 @@ +How to build PlatformIO based project +===================================== + +1. [Install PlatformIO Core](http://docs.platformio.org/page/core.html) +2. Download [development platform with examples](https://github.com/platformio/platform-espressif32/archive/develop.zip) +3. Extract ZIP archive +4. Run these commands: + +```shell +# Change directory to example +$ cd platform-espressif32/examples/pumbaa-blink + +# Process example project +$ pio run + +# Upload firmware +$ pio run --target upload +``` diff --git a/examples/pumbaa-blink/README.rst b/examples/pumbaa-blink/README.rst deleted file mode 100755 index 68035fd..0000000 --- a/examples/pumbaa-blink/README.rst +++ /dev/null @@ -1,29 +0,0 @@ -.. Copyright 2014-present PlatformIO - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - -How to build PlatformIO based project -===================================== - -1. `Install PlatformIO Core `_ -2. Download `development platform with examples `_ -3. Extract ZIP archive -4. Run these commands: - -.. code-block:: bash - - # Change directory to example - > cd platform-espressif32/examples/pumbaa-blink - - # Process example project - > platformio run - - # Upload firmware - > platformio run --target upload diff --git a/examples/simba-blink/README.md b/examples/simba-blink/README.md new file mode 100755 index 0000000..1543733 --- /dev/null +++ b/examples/simba-blink/README.md @@ -0,0 +1,18 @@ +How to build PlatformIO based project +===================================== + +1. [Install PlatformIO Core](http://docs.platformio.org/page/core.html) +2. Download [development platform with examples](https://github.com/platformio/platform-espressif32/archive/develop.zip) +3. Extract ZIP archive +4. Run these commands: + +```shell +# Change directory to example +$ cd platform-espressif32/examples/simba-blink + +# Process example project +$ pio run + +# Upload firmware +$ pio run --target upload +``` \ No newline at end of file diff --git a/examples/simba-blink/README.rst b/examples/simba-blink/README.rst deleted file mode 100755 index 62ded60..0000000 --- a/examples/simba-blink/README.rst +++ /dev/null @@ -1,29 +0,0 @@ -.. Copyright 2014-present PlatformIO - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - -How to build PlatformIO based project -===================================== - -1. `Install PlatformIO Core `_ -2. Download `development platform with examples `_ -3. Extract ZIP archive -4. Run these commands: - -.. code-block:: bash - - # Change directory to example - > cd platform-espressif32/examples/simba-blink - - # Process example project - > platformio run - - # Upload firmware - > platformio run --target upload