lib/main/MAVLink/common/mavlink_msg_command_cancel.h

   1 #pragma once
   2 // MESSAGE COMMAND_CANCEL PACKING
   3
   4 #define MAVLINK_MSG_ID_COMMAND_CANCEL 80
   5
   6
   7 typedef struct __mavlink_command_cancel_t {
   8  uint16_t command; /*<  Command ID (of command to cancel).*/
   9  uint8_t target_system; /*<  System executing long running command. Should not be broadcast (0).*/
  10  uint8_t target_component; /*<  Component executing long running command.*/
  11 } mavlink_command_cancel_t;
  12
  13 #define MAVLINK_MSG_ID_COMMAND_CANCEL_LEN 4
  14 #define MAVLINK_MSG_ID_COMMAND_CANCEL_MIN_LEN 4
  15 #define MAVLINK_MSG_ID_80_LEN 4
  16 #define MAVLINK_MSG_ID_80_MIN_LEN 4
  17
  18 #define MAVLINK_MSG_ID_COMMAND_CANCEL_CRC 14
  19 #define MAVLINK_MSG_ID_80_CRC 14
  20
  21
  22
  23 #if MAVLINK_COMMAND_24BIT
  24 #define MAVLINK_MESSAGE_INFO_COMMAND_CANCEL { \
  25     80, \
  26     "COMMAND_CANCEL", \
  27     3, \
  28     {  { "target_system", NULL, MAVLINK_TYPE_UINT8_T, 0, 2, offsetof(mavlink_command_cancel_t, target_system) }, \
  29          { "target_component", NULL, MAVLINK_TYPE_UINT8_T, 0, 3, offsetof(mavlink_command_cancel_t, target_component) }, \
  30          { "command", NULL, MAVLINK_TYPE_UINT16_T, 0, 0, offsetof(mavlink_command_cancel_t, command) }, \
  31          } \
  32 }
  33 #else
  34 #define MAVLINK_MESSAGE_INFO_COMMAND_CANCEL { \
  35     "COMMAND_CANCEL", \
  36     3, \
  37     {  { "target_system", NULL, MAVLINK_TYPE_UINT8_T, 0, 2, offsetof(mavlink_command_cancel_t, target_system) }, \
  38          { "target_component", NULL, MAVLINK_TYPE_UINT8_T, 0, 3, offsetof(mavlink_command_cancel_t, target_component) }, \
  39          { "command", NULL, MAVLINK_TYPE_UINT16_T, 0, 0, offsetof(mavlink_command_cancel_t, command) }, \
  40          } \
  41 }
  42 #endif
  43
  44 /**
  45  * @brief Pack a command_cancel message
  46  * @param system_id ID of this system
  47  * @param component_id ID of this component (e.g. 200 for IMU)
  48  * @param msg The MAVLink message to compress the data into
  49  *
  50  * @param target_system  System executing long running command. Should not be broadcast (0).
  51  * @param target_component  Component executing long running command.
  52  * @param command  Command ID (of command to cancel).
  53  * @return length of the message in bytes (excluding serial stream start sign)
  54  */
  55 static inline uint16_t mavlink_msg_command_cancel_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg,
  56                                uint8_t target_system, uint8_t target_component, uint16_t command)
  57 {
  58 #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  59     char buf[MAVLINK_MSG_ID_COMMAND_CANCEL_LEN];
  60     _mav_put_uint16_t(buf, 0, command);
  61     _mav_put_uint8_t(buf, 2, target_system);
  62     _mav_put_uint8_t(buf, 3, target_component);
  63
  64         memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_COMMAND_CANCEL_LEN);
  65 #else
  66     mavlink_command_cancel_t packet;
  67     packet.command = command;
  68     packet.target_system = target_system;
  69     packet.target_component = target_component;
  70
  71         memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_COMMAND_CANCEL_LEN);
  72 #endif
  73
  74     msg->msgid = MAVLINK_MSG_ID_COMMAND_CANCEL;
  75     return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_COMMAND_CANCEL_MIN_LEN, MAVLINK_MSG_ID_COMMAND_CANCEL_LEN, MAVLINK_MSG_ID_COMMAND_CANCEL_CRC);
  76 }
  77
  78 /**
  79  * @brief Pack a command_cancel message on a channel
  80  * @param system_id ID of this system
  81  * @param component_id ID of this component (e.g. 200 for IMU)
  82  * @param chan The MAVLink channel this message will be sent over
  83  * @param msg The MAVLink message to compress the data into
  84  * @param target_system  System executing long running command. Should not be broadcast (0).
  85  * @param target_component  Component executing long running command.
  86  * @param command  Command ID (of command to cancel).
  87  * @return length of the message in bytes (excluding serial stream start sign)
  88  */
  89 static inline uint16_t mavlink_msg_command_cancel_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan,
  90                                mavlink_message_t* msg,
  91                                    uint8_t target_system,uint8_t target_component,uint16_t command)
  92 {
  93 #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  94     char buf[MAVLINK_MSG_ID_COMMAND_CANCEL_LEN];
  95     _mav_put_uint16_t(buf, 0, command);
  96     _mav_put_uint8_t(buf, 2, target_system);
  97     _mav_put_uint8_t(buf, 3, target_component);
  98
  99         memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_COMMAND_CANCEL_LEN);
 100 #else
 101     mavlink_command_cancel_t packet;
 102     packet.command = command;
 103     packet.target_system = target_system;
 104     packet.target_component = target_component;
 105
 106         memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_COMMAND_CANCEL_LEN);
 107 #endif
 108
 109     msg->msgid = MAVLINK_MSG_ID_COMMAND_CANCEL;
 110     return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_COMMAND_CANCEL_MIN_LEN, MAVLINK_MSG_ID_COMMAND_CANCEL_LEN, MAVLINK_MSG_ID_COMMAND_CANCEL_CRC);
 111 }
 112
 113 /**
 114  * @brief Encode a command_cancel struct
 115  *
 116  * @param system_id ID of this system
 117  * @param component_id ID of this component (e.g. 200 for IMU)
 118  * @param msg The MAVLink message to compress the data into
 119  * @param command_cancel C-struct to read the message contents from
 120  */
 121 static inline uint16_t mavlink_msg_command_cancel_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_command_cancel_t* command_cancel)
 122 {
 123     return mavlink_msg_command_cancel_pack(system_id, component_id, msg, command_cancel->target_system, command_cancel->target_component, command_cancel->command);
 124 }
 125
 126 /**
 127  * @brief Encode a command_cancel struct on a channel
 128  *
 129  * @param system_id ID of this system
 130  * @param component_id ID of this component (e.g. 200 for IMU)
 131  * @param chan The MAVLink channel this message will be sent over
 132  * @param msg The MAVLink message to compress the data into
 133  * @param command_cancel C-struct to read the message contents from
 134  */
 135 static inline uint16_t mavlink_msg_command_cancel_encode_chan(uint8_t system_id, uint8_t component_id, uint8_t chan, mavlink_message_t* msg, const mavlink_command_cancel_t* command_cancel)
 136 {
 137     return mavlink_msg_command_cancel_pack_chan(system_id, component_id, chan, msg, command_cancel->target_system, command_cancel->target_component, command_cancel->command);
 138 }
 139
 140 /**
 141  * @brief Send a command_cancel message
 142  * @param chan MAVLink channel to send the message
 143  *
 144  * @param target_system  System executing long running command. Should not be broadcast (0).
 145  * @param target_component  Component executing long running command.
 146  * @param command  Command ID (of command to cancel).
 147  */
 148 #ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS
 149
 150 static inline void mavlink_msg_command_cancel_send(mavlink_channel_t chan, uint8_t target_system, uint8_t target_component, uint16_t command)
 151 {
 152 #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
 153     char buf[MAVLINK_MSG_ID_COMMAND_CANCEL_LEN];
 154     _mav_put_uint16_t(buf, 0, command);
 155     _mav_put_uint8_t(buf, 2, target_system);
 156     _mav_put_uint8_t(buf, 3, target_component);
 157
 158     _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_COMMAND_CANCEL, buf, MAVLINK_MSG_ID_COMMAND_CANCEL_MIN_LEN, MAVLINK_MSG_ID_COMMAND_CANCEL_LEN, MAVLINK_MSG_ID_COMMAND_CANCEL_CRC);
 159 #else
 160     mavlink_command_cancel_t packet;
 161     packet.command = command;
 162     packet.target_system = target_system;
 163     packet.target_component = target_component;
 164
 165     _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_COMMAND_CANCEL, (const char *)&packet, MAVLINK_MSG_ID_COMMAND_CANCEL_MIN_LEN, MAVLINK_MSG_ID_COMMAND_CANCEL_LEN, MAVLINK_MSG_ID_COMMAND_CANCEL_CRC);
 166 #endif
 167 }
 168
 169 /**
 170  * @brief Send a command_cancel message
 171  * @param chan MAVLink channel to send the message
 172  * @param struct The MAVLink struct to serialize
 173  */
 174 static inline void mavlink_msg_command_cancel_send_struct(mavlink_channel_t chan, const mavlink_command_cancel_t* command_cancel)
 175 {
 176 #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
 177     mavlink_msg_command_cancel_send(chan, command_cancel->target_system, command_cancel->target_component, command_cancel->command);
 178 #else
 179     _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_COMMAND_CANCEL, (const char *)command_cancel, MAVLINK_MSG_ID_COMMAND_CANCEL_MIN_LEN, MAVLINK_MSG_ID_COMMAND_CANCEL_LEN, MAVLINK_MSG_ID_COMMAND_CANCEL_CRC);
 180 #endif
 181 }
 182
 183 #if MAVLINK_MSG_ID_COMMAND_CANCEL_LEN <= MAVLINK_MAX_PAYLOAD_LEN
 184 /*
 185   This varient of _send() can be used to save stack space by re-using
 186   memory from the receive buffer.  The caller provides a
 187   mavlink_message_t which is the size of a full mavlink message. This
 188   is usually the receive buffer for the channel, and allows a reply to an
 189   incoming message with minimum stack space usage.
 190  */
 191 static inline void mavlink_msg_command_cancel_send_buf(mavlink_message_t *msgbuf, mavlink_channel_t chan,  uint8_t target_system, uint8_t target_component, uint16_t command)
 192 {
 193 #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
 194     char *buf = (char *)msgbuf;
 195     _mav_put_uint16_t(buf, 0, command);
 196     _mav_put_uint8_t(buf, 2, target_system);
 197     _mav_put_uint8_t(buf, 3, target_component);
 198
 199     _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_COMMAND_CANCEL, buf, MAVLINK_MSG_ID_COMMAND_CANCEL_MIN_LEN, MAVLINK_MSG_ID_COMMAND_CANCEL_LEN, MAVLINK_MSG_ID_COMMAND_CANCEL_CRC);
 200 #else
 201     mavlink_command_cancel_t *packet = (mavlink_command_cancel_t *)msgbuf;
 202     packet->command = command;
 203     packet->target_system = target_system;
 204     packet->target_component = target_component;
 205
 206     _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_COMMAND_CANCEL, (const char *)packet, MAVLINK_MSG_ID_COMMAND_CANCEL_MIN_LEN, MAVLINK_MSG_ID_COMMAND_CANCEL_LEN, MAVLINK_MSG_ID_COMMAND_CANCEL_CRC);
 207 #endif
 208 }
 209 #endif
 210
 211 #endif
 212
 213 // MESSAGE COMMAND_CANCEL UNPACKING
 214
 215
 216 /**
 217  * @brief Get field target_system from command_cancel message
 218  *
 219  * @return  System executing long running command. Should not be broadcast (0).
 220  */
 221 static inline uint8_t mavlink_msg_command_cancel_get_target_system(const mavlink_message_t* msg)
 222 {
 223     return _MAV_RETURN_uint8_t(msg,  2);
 224 }
 225
 226 /**
 227  * @brief Get field target_component from command_cancel message
 228  *
 229  * @return  Component executing long running command.
 230  */
 231 static inline uint8_t mavlink_msg_command_cancel_get_target_component(const mavlink_message_t* msg)
 232 {
 233     return _MAV_RETURN_uint8_t(msg,  3);
 234 }
 235
 236 /**
 237  * @brief Get field command from command_cancel message
 238  *
 239  * @return  Command ID (of command to cancel).
 240  */
 241 static inline uint16_t mavlink_msg_command_cancel_get_command(const mavlink_message_t* msg)
 242 {
 243     return _MAV_RETURN_uint16_t(msg,  0);
 244 }
 245
 246 /**
 247  * @brief Decode a command_cancel message into a struct
 248  *
 249  * @param msg The message to decode
 250  * @param command_cancel C-struct to decode the message contents into
 251  */
 252 static inline void mavlink_msg_command_cancel_decode(const mavlink_message_t* msg, mavlink_command_cancel_t* command_cancel)
 253 {
 254 #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
 255     command_cancel->command = mavlink_msg_command_cancel_get_command(msg);
 256     command_cancel->target_system = mavlink_msg_command_cancel_get_target_system(msg);
 257     command_cancel->target_component = mavlink_msg_command_cancel_get_target_component(msg);
 258 #else
 259         uint8_t len = msg->len < MAVLINK_MSG_ID_COMMAND_CANCEL_LEN? msg->len : MAVLINK_MSG_ID_COMMAND_CANCEL_LEN;
 260         memset(command_cancel, 0, MAVLINK_MSG_ID_COMMAND_CANCEL_LEN);
 261     memcpy(command_cancel, _MAV_PAYLOAD(msg), len);
 262 #endif
 263 }