mavlink_msg_waypoint.h 16.9 KB
Newer Older
James Goppert's avatar
James Goppert committed
1 2 3
// MESSAGE WAYPOINT PACKING

#define MAVLINK_MSG_ID_WAYPOINT 39
lm's avatar
lm committed
4 5
#define MAVLINK_MSG_ID_WAYPOINT_LEN 36
#define MAVLINK_MSG_39_LEN 36
lm's avatar
lm committed
6 7
#define MAVLINK_MSG_ID_WAYPOINT_KEY 0xC5
#define MAVLINK_MSG_39_KEY 0xC5
James Goppert's avatar
James Goppert committed
8 9 10

typedef struct __mavlink_waypoint_t 
{
lm's avatar
lm committed
11 12 13 14 15 16 17 18 19 20 21 22 23 24
	float param1;	///< PARAM1 / For NAV command waypoints: Radius in which the waypoint is accepted as reached, in meters
	float param2;	///< PARAM2 / For NAV command waypoints: Time that the MAV should stay inside the PARAM1 radius before advancing, in milliseconds
	float param3;	///< PARAM3 / For LOITER command waypoints: Orbit to circle around the waypoint, in meters. If positive the orbit direction should be clockwise, if negative the orbit direction should be counter-clockwise.
	float param4;	///< PARAM4 / For NAV and LOITER command waypoints: Yaw orientation in degrees, [0..360] 0 = NORTH
	float x;	///< PARAM5 / local: x position, global: latitude
	float y;	///< PARAM6 / y position: global: longitude
	float z;	///< PARAM7 / z position: global: altitude
	uint16_t seq;	///< Sequence
	uint8_t target_system;	///< System ID
	uint8_t target_component;	///< Component ID
	uint8_t frame;	///< The coordinate system of the waypoint. see MAV_FRAME in mavlink_types.h
	uint8_t command;	///< The scheduled action for the waypoint. see MAV_COMMAND in common.xml MAVLink specs
	uint8_t current;	///< false:0, true:1
	uint8_t autocontinue;	///< autocontinue to next wp
James Goppert's avatar
James Goppert committed
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

} mavlink_waypoint_t;

/**
 * @brief Pack a waypoint message
 * @param system_id ID of this system
 * @param component_id ID of this component (e.g. 200 for IMU)
 * @param msg The MAVLink message to compress the data into
 *
 * @param target_system System ID
 * @param target_component Component ID
 * @param seq Sequence
 * @param frame The coordinate system of the waypoint. see MAV_FRAME in mavlink_types.h
 * @param command The scheduled action for the waypoint. see MAV_COMMAND in common.xml MAVLink specs
 * @param current false:0, true:1
 * @param autocontinue autocontinue to next wp
 * @param param1 PARAM1 / For NAV command waypoints: Radius in which the waypoint is accepted as reached, in meters
 * @param param2 PARAM2 / For NAV command waypoints: Time that the MAV should stay inside the PARAM1 radius before advancing, in milliseconds
 * @param param3 PARAM3 / For LOITER command waypoints: Orbit to circle around the waypoint, in meters. If positive the orbit direction should be clockwise, if negative the orbit direction should be counter-clockwise.
 * @param param4 PARAM4 / For NAV and LOITER command waypoints: Yaw orientation in degrees, [0..360] 0 = NORTH
 * @param x PARAM5 / local: x position, global: latitude
 * @param y PARAM6 / y position: global: longitude
 * @param z PARAM7 / z position: global: altitude
 * @return length of the message in bytes (excluding serial stream start sign)
 */
