mavlink_msg_debug.h 8.41 KB
Newer Older
James Goppert's avatar
James Goppert committed
1 2
// MESSAGE DEBUG PACKING

3
#define MAVLINK_MSG_ID_DEBUG 254
James Goppert's avatar
James Goppert committed
4

lm's avatar
lm committed
5
typedef struct __mavlink_debug_t
James Goppert's avatar
James Goppert committed
6
{
7
 uint32_t time_boot_ms; ///< Timestamp (milliseconds since system boot)
lm's avatar
lm committed
8 9
 float value; ///< DEBUG value
 uint8_t ind; ///< index of debug variable
James Goppert's avatar
James Goppert committed
10 11
} mavlink_debug_t;

12 13
#define MAVLINK_MSG_ID_DEBUG_LEN 9
#define MAVLINK_MSG_ID_254_LEN 9
lm's avatar
lm committed
14

Lorenz Meier's avatar
Lorenz Meier committed
15 16 17
#define MAVLINK_MSG_ID_DEBUG_CRC 46
#define MAVLINK_MSG_ID_254_CRC 46

lm's avatar
lm committed
18 19 20 21


#define MAVLINK_MESSAGE_INFO_DEBUG { \
	"DEBUG", \
22
	3, \
lm's avatar
lm committed
23 24 25
	{  { "time_boot_ms", NULL, MAVLINK_TYPE_UINT32_T, 0, 0, offsetof(mavlink_debug_t, time_boot_ms) }, \
         { "value", NULL, MAVLINK_TYPE_FLOAT, 0, 4, offsetof(mavlink_debug_t, value) }, \
         { "ind", NULL, MAVLINK_TYPE_UINT8_T, 0, 8, offsetof(mavlink_debug_t, ind) }, \
lm's avatar
lm committed
26 27 28 29
         } \
}


James Goppert's avatar
James Goppert committed
30 31 32 33 34 35
/**
 * @brief Pack a debug 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
 *
36
 * @param time_boot_ms Timestamp (milliseconds since system boot)
James Goppert's avatar
James Goppert committed
37 38 39 40
 * @param ind index of debug variable
 * @param value DEBUG value
 * @return length of the message in bytes (excluding serial stream start sign)
 */
lm's avatar
lm committed
41
static inline uint16_t mavlink_msg_debug_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg,
42
						       uint32_t time_boot_ms, uint8_t ind, float value)
James Goppert's avatar
James Goppert committed
43
{
LM's avatar
LM committed
44
#if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
Lorenz Meier's avatar
Lorenz Meier committed
45
	char buf[MAVLINK_MSG_ID_DEBUG_LEN];
LM's avatar
LM committed
46 47 48 49
	_mav_put_uint32_t(buf, 0, time_boot_ms);
	_mav_put_float(buf, 4, value);
	_mav_put_uint8_t(buf, 8, ind);

Lorenz Meier's avatar
Lorenz Meier committed
50
        memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_DEBUG_LEN);
LM's avatar
LM committed
51 52 53 54 55
#else
	mavlink_debug_t packet;
	packet.time_boot_ms = time_boot_ms;
	packet.value = value;
	packet.ind = ind;
James Goppert's avatar
James Goppert committed
56

Lorenz Meier's avatar
Lorenz Meier committed
57
        memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_DEBUG_LEN);
LM's avatar
LM committed
58
#endif
James Goppert's avatar
James Goppert committed
59

LM's avatar
LM committed
60
	msg->msgid = MAVLINK_MSG_ID_DEBUG;
Lorenz Meier's avatar
Lorenz Meier committed
61 62 63 64 65
#if MAVLINK_CRC_EXTRA
    return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_DEBUG_LEN, MAVLINK_MSG_ID_DEBUG_CRC);
#else
    return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_DEBUG_LEN);
#endif
James Goppert's avatar
James Goppert committed
66 67 68
}

/**
lm's avatar
lm committed
69
 * @brief Pack a debug message on a channel
James Goppert's avatar
James Goppert committed
70 71
 * @param system_id ID of this system
 * @param component_id ID of this component (e.g. 200 for IMU)
Lorenz Meier's avatar
Lorenz Meier committed
72
 * @param chan The MAVLink channel this message will be sent over
James Goppert's avatar
James Goppert committed
73
 * @param msg The MAVLink message to compress the data into
74
 * @param time_boot_ms Timestamp (milliseconds since system boot)
James Goppert's avatar
James Goppert committed
75 76 77 78
 * @param ind index of debug variable
 * @param value DEBUG value
 * @return length of the message in bytes (excluding serial stream start sign)
 */
