arduino-audio-driver
Public Member Functions | Public Attributes | List of all members
PinsI2C Struct Reference

I2C pins. More...

#include <DriverPins.h>

Public Member Functions

 PinsI2C ()=default
 
 PinsI2C (PinFunction function, GpioPin scl, GpioPin sda, int port=-1, uint32_t frequency=100000, TwoWire &wire=Wire, bool active=true)
 
bool begin ()
 
void end ()
 
 operator bool ()
 
bool pinsAvailable ()
 

Public Attributes

uint32_t frequency = 100000
 
PinFunction function
 
TwoWire * p_wire = &Wire
 
int port = -1
 
GpioPin scl = -1
 
GpioPin sda = -1
 
bool set_active = true
 

Detailed Description

I2C pins.

Author
Phil Schatzmann

Constructor & Destructor Documentation

◆ PinsI2C() [1/2]

PinsI2C ( )
default

◆ PinsI2C() [2/2]

PinsI2C ( PinFunction  function,
GpioPin  scl,
GpioPin  sda,
int  port = -1,
uint32_t  frequency = 100000,
TwoWire &  wire = Wire,
bool  active = true 
)
inline

Member Function Documentation

◆ begin()

bool begin ( )
inline

◆ end()

void end ( )
inline

◆ operator bool()

operator bool ( )
inline

◆ pinsAvailable()

bool pinsAvailable ( )
inline

Member Data Documentation

◆ frequency

uint32_t frequency = 100000

◆ function

PinFunction function

◆ p_wire

TwoWire* p_wire = &Wire

◆ port

int port = -1

◆ scl

GpioPin scl = -1

◆ sda

GpioPin sda = -1

◆ set_active

bool set_active = true

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