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

#define MAVLINK_MSG_ID_STATUSTEXT 254
lm's avatar
lm committed
4 5
#define MAVLINK_MSG_ID_STATUSTEXT_LEN 51
#define MAVLINK_MSG_254_LEN 51
James Goppert's avatar
James Goppert committed
6 7 8 9

typedef struct __mavlink_statustext_t 
{
	uint8_t severity; ///< Severity of status, 0 = info message, 255 = critical fault
lm's avatar
lm committed
10
	char text[50]; ///< Status text message, without null termination character
James Goppert's avatar
James Goppert committed
11 12 13 14 15 16 17 18 19 20 21 22 23 24

} mavlink_statustext_t;
#define MAVLINK_MSG_STATUSTEXT_FIELD_TEXT_LEN 50

/**
 * @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
 *
 * @param severity Severity of status, 0 = info message, 255 = critical fault
 * @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
25
static inline uint16_t mavlink_msg_statustext_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, uint8_t severity, const char* text)
James Goppert's avatar
James Goppert committed
26
{
lm's avatar
lm committed
27
	mavlink_statustext_t *p = (mavlink_statustext_t *)&msg->payload[0];
James Goppert's avatar
James Goppert committed
28 29
	msg->msgid = MAVLINK_MSG_ID_STATUSTEXT;

lm's avatar
lm committed
30 31
	p->severity = severity; // uint8_t:Severity of status, 0 = info message, 255 = critical fault
	memcpy(p->text, text, sizeof(p->text)); // char[50]:Status text message, without null termination character
James Goppert's avatar
James Goppert committed
32

lm's avatar
lm committed
33
	return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_STATUSTEXT_LEN);
James Goppert's avatar
James Goppert committed
34 35 36 37 38 39 40 41 42 43 44 45
}

/**
 * @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 chan The MAVLink channel this message was sent over
 * @param msg The MAVLink message to compress the data into
 * @param severity Severity of status, 0 = info message, 255 = critical fault
 * @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
46
static inline uint16_t mavlink_msg_statustext_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan, mavlink_message_t* msg, uint8_t severity, const char* text)
James Goppert's avatar
James Goppert committed
47
{
lm's avatar
lm committed
48
	mavlink_statustext_t *p = (mavlink_statustext_t *)&msg->payload[0];
James Goppert's avatar
James Goppert committed
49 50
	msg->msgid = MAVLINK_MSG_ID_STATUSTEXT;

lm's avatar
lm committed
51 52
	p->severity = severity; // uint8_t:Severity of status, 0 = info message, 255 = critical fault
	memcpy(p->text, text, sizeof(p->text)); // char[50]:Status text message, without null termination character
James Goppert's avatar
James Goppert committed
53

lm's avatar
lm committed
54
	return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_STATUSTEXT_LEN);
James Goppert's avatar
James Goppert committed
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77
}

/**
 * @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
 *
 * @param severity Severity of status, 0 = info message, 255 = critical fault
 * @param text Status text message, without null termination character
 */
#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS
lm's avatar
lm committed
78
static inline void mavlink_msg_statustext_send(mavlink_channel_t chan, uint8_t severity, const char* text)
James Goppert's avatar
James Goppert committed
79 80
{
	mavlink_message_t msg;
lm's avatar
lm committed
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130
	uint16_t checksum;
	mavlink_statustext_t *p = (mavlink_statustext_t *)&msg.payload[0];

	p->severity = severity; // uint8_t:Severity of status, 0 = info message, 255 = critical fault
	memcpy(p->text, text, sizeof(p->text)); // char[50]:Status text message, without null termination character

	msg.STX = MAVLINK_STX;
	msg.len = MAVLINK_MSG_ID_STATUSTEXT_LEN;
	msg.msgid = MAVLINK_MSG_ID_STATUSTEXT;
	msg.sysid = mavlink_system.sysid;
	msg.compid = mavlink_system.compid;
	msg.seq = mavlink_get_channel_status(chan)->current_tx_seq;
	mavlink_get_channel_status(chan)->current_tx_seq = msg.seq + 1;
	checksum = crc_calculate_msg(&msg, msg.len + MAVLINK_CORE_HEADER_LEN);
	msg.ck_a = (uint8_t)(checksum & 0xFF); ///< Low byte
	msg.ck_b = (uint8_t)(checksum >> 8); ///< High byte

	mavlink_send_msg(chan, &msg);
}

#endif

#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS_SMALL
static inline void mavlink_msg_statustext_send(mavlink_channel_t chan, uint8_t severity, const char* text)
{
	mavlink_header_t hdr;
	mavlink_statustext_t payload;
	uint16_t checksum;
	mavlink_statustext_t *p = &payload;

	p->severity = severity; // uint8_t:Severity of status, 0 = info message, 255 = critical fault
	memcpy(p->text, text, sizeof(p->text)); // char[50]:Status text message, without null termination character

	hdr.STX = MAVLINK_STX;
	hdr.len = MAVLINK_MSG_ID_STATUSTEXT_LEN;
	hdr.msgid = MAVLINK_MSG_ID_STATUSTEXT;
	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 );

	crc_init(&checksum);
	checksum = crc_calculate_mem((uint8_t *)&hdr.len, &checksum, MAVLINK_CORE_HEADER_LEN);
	checksum = crc_calculate_mem((uint8_t *)&payload, &checksum, hdr.len );
	hdr.ck_a = (uint8_t)(checksum & 0xFF); ///< Low byte
	hdr.ck_b = (uint8_t)(checksum >> 8); ///< High byte

	mavlink_send_mem(chan, (uint8_t *)&payload, hdr.len);
	mavlink_send_mem(chan, (uint8_t *)&hdr.ck_a, MAVLINK_NUM_CHECKSUM_BYTES);
James Goppert's avatar
James Goppert committed
131 132 133 134 135 136 137 138 139 140 141 142
}

#endif
// MESSAGE STATUSTEXT UNPACKING

/**
 * @brief Get field severity from statustext message
 *
 * @return Severity of status, 0 = info message, 255 = critical fault
 */
static inline uint8_t mavlink_msg_statustext_get_severity(const mavlink_message_t* msg)
{
lm's avatar
lm committed
143 144
	mavlink_statustext_t *p = (mavlink_statustext_t *)&msg->payload[0];
	return (uint8_t)(p->severity);
James Goppert's avatar
James Goppert committed
145 146 147 148 149 150 151
}

/**
 * @brief Get field text from statustext message
 *
 * @return Status text message, without null termination character
 */
lm's avatar
lm committed
152
static inline uint16_t mavlink_msg_statustext_get_text(const mavlink_message_t* msg, char* text)
James Goppert's avatar
James Goppert committed
153
{
lm's avatar
lm committed
154
	mavlink_statustext_t *p = (mavlink_statustext_t *)&msg->payload[0];
James Goppert's avatar
James Goppert committed
155

lm's avatar
lm committed
156 157
	memcpy(text, p->text, sizeof(p->text));
	return sizeof(p->text);
James Goppert's avatar
James Goppert committed
158 159 160 161 162 163 164 165 166 167
}

/**
 * @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
168
	memcpy( statustext, msg->payload, sizeof(mavlink_statustext_t));
James Goppert's avatar
James Goppert committed
169
}