alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2025-08-25 17:58:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

rmt: add documentation

Browse Source
This commit is contained in:
Wangjialin
2016-11-22 01:31:56 +08:00
committed by Ivan Grokhotkov
parent 6a1dbc3f1c
commit 235eceea06
4 changed files with 105 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
components/driver/include/driver/rmt.h
View File

@@ -80,6 +80,9 @@ typedef enum {
RMT_CARRIER_LEVEL_MAX
} rmt_carrier_level_t;
/**
* @brief Data struct of RMT TX configure parameters
*/
typedef struct {
bool loop_en; /*!< RMT loop output mode*/
uint32_t carrier_freq_hz; /*!< RMT carrier frequency */
@@ -90,12 +93,18 @@ typedef struct {
bool idle_output_en; /*!< RMT idle level output enable*/
}rmt_tx_config_t;
/**
* @brief Data struct of RMT RX configure parameters
*/
typedef struct {
bool filter_en; /*!< RMT receiver filer enable*/
uint8_t filter_ticks_thresh; /*!< RMT filter tick number */
uint16_t idle_threshold; /*!< RMT RX idle threshold */
}rmt_rx_config_t;
/**
* @brief Data struct of RMT configure parameters
*/
typedef struct {
rmt_mode_t rmt_mode; /*!< RMT mode: transmitter or receiver */
rmt_channel_t channel; /*!< RMT channel */