lm's avatar
lm committed
79 80
static inline uint16_t mavlink_msg_debug_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan,
							   mavlink_message_t* msg,
81
						           uint32_t time_boot_ms,uint8_t ind,float value)
lm's avatar
lm committed
82
{
LM's avatar
LM committed
83
#if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
Lorenz Meier's avatar
Lorenz Meier committed
84
	char buf[MAVLINK_MSG_ID_DEBUG_LEN];
LM's avatar
LM committed
85 86 87
	_mav_put_uint32_t(buf, 0, time_boot_ms);
	_mav_put_float(buf, 4, value);
	_mav_put_uint8_t(buf, 8, ind);
lm's avatar
lm committed
88

Lorenz Meier's avatar
Lorenz Meier committed
89
        memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_DEBUG_LEN);
LM's avatar
LM committed
90 91 92 93 94
#else
	mavlink_debug_t packet;
	packet.time_boot_ms = time_boot_ms;
	packet.value = value;
	packet.ind = ind;
lm's avatar
lm committed
95

Lorenz Meier's avatar
Lorenz Meier committed
96
        memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_DEBUG_LEN);
LM's avatar
LM committed
97 98 99
#endif

	msg->msgid = MAVLINK_MSG_ID_DEBUG;
Lorenz Meier's avatar
Lorenz Meier committed
100 101 102 103 104
#if MAVLINK_CRC_EXTRA
    return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_DEBUG_LEN, MAVLINK_MSG_ID_DEBUG_CRC);
#else
    return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_DEBUG_LEN);
#endif
lm's avatar
lm committed
105 106
}

James Goppert's avatar
James Goppert committed
107
/**
Lorenz Meier's avatar
Lorenz Meier committed
108
 * @brief Encode a debug struct
James Goppert's avatar
James Goppert committed
109 110 111 112 113 114 115 116
 *
 * @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 debug C-struct to read the message contents from
 */
static inline uint16_t mavlink_msg_debug_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_debug_t* debug)
{
117
	return mavlink_msg_debug_pack(system_id, component_id, msg, debug->time_boot_ms, debug->ind, debug->value);
James Goppert's avatar
James Goppert committed
118 119
}

Lorenz Meier's avatar
Lorenz Meier committed
120 121 122 123 124 125 126 127 128 129 130 131 132 133
/**
 * @brief Encode a debug struct on a channel
 *
 * @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 will be sent over
 * @param msg The MAVLink message to compress the data into
 * @param debug C-struct to read the message contents from
 */
static inline uint16_t mavlink_msg_debug_encode_chan(uint8_t system_id, uint8_t component_id, uint8_t chan, mavlink_message_t* msg, const mavlink_debug_t* debug)
{
	return mavlink_msg_debug_pack_chan(system_id, component_id, chan, msg, debug->time_boot_ms, debug->ind, debug->value);
}

James Goppert's avatar
James Goppert committed
134 135 136 137
/**
 * @brief Send a debug message
 * @param chan MAVLink channel to send the message
 *
138
 * @param time_boot_ms Timestamp (milliseconds since system boot)
James Goppert's avatar
James Goppert committed
139 140 141
 * @param ind index of debug variable
 * @param value DEBUG value
 */
lm's avatar
lm committed
142 143
#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS

144
static inline void mavlink_msg_debug_send(mavlink_channel_t chan, uint32_t time_boot_ms, uint8_t ind, float value)
lm's avatar
lm committed
145
{
LM's avatar
LM committed
146
#if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
Lorenz Meier's avatar
Lorenz Meier committed
147
	char buf[MAVLINK_MSG_ID_DEBUG_LEN];
LM's avatar
LM committed
148 149 150
	_mav_put_uint32_t(buf, 0, time_boot_ms);
	_mav_put_float(buf, 4, value);
	_mav_put_uint8_t(buf, 8, ind);
LM's avatar
LM committed
151

Lorenz Meier's avatar
Lorenz Meier committed
152 153 154 155 156
#if MAVLINK_CRC_EXTRA
    _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_DEBUG, buf, MAVLINK_MSG_ID_DEBUG_LEN, MAVLINK_MSG_ID_DEBUG_CRC);
#else
    _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_DEBUG, buf, MAVLINK_MSG_ID_DEBUG_LEN);
#endif
LM's avatar
LM committed
157 158 159 160 161
#else
	mavlink_debug_t packet;
	packet.time_boot_ms = time_boot_ms;
	packet.value = value;
	packet.ind = ind;
LM's avatar
LM committed
162

