OVMS3-idf/docs/en/api-reference/peripherals/gpio.rst

GPIO & RTC GPIO
===============

Overview
--------

The ESP32 chip features 40 physical GPIO pads. Some GPIO pads cannot be used or do not have the corresponding pin on the chip package(refer to technical reference manual). Each pad can be used as a general purpose I/O or can be connected to an internal peripheral signal.

- Note that GPIO6-11 are usually used for SPI flash.
- GPIO34-39 can only be set as input mode and do not have software pullup or pulldown functions.

There is also separate "RTC GPIO" support, which functions when GPIOs are routed to the "RTC" low-power and analog subsystem. These pin functions can be used when in deep sleep, when the :doc:`Ultra Low Power co-processor <../../api-guides/ulp>` is running, or when analog functions such as ADC/DAC/etc are in use.

Application Example
-------------------

GPIO output and input interrupt example: :example:`peripherals/gpio`.

API Reference - Normal GPIO
---------------------------

.. include:: /_build/inc/gpio.inc

API Reference - RTC GPIO
------------------------

.. include:: /_build/inc/rtc_io.inc
docs: Add missing peripheral driver docs (ADC, DAC, RTC I/O, I2S) 2017-02-16 02:59:50 +00:00			`GPIO & RTC GPIO`
			`===============`
Draft of GPIO API included 2016-10-25 10:09:05 +00:00
API template - reflected template in other DRAFT API dcouments - DRAFT of Bluetooth API - link fixes in CONTRIBUTING.rst 2016-10-26 19:08:36 +00:00			`Overview`
			`--------`

Getting started guides 2017-03-26 22:01:52 +00:00			`The ESP32 chip features 40 physical GPIO pads. Some GPIO pads cannot be used or do not have the corresponding pin on the chip package(refer to technical reference manual). Each pad can be used as a general purpose I/O or can be connected to an internal peripheral signal.`
docs: Add missing peripheral driver docs (ADC, DAC, RTC I/O, I2S) 2017-02-16 02:59:50 +00:00
			`- Note that GPIO6-11 are usually used for SPI flash.`
			`- GPIO34-39 can only be set as input mode and do not have software pullup or pulldown functions.`

Getting started guides 2017-03-26 22:01:52 +00:00			There is also separate "RTC GPIO" support, which functions when GPIOs are routed to the "RTC" low-power and analog subsystem. These pin functions can be used when in deep sleep, when the :doc:`Ultra Low Power co-processor <../../api-guides/ulp>` is running, or when analog functions such as ADC/DAC/etc are in use.
API template - reflected template in other DRAFT API dcouments - DRAFT of Bluetooth API - link fixes in CONTRIBUTING.rst 2016-10-26 19:08:36 +00:00
			`Application Example`
			`-------------------`

docs: use custom roles to generate GitHub links This change replaces direct links to GitHub master branch with auto-generated links using docutils custom roles. These auto-generated links point to the tree or blob for the git commit ID (or tag) of the repository. This is needed to ensure that links don’t become broken when files in master branch are moved around or deleted. The following roles are introduced: - :idf:`path` - points to directory inside ESP-IDF - :idf_blob:`path` - points to file inside ESP-IDF - :idf_raw:`path` - points to raw view of the file inside ESP-IDF - :component:`path` - points to directory inside ESP-IDF components dir - :component_blob:`path` - points to file inside ESP-IDF components dir - :component_raw:`path` - points to raw view of the file inside ESP-IDF components dir - :example:`path` - points to directory inside ESP-IDF examples dir - :example_blob:`path` - points to file inside ESP-IDF examples dir - :example_raw:`path` - points to raw view of the file inside ESP-IDF examples dir A check is added to the CI build script, which searches RST files for presence of hard-coded links (identified by tree/master, blob/master, or raw/master part of the URL). This check can be run manually: cd docs && make gh-linkcheck Additionally, Sphinx linkcheck build type is used to create new CI test, which check for broken links. This test has to be triggered explicitly, because including it in normal build process (when the commit is not yet deployed to Github) will not work. It can be triggered in a regular fashion using a combination of cron and Curl, similar to stress tests. 2017-01-19 08:16:06 +00:00			GPIO output and input interrupt example: :example:`peripherals/gpio`.
All API Reference docs updated to match header files 1. Wi-Fi <api/esp_wifi> 2. Bluetooth <api/bt> 2. GPIO <api/gpio> 4. LED Control <api/ledc> 5. Logging <api/log> 6. Non-Volatile Storage <api/nvs_flash> 7. Virtual Filesystem <api/vfs> 2016-11-05 16:18:25 +00:00
docs: Generate Doxygen directives for API documentation This is to resolve issue reported in https://github.com/espressif/esp-idf/issues/130. 2017-05-02 08:36:01 +00:00			`API Reference - Normal GPIO`
			`---------------------------`
All API Reference docs updated to match header files 1. Wi-Fi <api/esp_wifi> 2. Bluetooth <api/bt> 2. GPIO <api/gpio> 4. LED Control <api/ledc> 5. Logging <api/log> 6. Non-Volatile Storage <api/nvs_flash> 7. Virtual Filesystem <api/vfs> 2016-11-05 16:18:25 +00:00
docs: Generate Doxygen directives for API documentation This is to resolve issue reported in https://github.com/espressif/esp-idf/issues/130. 2017-05-02 08:36:01 +00:00			`.. include:: /_build/inc/gpio.inc`
Revised api files - Included UART API - Addedd "Header Files" - Improved template - deleted redundat nvs.rst 2016-11-10 21:50:55 +00:00
docs: Generate Doxygen directives for API documentation This is to resolve issue reported in https://github.com/espressif/esp-idf/issues/130. 2017-05-02 08:36:01 +00:00			`API Reference - RTC GPIO`
			`------------------------`
Revised api files - Included UART API - Addedd "Header Files" - Improved template - deleted redundat nvs.rst 2016-11-10 21:50:55 +00:00
docs: Generate Doxygen directives for API documentation This is to resolve issue reported in https://github.com/espressif/esp-idf/issues/130. 2017-05-02 08:36:01 +00:00			`.. include:: /_build/inc/rtc_io.inc`
All API Reference docs updated to match header files 1. Wi-Fi <api/esp_wifi> 2. Bluetooth <api/bt> 2. GPIO <api/gpio> 4. LED Control <api/ledc> 5. Logging <api/log> 6. Non-Volatile Storage <api/nvs_flash> 7. Virtual Filesystem <api/vfs> 2016-11-05 16:18:25 +00:00