mavlink_msg_debug.h 4.95 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 15 16 17 18



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


James Goppert's avatar
James Goppert committed
27 28 29 30 31 32
/**
 * @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
 *
33
 * @param time_boot_ms Timestamp (milliseconds since system boot)
James Goppert's avatar
James Goppert committed
34 35 36 37
 * @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
38
static inline uint16_t mavlink_msg_debug_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg,
39
						       uint32_t time_boot_ms, uint8_t ind, float value)
James Goppert's avatar
James Goppert committed
40 41 42
{
	msg->msgid = MAVLINK_MSG_ID_DEBUG;

43 44 45
	put_uint32_t_by_index(msg, 0, time_boot_ms); // Timestamp (milliseconds since system boot)
	put_float_by_index(msg, 4, value); // DEBUG value
	put_uint8_t_by_index(msg, 8, ind); // index of debug variable
James Goppert's avatar
James Goppert committed
46

47
	return mavlink_finalize_message(msg, system_id, component_id, 9, 46);
James Goppert's avatar
James Goppert committed
48 49 50
}

/**
lm's avatar
lm committed
51
 * @brief Pack a debug message on a channel
James Goppert's avatar
James Goppert committed
52 53 54 55
 * @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
56
 * @param time_boot_ms Timestamp (milliseconds since system boot)
James Goppert's avatar
James Goppert committed
57 58 59 60
 * @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
61 62
static inline uint16_t mavlink_msg_debug_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan,
							   mavlink_message_t* msg,
63
						           uint32_t time_boot_ms,uint8_t ind,float value)
lm's avatar
lm committed
64 65 66
{
	msg->msgid = MAVLINK_MSG_ID_DEBUG;

67 68 69
	put_uint32_t_by_index(msg, 0, time_boot_ms); // Timestamp (milliseconds since system boot)
	put_float_by_index(msg, 4, value); // DEBUG value
	put_uint8_t_by_index(msg, 8, ind); // index of debug variable
lm's avatar
lm committed
70

71
	return mavlink_finalize_message_chan(msg, system_id, component_id, chan, 9, 46);
lm's avatar
lm committed
72 73
}

James Goppert's avatar
James Goppert committed
74 75 76 77 78 79 80 81 82 83
/**
 * @brief Encode a debug 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 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)
{
84
	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
85 86 87 88 89 90
}

/**
 * @brief Send a debug message
 * @param chan MAVLink channel to send the message
 *
91
 * @param time_boot_ms Timestamp (milliseconds since system boot)
James Goppert's avatar
James Goppert committed
92 93 94
 * @param ind index of debug variable
 * @param value DEBUG value
 */
lm's avatar
lm committed
95 96
#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS

97
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
98
{
99
	MAVLINK_ALIGNED_MESSAGE(msg, 9);
LM's avatar
LM committed
100 101
	msg->msgid = MAVLINK_MSG_ID_DEBUG;

102 103 104
	put_uint32_t_by_index(msg, 0, time_boot_ms); // Timestamp (milliseconds since system boot)
	put_float_by_index(msg, 4, value); // DEBUG value
	put_uint8_t_by_index(msg, 8, ind); // index of debug variable
LM's avatar
LM committed
105

106
	mavlink_finalize_message_chan_send(msg, chan, 9, 46);
James Goppert's avatar
James Goppert committed
107 108 109
}

#endif
lm's avatar
lm committed
110

James Goppert's avatar
James Goppert committed
111 112
// MESSAGE DEBUG UNPACKING

lm's avatar
lm committed
113

114 115 116 117 118 119 120 121 122 123
/**
 * @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)
{
	return MAVLINK_MSG_RETURN_uint32_t(msg,  0);
}

James Goppert's avatar
James Goppert committed
124 125 126 127 128 129 130
/**
 * @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)
{
131
	return MAVLINK_MSG_RETURN_uint8_t(msg,  8);
James Goppert's avatar
James Goppert committed
132 133 134 135 136 137 138 139 140
}

/**
 * @brief Get field value from debug message
 *
 * @return DEBUG value
 */
static inline float mavlink_msg_debug_get_value(const mavlink_message_t* msg)
{
141
	return MAVLINK_MSG_RETURN_float(msg,  4);
James Goppert's avatar
James Goppert committed
142 143 144 145 146 147 148 149 150 151
}

/**
 * @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
152
#if MAVLINK_NEED_BYTE_SWAP
153
	debug->time_boot_ms = mavlink_msg_debug_get_time_boot_ms(msg);
lm's avatar
lm committed
154 155 156
	debug->value = mavlink_msg_debug_get_value(msg);
	debug->ind = mavlink_msg_debug_get_ind(msg);
#else
157
	memcpy(debug, MAVLINK_PAYLOAD(msg), 9);
lm's avatar
lm committed
158
#endif
James Goppert's avatar
James Goppert committed
159
}