lib/main/MAVLink/common/mavlink_msg_request_data_stream.h

   1 // MESSAGE REQUEST_DATA_STREAM PACKING
   2
   3 #define MAVLINK_MSG_ID_REQUEST_DATA_STREAM 66
   4
   5 typedef struct __mavlink_request_data_stream_t
   6 {
   7  uint16_t req_message_rate; ///< The requested interval between two messages of this type
   8  uint8_t target_system; ///< The target requested to send the message stream.
   9  uint8_t target_component; ///< The target requested to send the message stream.
  10  uint8_t req_stream_id; ///< The ID of the requested data stream
  11  uint8_t start_stop; ///< 1 to start sending, 0 to stop sending.
  12 } mavlink_request_data_stream_t;
  13
  14 #define MAVLINK_MSG_ID_REQUEST_DATA_STREAM_LEN 6
  15 #define MAVLINK_MSG_ID_66_LEN 6
  16
  17 #define MAVLINK_MSG_ID_REQUEST_DATA_STREAM_CRC 148
  18 #define MAVLINK_MSG_ID_66_CRC 148
  19
  20
  21
  22 #define MAVLINK_MESSAGE_INFO_REQUEST_DATA_STREAM { \
  23         "REQUEST_DATA_STREAM", \
  24         5, \
  25         {  { "req_message_rate", NULL, MAVLINK_TYPE_UINT16_T, 0, 0, offsetof(mavlink_request_data_stream_t, req_message_rate) }, \
  26          { "target_system", NULL, MAVLINK_TYPE_UINT8_T, 0, 2, offsetof(mavlink_request_data_stream_t, target_system) }, \
  27          { "target_component", NULL, MAVLINK_TYPE_UINT8_T, 0, 3, offsetof(mavlink_request_data_stream_t, target_component) }, \
  28          { "req_stream_id", NULL, MAVLINK_TYPE_UINT8_T, 0, 4, offsetof(mavlink_request_data_stream_t, req_stream_id) }, \
  29          { "start_stop", NULL, MAVLINK_TYPE_UINT8_T, 0, 5, offsetof(mavlink_request_data_stream_t, start_stop) }, \
  30          } \
  31 }
  32
  33
  34 /**
  35  * @brief Pack a request_data_stream message
  36  * @param system_id ID of this system
  37  * @param component_id ID of this component (e.g. 200 for IMU)
  38  * @param msg The MAVLink message to compress the data into
  39  *
  40  * @param target_system The target requested to send the message stream.
  41  * @param target_component The target requested to send the message stream.
  42  * @param req_stream_id The ID of the requested data stream
  43  * @param req_message_rate The requested interval between two messages of this type
  44  * @param start_stop 1 to start sending, 0 to stop sending.
  45  * @return length of the message in bytes (excluding serial stream start sign)
  46  */
  47 static inline uint16_t mavlink_msg_request_data_stream_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg,
  48                                                        uint8_t target_system, uint8_t target_component, uint8_t req_stream_id, uint16_t req_message_rate, uint8_t start_stop)
  49 {
  50 #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  51         char buf[MAVLINK_MSG_ID_REQUEST_DATA_STREAM_LEN];
  52         _mav_put_uint16_t(buf, 0, req_message_rate);
  53         _mav_put_uint8_t(buf, 2, target_system);
  54         _mav_put_uint8_t(buf, 3, target_component);
  55         _mav_put_uint8_t(buf, 4, req_stream_id);
  56         _mav_put_uint8_t(buf, 5, start_stop);
  57
  58         memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_REQUEST_DATA_STREAM_LEN);
  59 #else
  60         mavlink_request_data_stream_t packet;
  61         packet.req_message_rate = req_message_rate;
  62         packet.target_system = target_system;
  63         packet.target_component = target_component;
  64         packet.req_stream_id = req_stream_id;
  65         packet.start_stop = start_stop;
  66
  67         memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_REQUEST_DATA_STREAM_LEN);
  68 #endif
  69
  70         msg->msgid = MAVLINK_MSG_ID_REQUEST_DATA_STREAM;
  71 #if MAVLINK_CRC_EXTRA
  72     return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_REQUEST_DATA_STREAM_LEN, MAVLINK_MSG_ID_REQUEST_DATA_STREAM_CRC);
  73 #else
  74     return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_REQUEST_DATA_STREAM_LEN);
  75 #endif
  76 }
  77
  78 /**
  79  * @brief Pack a request_data_stream 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 The target requested to send the message stream.
  85  * @param target_component The target requested to send the message stream.
  86  * @param req_stream_id The ID of the requested data stream
  87  * @param req_message_rate The requested interval between two messages of this type
  88  * @param start_stop 1 to start sending, 0 to stop sending.
  89  * @return length of the message in bytes (excluding serial stream start sign)
  90  */
  91 static inline uint16_t mavlink_msg_request_data_stream_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan,
  92                                                            mavlink_message_t* msg,
  93                                                            uint8_t target_system,uint8_t target_component,uint8_t req_stream_id,uint16_t req_message_rate,uint8_t start_stop)
  94 {
  95 #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  96         char buf[MAVLINK_MSG_ID_REQUEST_DATA_STREAM_LEN];
  97         _mav_put_uint16_t(buf, 0, req_message_rate);
  98         _mav_put_uint8_t(buf, 2, target_system);
  99         _mav_put_uint8_t(buf, 3, target_component);
 100         _mav_put_uint8_t(buf, 4, req_stream_id);
 101         _mav_put_uint8_t(buf, 5, start_stop);
 102
 103         memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_REQUEST_DATA_STREAM_LEN);
 104 #else
 105         mavlink_request_data_stream_t packet;
 106         packet.req_message_rate = req_message_rate;
 107         packet.target_system = target_system;
 108         packet.target_component = target_component;
 109         packet.req_stream_id = req_stream_id;
 110         packet.start_stop = start_stop;
 111
 112         memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_REQUEST_DATA_STREAM_LEN);
 113 #endif
 114
 115         msg->msgid = MAVLINK_MSG_ID_REQUEST_DATA_STREAM;
 116 #if MAVLINK_CRC_EXTRA
 117     return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_REQUEST_DATA_STREAM_LEN, MAVLINK_MSG_ID_REQUEST_DATA_STREAM_CRC);
 118 #else
 119     return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_REQUEST_DATA_STREAM_LEN);
 120 #endif
 121 }
 122
 123 /**
 124  * @brief Encode a request_data_stream struct
 125  *
 126  * @param system_id ID of this system
 127  * @param component_id ID of this component (e.g. 200 for IMU)
 128  * @param msg The MAVLink message to compress the data into
 129  * @param request_data_stream C-struct to read the message contents from
 130  */
 131 static inline uint16_t mavlink_msg_request_data_stream_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_request_data_stream_t* request_data_stream)
 132 {
 133         return mavlink_msg_request_data_stream_pack(system_id, component_id, msg, request_data_stream->target_system, request_data_stream->target_component, request_data_stream->req_stream_id, request_data_stream->req_message_rate, request_data_stream->start_stop);
 134 }
 135
 136 /**
 137  * @brief Encode a request_data_stream struct on a channel
 138  *
 139  * @param system_id ID of this system
 140  * @param component_id ID of this component (e.g. 200 for IMU)
 141  * @param chan The MAVLink channel this message will be sent over
 142  * @param msg The MAVLink message to compress the data into
 143  * @param request_data_stream C-struct to read the message contents from
 144  */
 145 static inline uint16_t mavlink_msg_request_data_stream_encode_chan(uint8_t system_id, uint8_t component_id, uint8_t chan, mavlink_message_t* msg, const mavlink_request_data_stream_t* request_data_stream)
 146 {
 147         return mavlink_msg_request_data_stream_pack_chan(system_id, component_id, chan, msg, request_data_stream->target_system, request_data_stream->target_component, request_data_stream->req_stream_id, request_data_stream->req_message_rate, request_data_stream->start_stop);
 148 }
 149
 150 /**
 151  * @brief Send a request_data_stream message
 152  * @param chan MAVLink channel to send the message
 153  *
 154  * @param target_system The target requested to send the message stream.
 155  * @param target_component The target requested to send the message stream.
 156  * @param req_stream_id The ID of the requested data stream
 157  * @param req_message_rate The requested interval between two messages of this type
 158  * @param start_stop 1 to start sending, 0 to stop sending.
 159  */
 160 #ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS
 161
 162 static inline void mavlink_msg_request_data_stream_send(mavlink_channel_t chan, uint8_t target_system, uint8_t target_component, uint8_t req_stream_id, uint16_t req_message_rate, uint8_t start_stop)
 163 {
 164 #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
 165         char buf[MAVLINK_MSG_ID_REQUEST_DATA_STREAM_LEN];
 166         _mav_put_uint16_t(buf, 0, req_message_rate);
 167         _mav_put_uint8_t(buf, 2, target_system);
 168         _mav_put_uint8_t(buf, 3, target_component);
 169         _mav_put_uint8_t(buf, 4, req_stream_id);
 170         _mav_put_uint8_t(buf, 5, start_stop);
 171
 172 #if MAVLINK_CRC_EXTRA
 173     _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_REQUEST_DATA_STREAM, buf, MAVLINK_MSG_ID_REQUEST_DATA_STREAM_LEN, MAVLINK_MSG_ID_REQUEST_DATA_STREAM_CRC);
 174 #else
 175     _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_REQUEST_DATA_STREAM, buf, MAVLINK_MSG_ID_REQUEST_DATA_STREAM_LEN);
 176 #endif
 177 #else
 178         mavlink_request_data_stream_t packet;
 179         packet.req_message_rate = req_message_rate;
 180         packet.target_system = target_system;
 181         packet.target_component = target_component;
 182         packet.req_stream_id = req_stream_id;
 183         packet.start_stop = start_stop;
 184
 185 #if MAVLINK_CRC_EXTRA
 186     _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_REQUEST_DATA_STREAM, (const char *)&packet, MAVLINK_MSG_ID_REQUEST_DATA_STREAM_LEN, MAVLINK_MSG_ID_REQUEST_DATA_STREAM_CRC);
 187 #else
 188     _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_REQUEST_DATA_STREAM, (const char *)&packet, MAVLINK_MSG_ID_REQUEST_DATA_STREAM_LEN);
 189 #endif
 190 #endif
 191 }
 192
 193 #if MAVLINK_MSG_ID_REQUEST_DATA_STREAM_LEN <= MAVLINK_MAX_PAYLOAD_LEN
 194 /*
 195   This varient of _send() can be used to save stack space by re-using
 196   memory from the receive buffer.  The caller provides a
 197   mavlink_message_t which is the size of a full mavlink message. This
 198   is usually the receive buffer for the channel, and allows a reply to an
 199   incoming message with minimum stack space usage.
 200  */
 201 static inline void mavlink_msg_request_data_stream_send_buf(mavlink_message_t *msgbuf, mavlink_channel_t chan,  uint8_t target_system, uint8_t target_component, uint8_t req_stream_id, uint16_t req_message_rate, uint8_t start_stop)
 202 {
 203 #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
 204         char *buf = (char *)msgbuf;
 205         _mav_put_uint16_t(buf, 0, req_message_rate);
 206         _mav_put_uint8_t(buf, 2, target_system);
 207         _mav_put_uint8_t(buf, 3, target_component);
 208         _mav_put_uint8_t(buf, 4, req_stream_id);
 209         _mav_put_uint8_t(buf, 5, start_stop);
 210
 211 #if MAVLINK_CRC_EXTRA
 212     _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_REQUEST_DATA_STREAM, buf, MAVLINK_MSG_ID_REQUEST_DATA_STREAM_LEN, MAVLINK_MSG_ID_REQUEST_DATA_STREAM_CRC);
 213 #else
 214     _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_REQUEST_DATA_STREAM, buf, MAVLINK_MSG_ID_REQUEST_DATA_STREAM_LEN);
 215 #endif
 216 #else
 217         mavlink_request_data_stream_t *packet = (mavlink_request_data_stream_t *)msgbuf;
 218         packet->req_message_rate = req_message_rate;
 219         packet->target_system = target_system;
 220         packet->target_component = target_component;
 221         packet->req_stream_id = req_stream_id;
 222         packet->start_stop = start_stop;
 223
 224 #if MAVLINK_CRC_EXTRA
 225     _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_REQUEST_DATA_STREAM, (const char *)packet, MAVLINK_MSG_ID_REQUEST_DATA_STREAM_LEN, MAVLINK_MSG_ID_REQUEST_DATA_STREAM_CRC);
 226 #else
 227     _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_REQUEST_DATA_STREAM, (const char *)packet, MAVLINK_MSG_ID_REQUEST_DATA_STREAM_LEN);
 228 #endif
 229 #endif
 230 }
 231 #endif
 232
 233 #endif
 234
 235 // MESSAGE REQUEST_DATA_STREAM UNPACKING
 236
 237
 238 /**
 239  * @brief Get field target_system from request_data_stream message
 240  *
 241  * @return The target requested to send the message stream.
 242  */
 243 static inline uint8_t mavlink_msg_request_data_stream_get_target_system(const mavlink_message_t* msg)
 244 {
 245         return _MAV_RETURN_uint8_t(msg,  2);
 246 }
 247
 248 /**
 249  * @brief Get field target_component from request_data_stream message
 250  *
 251  * @return The target requested to send the message stream.
 252  */
 253 static inline uint8_t mavlink_msg_request_data_stream_get_target_component(const mavlink_message_t* msg)
 254 {
 255         return _MAV_RETURN_uint8_t(msg,  3);
 256 }
 257
 258 /**
 259  * @brief Get field req_stream_id from request_data_stream message
 260  *
 261  * @return The ID of the requested data stream
 262  */
 263 static inline uint8_t mavlink_msg_request_data_stream_get_req_stream_id(const mavlink_message_t* msg)
 264 {
 265         return _MAV_RETURN_uint8_t(msg,  4);
 266 }
 267
 268 /**
 269  * @brief Get field req_message_rate from request_data_stream message
 270  *
 271  * @return The requested interval between two messages of this type
 272  */
 273 static inline uint16_t mavlink_msg_request_data_stream_get_req_message_rate(const mavlink_message_t* msg)
 274 {
 275         return _MAV_RETURN_uint16_t(msg,  0);
 276 }
 277
 278 /**
 279  * @brief Get field start_stop from request_data_stream message
 280  *
 281  * @return 1 to start sending, 0 to stop sending.
 282  */
 283 static inline uint8_t mavlink_msg_request_data_stream_get_start_stop(const mavlink_message_t* msg)
 284 {
 285         return _MAV_RETURN_uint8_t(msg,  5);
 286 }
 287
 288 /**
 289  * @brief Decode a request_data_stream message into a struct
 290  *
 291  * @param msg The message to decode
 292  * @param request_data_stream C-struct to decode the message contents into
 293  */
 294 static inline void mavlink_msg_request_data_stream_decode(const mavlink_message_t* msg, mavlink_request_data_stream_t* request_data_stream)
 295 {
 296 #if MAVLINK_NEED_BYTE_SWAP
 297         request_data_stream->req_message_rate = mavlink_msg_request_data_stream_get_req_message_rate(msg);
 298         request_data_stream->target_system = mavlink_msg_request_data_stream_get_target_system(msg);
 299         request_data_stream->target_component = mavlink_msg_request_data_stream_get_target_component(msg);
 300         request_data_stream->req_stream_id = mavlink_msg_request_data_stream_get_req_stream_id(msg);
 301         request_data_stream->start_stop = mavlink_msg_request_data_stream_get_start_stop(msg);
 302 #else
 303         memcpy(request_data_stream, _MAV_PAYLOAD(msg), MAVLINK_MSG_ID_REQUEST_DATA_STREAM_LEN);
 304 #endif
 305 }