mavlink_msg_marker.h 6.8 KB
Newer Older
James Goppert's avatar
James Goppert committed
1 2 3
// MESSAGE MARKER PACKING

#define MAVLINK_MSG_ID_MARKER 130
lm's avatar
lm committed
4 5
#define MAVLINK_MSG_ID_MARKER_LEN 26
#define MAVLINK_MSG_130_LEN 26
lm's avatar
lm committed
6 7
#define MAVLINK_MSG_ID_MARKER_KEY 0xDD
#define MAVLINK_MSG_130_KEY 0xDD
James Goppert's avatar
James Goppert committed
8 9 10

typedef struct __mavlink_marker_t 
{
lm's avatar
lm committed
11 12 13 14 15 16 17
	float x;	///< x position
	float y;	///< y position
	float z;	///< z position
	float roll;	///< roll orientation
	float pitch;	///< pitch orientation
	float yaw;	///< yaw orientation
	uint16_t id;	///< ID
James Goppert's avatar
James Goppert committed
18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37

} mavlink_marker_t;

/**
 * @brief Pack a marker 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 id ID
 * @param x x position
 * @param y y position
 * @param z z position
 * @param roll roll orientation
 * @param pitch pitch orientation
 * @param yaw yaw orientation
 * @return length of the message in bytes (excluding serial stream start sign)
 */
static inline uint16_t mavlink_msg_marker_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, uint16_t id, float x, float y, float z, float roll, float pitch, float yaw)
{
lm's avatar
lm committed
38
	mavlink_marker_t *p = (mavlink_marker_t *)&msg->payload[0];
James Goppert's avatar
James Goppert committed
39 40
	msg->msgid = MAVLINK_MSG_ID_MARKER;

lm's avatar
lm committed
41 42 43 44 45 46 47
	p->id = id;	// uint16_t:ID
	p->x = x;	// float:x position
	p->y = y;	// float:y position
	p->z = z;	// float:z position
	p->roll = roll;	// float:roll orientation
	p->pitch = pitch;	// float:pitch orientation
	p->yaw = yaw;	// float:yaw orientation
James Goppert's avatar
James Goppert committed
48

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

/**
 * @brief Pack a marker 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 id ID
 * @param x x position
 * @param y y position
 * @param z z position
 * @param roll roll orientation
 * @param pitch pitch orientation
 * @param yaw yaw orientation
 * @return length of the message in bytes (excluding serial stream start sign)
 */
static inline uint16_t mavlink_msg_marker_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan, mavlink_message_t* msg, uint16_t id, float x, float y, float z, float roll, float pitch, float yaw)
{
lm's avatar
lm committed
69
	mavlink_marker_t *p = (mavlink_marker_t *)&msg->payload[0];
James Goppert's avatar
James Goppert committed
70 71
	msg->msgid = MAVLINK_MSG_ID_MARKER;

lm's avatar
lm committed
72 73 74 75 76 77 78
	p->id = id;	// uint16_t:ID
	p->x = x;	// float:x position
	p->y = y;	// float:y position
	p->z = z;	// float:z position
	p->roll = roll;	// float:roll orientation
	p->pitch = pitch;	// float:pitch orientation
	p->yaw = yaw;	// float:yaw orientation
James Goppert's avatar
James Goppert committed
79

lm's avatar
lm committed
80
	return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_MARKER_LEN);
James Goppert's avatar
James Goppert committed
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95
}

/**
 * @brief Encode a marker 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 marker C-struct to read the message contents from
 */
static inline uint16_t mavlink_msg_marker_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_marker_t* marker)
{
	return mavlink_msg_marker_pack(system_id, component_id, msg, marker->id, marker->x, marker->y, marker->z, marker->roll, marker->pitch, marker->yaw);
}

lm's avatar
lm committed
96 97

#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS
James Goppert's avatar
James Goppert committed
98 99 100 101 102 103 104 105 106 107 108 109
/**
 * @brief Send a marker message
 * @param chan MAVLink channel to send the message
 *
 * @param id ID
 * @param x x position
 * @param y y position
 * @param z z position
 * @param roll roll orientation
 * @param pitch pitch orientation
 * @param yaw yaw orientation
 */