static inline uint16_t mavlink_msg_waypoint_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, uint8_t target_system, uint8_t target_component, uint16_t seq, uint8_t frame, uint8_t command, uint8_t current, uint8_t autocontinue, float param1, float param2, float param3, float param4, float x, float y, float z)
{
lm's avatar
lm committed
52
	mavlink_waypoint_t *p = (mavlink_waypoint_t *)&msg->payload[0];
James Goppert's avatar
James Goppert committed
53 54
	msg->msgid = MAVLINK_MSG_ID_WAYPOINT;

lm's avatar
lm committed
55 56 57 58 59 60 61 62 63 64 65 66 67 68
	p->target_system = target_system;	// uint8_t:System ID
	p->target_component = target_component;	// uint8_t:Component ID
	p->seq = seq;	// uint16_t:Sequence
	p->frame = frame;	// uint8_t:The coordinate system of the waypoint. see MAV_FRAME in mavlink_types.h
	p->command = command;	// uint8_t:The scheduled action for the waypoint. see MAV_COMMAND in common.xml MAVLink specs
	p->current = current;	// uint8_t:false:0, true:1
	p->autocontinue = autocontinue;	// uint8_t:autocontinue to next wp
	p->param1 = param1;	// float:PARAM1 / For NAV command waypoints: Radius in which the waypoint is accepted as reached, in meters
	p->param2 = param2;	// float:PARAM2 / For NAV command waypoints: Time that the MAV should stay inside the PARAM1 radius before advancing, in milliseconds
	p->param3 = param3;	// float:PARAM3 / For LOITER command waypoints: Orbit to circle around the waypoint, in meters. If positive the orbit direction should be clockwise, if negative the orbit direction should be counter-clockwise.
	p->param4 = param4;	// float:PARAM4 / For NAV and LOITER command waypoints: Yaw orientation in degrees, [0..360] 0 = NORTH
	p->x = x;	// float:PARAM5 / local: x position, global: latitude
	p->y = y;	// float:PARAM6 / y position: global: longitude
	p->z = z;	// float:PARAM7 / z position: global: altitude
lm's avatar
lm committed
69 70

	return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_WAYPOINT_LEN);
James Goppert's avatar
James Goppert committed
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
}

/**
 * @brief Pack a waypoint message
 * @param system_id ID of this system
 * @param component_id ID of this component (e.g. 200 for IMU)
 * @param chan The MAVLink channel this message was sent over
 * @param msg The MAVLink message to compress the data into
 * @param target_system System ID
 * @param target_component Component ID
 * @param seq Sequence
 * @param frame The coordinate system of the waypoint. see MAV_FRAME in mavlink_types.h
 * @param command The scheduled action for the waypoint. see MAV_COMMAND in common.xml MAVLink specs
 * @param current false:0, true:1
 * @param autocontinue autocontinue to next wp
 * @param param1 PARAM1 / For NAV command waypoints: Radius in which the waypoint is accepted as reached, in meters
 * @param param2 PARAM2 / For NAV command waypoints: Time that the MAV should stay inside the PARAM1 radius before advancing, in milliseconds
 * @param param3 PARAM3 / For LOITER command waypoints: Orbit to circle around the waypoint, in meters. If positive the orbit direction should be clockwise, if negative the orbit direction should be counter-clockwise.
 * @param param4 PARAM4 / For NAV and LOITER command waypoints: Yaw orientation in degrees, [0..360] 0 = NORTH
 * @param x PARAM5 / local: x position, global: latitude
 * @param y PARAM6 / y position: global: longitude
 * @param z PARAM7 / z position: global: altitude
 * @return length of the message in bytes (excluding serial stream start sign)
 */
static inline uint16_t mavlink_msg_waypoint_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan, mavlink_message_t* msg, uint8_t target_system, uint8_t target_component, uint16_t seq, uint8_t frame, uint8_t command, uint8_t current, uint8_t autocontinue, float param1, float param2, float param3, float param4, float x, float y, float z)
{
lm's avatar
lm committed
97
	mavlink_waypoint_t *p = (mavlink_waypoint_t *)&msg->payload[0];
James Goppert's avatar
James Goppert committed
98 99
	msg->msgid = MAVLINK_MSG_ID_WAYPOINT;

lm's avatar
lm committed
100 101 102 103 104 105 106 107 108 109 110 111 112 113
	p->target_system = target_system;	// uint8_t:System ID
	p->target_component = target_component;	// uint8_t:Component ID
	p->seq = seq;	// uint16_t:Sequence
	p->frame = frame;	// uint8_t:The coordinate system of the waypoint. see MAV_FRAME in mavlink_types.h
	p->command = command;	// uint8_t:The scheduled action for the waypoint. see MAV_COMMAND in common.xml MAVLink specs
	p->current = current;	// uint8_t:false:0, true:1
	p->autocontinue = autocontinue;	// uint8_t:autocontinue to next wp
	p->param1 = param1;	// float:PARAM1 / For NAV command waypoints: Radius in which the waypoint is accepted as reached, in meters
	p->param2 = param2;	// float:PARAM2 / For NAV command waypoints: Time that the MAV should stay inside the PARAM1 radius before advancing, in milliseconds
	p->param3 = param3;	// float:PARAM3 / For LOITER command waypoints: Orbit to circle around the waypoint, in meters. If positive the orbit direction should be clockwise, if negative the orbit direction should be counter-clockwise.
	p->param4 = param4;	// float:PARAM4 / For NAV and LOITER command waypoints: Yaw orientation in degrees, [0..360] 0 = NORTH
	p->x = x;	// float:PARAM5 / local: x position, global: latitude
	p->y = y;	// float:PARAM6 / y position: global: longitude
	p->z = z;	// float:PARAM7 / z position: global: altitude
lm's avatar
lm committed
114 115

	return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_WAYPOINT_LEN);
