I2cSlave.h

Go to the documentation of this file.

/*
    I2cSlave.h - An I2C slave library
    For AVR ATMega328p (Arduino Uno) and ATMega2560 (Arduino Mega).
    This is part of the AVRTools library.
    Copyright (c) 2014 Igor Mikolic-Torreira.  All right reserved.

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/





#ifndef I2cSlave_h
#define I2cSlave_h


#ifdef I2cMaster_h
#error "You cannot use both I2cMaster and I2cSlave in the same application"
#endif


#include <stdint.h>

#ifdef DEBUG_I2cSlaveDiary
#include "USART0.h"
#endif



#ifndef I2C_SLAVE_BUFFER_SIZE
#define I2C_SLAVE_BUFFER_SIZE       32
#endif

#if I2C_SLAVE_BUFFER_SIZE > 255
#error "I2C_SLAVE_BUFFER_SIZE exceeds size of a uint8_t"
#endif





namespace I2cSlave
{


    uint8_t processI2cMessage( uint8_t* buffer, uint8_t len );




    enum I2cBusSpeed
    {
        kI2cBusSlow                 = 0,                    
        kI2cBusFast                 = 1                     
    };



    enum I2cStatusCodes
    {
/*
        kI2cCompletedOk                    = 0x00,
        kI2cNotStarted                     = 0x01,
        kI2cInProgress                     = 0x02,
        kI2cError                          = 0x04,
        kI2cBusError                       = 0x07
*/
        kI2cCompletedOk                    = 0x00,          
        kI2cError                          = 0x01,          
        kI2cTxPartial                      = 0x02,          
        kI2cRxOverflow                     = 0x04,          
        kI2cInProgress                     = 0x06           
    };



    enum I2cPullups
    {
        kPullupsOff                 = 0,                    
        kPullupsOn                  = 1                     
    };




    void start( uint8_t ownAddress, uint8_t speed = kI2cBusFast, bool answerGeneralCall = false );


    void stop();


    void pullups( uint8_t set = kPullupsOn );


    bool busy();


#ifdef DEBUG_I2cSlaveDiary

    void setDebugSout( Serial0* s );

    void clearDebugI2cDiary();
    void dumpDebugI2cDiary();

#endif

};


#endif