mraa  0.9.6
Low Level Skeleton Library for Communication on GNU/Linux platforms
 All Data Structures Namespaces Files Functions Typedefs Enumerations Enumerator Macros Pages
i2c.hpp
1 /*
2  * Author: Brendan Le Foll <brendan.le.foll@intel.com>
3  * Copyright (c) 2014 Intel Corporation.
4  *
5  * Permission is hereby granted, free of charge, to any person obtaining
6  * a copy of this software and associated documentation files (the
7  * "Software"), to deal in the Software without restriction, including
8  * without limitation the rights to use, copy, modify, merge, publish,
9  * distribute, sublicense, and/or sell copies of the Software, and to
10  * permit persons to whom the Software is furnished to do so, subject to
11  * the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be
14  * included in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23  */
24 
25 #pragma once
26 
27 #include "i2c.h"
28 #include "types.hpp"
29 #include <stdexcept>
30 
31 namespace mraa
32 {
33 
43 class I2c
44 {
45  public:
54  I2c(int bus, bool raw = false)
55  {
56  if (raw) {
57  m_i2c = mraa_i2c_init_raw(bus);
58  } else {
59  m_i2c = mraa_i2c_init(bus);
60  }
61  if (m_i2c == NULL) {
62  throw std::invalid_argument("Invalid i2c bus");
63  }
64  }
65 
71  ~I2c()
72  {
73  mraa_i2c_stop(m_i2c);
74  }
75 
84  Result
86  {
87  return (Result) mraa_i2c_frequency(m_i2c, (mraa_i2c_mode_t) mode);
88  }
89 
97  Result
98  address(uint8_t address)
99  {
100  return (Result) mraa_i2c_address(m_i2c, address);
101  }
102 
108  uint8_t
110  {
111  return (uint8_t) mraa_i2c_read_byte(m_i2c);
112  }
113 
121  int
122  read(uint8_t* data, int length)
123  {
124  return mraa_i2c_read(m_i2c, data, length);
125  }
126 
133  uint8_t
134  readReg(uint8_t reg)
135  {
136  return mraa_i2c_read_byte_data(m_i2c, reg);
137  }
138 
145  uint16_t
146  readWordReg(uint8_t reg)
147  {
148  return mraa_i2c_read_word_data(m_i2c, reg);
149  }
150 
160  int
161  readBytesReg(uint8_t reg, uint8_t* data, int length)
162  {
163  return mraa_i2c_read_bytes_data(m_i2c, reg, data, length);
164  }
165 
172  Result
173  writeByte(uint8_t data)
174  {
175  return (Result) mraa_i2c_write_byte(m_i2c, data);
176  }
177 
186  Result
187  write(const uint8_t* data, int length)
188  {
189  return (Result) mraa_i2c_write(m_i2c, data, length);
190  }
191 
199  Result
200  writeReg(uint8_t reg, uint8_t data)
201  {
202  return (Result) mraa_i2c_write_byte_data(m_i2c, data, reg);
203  }
204 
212  Result
213  writeWordReg(uint8_t reg, uint16_t data)
214  {
215  return (Result) mraa_i2c_write_word_data(m_i2c, data, reg);
216  }
217 
218  private:
219  mraa_i2c_context m_i2c;
220 };
221 }
mraa_i2c_mode_t
Definition: types.h:228
Result
Definition: types.hpp:185
Result writeByte(uint8_t data)
Definition: i2c.hpp:173
mraa_result_t mraa_i2c_frequency(mraa_i2c_context dev, mraa_i2c_mode_t mode)
int mraa_i2c_read(mraa_i2c_context dev, uint8_t *data, int length)
mraa_i2c_context mraa_i2c_init(int bus)
uint8_t mraa_i2c_read_byte_data(mraa_i2c_context dev, const uint8_t command)
mraa_result_t mraa_i2c_write_byte(mraa_i2c_context dev, const uint8_t data)
mraa_result_t mraa_i2c_write_byte_data(mraa_i2c_context dev, const uint8_t data, const uint8_t command)
uint16_t mraa_i2c_read_word_data(mraa_i2c_context dev, const uint8_t command)
uint8_t readReg(uint8_t reg)
Definition: i2c.hpp:134
Result write(const uint8_t *data, int length)
Definition: i2c.hpp:187
int readBytesReg(uint8_t reg, uint8_t *data, int length)
Definition: i2c.hpp:161
I2cMode
Definition: types.hpp:220
mraa_result_t mraa_i2c_write(mraa_i2c_context dev, const uint8_t *data, int length)
uint16_t readWordReg(uint8_t reg)
Definition: i2c.hpp:146
Result writeWordReg(uint8_t reg, uint16_t data)
Definition: i2c.hpp:213
mraa_i2c_context mraa_i2c_init_raw(unsigned int bus)
struct _i2c * mraa_i2c_context
Definition: i2c.h:53
mraa_result_t mraa_i2c_address(mraa_i2c_context dev, uint8_t address)
Result writeReg(uint8_t reg, uint8_t data)
Definition: i2c.hpp:200
Result address(uint8_t address)
Definition: i2c.hpp:98
mraa_result_t mraa_i2c_stop(mraa_i2c_context dev)
int mraa_i2c_read_bytes_data(mraa_i2c_context dev, uint8_t command, uint8_t *data, int length)
uint8_t mraa_i2c_read_byte(mraa_i2c_context dev)
Result frequency(I2cMode mode)
Definition: i2c.hpp:85
~I2c()
Definition: i2c.hpp:71
API to Inter-Integrated Circuit.
Definition: i2c.hpp:43
int read(uint8_t *data, int length)
Definition: i2c.hpp:122
mraa_result_t mraa_i2c_write_word_data(mraa_i2c_context dev, const uint16_t data, const uint8_t command)
uint8_t readByte()
Definition: i2c.hpp:109
I2c(int bus, bool raw=false)
Definition: i2c.hpp:54
Inter-Integrated Circuit.