mirror
/
esp-idf
kopia lustrzana https://github.com/espressif/esp-idf
1
0
Forkuj 0
Kod Zgłoszenia Projekty Wydania Wiki Aktywność

Merge branch 'docs/update_syntax_error_for_customer_feedback' into 'master' 

docs: Update punctuation and syntax error for esp_err_tesp_sleep_enable_ext1_wakeup

Closes DOC-2263

See merge request espressif/esp-idf!15909
pull/7903/head
Shang Zhou 2021-11-12 06:41:49 +00:00
rodzic 0497f18688 1669504614
commit 6da09b3542
1 zmienionych plików z 4 dodań i 4 usunięć
Pokaż statystyki Ściągnij plik aktualizacji Ściągnij plik porównania Expand all files Collapse all files

8
components/esp_hw_support/include/esp_sleep.h
Wyświetl plik

@ -207,13 +207,13 @@ esp_err_t esp_sleep_enable_ext0_wakeup(gpio_num_t gpio_num, int level);
* configured in esp_sleep_start, immediately before * configured in esp_sleep_start, immediately before
* entering sleep mode. * entering sleep mode.
* *
* @note internal pullups and pulldowns don't work when RTC peripherals are * @note Internal pullups and pulldowns don't work when RTC peripherals are
* shut down. In this case, external resistors need to be added. * shut down. In this case, external resistors need to be added.
* Alternatively, RTC peripherals (and pullups/pulldowns) may be * Alternatively, RTC peripherals (and pullups/pulldowns) may be
* kept enabled using esp_sleep_pd_config function. * kept enabled using esp_sleep_pd_config function.
* *
* @param mask bit mask of GPIO numbers which will cause wakeup. Only GPIOs * @param mask bit mask of GPIO numbers which will cause wakeup. Only GPIOs
* which are have RTC functionality can be used in this bit map: * which have RTC functionality can be used in this bit map:
* 0,2,4,12-15,25-27,32-39. * 0,2,4,12-15,25-27,32-39.
* @param mode select logic function used to determine wakeup condition: * @param mode select logic function used to determine wakeup condition:
* - ESP_EXT1_WAKEUP_ALL_LOW: wake up when all selected GPIOs are low * - ESP_EXT1_WAKEUP_ALL_LOW: wake up when all selected GPIOs are low
@ -231,7 +231,7 @@ esp_err_t esp_sleep_enable_ext1_wakeup(uint64_t mask, esp_sleep_ext1_wakeup_mode
/** /**
* @brief Enable wakeup using specific gpio pins * @brief Enable wakeup using specific gpio pins
* *
* This function enables an IO pin to wake the chip from deep sleep * This function enables an IO pin to wake up the chip from deep sleep.
* *
* @note This function does not modify pin configuration. The pins are * @note This function does not modify pin configuration. The pins are
* configured in esp_sleep_start, immediately before * configured in esp_sleep_start, immediately before
@ -240,7 +240,7 @@ esp_err_t esp_sleep_enable_ext1_wakeup(uint64_t mask, esp_sleep_ext1_wakeup_mode
* @note You don't need to care to pull-up or pull-down before using this * @note You don't need to care to pull-up or pull-down before using this
* function, because this will be done in esp_sleep_start based on * function, because this will be done in esp_sleep_start based on
* param mask you give. BTW, when you use low level to wake up the * param mask you give. BTW, when you use low level to wake up the
* chip, we strongly recommand you to add external registors(pull-up). * chip, we strongly recommand you to add external registors (pull-up).
* *
* @param gpio_pin_mask Bit mask of GPIO numbers which will cause wakeup. Only GPIOs * @param gpio_pin_mask Bit mask of GPIO numbers which will cause wakeup. Only GPIOs
* which are have RTC functionality can be used in this bit map. * which are have RTC functionality can be used in this bit map.