mavlink_msg_safety_allowed_area.h 9.58 KB
Newer Older
James Goppert's avatar
James Goppert committed
1 2 3
// MESSAGE SAFETY_ALLOWED_AREA PACKING

#define MAVLINK_MSG_ID_SAFETY_ALLOWED_AREA 54
lm's avatar
lm committed
4 5
#define MAVLINK_MSG_ID_SAFETY_ALLOWED_AREA_LEN 25
#define MAVLINK_MSG_54_LEN 25
James Goppert's avatar
James Goppert committed
6 7 8 9 10 11 12 13 14

typedef struct __mavlink_safety_allowed_area_t 
{
	float p1x; ///< x position 1 / Latitude 1
	float p1y; ///< y position 1 / Longitude 1
	float p1z; ///< z position 1 / Altitude 1
	float p2x; ///< x position 2 / Latitude 2
	float p2y; ///< y position 2 / Longitude 2
	float p2z; ///< z position 2 / Altitude 2
15
	uint8_t frame; ///< Coordinate frame, as defined by MAV_FRAME enum in mavlink_types.h. Can be either global, GPS, right-handed with Z axis up or local, right handed, Z axis down.
James Goppert's avatar
James Goppert committed
16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35

} mavlink_safety_allowed_area_t;

/**
 * @brief Pack a safety_allowed_area 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 frame Coordinate frame, as defined by MAV_FRAME enum in mavlink_types.h. Can be either global, GPS, right-handed with Z axis up or local, right handed, Z axis down.
 * @param p1x x position 1 / Latitude 1
 * @param p1y y position 1 / Longitude 1
 * @param p1z z position 1 / Altitude 1
 * @param p2x x position 2 / Latitude 2
 * @param p2y y position 2 / Longitude 2
 * @param p2z z position 2 / Altitude 2
 * @return length of the message in bytes (excluding serial stream start sign)
 */
static inline uint16_t mavlink_msg_safety_allowed_area_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, uint8_t frame, float p1x, float p1y, float p1z, float p2x, float p2y, float p2z)
{
lm's avatar
lm committed
36
	mavlink_safety_allowed_area_t *p = (mavlink_safety_allowed_area_t *)&msg->payload[0];
James Goppert's avatar
James Goppert committed
37 38
	msg->msgid = MAVLINK_MSG_ID_SAFETY_ALLOWED_AREA;

lm's avatar
lm committed
39 40 41 42 43 44 45
	p->frame = frame; // uint8_t:Coordinate frame, as defined by MAV_FRAME enum in mavlink_types.h. Can be either global, GPS, right-handed with Z axis up or local, right handed, Z axis down.
	p->p1x = p1x; // float:x position 1 / Latitude 1
	p->p1y = p1y; // float:y position 1 / Longitude 1
	p->p1z = p1z; // float:z position 1 / Altitude 1
	p->p2x = p2x; // float:x position 2 / Latitude 2
	p->p2y = p2y; // float:y position 2 / Longitude 2
	p->p2z = p2z; // float:z position 2 / Altitude 2
James Goppert's avatar
James Goppert committed
46

lm's avatar
lm committed
47
	return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_SAFETY_ALLOWED_AREA_LEN);
James Goppert's avatar
James Goppert committed
48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66
}

/**
 * @brief Pack a safety_allowed_area 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 frame Coordinate frame, as defined by MAV_FRAME enum in mavlink_types.h. Can be either global, GPS, right-handed with Z axis up or local, right handed, Z axis down.
 * @param p1x x position 1 / Latitude 1
 * @param p1y y position 1 / Longitude 1
 * @param p1z z position 1 / Altitude 1
 * @param p2x x position 2 / Latitude 2
 * @param p2y y position 2 / Longitude 2
 * @param p2z z position 2 / Altitude 2
 * @return length of the message in bytes (excluding serial stream start sign)
 */
static inline uint16_t mavlink_msg_safety_allowed_area_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan, mavlink_message_t* msg, uint8_t frame, float p1x, float p1y, float p1z, float p2x, float p2y, float p2z)
{
lm's avatar
lm committed
67
	mavlink_safety_allowed_area_t *p = (mavlink_safety_allowed_area_t *)&msg->payload[0];
James Goppert's avatar
James Goppert committed
68 69
	msg->msgid = MAVLINK_MSG_ID_SAFETY_ALLOWED_AREA;

lm's avatar
lm committed
70 71 72 73 74 75 76
	p->frame = frame; // uint8_t:Coordinate frame, as defined by MAV_FRAME enum in mavlink_types.h. Can be either global, GPS, right-handed with Z axis up or local, right handed, Z axis down.
	p->p1x = p1x; // float:x position 1 / Latitude 1
	p->p1y = p1y; // float:y position 1 / Longitude 1
	p->p1z = p1z; // float:z position 1 / Altitude 1
	p->p2x = p2x; // float:x position 2 / Latitude 2
	p->p2y = p2y; // float:y position 2 / Longitude 2
	p->p2z = p2z; // float:z position 2 / Altitude 2
James Goppert's avatar
James Goppert committed
77

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

/**
 * @brief Encode a safety_allowed_area 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 safety_allowed_area C-struct to read the message contents from
 */
static inline uint16_t mavlink_msg_safety_allowed_area_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_safety_allowed_area_t* safety_allowed_area)
{
	return mavlink_msg_safety_allowed_area_pack(system_id, component_id, msg, safety_allowed_area->frame, safety_allowed_area->p1x, safety_allowed_area->p1y, safety_allowed_area->p1z, safety_allowed_area->p2x, safety_allowed_area->p2y, safety_allowed_area->p2z);
}

