AceWire  0.2.0
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 
44 template <typename T_WIRE>
46  public:
53  explicit TwoWireInterface(T_WIRE& wire) : mWire(wire) {}
54 
56  void begin() {}
57 
59  void end() {}
60 
62  void beginTransmission(uint8_t addr) {
63  mWire.beginTransmission(addr);
64  }
65 
67  void write(uint8_t data) {
68  mWire.write(data);
69  }
70 
72  void endTransmission() {
73  mWire.endTransmission();
74  }
75 
77  uint8_t requestFrom(uint8_t addr, uint8_t quantity, bool stop = true) {
78  return mWire.requestFrom(addr, quantity, (uint8_t) stop);
79  }
80 
82  uint8_t read() {
83  return mWire.read();
84  }
85 
90  void endRequest() {}
91 
92  // Use default copy constructor and assignment operator.
93  TwoWireInterface(const TwoWireInterface&) = default;
94  TwoWireInterface& operator=(const TwoWireInterface&) = default;
95 
96  private:
97  T_WIRE& mWire;
98 };
99 
100 }
101 
102 #endif
ace_wire::TwoWireInterface::TwoWireInterface
TwoWireInterface(T_WIRE &wire)
Constructor.
Definition: TwoWireInterface.h:53
ace_wire::TwoWireInterface::endRequest
void endRequest()
End requestFrom().
Definition: TwoWireInterface.h:90
ace_wire::TwoWireInterface::beginTransmission
void beginTransmission(uint8_t addr)
Start transmission at specified I2C addr.
Definition: TwoWireInterface.h:62
ace_wire::TwoWireInterface::read
uint8_t read()
Read byte from buffer.
Definition: TwoWireInterface.h:82
ace_wire::TwoWireInterface::end
void end()
End the interface.
Definition: TwoWireInterface.h:59
ace_wire::TwoWireInterface::endTransmission
void endTransmission()
End building of the buffer, and actually transmit the data.
Definition: TwoWireInterface.h:72
ace_wire::TwoWireInterface::write
void write(uint8_t data)
Write data into the write buffer.
Definition: TwoWireInterface.h:67
ace_wire::TwoWireInterface::requestFrom
uint8_t requestFrom(uint8_t addr, uint8_t quantity, bool stop=true)
Read bytes from the slave and store in buffer owned by T_WIRE.
Definition: TwoWireInterface.h:77
ace_wire::TwoWireInterface
A thin wrapper around an I2C TwoWire class and its Wire object.
Definition: TwoWireInterface.h:45
ace_wire::TwoWireInterface::begin
void begin()
Initial the interface.
Definition: TwoWireInterface.h:56