ArduinoLibs
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
I2CMaster.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 I2CMaster_h
24 #define I2CMaster_h
25 
26 #include <inttypes.h>
27 
28 class I2CMaster {
29 public:
30  virtual unsigned int maxTransferSize() const = 0;
31 
32  virtual void startWrite(unsigned int address);
33  virtual void write(uint8_t value) = 0;
34  virtual bool endWrite() = 0;
35 
36  virtual bool startRead(unsigned int address, unsigned int count) = 0;
37  virtual unsigned int available() = 0;
38  virtual uint8_t read() = 0;
39 };
40 
41 #endif
virtual void write(uint8_t value)=0
Writes a single byte value on the I2C bus.
virtual bool startRead(unsigned int address, unsigned int count)=0
Starts a read operation for count bytes by sending the start condition and the I2C control byte...
virtual unsigned int maxTransferSize() const =0
Returns the maximum number of bytes that can be read or written in a single request by this bus maste...
virtual unsigned int available()=0
Returns the number of bytes that are still available for reading.
virtual void startWrite(unsigned int address)
Starts a write operation by sending a start condition and the I2C control byte.
virtual bool endWrite()=0
Ends the current write operation.
Abstract base class for I2C master implementations.
Definition: I2CMaster.h:28
virtual uint8_t read()=0
Reads a single byte from the I2C bus.