/**
 * @brief Send a safety_allowed_area message
 * @param chan MAVLink channel to send the message
 *
 * @param frame Coordinate frame, as defined by MAV_FRAME enum in mavlink_types.h. Can be either global, GPS, right-handed with Z axis up or local, right handed, Z axis down.
 * @param p1x x position 1 / Latitude 1
 * @param p1y y position 1 / Longitude 1
 * @param p1z z position 1 / Altitude 1
 * @param p2x x position 2 / Latitude 2
 * @param p2y y position 2 / Longitude 2
 * @param p2z z position 2 / Altitude 2
 */
lm's avatar
lm committed
106 107


108
#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS
lm's avatar
lm committed
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
static inline void mavlink_msg_safety_allowed_area_send(mavlink_channel_t chan, uint8_t frame, float p1x, float p1y, float p1z, float p2x, float p2y, float p2z)
{
	mavlink_header_t hdr;
	mavlink_safety_allowed_area_t payload;
	uint16_t checksum;
	mavlink_safety_allowed_area_t *p = &payload;

	p->frame = frame; // uint8_t:Coordinate frame, as defined by MAV_FRAME enum in mavlink_types.h. Can be either global, GPS, right-handed with Z axis up or local, right handed, Z axis down.
	p->p1x = p1x; // float:x position 1 / Latitude 1
	p->p1y = p1y; // float:y position 1 / Longitude 1
	p->p1z = p1z; // float:z position 1 / Altitude 1
	p->p2x = p2x; // float:x position 2 / Latitude 2
	p->p2y = p2y; // float:y position 2 / Longitude 2
	p->p2z = p2z; // float:z position 2 / Altitude 2

	hdr.STX = MAVLINK_STX;
	hdr.len = MAVLINK_MSG_ID_SAFETY_ALLOWED_AREA_LEN;
	hdr.msgid = MAVLINK_MSG_ID_SAFETY_ALLOWED_AREA;
	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
141 142 143 144 145 146 147 148 149 150 151 152
}

#endif
// MESSAGE SAFETY_ALLOWED_AREA UNPACKING

/**
 * @brief Get field frame from safety_allowed_area message
 *
 * @return Coordinate frame, as defined by MAV_FRAME enum in mavlink_types.h. Can be either global, GPS, right-handed with Z axis up or local, right handed, Z axis down.
 */
static inline uint8_t mavlink_msg_safety_allowed_area_get_frame(const mavlink_message_t* msg)
{
lm's avatar
lm committed
153 154
	mavlink_safety_allowed_area_t *p = (mavlink_safety_allowed_area_t *)&msg->payload[0];
	return (uint8_t)(p->frame);
James Goppert's avatar
James Goppert committed
155 156 157 158 159 160 161 162 163
}

/**
 * @brief Get field p1x from safety_allowed_area message
 *
 * @return x position 1 / Latitude 1
 */
static inline float mavlink_msg_safety_allowed_area_get_p1x(const mavlink_message_t* msg)
{
lm's avatar
lm committed
164 165
	mavlink_safety_allowed_area_t *p = (mavlink_safety_allowed_area_t *)&msg->payload[0];
	return (float)(p->p1x);
James Goppert's avatar
James Goppert committed
166 167 168 169 170 171 172 173 174
}

/**
 * @brief Get field p1y from safety_allowed_area message
 *
 * @return y position 1 / Longitude 1
 */
static inline float mavlink_msg_safety_allowed_area_get_p1y(const mavlink_message_t* msg)
{
lm's avatar
lm committed
175 176
	mavlink_safety_allowed_area_t *p = (mavlink_safety_allowed_area_t *)&msg->payload[0];
	return (float)(p->p1y);
James Goppert's avatar
James Goppert committed
177 178 179 180 181 182 183 184 185
}

/**
 * @brief Get field p1z from safety_allowed_area message
 *
 * @return z position 1 / Altitude 1
 */
static inline float mavlink_msg_safety_allowed_area_get_p1z(const mavlink_message_t* msg)
{
lm's avatar
lm committed
186 187
	mavlink_safety_allowed_area_t *p = (mavlink_safety_allowed_area_t *)&msg->payload[0];
	return (float)(p->p1z);
James Goppert's avatar
James Goppert committed
188 189 190 191 192 193 194 195 196
}

/**
 * @brief Get field p2x from safety_allowed_area message
 *
 * @return x position 2 / Latitude 2
 */
static inline float mavlink_msg_safety_allowed_area_get_p2x(const mavlink_message_t* msg)
{
lm's avatar
lm committed
197 198
	mavlink_safety_allowed_area_t *p = (mavlink_safety_allowed_area_t *)&msg->payload[0];
	return (float)(p->p2x);
James Goppert's avatar
James Goppert committed
199 200 201 202 203 204 205 206 207
}

/**
 * @brief Get field p2y from safety_allowed_area message
 *
 * @return y position 2 / Longitude 2
 */
static inline float mavlink_msg_safety_allowed_area_get_p2y(const mavlink_message_t* msg)
{
lm's avatar
lm committed
208 209
	mavlink_safety_allowed_area_t *p = (mavlink_safety_allowed_area_t *)&msg->payload[0];
	return (float)(p->p2y);
James Goppert's avatar
James Goppert committed
210 211 212 213 214 215 216 217 218
}

/**
 * @brief Get field p2z from safety_allowed_area message
 *
 * @return z position 2 / Altitude 2
 */
static inline float mavlink_msg_safety_allowed_area_get_p2z(const mavlink_message_t* msg)
{
lm's avatar
lm committed
219 220
	mavlink_safety_allowed_area_t *p = (mavlink_safety_allowed_area_t *)&msg->payload[0];
	return (float)(p->p2z);
James Goppert's avatar
James Goppert committed
221 222 223 224 225 226 227 228 229 230
}

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