AceWire  0.4.1
Unified interface for selecting different I2C implementations on Arduino platforms
TwoWireInterface.h
1 /*
2 MIT License
3 
4 Copyright (c) 2021 Brian T. Park
5 
6 Permission is hereby granted, free of charge, to any person obtaining a copy
7 of this software and associated documentation files (the "Software"), to deal
8 in the Software without restriction, including without limitation the rights
9 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 copies of the Software, and to permit persons to whom the Software is
11 furnished to do so, subject to the following conditions:
12 
13 The above copyright notice and this permission notice shall be included in all
14 copies or substantial portions of the Software.
15 
16 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22 SOFTWARE.
23 */
24 
25 #ifndef ACE_WIRE_TWO_WIRE_INTERFACE_H
26 #define ACE_WIRE_TWO_WIRE_INTERFACE_H
27 
28 #include <stdint.h>
29 
30 namespace ace_wire {
31 
49 template <typename T_WIRE>
51  public:
56  explicit TwoWireInterface(T_WIRE& wire) : mWire(wire) {}
57 
59  void begin() const {}
60 
62  void end() const {}
63 
71  uint8_t beginTransmission(uint8_t addr) const {
72  mWire.beginTransmission(addr);
73  return 0;
74  }
75 
81  uint8_t write(uint8_t data) const {
82  return (uint8_t) mWire.write(data);
83  }
84 
98  uint8_t endTransmission(bool sendStop = true) const {
99  return mWire.endTransmission(sendStop);
100  }
101 
113  uint8_t requestFrom(uint8_t addr, uint8_t quantity, bool sendStop = true)
114  const {
115  return mWire.requestFrom(addr, quantity, (uint8_t) sendStop);
116  }
117 
119  uint8_t read() const {
120  return mWire.read();
121  }
122 
123  // Use default copy constructor and assignment operator.
124  TwoWireInterface(const TwoWireInterface&) = default;
125  TwoWireInterface& operator=(const TwoWireInterface&) = default;
126 
127  private:
128  T_WIRE& mWire;
129 };
130 
131 }
132 
133 #endif
ace_wire::TwoWireInterface::TwoWireInterface
TwoWireInterface(T_WIRE &wire)
Constructor.
Definition: TwoWireInterface.h:56
ace_wire::TwoWireInterface::read
uint8_t read() const
Read byte from the TwoWire receive buffer.
Definition: TwoWireInterface.h:119
ace_wire::TwoWireInterface::begin
void begin() const
Initialize the interface.
Definition: TwoWireInterface.h:59
ace_wire::TwoWireInterface::beginTransmission
uint8_t beginTransmission(uint8_t addr) const
Prepare the write buffer to accept a sequence of data, and save the addr for transmission when endTra...
Definition: TwoWireInterface.h:71
ace_wire::TwoWireInterface::endTransmission
uint8_t endTransmission(bool sendStop=true) const
Send the data in the buffer, with a STOP condition if sendStop is true.
Definition: TwoWireInterface.h:98
ace_wire::TwoWireInterface
A thin wrapper around the default TwoWire class and its Wire object provided by most Arduino platform...
Definition: TwoWireInterface.h:50
ace_wire::TwoWireInterface::end
void end() const
End the interface.
Definition: TwoWireInterface.h:62
ace_wire::TwoWireInterface::requestFrom
uint8_t requestFrom(uint8_t addr, uint8_t quantity, bool sendStop=true) const
Read bytes from the slave and store in buffer owned by TwoWire and send a STOP condition if sendStop ...
Definition: TwoWireInterface.h:113
ace_wire::TwoWireInterface::write
uint8_t write(uint8_t data) const
Write data into the write buffer.
Definition: TwoWireInterface.h:81