mavlink_msg_point_of_interest.h 10.2 KB
Newer Older
James Goppert's avatar
James Goppert committed
1 2
// MESSAGE POINT_OF_INTEREST PACKING

lm's avatar
lm committed
3
#define MAVLINK_MSG_ID_POINT_OF_INTEREST 191
James Goppert's avatar
James Goppert committed
4

lm's avatar
lm committed
5
typedef struct __mavlink_point_of_interest_t
James Goppert's avatar
James Goppert committed
6
{
lm's avatar
lm committed
7 8 9 10 11 12 13 14
 float x; ///< X Position
 float y; ///< Y Position
 float z; ///< Z Position
 uint16_t timeout; ///< 0: no timeout, >1: timeout in seconds
 uint8_t type; ///< 0: Notice, 1: Warning, 2: Critical, 3: Emergency, 4: Debug
 uint8_t color; ///< 0: blue, 1: yellow, 2: red, 3: orange, 4: green, 5: magenta
 uint8_t coordinate_system; ///< 0: global, 1:local
 char name[26]; ///< POI name
James Goppert's avatar
James Goppert committed
15
} mavlink_point_of_interest_t;
lm's avatar
lm committed
16 17 18 19

#define MAVLINK_MSG_ID_POINT_OF_INTEREST_LEN 43
#define MAVLINK_MSG_ID_191_LEN 43

20
#define MAVLINK_MSG_POINT_OF_INTEREST_FIELD_NAME_LEN 26
James Goppert's avatar
James Goppert committed
21

lm's avatar
lm committed
22 23 24
#define MAVLINK_MESSAGE_INFO_POINT_OF_INTEREST { \
	"POINT_OF_INTEREST", \
	8, \
lm's avatar
lm committed
25 26 27 28 29 30 31 32
	{  { "x", NULL, MAVLINK_TYPE_FLOAT, 0, 0, offsetof(mavlink_point_of_interest_t, x) }, \
         { "y", NULL, MAVLINK_TYPE_FLOAT, 0, 4, offsetof(mavlink_point_of_interest_t, y) }, \
         { "z", NULL, MAVLINK_TYPE_FLOAT, 0, 8, offsetof(mavlink_point_of_interest_t, z) }, \
         { "timeout", NULL, MAVLINK_TYPE_UINT16_T, 0, 12, offsetof(mavlink_point_of_interest_t, timeout) }, \
         { "type", NULL, MAVLINK_TYPE_UINT8_T, 0, 14, offsetof(mavlink_point_of_interest_t, type) }, \
         { "color", NULL, MAVLINK_TYPE_UINT8_T, 0, 15, offsetof(mavlink_point_of_interest_t, color) }, \
         { "coordinate_system", NULL, MAVLINK_TYPE_UINT8_T, 0, 16, offsetof(mavlink_point_of_interest_t, coordinate_system) }, \
         { "name", NULL, MAVLINK_TYPE_CHAR, 26, 17, offsetof(mavlink_point_of_interest_t, name) }, \
lm's avatar
lm committed
33 34 35 36
         } \
}


James Goppert's avatar
James Goppert committed
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52
/**
 * @brief Pack a point_of_interest 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 type 0: Notice, 1: Warning, 2: Critical, 3: Emergency, 4: Debug
 * @param color 0: blue, 1: yellow, 2: red, 3: orange, 4: green, 5: magenta
 * @param coordinate_system 0: global, 1:local
 * @param timeout 0: no timeout, >1: timeout in seconds
 * @param x X Position
 * @param y Y Position
 * @param z Z Position
 * @param name POI name
 * @return length of the message in bytes (excluding serial stream start sign)
 */
lm's avatar
lm committed
53 54
static inline uint16_t mavlink_msg_point_of_interest_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg,
						       uint8_t type, uint8_t color, uint8_t coordinate_system, uint16_t timeout, float x, float y, float z, const char *name)
James Goppert's avatar
James Goppert committed
55
{
LM's avatar
LM committed
56 57 58 59 60 61 62 63 64 65
#if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
	char buf[43];
	_mav_put_float(buf, 0, x);
	_mav_put_float(buf, 4, y);
	_mav_put_float(buf, 8, z);
	_mav_put_uint16_t(buf, 12, timeout);
	_mav_put_uint8_t(buf, 14, type);
	_mav_put_uint8_t(buf, 15, color);
	_mav_put_uint8_t(buf, 16, coordinate_system);
	_mav_put_char_array(buf, 17, name, 26);
66
        memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, 43);
LM's avatar
LM committed
67 68 69 70 71 72 73 74 75
#else
	mavlink_point_of_interest_t packet;
	packet.x = x;
	packet.y = y;
	packet.z = z;
	packet.timeout = timeout;
	packet.type = type;
	packet.color = color;
	packet.coordinate_system = coordinate_system;
76
	mav_array_memcpy(packet.name, name, sizeof(char)*26);
77
        memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, 43);
LM's avatar
LM committed
78
#endif
James Goppert's avatar
James Goppert committed
79

