MAV'RIC
sonar_i2cxl.h
1 /*******************************************************************************
2  * Copyright (c) 2009-2014, MAV'RIC Development Team
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright notice,
9  * this list of conditions and the following disclaimer.
10  *
11  * 2. Redistributions in binary form must reproduce the above copyright notice,
12  * this list of conditions and the following disclaimer in the documentation
13  * and/or other materials provided with the distribution.
14  *
15  * 3. Neither the name of the copyright holder nor the names of its contributors
16  * may be used to endorse or promote products derived from this software without
17  * specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
23  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  ******************************************************************************/
31 
32 /*******************************************************************************
33  * \file sonar_i2cxl.h
34  *
35  * \author MAV'RIC Team
36  * \author Julien Lecoeur
37  *
38  * \brief Driver for the sonar module using i2C communication protocol
39  *
40  ******************************************************************************/
41 
42 
43 #ifndef I2CXL_SONAR_H_
44 #define I2CXL_SONAR_H_
45 
46 #ifdef __cplusplus
47  extern "C" {
48 #endif
49 
50 #include <stdint.h>
51 #include "sonar.h"
52 
56 typedef struct
57 {
58  uint8_t i2c_address;
61 
67 void sonar_i2cxl_init(sonar_i2cxl_t* sonar);
68 
75 void sonar_i2cxl_update(sonar_i2cxl_t* sonar);
76 
77 
78 #ifdef __cplusplus
79  }
80 #endif
81 
82 #endif /* I2CXL_SONAR_H */
Sonar structure, independent of the sensor used.
Definition: sonar.h:57
uint8_t i2c_address
address of the sonar module
Definition: sonar_i2cxl.h:58
sonar_t data
sensor data
Definition: sonar_i2cxl.h:59
structure of the sonar_i2cxl module
Definition: sonar_i2cxl.h:56