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

#define MAVLINK_MSG_ID_POINT_OF_INTEREST 161
4 5
#define MAVLINK_MSG_ID_POINT_OF_INTEREST_LEN 43
#define MAVLINK_MSG_161_LEN 43
James Goppert's avatar
James Goppert committed
6 7 8 9 10 11

typedef struct __mavlink_point_of_interest_t 
{
	float x; ///< X Position
	float y; ///< Y Position
	float z; ///< Z Position
12 13 14 15
	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
LM's avatar
LM committed
16
	char name[26]; ///< POI name
James Goppert's avatar
James Goppert committed
17 18

} mavlink_point_of_interest_t;
19
#define MAVLINK_MSG_POINT_OF_INTEREST_FIELD_NAME_LEN 26
James Goppert's avatar
James Goppert committed
20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36

/**
 * @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
37
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
38
{
lm's avatar
lm committed
39
	mavlink_point_of_interest_t *p = (mavlink_point_of_interest_t *)&msg->payload[0];
James Goppert's avatar
James Goppert committed
40 41
	msg->msgid = MAVLINK_MSG_ID_POINT_OF_INTEREST;

lm's avatar
lm committed
42 43 44 45 46 47 48
	p->type = type; // uint8_t:0: Notice, 1: Warning, 2: Critical, 3: Emergency, 4: Debug
	p->color = color; // uint8_t:0: blue, 1: yellow, 2: red, 3: orange, 4: green, 5: magenta
	p->coordinate_system = coordinate_system; // uint8_t:0: global, 1:local
	p->timeout = timeout; // uint16_t:0: no timeout, >1: timeout in seconds
	p->x = x; // float:X Position
	p->y = y; // float:Y Position
	p->z = z; // float:Z Position
LM's avatar
LM committed
49
	memcpy(p->name, name, sizeof(p->name)); // char[26]:POI name
James Goppert's avatar
James Goppert committed
50

lm's avatar
lm committed
51
	return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_POINT_OF_INTEREST_LEN);
James Goppert's avatar
James Goppert committed
52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69
}

/**
 * @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 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
70
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)
James Goppert's avatar
James Goppert committed
71
{
lm's avatar
lm committed
72
	mavlink_point_of_interest_t *p = (mavlink_point_of_interest_t *)&msg->payload[0];
James Goppert's avatar
James Goppert committed
73 74
	msg->msgid = MAVLINK_MSG_ID_POINT_OF_INTEREST;

lm's avatar
lm committed
75 76 77 78 79 80 81
	p->type = type; // uint8_t:0: Notice, 1: Warning, 2: Critical, 3: Emergency, 4: Debug
	p->color = color; // uint8_t:0: blue, 1: yellow, 2: red, 3: orange, 4: green, 5: magenta
	p->coordinate_system = coordinate_system; // uint8_t:0: global, 1:local
	p->timeout = timeout; // uint16_t:0: no timeout, >1: timeout in seconds
	p->x = x; // float:X Position
	p->y = y; // float:Y Position
	p->z = z; // float:Z Position
LM's avatar
LM committed
82
	memcpy(p->name, name, sizeof(p->name)); // char[26]:POI name
James Goppert's avatar
James Goppert committed
83

lm's avatar
lm committed
84
	return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_POINT_OF_INTEREST_LEN);
James Goppert's avatar
James Goppert committed
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
}

/**
 * @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
113 114


115
#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS
LM's avatar
LM committed
116
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
117 118 119 120 121 122 123 124 125 126 127 128 129
{
	mavlink_header_t hdr;
	mavlink_point_of_interest_t payload;
	uint16_t checksum;
	mavlink_point_of_interest_t *p = &payload;

	p->type = type; // uint8_t:0: Notice, 1: Warning, 2: Critical, 3: Emergency, 4: Debug
	p->color = color; // uint8_t:0: blue, 1: yellow, 2: red, 3: orange, 4: green, 5: magenta
	p->coordinate_system = coordinate_system; // uint8_t:0: global, 1:local
	p->timeout = timeout; // uint16_t:0: no timeout, >1: timeout in seconds
	p->x = x; // float:X Position
	p->y = y; // float:Y Position
	p->z = z; // float:Z Position
LM's avatar
LM committed
130
	memcpy(p->name, name, sizeof(p->name)); // char[26]:POI name
lm's avatar
lm committed
131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148

	hdr.STX = MAVLINK_STX;
	hdr.len = MAVLINK_MSG_ID_POINT_OF_INTEREST_LEN;
	hdr.msgid = MAVLINK_MSG_ID_POINT_OF_INTEREST;
	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 );

	crc_init(&checksum);
	checksum = crc_calculate_mem((uint8_t *)&hdr.len, &checksum, MAVLINK_CORE_HEADER_LEN);
	checksum = crc_calculate_mem((uint8_t *)&payload, &checksum, hdr.len );
	hdr.ck_a = (uint8_t)(checksum & 0xFF); ///< Low byte
	hdr.ck_b = (uint8_t)(checksum >> 8); ///< High byte

	mavlink_send_mem(chan, (uint8_t *)&payload, hdr.len);
	mavlink_send_mem(chan, (uint8_t *)&hdr.ck_a, MAVLINK_NUM_CHECKSUM_BYTES);
James Goppert's avatar
James Goppert committed
149 150 151 152 153 154 155 156 157 158 159 160
}

#endif
// MESSAGE POINT_OF_INTEREST UNPACKING

/**
 * @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
161 162
	mavlink_point_of_interest_t *p = (mavlink_point_of_interest_t *)&msg->payload[0];
	return (uint8_t)(p->type);
James Goppert's avatar
James Goppert committed
163 164 165 166 167 168 169 170 171
}

/**
 * @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
172 173
	mavlink_point_of_interest_t *p = (mavlink_point_of_interest_t *)&msg->payload[0];
	return (uint8_t)(p->color);
James Goppert's avatar
James Goppert committed
174 175 176 177 178 179 180 181 182
}

/**
 * @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
183 184
	mavlink_point_of_interest_t *p = (mavlink_point_of_interest_t *)&msg->payload[0];
	return (uint8_t)(p->coordinate_system);
James Goppert's avatar
James Goppert committed
185 186 187 188 189 190 191 192 193
}

/**
 * @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
194 195
	mavlink_point_of_interest_t *p = (mavlink_point_of_interest_t *)&msg->payload[0];
	return (uint16_t)(p->timeout);
James Goppert's avatar
James Goppert committed
196 197 198 199 200 201 202 203 204
}

/**
 * @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
205 206
	mavlink_point_of_interest_t *p = (mavlink_point_of_interest_t *)&msg->payload[0];
	return (float)(p->x);
James Goppert's avatar
James Goppert committed
207 208 209 210 211 212 213 214 215
}

/**
 * @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
216 217
	mavlink_point_of_interest_t *p = (mavlink_point_of_interest_t *)&msg->payload[0];
	return (float)(p->y);
James Goppert's avatar
James Goppert committed
218 219 220 221 222 223 224 225 226
}

/**
 * @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
227 228
	mavlink_point_of_interest_t *p = (mavlink_point_of_interest_t *)&msg->payload[0];
	return (float)(p->z);
James Goppert's avatar
James Goppert committed
229 230 231 232 233 234 235
}

/**
 * @brief Get field name from point_of_interest message
 *
 * @return POI name
 */
LM's avatar
LM committed
236
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
237
{
lm's avatar
lm committed
238
	mavlink_point_of_interest_t *p = (mavlink_point_of_interest_t *)&msg->payload[0];
James Goppert's avatar
James Goppert committed
239

lm's avatar
lm committed
240 241
	memcpy(name, p->name, sizeof(p->name));
	return sizeof(p->name);
James Goppert's avatar
James Goppert committed
242 243 244 245 246 247 248 249 250 251
}

/**
 * @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
252
	memcpy( point_of_interest, msg->payload, sizeof(mavlink_point_of_interest_t));
James Goppert's avatar
James Goppert committed
253
}