esp32-warm-water
esp32 based project for the control of a heating element based on temperature
Data Structures | Macros | Functions
owb_rmt.h File Reference

Interface definitions for ESP32 RMT driver used to communicate with devices on the One Wire Bus. More...

#include "freertos/FreeRTOS.h"
#include "freertos/queue.h"
#include "freertos/ringbuf.h"
#include "driver/rmt.h"
Include dependency graph for owb_rmt.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  owb_rmt_driver_info
 RMT driver information. More...
 

Macros

#define OWB_RMT_H
 

Functions

OneWireBusowb_rmt_initialize (owb_rmt_driver_info *info, gpio_num_t gpio_num, rmt_channel_t tx_channel, rmt_channel_t rx_channel)
 Initialise the RMT driver. More...
 

Detailed Description

Interface definitions for ESP32 RMT driver used to communicate with devices on the One Wire Bus.

This is the recommended driver.

Definition in file owb_rmt.h.

Macro Definition Documentation

◆ OWB_RMT_H

#define OWB_RMT_H

Definition at line 36 of file owb_rmt.h.

Function Documentation

◆ owb_rmt_initialize()

OneWireBus* owb_rmt_initialize ( owb_rmt_driver_info info,
gpio_num_t  gpio_num,
rmt_channel_t  tx_channel,
rmt_channel_t  rx_channel 
)

Initialise the RMT driver.

Parameters
[in]infoPointer to an uninitialized owb_rmt_driver_info structure. Note: the structure must remain in scope for the lifetime of this component.
[in]gpio_numThe GPIO number to use as the One Wire bus data line.
[in]tx_channelThe RMT channel to use for transmitting data to bus devices.
[in]rx_channelthe RMT channel to use for receiving data from bus devices.
Returns
OneWireBus *, pass this into the other OneWireBus public API functions

Definition at line 453 of file owb_rmt.c.

Here is the caller graph for this function: