GNU Radio 3.6.3.1 C++ API
i2c.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2001,2004 Free Software Foundation, Inc.
4  *
5  * This file is part of GNU Radio
6  *
7  * GNU Radio is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 3, or (at your option)
10  * any later version.
11  *
12  * GNU Radio is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with GNU Radio; see the file COPYING. If not, write to
19  * the Free Software Foundation, Inc., 51 Franklin Street,
20  * Boston, MA 02110-1301, USA.
21  */
22 
23 #ifndef INCLUDED_I2C_H
24 #define INCLUDED_I2C_H
25 
26 #include <gr_core_api.h>
27 #include <boost/shared_ptr.hpp>
28 
29 class i2c;
31 
32 /*!
33  * \brief abstract class for controlling i2c bus
34  */
36  public:
37 
38  i2c () {}
39  virtual ~i2c ();
40 
41  //! \returns true iff successful
42  virtual bool write (int addr, const unsigned char *buf, int nbytes) = 0;
43 
44  //! \returns number of bytes read or -1 if error
45  virtual int read (int addr, unsigned char *buf, int max_bytes) = 0;
46 };
47 
48 #endif /* INCLUDED_I2C_H */
49