uploaded 6 hours ago
TV-B-Gone board runtime component for ESP-IDF using the RMT TX peripheral.
readme
# TV-B-Gone for ESP-IDF
`tv-b-gone` packages the current TV-B-Gone ESP-IDF firmware as a reusable component for ESP-IDF projects while keeping the public C API under `tvbgone_core`.
This project is based on the [TV-B-Gone-kit_V2](https://github.com/maltman23/TV-B-Gone-kit_V2) by Mitch Altman.
## What It Includes
- The current TV-B-Gone IR transmit logic
- The bundled `WORLDcodes.cpp` TV-B-Gone power-code database shared with the Arduino implementation
- A root-level component layout consistent with the rest of this repository
## Core Responsibility
The core configures and drives only the IR output hardware. Button handling,
visible LED signaling, and any board-specific UI behavior belong in the
application or example code.
## Public API
```c
#include "tvbgone_core.h"
tvbgone_core_config_t config;
tvbgone_core_get_default_config(&config);
config.ir_led_gpio = GPIO_NUM_2;
ESP_ERROR_CHECK(tvbgone_core_init(&config));
ESP_ERROR_CHECK(tvbgone_core_send(TVBGONE_CORE_REGION_NA,
TVBGONE_CORE_SEND_MODE_SINGLE));
```
Available send options:
- Regions: `TVBGONE_CORE_REGION_NA`, `TVBGONE_CORE_REGION_EU`, `TVBGONE_CORE_REGION_BOTH`
- Modes: `TVBGONE_CORE_SEND_MODE_SINGLE`, `TVBGONE_CORE_SEND_MODE_CONTINUOUS`
Use `tvbgone_core_stop()` to interrupt an in-flight single sweep or stop a
continuous send loop. Use `tvbgone_core_deinit()` when you need to tear down the
IR hardware before reconfiguration.
## Example
The example in [`examples/tvbgone_esp32c3_supermini`](examples/tvbgone_esp32c3_supermini)
is the reference application for this component. It keeps the board-facing
behavior in example code:
- press NA to transmit the North America database
- press EU to transmit the Europe database
- press either button during transmission to stop and restart from the beginning
- drive the visible status LED outside the core API
## Build The Example
```bash
cd examples/tvbgone_esp32c3_supermini
idf.py set-target esp32c3
idf.py build
```
Links
- Homepage
- Documentation
-
Repository
3376bb1c1c084b62c1d8cac7c23a95923137cb52
- Issues
Supports all targets
Maintainer
- Pedro Minatel <pminatel@gmail.com>
License: CC-BY-SA-4.0
To add this component to your project, run:
download archive
idf.py add-dependency "pedrominatel/tv-b-gone^0.2.0"
Stats
-
Archive size ~ 29.64 KB
-
Downloaded in total 1 time
-
Weekly Downloads (All Versions)
-
This version: 0 times
Badge
