arduino-audio-driver
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Public Member Functions | Public Attributes | List of all members
PinsI2C Struct Reference

I2C pins. More...

#include <DriverPins.h>

Inheritance diagram for PinsI2C:
I2CConfig

Public Member Functions

 PinsI2C ()
 
 PinsI2C (PinFunction function, GpioPin scl, GpioPin sda, int address=-1, uint32_t frequency=100000, i2c_bus_handle_t wire=nullptr, bool active=true)
 
bool begin ()
 
void end ()
 
 operator bool ()
 
bool pinsAvailable ()
 

Public Attributes

int address
 
uint32_t frequency
 
PinFunction function
 
i2c_bus_handle_t p_wire
 
int port
 
GpioPin scl
 
GpioPin sda
 
bool set_active = true
 

Detailed Description

I2C pins.

Author
Phil Schatzmann

Constructor & Destructor Documentation

◆ PinsI2C() [1/2]

PinsI2C ( )
inline

◆ PinsI2C() [2/2]

PinsI2C ( PinFunction  function,
GpioPin  scl,
GpioPin  sda,
int  address = -1,
uint32_t  frequency = 100000,
i2c_bus_handle_t  wire = nullptr,
bool  active = true 
)
inline

Member Function Documentation

◆ begin()

bool begin ( )
inline

< error_t value indicating success (no error)

◆ end()

void end ( )
inline

◆ operator bool()

operator bool ( )
inline

◆ pinsAvailable()

bool pinsAvailable ( )
inline

Member Data Documentation

◆ address

int address
inherited

◆ frequency

uint32_t frequency
inherited

◆ function

PinFunction function

◆ p_wire

i2c_bus_handle_t p_wire
inherited

◆ port

int port
inherited

◆ scl

GpioPin scl
inherited

◆ sda

GpioPin sda
inherited

◆ set_active

bool set_active = true

The documentation for this struct was generated from the following file: