Digital IO
Public Member Functions
FastI2cMaster< sclPin, sdaPin > Class Template Reference

Fast software I2C master class. More...

#include <SoftI2cMaster.h>

Inheritance diagram for FastI2cMaster< sclPin, sdaPin >:
Inheritance graph
[legend]
Collaboration diagram for FastI2cMaster< sclPin, sdaPin >:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void begin ()
uint8_t read (uint8_t last)
void start ()
void stop (void)
bool transfer (uint8_t addressRW, void *buf, size_t nbyte, uint8_t option=I2C_STOP)
bool transferContinue (void *buf, size_t nbyte, uint8_t option=I2C_STOP)
bool write (uint8_t data)

Detailed Description

template<uint8_t sclPin, uint8_t sdaPin>
class FastI2cMaster< sclPin, sdaPin >

Fast software I2C master class.

Definition at line 169 of file SoftI2cMaster.h.


Member Function Documentation

template<uint8_t sclPin, uint8_t sdaPin>
void FastI2cMaster< sclPin, sdaPin >::begin ( ) [inline]

Initialize I2C bus pins.

Definition at line 177 of file SoftI2cMaster.h.

template<uint8_t sclPin, uint8_t sdaPin>
uint8_t FastI2cMaster< sclPin, sdaPin >::read ( uint8_t  last) [inline, virtual]

Read a byte

Note:
This function should only be used by experts. Data should be accessed by calling transfer() and transferContinue()
Parameters:
[in]lastsend a NACK to terminate read if last is true else send an ACK to continue the read.
Returns:
byte read from I2C bus

Implements I2cMasterBase.

Definition at line 185 of file SoftI2cMaster.h.

template<uint8_t sclPin, uint8_t sdaPin>
void FastI2cMaster< sclPin, sdaPin >::start ( ) [inline, virtual]

Issue a start condition

Note:
This function should only be used by experts. Data should be accessed by calling transfer() and transferContinue()

Implements I2cMasterBase.

Definition at line 208 of file SoftI2cMaster.h.

template<uint8_t sclPin, uint8_t sdaPin>
void FastI2cMaster< sclPin, sdaPin >::stop ( void  ) [inline, virtual]

Issue a stop condition.

Note:
This function should only be used by experts. Data should be accessed by calling transfer() and transferContinue()

Implements I2cMasterBase.

Definition at line 222 of file SoftI2cMaster.h.

template<uint8_t sclPin, uint8_t sdaPin>
bool FastI2cMaster< sclPin, sdaPin >::write ( uint8_t  data) [inline, virtual]

Write a byte

Note:
This function should only be used by experts. Data should be accessed by calling transfer() and transferContinue()
Parameters:
[in]databyte to write
Returns:
true for ACK or false for NACK

Implements I2cMasterBase.

Definition at line 231 of file SoftI2cMaster.h.


The documentation for this class was generated from the following file:
 All Classes Files Functions Variables Defines