LM's avatar
LM committed
80
	msg->msgid = MAVLINK_MSG_ID_POINT_OF_INTEREST;
lm's avatar
lm committed
81
	return mavlink_finalize_message(msg, system_id, component_id, 43, 95);
James Goppert's avatar
James Goppert committed
82 83 84
}

/**
lm's avatar
lm committed
85
 * @brief Pack a point_of_interest message on a channel
James Goppert's avatar
James Goppert committed
86 87 88 89 90 91 92 93 94 95 96 97 98 99
 * @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 type 0: Notice, 1: Warning, 2: Critical, 3: Emergency, 4: Debug
 * @param color 0: blue, 1: yellow, 2: red, 3: orange, 4: green, 5: magenta
 * @param coordinate_system 0: global, 1:local
 * @param timeout 0: no timeout, >1: timeout in seconds
 * @param x X Position
 * @param y Y Position
 * @param z Z Position
 * @param name POI name
 * @return length of the message in bytes (excluding serial stream start sign)
 */
lm's avatar
lm committed
100 101 102 103
static inline uint16_t mavlink_msg_point_of_interest_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan,
							   mavlink_message_t* msg,
						           uint8_t type,uint8_t color,uint8_t coordinate_system,uint16_t timeout,float x,float y,float z,const char *name)
{
LM's avatar
LM committed
104 105 106 107 108 109 110 111 112 113
#if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
	char buf[43];
	_mav_put_float(buf, 0, x);
	_mav_put_float(buf, 4, y);
	_mav_put_float(buf, 8, z);
	_mav_put_uint16_t(buf, 12, timeout);
	_mav_put_uint8_t(buf, 14, type);
	_mav_put_uint8_t(buf, 15, color);
	_mav_put_uint8_t(buf, 16, coordinate_system);
	_mav_put_char_array(buf, 17, name, 26);
114
        memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, 43);
LM's avatar
LM committed
115 116 117 118 119 120 121 122 123
#else
	mavlink_point_of_interest_t packet;
	packet.x = x;
	packet.y = y;
	packet.z = z;
	packet.timeout = timeout;
	packet.type = type;
	packet.color = color;
	packet.coordinate_system = coordinate_system;
124
	mav_array_memcpy(packet.name, name, sizeof(char)*26);
125
        memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, 43);
LM's avatar
LM committed
126
#endif
lm's avatar
lm committed
127

LM's avatar
LM committed
128
	msg->msgid = MAVLINK_MSG_ID_POINT_OF_INTEREST;
lm's avatar
lm committed
129 130 131
	return mavlink_finalize_message_chan(msg, system_id, component_id, chan, 43, 95);
}

James Goppert's avatar
James Goppert committed
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
/**
 * @brief Encode a point_of_interest 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 point_of_interest C-struct to read the message contents from
 */
static inline uint16_t mavlink_msg_point_of_interest_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_point_of_interest_t* point_of_interest)
{
	return mavlink_msg_point_of_interest_pack(system_id, component_id, msg, point_of_interest->type, point_of_interest->color, point_of_interest->coordinate_system, point_of_interest->timeout, point_of_interest->x, point_of_interest->y, point_of_interest->z, point_of_interest->name);
}

/**
 * @brief Send a point_of_interest message
 * @param chan MAVLink channel to send the message
 *
 * @param type 0: Notice, 1: Warning, 2: Critical, 3: Emergency, 4: Debug
 * @param color 0: blue, 1: yellow, 2: red, 3: orange, 4: green, 5: magenta
 * @param coordinate_system 0: global, 1:local
 * @param timeout 0: no timeout, >1: timeout in seconds
 * @param x X Position
 * @param y Y Position
 * @param z Z Position
 * @param name POI name
 */
lm's avatar
lm committed
158 159 160
#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS

static inline void mavlink_msg_point_of_interest_send(mavlink_channel_t chan, uint8_t type, uint8_t color, uint8_t coordinate_system, uint16_t timeout, float x, float y, float z, const char *name)
lm's avatar
lm committed
161
{
LM's avatar
LM committed
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
#if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
	char buf[43];
	_mav_put_float(buf, 0, x);
	_mav_put_float(buf, 4, y);
	_mav_put_float(buf, 8, z);
	_mav_put_uint16_t(buf, 12, timeout);
	_mav_put_uint8_t(buf, 14, type);
	_mav_put_uint8_t(buf, 15, color);
	_mav_put_uint8_t(buf, 16, coordinate_system);
	_mav_put_char_array(buf, 17, name, 26);
	_mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_POINT_OF_INTEREST, buf, 43, 95);
#else
	mavlink_point_of_interest_t packet;
	packet.x = x;
	packet.y = y;
	packet.z = z;
	packet.timeout = timeout;
	packet.type = type;
	packet.color = color;
	packet.coordinate_system = coordinate_system;
182
	mav_array_memcpy(packet.name, name, sizeof(char)*26);
LM's avatar
LM committed
183 184
	_mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_POINT_OF_INTEREST, (const char *)&packet, 43, 95);
#endif
James Goppert's avatar
James Goppert committed
185 186 187
}

#endif
lm's avatar
lm committed
188

James Goppert's avatar
James Goppert committed
189 190
// MESSAGE POINT_OF_INTEREST UNPACKING

lm's avatar
lm committed
191

James Goppert's avatar
James Goppert committed
192 193 194 195 196 197 198
/**
 * @brief Get field type from point_of_interest message
 *
 * @return 0: Notice, 1: Warning, 2: Critical, 3: Emergency, 4: Debug
 */
static inline uint8_t mavlink_msg_point_of_interest_get_type(const mavlink_message_t* msg)
{
LM's avatar
LM committed
199
	return _MAV_RETURN_uint8_t(msg,  14);
James Goppert's avatar
James Goppert committed
200 201 202 203 204 205 206 207 208
}

/**
 * @brief Get field color from point_of_interest message
 *
 * @return 0: blue, 1: yellow, 2: red, 3: orange, 4: green, 5: magenta
 */
static inline uint8_t mavlink_msg_point_of_interest_get_color(const mavlink_message_t* msg)
{
LM's avatar
LM committed
209
	return _MAV_RETURN_uint8_t(msg,  15);
James Goppert's avatar
James Goppert committed
210 211 212 213 214 215 216 217 218
}

/**
 * @brief Get field coordinate_system from point_of_interest message
 *
 * @return 0: global, 1:local
 */
static inline uint8_t mavlink_msg_point_of_interest_get_coordinate_system(const mavlink_message_t* msg)
{
LM's avatar
LM committed
219
	return _MAV_RETURN_uint8_t(msg,  16);
James Goppert's avatar
James Goppert committed
220 221 222 223 224 225 226 227 228
}

/**
 * @brief Get field timeout from point_of_interest message
 *
 * @return 0: no timeout, >1: timeout in seconds
 */
static inline uint16_t mavlink_msg_point_of_interest_get_timeout(const mavlink_message_t* msg)
{
LM's avatar
LM committed
229
	return _MAV_RETURN_uint16_t(msg,  12);
James Goppert's avatar
James Goppert committed
230 231 232 233 234 235 236 237 238
}

/**
 * @brief Get field x from point_of_interest message
 *
 * @return X Position
 */
static inline float mavlink_msg_point_of_interest_get_x(const mavlink_message_t* msg)
{
LM's avatar
LM committed
239
	return _MAV_RETURN_float(msg,  0);
James Goppert's avatar
James Goppert committed
240 241 242 243 244 245 246 247 248
}

/**
 * @brief Get field y from point_of_interest message
 *
 * @return Y Position
 */
static inline float mavlink_msg_point_of_interest_get_y(const mavlink_message_t* msg)
{
LM's avatar
LM committed
249
	return _MAV_RETURN_float(msg,  4);
James Goppert's avatar
James Goppert committed
250 251 252 253 254 255 256 257 258
}

/**
 * @brief Get field z from point_of_interest message
 *
 * @return Z Position
 */
static inline float mavlink_msg_point_of_interest_get_z(const mavlink_message_t* msg)
{
LM's avatar
LM committed
259
	return _MAV_RETURN_float(msg,  8);
James Goppert's avatar
James Goppert committed
260 261 262 263 264 265 266
}

/**
 * @brief Get field name from point_of_interest message
 *
 * @return POI name
 */
lm's avatar
lm committed
267
static inline uint16_t mavlink_msg_point_of_interest_get_name(const mavlink_message_t* msg, char *name)
James Goppert's avatar
James Goppert committed
268
{
LM's avatar
LM committed
269
	return _MAV_RETURN_char_array(msg, name, 26,  17);
James Goppert's avatar
James Goppert committed
270 271 272 273 274 275 276 277 278 279
}

/**
 * @brief Decode a point_of_interest message into a struct
 *
 * @param msg The message to decode
 * @param point_of_interest C-struct to decode the message contents into
 */
static inline void mavlink_msg_point_of_interest_decode(const mavlink_message_t* msg, mavlink_point_of_interest_t* point_of_interest)
{
lm's avatar
lm committed
280 281 282 283 284 285 286 287 288 289
#if MAVLINK_NEED_BYTE_SWAP
	point_of_interest->x = mavlink_msg_point_of_interest_get_x(msg);
	point_of_interest->y = mavlink_msg_point_of_interest_get_y(msg);
	point_of_interest->z = mavlink_msg_point_of_interest_get_z(msg);
	point_of_interest->timeout = mavlink_msg_point_of_interest_get_timeout(msg);
	point_of_interest->type = mavlink_msg_point_of_interest_get_type(msg);
	point_of_interest->color = mavlink_msg_point_of_interest_get_color(msg);
	point_of_interest->coordinate_system = mavlink_msg_point_of_interest_get_coordinate_system(msg);
	mavlink_msg_point_of_interest_get_name(msg, point_of_interest->name);
#else
LM's avatar
LM committed
290
	memcpy(point_of_interest, _MAV_PAYLOAD(msg), 43);
lm's avatar
lm committed
291
#endif
James Goppert's avatar
James Goppert committed
292
}