aboutsummaryrefslogtreecommitdiff
path: root/src/modules/uORB/topics/offboard_control_setpoint.h
blob: 47c89f70831fdbe83778979379f6483f25839c5f (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
/****************************************************************************
 *
 *	 Copyright (C) 2008-2012 PX4 Development Team. All rights reserved.
 *	 Author: @author Lorenz Meier <lm@inf.ethz.ch>
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *		notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *		notice, this list of conditions and the following disclaimer in
 *		the documentation and/or other materials provided with the
 *		distribution.
 * 3. Neither the name PX4 nor the names of its contributors may be
 *		used to endorse or promote products derived from this software
 *		without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 ****************************************************************************/

/**
 * @file offboard_control_setpoint.h
 * Definition of the manual_control_setpoint uORB topic.
 */

#ifndef TOPIC_OFFBOARD_CONTROL_SETPOINT_H_
#define TOPIC_OFFBOARD_CONTROL_SETPOINT_H_

#include <stdint.h>
#include "../uORB.h"

/**
 * Off-board control inputs.
 *
 * Typically sent by a ground control station / joystick or by
 * some off-board controller via C or SIMULINK.
 */
enum OFFBOARD_CONTROL_MODE {
	OFFBOARD_CONTROL_MODE_DIRECT = 0,
	OFFBOARD_CONTROL_MODE_DIRECT_RATES = 1,
	OFFBOARD_CONTROL_MODE_DIRECT_ATTITUDE = 2,
	OFFBOARD_CONTROL_MODE_DIRECT_LOCAL_NED = 3,
	OFFBOARD_CONTROL_MODE_DIRECT_LOCAL_OFFSET_NED = 4,
	OFFBOARD_CONTROL_MODE_DIRECT_BODY_NED = 5,
	OFFBOARD_CONTROL_MODE_DIRECT_BODY_OFFSET_NED = 6,
	OFFBOARD_CONTROL_MODE_DIRECT_GLOBAL = 7,
	OFFBOARD_CONTROL_MODE_DIRECT_FORCE = 8,
	OFFBOARD_CONTROL_MODE_ATT_YAW_RATE = 9,
	OFFBOARD_CONTROL_MODE_ATT_YAW_POS = 10,
	OFFBOARD_CONTROL_MODE_MULTIROTOR_SIMPLE = 11, /**< roll / pitch rotated aligned to the takeoff orientation, throttle stabilized, yaw pos */
};

enum OFFBOARD_CONTROL_FRAME {
	OFFBOARD_CONTROL_FRAME_LOCAL_NED = 0,
	OFFBOARD_CONTROL_FRAME_LOCAL_OFFSET_NED = 1,
	OFFBOARD_CONTROL_FRAME_BODY_NED = 2,
	OFFBOARD_CONTROL_FRAME_BODY_OFFSET_NED = 3,
	OFFBOARD_CONTROL_FRAME_GLOBAL = 4
};

/**
 * @addtogroup topics
 * @{
 */

struct offboard_control_setpoint_s {
	uint64_t timestamp;

	enum OFFBOARD_CONTROL_MODE mode;		 /**< The current control inputs mode */

	double position[3];	/**< lat, lon, alt / x, y, z */
	float velocity[3];	/**< x vel, y vel, z vel */
	float acceleration[3];	/**< x acc, y acc, z acc */
	float attitude[4];	/**< attitude of vehicle (quaternion) */
	float attitude_rate[3];	/**< body angular rates (x, y, z) */

	uint16_t ignore; /**< if field i is set to true, pi should be ignored */
	//XXX define constants for bit offsets
	bool isForceSetpoint; /**< the acceleration vector should be interpreted as force */

	float override_mode_switch;

	float aux1_cam_pan_flaps;
	float aux2_cam_tilt;
	float aux3_cam_zoom;
	float aux4_cam_roll;

}; /**< offboard control inputs */
/**
 * @}
 */

/**
 * Returns true if the position setpoint at index should be ignored
 */
inline bool offboard_control_sp_ignore_position(const struct offboard_control_setpoint_s &offboard_control_sp, int index) {
	return (bool)(offboard_control_sp.ignore & (1 << index));
}

/**
 * Returns true if all position setpoints should be ignored
 */
inline bool offboard_control_sp_ignore_position_all(const struct offboard_control_setpoint_s &offboard_control_sp) {
	for (int i = 0; i < 3; i++) {
		if (offboard_control_sp_ignore_position(offboard_control_sp, i))	{
			return true;
		}
	}
	return false;
}

/**
 * Returns true if the velocity setpoint at index should be ignored
 */
inline bool offboard_control_sp_ignore_velocity(const struct offboard_control_setpoint_s &offboard_control_sp, int index) {
	return (bool)(offboard_control_sp.ignore & (1 << (3 + index)));
}

/**
 * Returns true if all velocity setpoints should be ignored
 */
inline bool offboard_control_sp_ignore_velocity_all(const struct offboard_control_setpoint_s &offboard_control_sp) {
	for (int i = 0; i < 3; i++) {
		if (offboard_control_sp_ignore_velocity(offboard_control_sp, i))	{
			return true;
		}
	}
	return false;
}

/**
 * Returns true if the acceleration setpoint at index should be ignored
 */
inline bool offboard_control_sp_ignore_acceleration(const struct offboard_control_setpoint_s &offboard_control_sp, int index) {
	return (bool)(offboard_control_sp.ignore & (1 << (6 + index)));
}

/**
 * Returns true if all acceleration setpoints should be ignored
 */
inline bool offboard_control_sp_ignore_acceleration_all(const struct offboard_control_setpoint_s &offboard_control_sp) {
	for (int i = 0; i < 3; i++) {
		if (offboard_control_sp_ignore_acceleration(offboard_control_sp, i))	{
			return true;
		}
	}
	return false;
}

/**
 * Returns true if the bodyrate setpoint at index should be ignored
 */
inline bool offboard_control_sp_ignore_bodyrates(const struct offboard_control_setpoint_s &offboard_control_sp, int index) {
	return (bool)(offboard_control_sp.ignore & (1 << (9 + index)));
}

/**
 * Returns true if the attitude setpoint should be ignored
 */
inline bool offboard_control_sp_ignore_attitude(const struct offboard_control_setpoint_s &offboard_control_sp) {
	return (bool)(offboard_control_sp.ignore & (1 << 10));
}


/* register this as object request broker structure */
ORB_DECLARE(offboard_control_setpoint);

#endif