James Goppert's avatar
James Goppert committed
116 117 118 119 120 121 122 123 124 125 126 127 128 129 130
}

/**
 * @brief Encode a waypoint struct into a message
 *
 * @param system_id ID of this system
 * @param component_id ID of this component (e.g. 200 for IMU)
 * @param msg The MAVLink message to compress the data into
 * @param waypoint C-struct to read the message contents from
 */
static inline uint16_t mavlink_msg_waypoint_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_waypoint_t* waypoint)
{
	return mavlink_msg_waypoint_pack(system_id, component_id, msg, waypoint->target_system, waypoint->target_component, waypoint->seq, waypoint->frame, waypoint->command, waypoint->current, waypoint->autocontinue, waypoint->param1, waypoint->param2, waypoint->param3, waypoint->param4, waypoint->x, waypoint->y, waypoint->z);
}

lm's avatar
lm committed
131 132

#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS
James Goppert's avatar
James Goppert committed
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
/**
 * @brief Send a waypoint message
 * @param chan MAVLink channel to send the message
 *
 * @param target_system System ID
 * @param target_component Component ID
 * @param seq Sequence
 * @param frame The coordinate system of the waypoint. see MAV_FRAME in mavlink_types.h
 * @param command The scheduled action for the waypoint. see MAV_COMMAND in common.xml MAVLink specs
 * @param current false:0, true:1
 * @param autocontinue autocontinue to next wp
 * @param param1 PARAM1 / For NAV command waypoints: Radius in which the waypoint is accepted as reached, in meters
 * @param param2 PARAM2 / For NAV command waypoints: Time that the MAV should stay inside the PARAM1 radius before advancing, in milliseconds
 * @param param3 PARAM3 / For LOITER command waypoints: Orbit to circle around the waypoint, in meters. If positive the orbit direction should be clockwise, if negative the orbit direction should be counter-clockwise.
 * @param param4 PARAM4 / For NAV and LOITER command waypoints: Yaw orientation in degrees, [0..360] 0 = NORTH
 * @param x PARAM5 / local: x position, global: latitude
 * @param y PARAM6 / y position: global: longitude
 * @param z PARAM7 / z position: global: altitude
 */
lm's avatar
lm committed
152 153 154 155
static inline void mavlink_msg_waypoint_send(mavlink_channel_t chan, uint8_t target_system, uint8_t target_component, uint16_t seq, uint8_t frame, uint8_t command, uint8_t current, uint8_t autocontinue, float param1, float param2, float param3, float param4, float x, float y, float z)
{
	mavlink_header_t hdr;
	mavlink_waypoint_t payload;
lm's avatar
lm committed
156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171

	MAVLINK_BUFFER_CHECK_START( chan, MAVLINK_MSG_ID_WAYPOINT_LEN )
	payload.target_system = target_system;	// uint8_t:System ID
	payload.target_component = target_component;	// uint8_t:Component ID
	payload.seq = seq;	// uint16_t:Sequence
	payload.frame = frame;	// uint8_t:The coordinate system of the waypoint. see MAV_FRAME in mavlink_types.h
	payload.command = command;	// uint8_t:The scheduled action for the waypoint. see MAV_COMMAND in common.xml MAVLink specs
	payload.current = current;	// uint8_t:false:0, true:1
	payload.autocontinue = autocontinue;	// uint8_t:autocontinue to next wp
	payload.param1 = param1;	// float:PARAM1 / For NAV command waypoints: Radius in which the waypoint is accepted as reached, in meters
	payload.param2 = param2;	// float:PARAM2 / For NAV command waypoints: Time that the MAV should stay inside the PARAM1 radius before advancing, in milliseconds
	payload.param3 = param3;	// float:PARAM3 / For LOITER command waypoints: Orbit to circle around the waypoint, in meters. If positive the orbit direction should be clockwise, if negative the orbit direction should be counter-clockwise.
	payload.param4 = param4;	// float:PARAM4 / For NAV and LOITER command waypoints: Yaw orientation in degrees, [0..360] 0 = NORTH
	payload.x = x;	// float:PARAM5 / local: x position, global: latitude
	payload.y = y;	// float:PARAM6 / y position: global: longitude
	payload.z = z;	// float:PARAM7 / z position: global: altitude
lm's avatar
lm committed
172 173 174 175 176 177 178 179 180 181

	hdr.STX = MAVLINK_STX;
	hdr.len = MAVLINK_MSG_ID_WAYPOINT_LEN;
	hdr.msgid = MAVLINK_MSG_ID_WAYPOINT;
	hdr.sysid = mavlink_system.sysid;
	hdr.compid = mavlink_system.compid;
	hdr.seq = mavlink_get_channel_status(chan)->current_tx_seq;
	mavlink_get_channel_status(chan)->current_tx_seq = hdr.seq + 1;
	mavlink_send_mem(chan, (uint8_t *)&hdr.STX, MAVLINK_NUM_HEADER_BYTES );

lm's avatar
lm committed
182 183 184 185 186 187
	crc_init(&hdr.ck);
	crc_calculate_mem((uint8_t *)&hdr.len, &hdr.ck, MAVLINK_CORE_HEADER_LEN);
	crc_calculate_mem((uint8_t *)&payload, &hdr.ck, hdr.len );
	crc_accumulate( 0xC5, &hdr.ck); /// include key in X25 checksum
	mavlink_send_mem(chan, (uint8_t *)&hdr.ck, MAVLINK_NUM_CHECKSUM_BYTES);
	MAVLINK_BUFFER_CHECK_END
James Goppert's avatar
James Goppert committed
188 189 190 191 192 193 194 195 196 197 198 199
}

#endif
// MESSAGE WAYPOINT UNPACKING

/**
 * @brief Get field target_system from waypoint message
 *
 * @return System ID
 */
static inline uint8_t mavlink_msg_waypoint_get_target_system(const mavlink_message_t* msg)
{
lm's avatar
lm committed
200 201
	mavlink_waypoint_t *p = (mavlink_waypoint_t *)&msg->payload[0];
	return (uint8_t)(p->target_system);
James Goppert's avatar
James Goppert committed
202 203 204 205 206 207 208 209 210
}

/**
 * @brief Get field target_component from waypoint message
 *
 * @return Component ID
 */
static inline uint8_t mavlink_msg_waypoint_get_target_component(const mavlink_message_t* msg)
{
lm's avatar
lm committed
211 212
	mavlink_waypoint_t *p = (mavlink_waypoint_t *)&msg->payload[0];
	return (uint8_t)(p->target_component);
James Goppert's avatar
James Goppert committed
213 214 215 216 217 218 219 220 221
}

/**
 * @brief Get field seq from waypoint message
 *
 * @return Sequence
 */
static inline uint16_t mavlink_msg_waypoint_get_seq(const mavlink_message_t* msg)
{
lm's avatar
lm committed
222 223
	mavlink_waypoint_t *p = (mavlink_waypoint_t *)&msg->payload[0];
	return (uint16_t)(p->seq);
James Goppert's avatar
James Goppert committed
224 225 226 227 228 229 230 231 232
}

/**
 * @brief Get field frame from waypoint message
 *
 * @return The coordinate system of the waypoint. see MAV_FRAME in mavlink_types.h
 */
static inline uint8_t mavlink_msg_waypoint_get_frame(const mavlink_message_t* msg)
{
lm's avatar
lm committed
233 234
	mavlink_waypoint_t *p = (mavlink_waypoint_t *)&msg->payload[0];
	return (uint8_t)(p->frame);
James Goppert's avatar
James Goppert committed
235 236 237 238 239 240 241 242 243
}

/**
 * @brief Get field command from waypoint message
 *
 * @return The scheduled action for the waypoint. see MAV_COMMAND in common.xml MAVLink specs
 */
static inline uint8_t mavlink_msg_waypoint_get_command(const mavlink_message_t* msg)
{
lm's avatar
lm committed
244 245
	mavlink_waypoint_t *p = (mavlink_waypoint_t *)&msg->payload[0];
	return (uint8_t)(p->command);
James Goppert's avatar
James Goppert committed
246 247 248 249 250 251 252 253 254
}

/**
 * @brief Get field current from waypoint message
 *
 * @return false:0, true:1
 */
static inline uint8_t mavlink_msg_waypoint_get_current(const mavlink_message_t* msg)
{
lm's avatar
lm committed
255 256
	mavlink_waypoint_t *p = (mavlink_waypoint_t *)&msg->payload[0];
	return (uint8_t)(p->current);
James Goppert's avatar
James Goppert committed
257 258 259 260 261 262 263 264 265
}

/**
 * @brief Get field autocontinue from waypoint message
 *
 * @return autocontinue to next wp
 */
