mavlink_msg_command_ack.h 8.11 KB
Newer Older
James Goppert's avatar
James Goppert committed
1 2
// MESSAGE COMMAND_ACK PACKING

3
#define MAVLINK_MSG_ID_COMMAND_ACK 77
James Goppert's avatar
James Goppert committed
4

lm's avatar
lm committed
5
typedef struct __mavlink_command_ack_t
James Goppert's avatar
James Goppert committed
6
{
7
 uint16_t command; ///< Command ID, as defined by MAV_CMD enum.
8
 uint8_t result; ///< See MAV_RESULT enum
James Goppert's avatar
James Goppert committed
9 10
} mavlink_command_ack_t;

11 12
#define MAVLINK_MSG_ID_COMMAND_ACK_LEN 3
#define MAVLINK_MSG_ID_77_LEN 3
lm's avatar
lm committed
13

Lorenz Meier's avatar
Lorenz Meier committed
14 15 16
#define MAVLINK_MSG_ID_COMMAND_ACK_CRC 143
#define MAVLINK_MSG_ID_77_CRC 143

lm's avatar
lm committed
17 18 19 20 21


#define MAVLINK_MESSAGE_INFO_COMMAND_ACK { \
	"COMMAND_ACK", \
	2, \
22 23
	{  { "command", NULL, MAVLINK_TYPE_UINT16_T, 0, 0, offsetof(mavlink_command_ack_t, command) }, \
         { "result", NULL, MAVLINK_TYPE_UINT8_T, 0, 2, offsetof(mavlink_command_ack_t, result) }, \
lm's avatar
lm committed
24 25 26 27
         } \
}


James Goppert's avatar
James Goppert committed
28 29 30 31 32 33
/**
 * @brief Pack a command_ack 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
 *
34
 * @param command Command ID, as defined by MAV_CMD enum.
35
 * @param result See MAV_RESULT enum
James Goppert's avatar
James Goppert committed
36 37
 * @return length of the message in bytes (excluding serial stream start sign)
 */
lm's avatar
lm committed
38
static inline uint16_t mavlink_msg_command_ack_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg,
39
						       uint16_t command, uint8_t result)
James Goppert's avatar
James Goppert committed
40
{
LM's avatar
LM committed
41
#if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
Lorenz Meier's avatar
Lorenz Meier committed
42
	char buf[MAVLINK_MSG_ID_COMMAND_ACK_LEN];
43 44
	_mav_put_uint16_t(buf, 0, command);
	_mav_put_uint8_t(buf, 2, result);
LM's avatar
LM committed
45

Lorenz Meier's avatar
Lorenz Meier committed
46
        memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_COMMAND_ACK_LEN);
LM's avatar
LM committed
47 48 49 50
#else
	mavlink_command_ack_t packet;
	packet.command = command;
	packet.result = result;
James Goppert's avatar
James Goppert committed
51

Lorenz Meier's avatar
Lorenz Meier committed
52
        memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_COMMAND_ACK_LEN);
LM's avatar
LM committed
53
#endif
James Goppert's avatar
James Goppert committed
54

LM's avatar
LM committed
55
	msg->msgid = MAVLINK_MSG_ID_COMMAND_ACK;
Lorenz Meier's avatar
Lorenz Meier committed
56 57 58 59 60
#if MAVLINK_CRC_EXTRA
    return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_COMMAND_ACK_LEN, MAVLINK_MSG_ID_COMMAND_ACK_CRC);
#else
    return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_COMMAND_ACK_LEN);
#endif
James Goppert's avatar
James Goppert committed
61 62 63
}

/**
lm's avatar
lm committed
64
 * @brief Pack a command_ack message on a channel
James Goppert's avatar
James Goppert committed
65 66
 * @param system_id ID of this system
 * @param component_id ID of this component (e.g. 200 for IMU)
Lorenz Meier's avatar
Lorenz Meier committed
67
 * @param chan The MAVLink channel this message will be sent over
James Goppert's avatar
James Goppert committed
68
 * @param msg The MAVLink message to compress the data into
69
 * @param command Command ID, as defined by MAV_CMD enum.
70
 * @param result See MAV_RESULT enum
James Goppert's avatar
James Goppert committed
71 72
 * @return length of the message in bytes (excluding serial stream start sign)
 */
