ArduinoLibs
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
SoftI2C.h
1 /*
2  * Copyright (C) 2012 Southern Storm Software, Pty Ltd.
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a
5  * copy of this software and associated documentation files (the "Software"),
6  * to deal in the Software without restriction, including without limitation
7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8  * and/or sell copies of the Software, and to permit persons to whom the
9  * Software is furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice shall be included
12  * in all copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
15  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
19  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
20  * DEALINGS IN THE SOFTWARE.
21  */
22 
23 #ifndef SoftI2C_h
24 #define SoftI2C_h
25 
26 #include "I2CMaster.h"
27 
28 class SoftI2C : public I2CMaster {
29 public:
30  SoftI2C(uint8_t dataPin, uint8_t clockPin);
31 
32  unsigned int maxTransferSize() const;
33 
34  void startWrite(unsigned int address);
35  void write(uint8_t value);
36  bool endWrite();
37 
38  bool startRead(unsigned int address, unsigned int count);
39  unsigned int available();
40  uint8_t read();
41 
42 private:
43  uint8_t _dataPin;
44  uint8_t _clockPin;
45  bool started;
46  bool acked;
47  bool inWrite;
48  unsigned int readCount;
49 
50  void start();
51  void stop();
52  void writeBit(bool bit);
53  bool readBit();
54 };
55 
56 #endif
Bit-banged implementation of an I2C master.
Definition: SoftI2C.h:28
bool startRead(unsigned int address, unsigned int count)
Starts a read operation for count bytes by sending the start condition and the I2C control byte...
Definition: SoftI2C.cpp:135
bool endWrite()
Ends the current write operation.
Definition: SoftI2C.cpp:129
SoftI2C(uint8_t dataPin, uint8_t clockPin)
Constructs a new software I2C master on dataPin and clockPin.
Definition: SoftI2C.cpp:50
unsigned int available()
Returns the number of bytes that are still available for reading.
Definition: SoftI2C.cpp:155
uint8_t read()
Reads a single byte from the I2C bus.
Definition: SoftI2C.cpp:160
void write(uint8_t value)
Writes a single byte value on the I2C bus.
Definition: SoftI2C.cpp:118
unsigned int maxTransferSize() const
Returns the maximum number of bytes that can be read or written in a single request by this bus maste...
Definition: SoftI2C.cpp:65
Abstract base class for I2C master implementations.
Definition: I2CMaster.h:28
void startWrite(unsigned int address)
Starts a write operation by sending a start condition and the I2C control byte.
Definition: SoftI2C.cpp:104