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"

Go to the source code of this file.

Data Structures
struct	owb_rmt_driver_info
	RMT driver information. More...

Functions
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. More...

Detailed Description

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

This is the recommended driver.

Function Documentation

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]	info	Pointer to an uninitialized owb_rmt_driver_info structure. Note: the structure must remain in scope for the lifetime of this component.
[in]	gpio_num	The GPIO number to use as the One Wire bus data line.
[in]	tx_channel	The RMT channel to use for transmitting data to bus devices.
[in]	rx_channel	the RMT channel to use for receiving data from bus devices.

Returns

OneWireBus *, pass this into the other OneWireBus public API functions