lm's avatar
lm committed
73 74
static inline uint16_t mavlink_msg_command_ack_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan,
							   mavlink_message_t* msg,
75
						           uint16_t command,uint8_t result)
lm's avatar
lm committed
76
{
LM's avatar
LM committed
77
#if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
Lorenz Meier's avatar
Lorenz Meier committed
78
	char buf[MAVLINK_MSG_ID_COMMAND_ACK_LEN];
79 80
	_mav_put_uint16_t(buf, 0, command);
	_mav_put_uint8_t(buf, 2, result);
lm's avatar
lm committed
81

Lorenz Meier's avatar
Lorenz Meier committed
82
        memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_COMMAND_ACK_LEN);
LM's avatar
LM committed
83 84 85 86
#else
	mavlink_command_ack_t packet;
	packet.command = command;
	packet.result = result;
lm's avatar
lm committed
87

Lorenz Meier's avatar
Lorenz Meier committed
88
        memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_COMMAND_ACK_LEN);
LM's avatar
LM committed
89 90 91
#endif

	msg->msgid = MAVLINK_MSG_ID_COMMAND_ACK;
Lorenz Meier's avatar
Lorenz Meier committed
92 93 94 95 96
#if MAVLINK_CRC_EXTRA
    return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_COMMAND_ACK_LEN, MAVLINK_MSG_ID_COMMAND_ACK_CRC);
#else
    return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_COMMAND_ACK_LEN);
#endif
lm's avatar
lm committed
97 98
}

James Goppert's avatar
James Goppert committed
99
/**
Lorenz Meier's avatar
Lorenz Meier committed
100
 * @brief Encode a command_ack struct
James Goppert's avatar
James Goppert committed
101 102 103 104 105 106 107 108 109 110 111
 *
 * @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 command_ack C-struct to read the message contents from
 */
static inline uint16_t mavlink_msg_command_ack_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_command_ack_t* command_ack)
{
	return mavlink_msg_command_ack_pack(system_id, component_id, msg, command_ack->command, command_ack->result);
}

Lorenz Meier's avatar
Lorenz Meier committed
112 113 114 115 116 117 118 119 120 121 122 123 124 125
/**
 * @brief Encode a command_ack struct on a channel
 *
 * @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 will be sent over
 * @param msg The MAVLink message to compress the data into
 * @param command_ack C-struct to read the message contents from
 */
static inline uint16_t mavlink_msg_command_ack_encode_chan(uint8_t system_id, uint8_t component_id, uint8_t chan, mavlink_message_t* msg, const mavlink_command_ack_t* command_ack)
{
	return mavlink_msg_command_ack_pack_chan(system_id, component_id, chan, msg, command_ack->command, command_ack->result);
}

James Goppert's avatar
James Goppert committed
126 127 128 129
/**
 * @brief Send a command_ack message
 * @param chan MAVLink channel to send the message
 *
130
 * @param command Command ID, as defined by MAV_CMD enum.
131
 * @param result See MAV_RESULT enum
James Goppert's avatar
James Goppert committed
132
 */
lm's avatar
lm committed
133 134
#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS

135
static inline void mavlink_msg_command_ack_send(mavlink_channel_t chan, uint16_t command, uint8_t result)
lm's avatar
lm committed
136
{
LM's avatar
LM committed
137
#if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
Lorenz Meier's avatar
Lorenz Meier committed
138
	char buf[MAVLINK_MSG_ID_COMMAND_ACK_LEN];
139 140
	_mav_put_uint16_t(buf, 0, command);
	_mav_put_uint8_t(buf, 2, result);
LM's avatar
LM committed
141

Lorenz Meier's avatar
Lorenz Meier committed
142 143 144 145 146
#if MAVLINK_CRC_EXTRA
    _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_COMMAND_ACK, buf, MAVLINK_MSG_ID_COMMAND_ACK_LEN, MAVLINK_MSG_ID_COMMAND_ACK_CRC);
#else
    _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_COMMAND_ACK, buf, MAVLINK_MSG_ID_COMMAND_ACK_LEN);
#endif
LM's avatar
LM committed
147 148 149 150
#else
	mavlink_command_ack_t packet;
	packet.command = command;
	packet.result = result;
LM's avatar
LM committed
151