Lorenz Meier's avatar
Lorenz Meier committed
163 164 165 166 167
#if MAVLINK_CRC_EXTRA
    _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_DEBUG, (const char *)&packet, MAVLINK_MSG_ID_DEBUG_LEN, MAVLINK_MSG_ID_DEBUG_CRC);
#else
    _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_DEBUG, (const char *)&packet, MAVLINK_MSG_ID_DEBUG_LEN);
#endif
LM's avatar
LM committed
168
#endif
James Goppert's avatar
James Goppert committed
169 170
}

171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206
#if MAVLINK_MSG_ID_DEBUG_LEN <= MAVLINK_MAX_PAYLOAD_LEN
/*
  This varient of _send() can be used to save stack space by re-using
  memory from the receive buffer.  The caller provides a
  mavlink_message_t which is the size of a full mavlink message. This
  is usually the receive buffer for the channel, and allows a reply to an
  incoming message with minimum stack space usage.
 */
static inline void mavlink_msg_debug_send_buf(mavlink_message_t *msgbuf, mavlink_channel_t chan,  uint32_t time_boot_ms, uint8_t ind, float value)
{
#if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
	char *buf = (char *)msgbuf;
	_mav_put_uint32_t(buf, 0, time_boot_ms);
	_mav_put_float(buf, 4, value);
	_mav_put_uint8_t(buf, 8, ind);

#if MAVLINK_CRC_EXTRA
    _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_DEBUG, buf, MAVLINK_MSG_ID_DEBUG_LEN, MAVLINK_MSG_ID_DEBUG_CRC);
#else
    _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_DEBUG, buf, MAVLINK_MSG_ID_DEBUG_LEN);
#endif
#else
	mavlink_debug_t *packet = (mavlink_debug_t *)msgbuf;
	packet->time_boot_ms = time_boot_ms;
	packet->value = value;
	packet->ind = ind;

#if MAVLINK_CRC_EXTRA
    _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_DEBUG, (const char *)packet, MAVLINK_MSG_ID_DEBUG_LEN, MAVLINK_MSG_ID_DEBUG_CRC);
#else
    _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_DEBUG, (const char *)packet, MAVLINK_MSG_ID_DEBUG_LEN);
#endif
#endif
}
#endif

James Goppert's avatar
James Goppert committed
207
#endif
lm's avatar
lm committed
208

James Goppert's avatar
James Goppert committed
209 210
// MESSAGE DEBUG UNPACKING

lm's avatar
lm committed
211

212 213 214 215 216 217 218
/**
 * @brief Get field time_boot_ms from debug message
 *
 * @return Timestamp (milliseconds since system boot)
 */
static inline uint32_t mavlink_msg_debug_get_time_boot_ms(const mavlink_message_t* msg)
{
LM's avatar
LM committed
219
	return _MAV_RETURN_uint32_t(msg,  0);
220 221
}

James Goppert's avatar
James Goppert committed
222 223 224 225 226 227 228
/**
 * @brief Get field ind from debug message
 *
 * @return index of debug variable
 */
static inline uint8_t mavlink_msg_debug_get_ind(const mavlink_message_t* msg)
{
LM's avatar
LM committed
229
	return _MAV_RETURN_uint8_t(msg,  8);
James Goppert's avatar
James Goppert committed
230 231 232 233 234 235 236 237 238
}

/**
 * @brief Get field value from debug message
 *
 * @return DEBUG value
 */
static inline float mavlink_msg_debug_get_value(const mavlink_message_t* msg)
{
LM's avatar
LM committed
239
	return _MAV_RETURN_float(msg,  4);
James Goppert's avatar
James Goppert committed
240 241 242 243 244 245 246 247 248 249
}

/**
 * @brief Decode a debug message into a struct
 *
 * @param msg The message to decode
 * @param debug C-struct to decode the message contents into
 */
static inline void mavlink_msg_debug_decode(const mavlink_message_t* msg, mavlink_debug_t* debug)
{
lm's avatar
lm committed
250
#if MAVLINK_NEED_BYTE_SWAP
251
	debug->time_boot_ms = mavlink_msg_debug_get_time_boot_ms(msg);
lm's avatar
lm committed
252 253 254
	debug->value = mavlink_msg_debug_get_value(msg);
	debug->ind = mavlink_msg_debug_get_ind(msg);
#else
Lorenz Meier's avatar
Lorenz Meier committed
255
	memcpy(debug, _MAV_PAYLOAD(msg), MAVLINK_MSG_ID_DEBUG_LEN);
lm's avatar
lm committed
256
#endif
James Goppert's avatar
James Goppert committed
257
}