alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Merge branch 'bugfix/gpio_timer_doc_fixes' into 'master'

Browse Source 
Minor fixes of GPIO and timer group driver docs

See merge request idf/esp-idf!2081
This commit is contained in:
Ivan Grokhotkov 2018-03-20 10:49:36 +08:00
commit 7e2028d598
3 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
components/driver/include/driver/gpio.h
View File

@ -302,6 +302,8 @@ esp_err_t gpio_set_level(gpio_num_t gpio_num, uint32_t level);
/** /**
* @brief GPIO get input level * @brief GPIO get input level
* *
* @warning If the pad is not configured for input (or input and output) the returned value is always 0.
*
* @param gpio_num GPIO number. If you want to get the logic level of e.g. pin GPIO16, gpio_num should be GPIO_NUM_16 (16); * @param gpio_num GPIO number. If you want to get the logic level of e.g. pin GPIO16, gpio_num should be GPIO_NUM_16 (16);
* *
* @return * @return

2
components/driver/include/driver/timer.h
View File

@ -238,7 +238,7 @@ esp_err_t timer_set_alarm_value(timer_group_t group_num, timer_idx_t timer_num,
esp_err_t timer_get_alarm_value(timer_group_t group_num, timer_idx_t timer_num, uint64_t* alarm_value); esp_err_t timer_get_alarm_value(timer_group_t group_num, timer_idx_t timer_num, uint64_t* alarm_value);
/** /**
* @brief Get timer alarm value. * @brief Enable or disable generation of timer alarm events.
* *
* @param group_num Timer group, 0 for TIMERG0 or 1 for TIMERG1 * @param group_num Timer group, 0 for TIMERG0 or 1 for TIMERG1
* @param timer_num Timer index, 0 for hw_timer[0] & 1 for hw_timer[1] * @param timer_num Timer index, 0 for hw_timer[0] & 1 for hw_timer[1]

3
docs/en/api-reference/peripherals/timer.rst
View File

@ -67,7 +67,8 @@ After the alarm is enabled and the timer reaches the alarm value, depending on c
.. note:: .. note::
The alarm will be triggered immediately, if an alarm value is set and the timer has already passed this value. * The alarm will be triggered immediately, if an alarm value is set and the timer has already passed this value.
* Once triggered the alarm will be disabled automatically and needs to be re-armed to trigger again.
To check what alarm value has been set up, call :cpp:func:`timer_get_alarm_value`. To check what alarm value has been set up, call :cpp:func:`timer_get_alarm_value`.