mavlink_msg_statustext.h 5.54 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
lm's avatar
lm committed
6 7
#define MAVLINK_MSG_ID_STATUSTEXT_KEY 0x90
#define MAVLINK_MSG_254_KEY 0x90
James Goppert's avatar
James Goppert committed
8 9 10

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

} 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
27
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
28
{
lm's avatar
lm committed
29
	mavlink_statustext_t *p = (mavlink_statustext_t *)&msg->payload[0];
James Goppert's avatar
James Goppert committed
30 31
	msg->msgid = MAVLINK_MSG_ID_STATUSTEXT;

lm's avatar
lm committed
32 33
	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
34

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

/**
 * @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
48
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
49
{
lm's avatar
lm committed
50
	mavlink_statustext_t *p = (mavlink_statustext_t *)&msg->payload[0];
James Goppert's avatar
James Goppert committed
51 52
	msg->msgid = MAVLINK_MSG_ID_STATUSTEXT;

lm's avatar
lm committed
53 54
	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
55

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

/**
 * @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);
}

lm's avatar
lm committed
72 73

#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS
James Goppert's avatar
James Goppert committed
74 75 76 77 78 79 80
/**
 * @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
 */
LM's avatar
LM committed
81
static inline void mavlink_msg_statustext_send(mavlink_channel_t chan, uint8_t severity, const char* text)
lm's avatar
lm committed
82 83 84 85
{
	mavlink_header_t hdr;
	mavlink_statustext_t payload;

lm's avatar
lm committed
86 87 88
	MAVLINK_BUFFER_CHECK_START( chan, MAVLINK_MSG_ID_STATUSTEXT_LEN )
	payload.severity = severity;	// uint8_t:Severity of status, 0 = info message, 255 = critical fault
	memcpy(payload.text, text, sizeof(payload.text));	// char[50]:Status text message, without null termination character
lm's avatar
lm committed
89 90 91 92 93 94 95 96 97 98

	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 );

lm's avatar
lm committed
99 100 101 102 103 104
	crc_init(&hdr.ck);
	crc_calculate_mem((uint8_t *)&hdr.len, &hdr.ck, MAVLINK_CORE_HEADER_LEN);
	crc_calculate_mem((uint8_t *)&payload, &hdr.ck, hdr.len );
	crc_accumulate( 0x90, &hdr.ck); /// include key in X25 checksum
	mavlink_send_mem(chan, (uint8_t *)&hdr.ck, MAVLINK_NUM_CHECKSUM_BYTES);
	MAVLINK_BUFFER_CHECK_END
James Goppert's avatar
James Goppert committed
105 106 107 108 109 110 111 112 113 114 115 116
}

#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
117 118
	mavlink_statustext_t *p = (mavlink_statustext_t *)&msg->payload[0];
	return (uint8_t)(p->severity);
James Goppert's avatar
James Goppert committed
119 120 121 122 123 124 125
}

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

lm's avatar
lm committed
130 131
	memcpy(text, p->text, sizeof(p->text));
	return sizeof(p->text);
James Goppert's avatar
James Goppert committed
132 133 134 135 136 137 138 139 140 141
}

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