libjoybus
Joybus implementation for 32-bit MCUs
Loading...
Searching...
No Matches
ESP32 Backend

Espressif ESP32 Joybus backend. More...

Data Structures

struct  joybus_esp32_data
struct  joybus_esp32
 An ESP32 Joybus instance. More...
struct  joybus_esp32_config
 Configuration for an ESP32 Joybus instance. More...

Macros

#define JOYBUS_ESP32(bus)
 Macro to cast a generic Joybus instance to an ESP32 Joybus instance.

Functions

static struct joybus_esp32_config joybus_esp32_config_default (gpio_num_t gpio)
 Build an ESP32 config with default values.
int joybus_esp32_init (struct joybus_esp32 *esp32_bus, struct joybus_esp32_config config)
 Initialize an ESP32 Joybus instance.

Detailed Description

Espressif ESP32 Joybus backend.

Macro Definition Documentation

◆ JOYBUS_ESP32

#define JOYBUS_ESP32 ( bus)
Value:
((struct joybus_esp32 *)(bus))
An ESP32 Joybus instance.
Definition esp32.h:71

Macro to cast a generic Joybus instance to an ESP32 Joybus instance.

Function Documentation

◆ joybus_esp32_config_default()

struct joybus_esp32_config joybus_esp32_config_default ( gpio_num_t gpio)
inlinestatic

Build an ESP32 config with default values.

Parameters
gpiothe GPIO pin to use for the Joybus data line
Returns
a config with the given GPIO and a nominal frequency

◆ joybus_esp32_init()

int joybus_esp32_init ( struct joybus_esp32 * esp32_bus,
struct joybus_esp32_config config )

Initialize an ESP32 Joybus instance.

Parameters
esp32_busthe ESP32 Joybus instance to initialize
configthe configuration to use, eg. from joybus_esp32_config_default()
Returns
0 on success, a negative joybus_error on failure