static inline uint8_t mavlink_msg_waypoint_get_autocontinue(const mavlink_message_t* msg)
{
lm's avatar
lm committed
266 267
	mavlink_waypoint_t *p = (mavlink_waypoint_t *)&msg->payload[0];
	return (uint8_t)(p->autocontinue);
James Goppert's avatar
James Goppert committed
268 269 270 271 272 273 274 275 276
}

/**
 * @brief Get field param1 from waypoint message
 *
 * @return PARAM1 / For NAV command waypoints: Radius in which the waypoint is accepted as reached, in meters
 */
static inline float mavlink_msg_waypoint_get_param1(const mavlink_message_t* msg)
{
lm's avatar
lm committed
277 278
	mavlink_waypoint_t *p = (mavlink_waypoint_t *)&msg->payload[0];
	return (float)(p->param1);
James Goppert's avatar
James Goppert committed
279 280 281 282 283 284 285 286 287
}

/**
 * @brief Get field param2 from waypoint message
 *
 * @return PARAM2 / For NAV command waypoints: Time that the MAV should stay inside the PARAM1 radius before advancing, in milliseconds
 */
static inline float mavlink_msg_waypoint_get_param2(const mavlink_message_t* msg)
{
lm's avatar
lm committed
288 289
	mavlink_waypoint_t *p = (mavlink_waypoint_t *)&msg->payload[0];
	return (float)(p->param2);
James Goppert's avatar
James Goppert committed
290 291 292 293 294 295 296 297 298
}

/**
 * @brief Get field param3 from waypoint message
 *
 * @return PARAM3 / For LOITER command waypoints: Orbit to circle around the waypoint, in meters. If positive the orbit direction should be clockwise, if negative the orbit direction should be counter-clockwise.
 */
static inline float mavlink_msg_waypoint_get_param3(const mavlink_message_t* msg)
{
lm's avatar
lm committed
299 300
	mavlink_waypoint_t *p = (mavlink_waypoint_t *)&msg->payload[0];
	return (float)(p->param3);
James Goppert's avatar
James Goppert committed
301 302 303 304 305 306 307 308 309
}

/**
 * @brief Get field param4 from waypoint message
 *
 * @return PARAM4 / For NAV and LOITER command waypoints: Yaw orientation in degrees, [0..360] 0 = NORTH
 */
static inline float mavlink_msg_waypoint_get_param4(const mavlink_message_t* msg)
{
lm's avatar
lm committed
310 311
	mavlink_waypoint_t *p = (mavlink_waypoint_t *)&msg->payload[0];
	return (float)(p->param4);
James Goppert's avatar
James Goppert committed
312 313 314 315 316 317 318 319 320
}

/**
 * @brief Get field x from waypoint message
 *
 * @return PARAM5 / local: x position, global: latitude
 */
static inline float mavlink_msg_waypoint_get_x(const mavlink_message_t* msg)
{
lm's avatar
lm committed
321 322
	mavlink_waypoint_t *p = (mavlink_waypoint_t *)&msg->payload[0];
	return (float)(p->x);
James Goppert's avatar
James Goppert committed
323 324 325 326 327 328 329 330 331
}

/**
 * @brief Get field y from waypoint message
 *
 * @return PARAM6 / y position: global: longitude
 */
static inline float mavlink_msg_waypoint_get_y(const mavlink_message_t* msg)
{
lm's avatar
lm committed
332 333
	mavlink_waypoint_t *p = (mavlink_waypoint_t *)&msg->payload[0];
	return (float)(p->y);
James Goppert's avatar
James Goppert committed
334 335 336 337 338 339 340 341 342
}

/**
 * @brief Get field z from waypoint message
 *
 * @return PARAM7 / z position: global: altitude
 */
static inline float mavlink_msg_waypoint_get_z(const mavlink_message_t* msg)
{
lm's avatar
lm committed
343 344
	mavlink_waypoint_t *p = (mavlink_waypoint_t *)&msg->payload[0];
	return (float)(p->z);
James Goppert's avatar
James Goppert committed
345 346 347 348 349 350 351 352 353 354
}

/**
 * @brief Decode a waypoint message into a struct
 *
 * @param msg The message to decode
 * @param waypoint C-struct to decode the message contents into
 */
static inline void mavlink_msg_waypoint_decode(const mavlink_message_t* msg, mavlink_waypoint_t* waypoint)
{
lm's avatar
lm committed
355
	memcpy( waypoint, msg->payload, sizeof(mavlink_waypoint_t));
James Goppert's avatar
James Goppert committed
356
}