mavlink_msg_statustext.h 5.39 KB
Newer Older
James Goppert's avatar
James Goppert committed
1 2
// MESSAGE STATUSTEXT PACKING

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

lm's avatar
lm committed
5
typedef struct __mavlink_statustext_t
James Goppert's avatar
James Goppert committed
6
{
7 8
 uint8_t severity; ///< Severity of status, 0 = info message, 255 = critical fault
 int8_t text[50]; ///< Status text message, without null termination character
James Goppert's avatar
James Goppert committed
9
} mavlink_statustext_t;
lm's avatar
lm committed
10 11

#define MAVLINK_MSG_ID_STATUSTEXT_LEN 51
12
#define MAVLINK_MSG_ID_254_LEN 51
lm's avatar
lm committed
13

James Goppert's avatar
James Goppert committed
14 15
#define MAVLINK_MSG_STATUSTEXT_FIELD_TEXT_LEN 50

lm's avatar
lm committed
16 17 18
#define MAVLINK_MESSAGE_INFO_STATUSTEXT { \
	"STATUSTEXT", \
	2, \
lm's avatar
lm committed
19
	{  { "severity", NULL, MAVLINK_TYPE_UINT8_T, 0, 0, offsetof(mavlink_statustext_t, severity) }, \
20
         { "text", NULL, MAVLINK_TYPE_INT8_T, 50, 1, offsetof(mavlink_statustext_t, text) }, \
lm's avatar
lm committed
21 22 23 24
         } \
}


James Goppert's avatar
James Goppert committed
25 26 27 28 29 30
/**
 * @brief Pack a statustext 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
 *
31
 * @param severity Severity of status, 0 = info message, 255 = critical fault
James Goppert's avatar
James Goppert committed
32 33 34
 * @param text Status text message, without null termination character
 * @return length of the message in bytes (excluding serial stream start sign)
 */
lm's avatar
lm committed
35
static inline uint16_t mavlink_msg_statustext_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg,
36
						       uint8_t severity, const int8_t *text)
James Goppert's avatar
James Goppert committed
37
{
LM's avatar
LM committed
38 39 40
#if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
	char buf[51];
	_mav_put_uint8_t(buf, 0, severity);
41
	_mav_put_int8_t_array(buf, 1, text, 50);
42
        memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, 51);
LM's avatar
LM committed
43 44 45
#else
	mavlink_statustext_t packet;
	packet.severity = severity;
46
	mav_array_memcpy(packet.text, text, sizeof(int8_t)*50);
47
        memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, 51);
LM's avatar
LM committed
48
#endif
James Goppert's avatar
James Goppert committed
49

LM's avatar
LM committed
50
	msg->msgid = MAVLINK_MSG_ID_STATUSTEXT;
51
	return mavlink_finalize_message(msg, system_id, component_id, 51);
James Goppert's avatar
James Goppert committed
52 53 54
}

/**
lm's avatar
lm committed
55
 * @brief Pack a statustext message on a channel
James Goppert's avatar
James Goppert committed
56 57 58 59
 * @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
60
 * @param severity Severity of status, 0 = info message, 255 = critical fault
James Goppert's avatar
James Goppert committed
61 62 63
 * @param text Status text message, without null termination character
 * @return length of the message in bytes (excluding serial stream start sign)
 */
lm's avatar
lm committed
64 65
static inline uint16_t mavlink_msg_statustext_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan,
							   mavlink_message_t* msg,
66
						           uint8_t severity,const int8_t *text)
lm's avatar
lm committed
67
{
LM's avatar
LM committed
68 69 70
#if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
	char buf[51];
	_mav_put_uint8_t(buf, 0, severity);
71
	_mav_put_int8_t_array(buf, 1, text, 50);
72
        memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, 51);
LM's avatar
LM committed
73 74 75
#else
	mavlink_statustext_t packet;
	packet.severity = severity;
76
	mav_array_memcpy(packet.text, text, sizeof(int8_t)*50);
77
        memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, 51);
LM's avatar
LM committed
78
#endif
lm's avatar
lm committed
79

LM's avatar
LM committed
80
	msg->msgid = MAVLINK_MSG_ID_STATUSTEXT;
81
	return mavlink_finalize_message_chan(msg, system_id, component_id, chan, 51);
lm's avatar
lm committed
82 83
}

James Goppert's avatar
James Goppert committed
84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100
/**
 * @brief Encode a statustext 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 statustext C-struct to read the message contents from
 */
static inline uint16_t mavlink_msg_statustext_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_statustext_t* statustext)
{
	return mavlink_msg_statustext_pack(system_id, component_id, msg, statustext->severity, statustext->text);
}

/**
 * @brief Send a statustext message
 * @param chan MAVLink channel to send the message
 *
101
 * @param severity Severity of status, 0 = info message, 255 = critical fault
James Goppert's avatar
James Goppert committed
102 103
 * @param text Status text message, without null termination character
 */
lm's avatar
lm committed
104 105
#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS

106
static inline void mavlink_msg_statustext_send(mavlink_channel_t chan, uint8_t severity, const int8_t *text)
lm's avatar
lm committed
107
{
LM's avatar
LM committed
108 109 110
#if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
	char buf[51];
	_mav_put_uint8_t(buf, 0, severity);
111 112
	_mav_put_int8_t_array(buf, 1, text, 50);
	_mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_STATUSTEXT, buf, 51);
LM's avatar
LM committed
113 114 115
#else
	mavlink_statustext_t packet;
	packet.severity = severity;
116 117
	mav_array_memcpy(packet.text, text, sizeof(int8_t)*50);
	_mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_STATUSTEXT, (const char *)&packet, 51);
LM's avatar
LM committed
118
#endif
James Goppert's avatar
James Goppert committed
119 120 121
}

#endif
lm's avatar
lm committed
122

James Goppert's avatar
James Goppert committed
123 124
// MESSAGE STATUSTEXT UNPACKING

lm's avatar
lm committed
125

James Goppert's avatar
James Goppert committed
126 127 128
/**
 * @brief Get field severity from statustext message
 *
129
 * @return Severity of status, 0 = info message, 255 = critical fault
James Goppert's avatar
James Goppert committed
130 131 132
 */
static inline uint8_t mavlink_msg_statustext_get_severity(const mavlink_message_t* msg)
{
LM's avatar
LM committed
133
	return _MAV_RETURN_uint8_t(msg,  0);
James Goppert's avatar
James Goppert committed
134 135 136 137 138 139 140
}

/**
 * @brief Get field text from statustext message
 *
 * @return Status text message, without null termination character
 */
141
static inline uint16_t mavlink_msg_statustext_get_text(const mavlink_message_t* msg, int8_t *text)
James Goppert's avatar
James Goppert committed
142
{
143
	return _MAV_RETURN_int8_t_array(msg, text, 50,  1);
James Goppert's avatar
James Goppert committed
144 145 146 147 148 149 150 151 152 153
}

/**
 * @brief Decode a statustext message into a struct
 *
 * @param msg The message to decode
 * @param statustext C-struct to decode the message contents into
 */
static inline void mavlink_msg_statustext_decode(const mavlink_message_t* msg, mavlink_statustext_t* statustext)
{
lm's avatar
lm committed
154 155 156 157
#if MAVLINK_NEED_BYTE_SWAP
	statustext->severity = mavlink_msg_statustext_get_severity(msg);
	mavlink_msg_statustext_get_text(msg, statustext->text);
#else
LM's avatar
LM committed
158
	memcpy(statustext, _MAV_PAYLOAD(msg), 51);
lm's avatar
lm committed
159
#endif
James Goppert's avatar
James Goppert committed
160
}