OVMS3-idf/examples/peripherals/rmt_nec_tx_rx/README.md

# _RMT NEC_TX_RX Example_

(See the README.md file in the upper level 'examples' directory for more information about examples.)

This example uses the remote control (RMT) peripheral to transmit and receive codes for the NEC infrared remote protocol.

## How to Use Example

### Hardware Required

* A development board with ESP32 SoC (e.g., ESP32-DevKitC, ESP-WROVER-KIT, etc.)
* A USB cable for Power supply and programming

By default, this example runs a self test which assumes the TX pin (GPIO18) and RX pin (GPIO19) are _connected together_. 

To disable self-test mode, comment out RMT_RX_SELF_TEST in infrared_nec_main.c, after which, you need to connect a IR transmitter and a receiver to GPIO18 and GPIO19. 

The TX pin and RX pin can be modified in top of the main/infrared_nec_main.c file.

```
#define RMT_TX_GPIO_NUM  18     /*!< GPIO number for transmitter signal */
#define RMT_RX_GPIO_NUM  19     /*!< GPIO number for receiver */
```

### Configure the Project

```
make menuconfig
```

* Set serial port under Serial Flasher Options.

### Build and Flash

Build the project and flash it to the board, then run monitor tool to view serial output:

```
make -j4 flash monitor
```

(To exit the serial monitor, type ``Ctrl-]``.)

See the Getting Started Guide for full steps to configure and use ESP-IDF to build projects.

## Example Output

Run this example, you will see the following output log:
```
NEC: RMT TX DATA
NEC: RMT RCV --- addr: 0xee11 cmd: 0xff00
NEC: RMT RCV --- addr: 0xed12 cmd: 0xfe01
NEC: RMT RCV --- addr: 0xec13 cmd: 0xfd02
NEC: RMT RCV --- addr: 0xeb14 cmd: 0xfc03
NEC: RMT RCV --- addr: 0xea15 cmd: 0xfb04
NEC: RMT RCV --- addr: 0xe916 cmd: 0xfa05
NEC: RMT RCV --- addr: 0xe817 cmd: 0xf906
NEC: RMT RCV --- addr: 0xe718 cmd: 0xf807
NEC: RMT RCV --- addr: 0xe619 cmd: 0xf708
NEC: RMT RCV --- addr: 0xe51a cmd: 0xf609
NEC: RMT RCV --- addr: 0xe41b cmd: 0xf50a
NEC: RMT RCV --- addr: 0xe31c cmd: 0xf40b
NEC: RMT RCV --- addr: 0xe21d cmd: 0xf30c
NEC: RMT RCV --- addr: 0xe11e cmd: 0xf20d
NEC: RMT RCV --- addr: 0xe01f cmd: 0xf10e
NEC: RMT RCV --- addr: 0xdf20 cmd: 0xf00f
NEC: RMT RCV --- addr: 0xde21 cmd: 0xef10
NEC: RMT RCV --- addr: 0xdd22 cmd: 0xee11
NEC: RMT RCV --- addr: 0xdc23 cmd: 0xed12
NEC: RMT RCV --- addr: 0xdb24 cmd: 0xec13
NEC: RMT RCV --- addr: 0xda25 cmd: 0xeb14
```

## Troubleshooting

* Programming fail

    * Hardware connection is not correct: run `make monitor`, and reboot your board to see if there is any output logs.
    * The baud rate for downloading is too high: lower your baud rate in the `menuconfig` menu, and try again.

