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

#define MAVLINK_MSG_ID_DEBUG 255

lm's avatar
lm committed
5
typedef struct __mavlink_debug_t
James Goppert's avatar
James Goppert committed
6
{
lm's avatar
lm committed
7 8
 float value; ///< DEBUG value
 uint8_t ind; ///< index of debug variable
James Goppert's avatar
James Goppert committed
9 10
} mavlink_debug_t;

lm's avatar
lm committed
11 12 13 14 15 16 17 18 19 20 21 22 23 24
#define MAVLINK_MSG_ID_DEBUG_LEN 5
#define MAVLINK_MSG_ID_255_LEN 5



#define MAVLINK_MESSAGE_INFO_DEBUG { \
	"DEBUG", \
	2, \
	{  { "value", MAVLINK_TYPE_FLOAT, 0, 0, offsetof(mavlink_debug_t, value) }, \
         { "ind", MAVLINK_TYPE_UINT8_T, 0, 4, offsetof(mavlink_debug_t, ind) }, \
         } \
}


James Goppert's avatar
James Goppert committed
25 26 27 28 29 30 31 32 33 34
/**
 * @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
 *
 * @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
35 36
static inline uint16_t mavlink_msg_debug_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg,
						       uint8_t ind, float value)
James Goppert's avatar
James Goppert committed
37 38 39
{
	msg->msgid = MAVLINK_MSG_ID_DEBUG;

lm's avatar
lm committed
40 41
	put_float_by_index(msg, 0, value); // DEBUG value
	put_uint8_t_by_index(msg, 4, ind); // index of debug variable
James Goppert's avatar
James Goppert committed
42

lm's avatar
lm committed
43
	return mavlink_finalize_message(msg, system_id, component_id, 5, 127);
James Goppert's avatar
James Goppert committed
44 45 46
}

/**
lm's avatar
lm committed
47
 * @brief Pack a debug message on a channel
James Goppert's avatar
James Goppert committed
48 49 50 51 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
 * @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
56 57 58 59 60 61 62 63 64 65 66 67
static inline uint16_t mavlink_msg_debug_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan,
							   mavlink_message_t* msg,
						           uint8_t ind,float value)
{
	msg->msgid = MAVLINK_MSG_ID_DEBUG;

	put_float_by_index(msg, 0, value); // DEBUG value
	put_uint8_t_by_index(msg, 4, ind); // index of debug variable

	return mavlink_finalize_message_chan(msg, system_id, component_id, chan, 5, 127);
}

James Goppert's avatar
James Goppert committed
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87
/**
 * @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)
{
	return mavlink_msg_debug_pack(system_id, component_id, msg, debug->ind, debug->value);
}

/**
 * @brief Send a debug message
 * @param chan MAVLink channel to send the message
 *
 * @param ind index of debug variable
 * @param value DEBUG value
 */
lm's avatar
lm committed
88 89
#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS

lm's avatar
lm committed
90 91
static inline void mavlink_msg_debug_send(mavlink_channel_t chan, uint8_t ind, float value)
{
lm's avatar
lm committed
92
	MAVLINK_ALIGNED_MESSAGE(msg, 5);
LM's avatar
LM committed
93 94 95 96 97 98
	msg->msgid = MAVLINK_MSG_ID_DEBUG;

	put_float_by_index(msg, 0, value); // DEBUG value
	put_uint8_t_by_index(msg, 4, ind); // index of debug variable

	mavlink_finalize_message_chan_send(msg, chan, 5, 127);
James Goppert's avatar
James Goppert committed
99 100 101
}

#endif
lm's avatar
lm committed
102

James Goppert's avatar
James Goppert committed
103 104
// MESSAGE DEBUG UNPACKING

lm's avatar
lm committed
105

James Goppert's avatar
James Goppert committed
106 107 108 109 110 111 112
/**
 * @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
113
	return MAVLINK_MSG_RETURN_uint8_t(msg,  4);
James Goppert's avatar
James Goppert committed
114 115 116 117 118 119 120 121 122
}

/**
 * @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
123
	return MAVLINK_MSG_RETURN_float(msg,  0);
James Goppert's avatar
James Goppert committed
124 125 126 127 128 129 130 131 132 133
}

/**
 * @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
134 135 136 137 138 139
#if MAVLINK_NEED_BYTE_SWAP
	debug->value = mavlink_msg_debug_get_value(msg);
	debug->ind = mavlink_msg_debug_get_ind(msg);
#else
	memcpy(debug, MAVLINK_PAYLOAD(msg), 5);
#endif
James Goppert's avatar
James Goppert committed
140
}