Lorenz Meier's avatar
Lorenz Meier committed
152 153 154 155 156
#if MAVLINK_CRC_EXTRA
    _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_COMMAND_ACK, (const char *)&packet, MAVLINK_MSG_ID_COMMAND_ACK_LEN, MAVLINK_MSG_ID_COMMAND_ACK_CRC);
#else
    _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_COMMAND_ACK, (const char *)&packet, MAVLINK_MSG_ID_COMMAND_ACK_LEN);
#endif
LM's avatar
LM committed
157
#endif
James Goppert's avatar
James Goppert committed
158 159
}

160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193
#if MAVLINK_MSG_ID_COMMAND_ACK_LEN <= MAVLINK_MAX_PAYLOAD_LEN
/*
  This varient of _send() can be used to save stack space by re-using
  memory from the receive buffer.  The caller provides a
  mavlink_message_t which is the size of a full mavlink message. This
  is usually the receive buffer for the channel, and allows a reply to an
  incoming message with minimum stack space usage.
 */
static inline void mavlink_msg_command_ack_send_buf(mavlink_message_t *msgbuf, mavlink_channel_t chan,  uint16_t command, uint8_t result)
{
#if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
	char *buf = (char *)msgbuf;
	_mav_put_uint16_t(buf, 0, command);
	_mav_put_uint8_t(buf, 2, result);

#if MAVLINK_CRC_EXTRA
    _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_COMMAND_ACK, buf, MAVLINK_MSG_ID_COMMAND_ACK_LEN, MAVLINK_MSG_ID_COMMAND_ACK_CRC);
#else
    _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_COMMAND_ACK, buf, MAVLINK_MSG_ID_COMMAND_ACK_LEN);
#endif
#else
	mavlink_command_ack_t *packet = (mavlink_command_ack_t *)msgbuf;
	packet->command = command;
	packet->result = result;

#if MAVLINK_CRC_EXTRA
    _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_COMMAND_ACK, (const char *)packet, MAVLINK_MSG_ID_COMMAND_ACK_LEN, MAVLINK_MSG_ID_COMMAND_ACK_CRC);
#else
    _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_COMMAND_ACK, (const char *)packet, MAVLINK_MSG_ID_COMMAND_ACK_LEN);
#endif
#endif
}
#endif

James Goppert's avatar
James Goppert committed
194
#endif
lm's avatar
lm committed
195

James Goppert's avatar
James Goppert committed
196 197
// MESSAGE COMMAND_ACK UNPACKING

lm's avatar
lm committed
198

James Goppert's avatar
James Goppert committed
199 200 201
/**
 * @brief Get field command from command_ack message
 *
202
 * @return Command ID, as defined by MAV_CMD enum.
James Goppert's avatar
James Goppert committed
203
 */
204
static inline uint16_t mavlink_msg_command_ack_get_command(const mavlink_message_t* msg)
James Goppert's avatar
James Goppert committed
205
{
206
	return _MAV_RETURN_uint16_t(msg,  0);
James Goppert's avatar
James Goppert committed
207 208 209 210 211
}

/**
 * @brief Get field result from command_ack message
 *
212
 * @return See MAV_RESULT enum
James Goppert's avatar
James Goppert committed
213
 */
214
static inline uint8_t mavlink_msg_command_ack_get_result(const mavlink_message_t* msg)
James Goppert's avatar
James Goppert committed
215
{
216
	return _MAV_RETURN_uint8_t(msg,  2);
James Goppert's avatar
James Goppert committed
217 218 219 220 221 222 223 224 225 226
}

/**
 * @brief Decode a command_ack message into a struct
 *
 * @param msg The message to decode
 * @param command_ack C-struct to decode the message contents into
 */
static inline void mavlink_msg_command_ack_decode(const mavlink_message_t* msg, mavlink_command_ack_t* command_ack)
{
lm's avatar
lm committed
227 228 229 230
#if MAVLINK_NEED_BYTE_SWAP
	command_ack->command = mavlink_msg_command_ack_get_command(msg);
	command_ack->result = mavlink_msg_command_ack_get_result(msg);
#else
Lorenz Meier's avatar
Lorenz Meier committed
231
	memcpy(command_ack, _MAV_PAYLOAD(msg), MAVLINK_MSG_ID_COMMAND_ACK_LEN);
lm's avatar
lm committed
232
#endif
James Goppert's avatar
James Goppert committed
233
}