Andrew Fagg / I2CTransaction

Class for representing and controlling entire I2C transactions (the master side). This class allows one to separate in code the configuration of I2C transactions from their use. This property simplifies the process of executing transactions in, for example, the body of a real-time control loop.

I2CTransaction.h

Committer:
symbiotic
Date:
2014-12-20
Revision:
8:63e07ac95a2c
Parent:
7:61e9a1da1f20

File content as of revision 8:63e07ac95a2c:

#ifndef I2CTRANSACTION_H
#define I2CTRANSACTION_H
#include "MODI2C.h"

class I2CTransaction
{
public:
    I2CTransaction(int address, char* writePacket, int writePacketLength, char* readPacket = NULL, int readPacketLength = 0);
    static void setFrequency(int frequency);
    static void setMaxRetry(int maxRetry);
    bool completed();
    int getStatus(int i);
    bool initiateTransaction();
    bool waitForCompletion(int timeout = 1000);
    void displayStatus(Serial *pc, char * strg);
    bool success();
    bool transmissionError(); 
    bool checkTransaction();
    void clearStatus();
    static int getI2CQueueLength();
    static void reset();
    static void resetBus();
    static void cycleBus();
    static void initI2C(PinName sda, PinName scl);

private:
    static MODI2C *i2c;

    int status[2];      // Status words for both the write and read halves of the transaction
    int address;
    char* writePacket;
    int writePacketLength;
    char* readPacket;
    int readPacketLength;
    int retryCount;
    static int maxRetryCount;
};


#endif