For any technical queries, please open an [issue] (https://github.com/espressif/esp-idf/issues) on GitHub. We will get back to you soon.
Update README.md 2018-07-15 04:52:55 +00:00			`# _RMT NEC_TX_RX Example_`
examples: Standardise naming of files, symbols, etc. in examples * Use "example" in all example function & variable names, ie use i2c_example_xxx instead of i2c_xxx for example functions. Closes #198 https://github.com/espressif/esp-idf/issues/198 * Mark example functions, etc. static * Replace uses of "test" & "demo" with "example" * Split the UART example into two * Rename "main" example files to end with "_main.c" for disambiguation 2017-03-22 04:36:11 +00:00
driver(rmt): update README.md file of rmt related example. 2018-06-27 11:27:56 +00:00			`(See the README.md file in the upper level 'examples' directory for more information about examples.)`
Examples: Add READMEs for examples which did not have them Closes github #128 https://github.com/espressif/esp-idf/issues/128 2016-12-22 01:18:15 +00:00
driver(rmt): update README.md file of rmt related example. 2018-06-27 11:27:56 +00:00			`This example uses the remote control (RMT) peripheral to transmit and receive codes for the NEC infrared remote protocol.`

			`## How to Use Example`

			`### Hardware Required`

doc(rmt): fixed some typos in rmt example readme file 2018-09-17 02:18:59 +00:00			`* A development board with ESP32 SoC (e.g., ESP32-DevKitC, ESP-WROVER-KIT, etc.)`
Update README.md 2018-07-15 04:52:55 +00:00			`* A USB cable for Power supply and programming`
driver(rmt): update README.md file of rmt related example. 2018-06-27 11:27:56 +00:00
			`By default, this example runs a self test which assumes the TX pin (GPIO18) and RX pin (GPIO19) are _connected together_.`

			`To disable self-test mode, comment out RMT_RX_SELF_TEST in infrared_nec_main.c, after which, you need to connect a IR transmitter and a receiver to GPIO18 and GPIO19.`

			`The TX pin and RX pin can be modified in top of the main/infrared_nec_main.c file.`

			```
			`#define RMT_TX_GPIO_NUM 18 /!< GPIO number for transmitter signal /`
			`#define RMT_RX_GPIO_NUM 19 /!< GPIO number for receiver /`
			```

			`### Configure the Project`

			```
			`make menuconfig`
			```

			`* Set serial port under Serial Flasher Options.`

			`### Build and Flash`

			`Build the project and flash it to the board, then run monitor tool to view serial output:`

			```
			`make -j4 flash monitor`
			```

			(To exit the serial monitor, type ``Ctrl-]``.)

			`See the Getting Started Guide for full steps to configure and use ESP-IDF to build projects.`

			`## Example Output`

			`Run this example, you will see the following output log:`
			```
			`NEC: RMT TX DATA`
			`NEC: RMT RCV --- addr: 0xee11 cmd: 0xff00`
			`NEC: RMT RCV --- addr: 0xed12 cmd: 0xfe01`
			`NEC: RMT RCV --- addr: 0xec13 cmd: 0xfd02`
			`NEC: RMT RCV --- addr: 0xeb14 cmd: 0xfc03`
			`NEC: RMT RCV --- addr: 0xea15 cmd: 0xfb04`
			`NEC: RMT RCV --- addr: 0xe916 cmd: 0xfa05`
			`NEC: RMT RCV --- addr: 0xe817 cmd: 0xf906`
			`NEC: RMT RCV --- addr: 0xe718 cmd: 0xf807`
			`NEC: RMT RCV --- addr: 0xe619 cmd: 0xf708`
			`NEC: RMT RCV --- addr: 0xe51a cmd: 0xf609`
			`NEC: RMT RCV --- addr: 0xe41b cmd: 0xf50a`
			`NEC: RMT RCV --- addr: 0xe31c cmd: 0xf40b`
			`NEC: RMT RCV --- addr: 0xe21d cmd: 0xf30c`
			`NEC: RMT RCV --- addr: 0xe11e cmd: 0xf20d`
			`NEC: RMT RCV --- addr: 0xe01f cmd: 0xf10e`
			`NEC: RMT RCV --- addr: 0xdf20 cmd: 0xf00f`
			`NEC: RMT RCV --- addr: 0xde21 cmd: 0xef10`
			`NEC: RMT RCV --- addr: 0xdd22 cmd: 0xee11`
			`NEC: RMT RCV --- addr: 0xdc23 cmd: 0xed12`
			`NEC: RMT RCV --- addr: 0xdb24 cmd: 0xec13`
			`NEC: RMT RCV --- addr: 0xda25 cmd: 0xeb14`
			```

			`## Troubleshooting`

			`* Programming fail`

Update README.md 2018-07-15 04:52:55 +00:00			* Hardware connection is not correct: run `make monitor`, and reboot your board to see if there is any output logs.
			* The baud rate for downloading is too high: lower your baud rate in the `menuconfig` menu, and try again.
driver(rmt): update README.md file of rmt related example. 2018-06-27 11:27:56 +00:00
doc(rmt): fixed some typos in rmt example readme file 2018-09-17 02:18:59 +00:00			`For any technical queries, please open an [issue] (https://github.com/espressif/esp-idf/issues) on GitHub. We will get back to you soon.`