lm's avatar
lm committed
110 111 112 113 114
static inline void mavlink_msg_marker_send(mavlink_channel_t chan, uint16_t id, float x, float y, float z, float roll, float pitch, float yaw)
{
	mavlink_header_t hdr;
	mavlink_marker_t payload;

lm's avatar
lm committed
115 116 117 118 119 120 121 122
	MAVLINK_BUFFER_CHECK_START( chan, MAVLINK_MSG_ID_MARKER_LEN )
	payload.id = id;	// uint16_t:ID
	payload.x = x;	// float:x position
	payload.y = y;	// float:y position
	payload.z = z;	// float:z position
	payload.roll = roll;	// float:roll orientation
	payload.pitch = pitch;	// float:pitch orientation
	payload.yaw = yaw;	// float:yaw orientation
lm's avatar
lm committed
123 124 125 126 127 128 129 130 131 132

	hdr.STX = MAVLINK_STX;
	hdr.len = MAVLINK_MSG_ID_MARKER_LEN;
	hdr.msgid = MAVLINK_MSG_ID_MARKER;
	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
133 134 135 136 137 138
	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( 0xDD, &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
139 140 141 142 143 144 145 146 147 148 149 150
}

#endif
// MESSAGE MARKER UNPACKING

/**
 * @brief Get field id from marker message
 *
 * @return ID
 */
static inline uint16_t mavlink_msg_marker_get_id(const mavlink_message_t* msg)
{
lm's avatar
lm committed
151 152
	mavlink_marker_t *p = (mavlink_marker_t *)&msg->payload[0];
	return (uint16_t)(p->id);
James Goppert's avatar
James Goppert committed
153 154 155 156 157 158 159 160 161
}

/**
 * @brief Get field x from marker message
 *
 * @return x position
 */
static inline float mavlink_msg_marker_get_x(const mavlink_message_t* msg)
{
lm's avatar
lm committed
162 163
	mavlink_marker_t *p = (mavlink_marker_t *)&msg->payload[0];
	return (float)(p->x);
James Goppert's avatar
James Goppert committed
164 165 166 167 168 169 170 171 172
}

/**
 * @brief Get field y from marker message
 *
 * @return y position
 */
static inline float mavlink_msg_marker_get_y(const mavlink_message_t* msg)
{
lm's avatar
lm committed
173 174
	mavlink_marker_t *p = (mavlink_marker_t *)&msg->payload[0];
	return (float)(p->y);
James Goppert's avatar
James Goppert committed
175 176 177 178 179 180 181 182 183
}

/**
 * @brief Get field z from marker message
 *
 * @return z position
 */
static inline float mavlink_msg_marker_get_z(const mavlink_message_t* msg)
{
lm's avatar
lm committed
184 185
	mavlink_marker_t *p = (mavlink_marker_t *)&msg->payload[0];
	return (float)(p->z);
James Goppert's avatar
James Goppert committed
186 187 188 189 190 191 192 193 194
}

/**
 * @brief Get field roll from marker message
 *
 * @return roll orientation
 */
static inline float mavlink_msg_marker_get_roll(const mavlink_message_t* msg)
{
lm's avatar
lm committed
195 196
	mavlink_marker_t *p = (mavlink_marker_t *)&msg->payload[0];
	return (float)(p->roll);
James Goppert's avatar
James Goppert committed
197 198 199 200 201 202 203 204 205
}

/**
 * @brief Get field pitch from marker message
 *
 * @return pitch orientation
 */
static inline float mavlink_msg_marker_get_pitch(const mavlink_message_t* msg)
{
lm's avatar
lm committed
206 207
	mavlink_marker_t *p = (mavlink_marker_t *)&msg->payload[0];
	return (float)(p->pitch);
James Goppert's avatar
James Goppert committed
208 209 210 211 212 213 214 215 216
}

/**
 * @brief Get field yaw from marker message
 *
 * @return yaw orientation
 */
static inline float mavlink_msg_marker_get_yaw(const mavlink_message_t* msg)
{
lm's avatar
lm committed
217 218
	mavlink_marker_t *p = (mavlink_marker_t *)&msg->payload[0];
	return (float)(p->yaw);
James Goppert's avatar
James Goppert committed
219 220 221 222 223 224 225 226 227 228
}

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