PX4 Firmware
PX4 Autopilot Software http://px4.io
drv_mag.h
Go to the documentation of this file.
1 /****************************************************************************
2  *
3  * Copyright (c) 2012-2016 PX4 Development Team. 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
7  * are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  * notice, this list of conditions and the following disclaimer in
13  * the documentation and/or other materials provided with the
14  * distribution.
15  * 3. Neither the name PX4 nor the names of its contributors may be
16  * used to endorse or promote products derived from this software
17  * without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
22  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
23  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
24  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
25  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
26  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
27  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
29  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  *
32  ****************************************************************************/
33 
34 /**
35  * @file Magnetometer driver interface.
36  */
37 
38 #ifndef _DRV_MAG_H
39 #define _DRV_MAG_H
40 
41 #include <stdint.h>
42 #include <sys/ioctl.h>
43 
44 #include "drv_sensor.h"
45 #include "drv_orb_dev.h"
46 
47 #define MAG_BASE_DEVICE_PATH "/dev/mag"
48 #define MAG0_DEVICE_PATH "/dev/mag0"
49 #define MAG1_DEVICE_PATH "/dev/mag1"
50 #define MAG2_DEVICE_PATH "/dev/mag2"
51 
52 #include <uORB/topics/sensor_mag.h>
53 #define mag_report sensor_mag_s
54 
55 /** mag scaling factors; Vout = (Vin * Vscale) + Voffset */
57  float x_offset;
58  float x_scale;
59  float y_offset;
60  float y_scale;
61  float z_offset;
62  float z_scale;
63 };
64 
65 /*
66  * ioctl() definitions
67  */
68 
69 #define _MAGIOCBASE (0x2400)
70 #define _MAGIOC(_n) (_PX4_IOC(_MAGIOCBASE, _n))
71 
72 /** set the mag scaling constants to the structure pointed to by (arg) */
73 #define MAGIOCSSCALE _MAGIOC(4)
74 
75 /** copy the mag scaling constants to the structure pointed to by (arg) */
76 #define MAGIOCGSCALE _MAGIOC(5)
77 
78 /** set the measurement range to handle (at least) arg Gauss */
79 #define MAGIOCSRANGE _MAGIOC(6)
80 
81 /** perform self-calibration, update scale factors to canonical units */
82 #define MAGIOCCALIBRATE _MAGIOC(8)
83 
84 /** excite strap */
85 #define MAGIOCEXSTRAP _MAGIOC(9)
86 
87 /** determine if mag is external or onboard */
88 #define MAGIOCGEXTERNAL _MAGIOC(11)
89 
90 /** enable/disable temperature compensation */
91 #define MAGIOCSTEMPCOMP _MAGIOC(12)
92 
93 #endif /* _DRV_MAG_H */
uORB published object driver.
mag scaling factors; Vout = (Vin * Vscale) + Voffset
Definition: drv_mag.h:56
float x_offset
Definition: drv_mag.h:57
float y_offset
Definition: drv_mag.h:59
Common sensor API and ioctl definitions.
float z_offset
Definition: drv_mag.h:61