MAV'RIC
sonar.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.h
34  *
35  * \author MAV'RIC Team
36  * \author Julien Lecoeur
37  *
38  * \brief Definition of structure for sonar, independent of the sensor used
39  *
40  ******************************************************************************/
41 
42 
43 #ifndef SONAR_H_
44 #define SONAR_H_
45 
46 #ifdef __cplusplus
47  extern "C" {
48 #endif
49 
50 #include <stdint.h>
51 #include <stdbool.h>
52 #include "quaternions.h"
53 
57 typedef struct
58 {
59  uint32_t last_update;
61  float min_distance;
62  float max_distance;
64  float covariance;
65  bool healthy;
66 } sonar_t;
67 
68 
69 #ifdef __cplusplus
70  }
71 #endif
72 
73 #endif /* SONAR_H */
Sonar structure, independent of the sensor used.
Definition: sonar.h:57
uint32_t last_update
Time since system boot.
Definition: sonar.h:59
float covariance
Measurement covariance in centimeters, 0 for unknown / invalid readings.
Definition: sonar.h:64
float current_distance
Measured distance in meters.
Definition: sonar.h:63
float min_distance
Minimum distance the sensor can measure in centimeters.
Definition: sonar.h:61
float max_distance
Maximum distance the sensor can measure in centimeters.
Definition: sonar.h:62
bool healthy
Indicates whether the current measurement can be trusted.
Definition: sonar.h:65
Unit quaternion.
Definition: quaternions.h:62
quat_t orientation
Direction the sensor faces from FIXME enum.
Definition: sonar.h:60