mavlink_msg_request_data_stream.h 9.73 KB
Newer Older
James Goppert's avatar
James Goppert committed
1 2 3 4
// MESSAGE REQUEST_DATA_STREAM PACKING

#define MAVLINK_MSG_ID_REQUEST_DATA_STREAM 66

lm's avatar
lm committed
5
typedef struct __mavlink_request_data_stream_t
James Goppert's avatar
James Goppert committed
6
{
lm's avatar
lm committed
7 8 9 10 11
 uint16_t req_message_rate; ///< The requested interval between two messages of this type
 uint8_t target_system; ///< The target requested to send the message stream.
 uint8_t target_component; ///< The target requested to send the message stream.
 uint8_t req_stream_id; ///< The ID of the requested data stream
 uint8_t start_stop; ///< 1 to start sending, 0 to stop sending.
James Goppert's avatar
James Goppert committed
12 13
} mavlink_request_data_stream_t;

lm's avatar
lm committed
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
#define MAVLINK_MSG_ID_REQUEST_DATA_STREAM_LEN 6
#define MAVLINK_MSG_ID_66_LEN 6



#define MAVLINK_MESSAGE_INFO_REQUEST_DATA_STREAM { \
	"REQUEST_DATA_STREAM", \
	5, \
	{  { "req_message_rate", MAVLINK_TYPE_UINT16_T, 0, 0, offsetof(mavlink_request_data_stream_t, req_message_rate) }, \
         { "target_system", MAVLINK_TYPE_UINT8_T, 0, 2, offsetof(mavlink_request_data_stream_t, target_system) }, \
         { "target_component", MAVLINK_TYPE_UINT8_T, 0, 3, offsetof(mavlink_request_data_stream_t, target_component) }, \
         { "req_stream_id", MAVLINK_TYPE_UINT8_T, 0, 4, offsetof(mavlink_request_data_stream_t, req_stream_id) }, \
         { "start_stop", MAVLINK_TYPE_UINT8_T, 0, 5, offsetof(mavlink_request_data_stream_t, start_stop) }, \
         } \
}


James Goppert's avatar
James Goppert committed
31 32 33 34 35 36 37 38
/**
 * @brief Pack a request_data_stream 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 target_system The target requested to send the message stream.
 * @param target_component The target requested to send the message stream.
39
 * @param req_stream_id The ID of the requested data stream
James Goppert's avatar
James Goppert committed
40 41 42 43
 * @param req_message_rate The requested interval between two messages of this type
 * @param start_stop 1 to start sending, 0 to stop sending.
 * @return length of the message in bytes (excluding serial stream start sign)
 */
lm's avatar
lm committed
44 45
static inline uint16_t mavlink_msg_request_data_stream_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg,
						       uint8_t target_system, uint8_t target_component, uint8_t req_stream_id, uint16_t req_message_rate, uint8_t start_stop)
James Goppert's avatar
James Goppert committed
46 47 48
{
	msg->msgid = MAVLINK_MSG_ID_REQUEST_DATA_STREAM;

lm's avatar
lm committed
49 50 51 52 53
	put_uint16_t_by_index(msg, 0, req_message_rate); // The requested interval between two messages of this type
	put_uint8_t_by_index(msg, 2, target_system); // The target requested to send the message stream.
	put_uint8_t_by_index(msg, 3, target_component); // The target requested to send the message stream.
	put_uint8_t_by_index(msg, 4, req_stream_id); // The ID of the requested data stream
	put_uint8_t_by_index(msg, 5, start_stop); // 1 to start sending, 0 to stop sending.
James Goppert's avatar
James Goppert committed
54

lm's avatar
lm committed
55
	return mavlink_finalize_message(msg, system_id, component_id, 6, 148);
James Goppert's avatar
James Goppert committed
56 57 58
}

/**
lm's avatar
lm committed
59
 * @brief Pack a request_data_stream message on a channel
James Goppert's avatar
James Goppert committed
60 61 62 63 64 65
 * @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 target_system The target requested to send the message stream.
 * @param target_component The target requested to send the message stream.
66
 * @param req_stream_id The ID of the requested data stream
James Goppert's avatar
James Goppert committed
67 68 69 70
 * @param req_message_rate The requested interval between two messages of this type
 * @param start_stop 1 to start sending, 0 to stop sending.
 * @return length of the message in bytes (excluding serial stream start sign)
 */
lm's avatar
lm committed
71 72 73
static inline uint16_t mavlink_msg_request_data_stream_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan,
							   mavlink_message_t* msg,
						           uint8_t target_system,uint8_t target_component,uint8_t req_stream_id,uint16_t req_message_rate,uint8_t start_stop)
James Goppert's avatar
James Goppert committed
74 75 76
{
	msg->msgid = MAVLINK_MSG_ID_REQUEST_DATA_STREAM;

lm's avatar
lm committed
77 78 79 80 81
	put_uint16_t_by_index(msg, 0, req_message_rate); // The requested interval between two messages of this type
	put_uint8_t_by_index(msg, 2, target_system); // The target requested to send the message stream.
	put_uint8_t_by_index(msg, 3, target_component); // The target requested to send the message stream.
	put_uint8_t_by_index(msg, 4, req_stream_id); // The ID of the requested data stream
	put_uint8_t_by_index(msg, 5, start_stop); // 1 to start sending, 0 to stop sending.
James Goppert's avatar
James Goppert committed
82

lm's avatar
lm committed
83
	return mavlink_finalize_message_chan(msg, system_id, component_id, chan, 6, 148);
James Goppert's avatar
James Goppert committed
84 85
}

lm's avatar
lm committed
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
#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS

/**
 * @brief Pack a request_data_stream message on a channel and send
 * @param chan The MAVLink channel this message was sent over
 * @param msg The MAVLink message to compress the data into
 * @param target_system The target requested to send the message stream.
 * @param target_component The target requested to send the message stream.
 * @param req_stream_id The ID of the requested data stream
 * @param req_message_rate The requested interval between two messages of this type
 * @param start_stop 1 to start sending, 0 to stop sending.
 */
static inline void mavlink_msg_request_data_stream_pack_chan_send(mavlink_channel_t chan,
							   mavlink_message_t* msg,
						           uint8_t target_system,uint8_t target_component,uint8_t req_stream_id,uint16_t req_message_rate,uint8_t start_stop)
{
	msg->msgid = MAVLINK_MSG_ID_REQUEST_DATA_STREAM;

	put_uint16_t_by_index(msg, 0, req_message_rate); // The requested interval between two messages of this type
	put_uint8_t_by_index(msg, 2, target_system); // The target requested to send the message stream.
	put_uint8_t_by_index(msg, 3, target_component); // The target requested to send the message stream.
	put_uint8_t_by_index(msg, 4, req_stream_id); // The ID of the requested data stream
	put_uint8_t_by_index(msg, 5, start_stop); // 1 to start sending, 0 to stop sending.

	mavlink_finalize_message_chan_send(msg, chan, 6, 148);
}
#endif // MAVLINK_USE_CONVENIENCE_FUNCTIONS


James Goppert's avatar
James Goppert committed
115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133
/**
 * @brief Encode a request_data_stream 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 request_data_stream C-struct to read the message contents from
 */
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)
{
	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);
}

/**
 * @brief Send a request_data_stream message
 * @param chan MAVLink channel to send the message
 *
 * @param target_system The target requested to send the message stream.
 * @param target_component The target requested to send the message stream.
134
 * @param req_stream_id The ID of the requested data stream
James Goppert's avatar
James Goppert committed
135 136 137
 * @param req_message_rate The requested interval between two messages of this type
 * @param start_stop 1 to start sending, 0 to stop sending.
 */
lm's avatar
lm committed
138 139
#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS

lm's avatar
lm committed
140 141
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)
{
lm's avatar
lm committed
142 143
	MAVLINK_ALIGNED_MESSAGE(msg, 6);
	mavlink_msg_request_data_stream_pack_chan_send(chan, msg, target_system, target_component, req_stream_id, req_message_rate, start_stop);
James Goppert's avatar
James Goppert committed
144 145 146
}

#endif
lm's avatar
lm committed
147

James Goppert's avatar
James Goppert committed
148 149
// MESSAGE REQUEST_DATA_STREAM UNPACKING

lm's avatar
lm committed
150

James Goppert's avatar
James Goppert committed
151 152 153 154 155 156 157
/**
 * @brief Get field target_system from request_data_stream message
 *
 * @return The target requested to send the message stream.
 */
static inline uint8_t mavlink_msg_request_data_stream_get_target_system(const mavlink_message_t* msg)
{
lm's avatar
lm committed
158
	return MAVLINK_MSG_RETURN_uint8_t(msg,  2);
James Goppert's avatar
James Goppert committed
159 160 161 162 163 164 165 166 167
}

/**
 * @brief Get field target_component from request_data_stream message
 *
 * @return The target requested to send the message stream.
 */
static inline uint8_t mavlink_msg_request_data_stream_get_target_component(const mavlink_message_t* msg)
{
lm's avatar
lm committed
168
	return MAVLINK_MSG_RETURN_uint8_t(msg,  3);
James Goppert's avatar
James Goppert committed
169 170 171 172 173
}

/**
 * @brief Get field req_stream_id from request_data_stream message
 *
174
 * @return The ID of the requested data stream
James Goppert's avatar
James Goppert committed
175 176 177
 */
static inline uint8_t mavlink_msg_request_data_stream_get_req_stream_id(const mavlink_message_t* msg)
{
lm's avatar
lm committed
178
	return MAVLINK_MSG_RETURN_uint8_t(msg,  4);
James Goppert's avatar
James Goppert committed
179 180 181 182 183 184 185 186 187
}

/**
 * @brief Get field req_message_rate from request_data_stream message
 *
 * @return The requested interval between two messages of this type
 */
static inline uint16_t mavlink_msg_request_data_stream_get_req_message_rate(const mavlink_message_t* msg)
{
lm's avatar
lm committed
188
	return MAVLINK_MSG_RETURN_uint16_t(msg,  0);
James Goppert's avatar
James Goppert committed
189 190 191 192 193 194 195 196 197
}

/**
 * @brief Get field start_stop from request_data_stream message
 *
 * @return 1 to start sending, 0 to stop sending.
 */
static inline uint8_t mavlink_msg_request_data_stream_get_start_stop(const mavlink_message_t* msg)
{
lm's avatar
lm committed
198
	return MAVLINK_MSG_RETURN_uint8_t(msg,  5);
James Goppert's avatar
James Goppert committed
199 200 201 202 203 204 205 206 207 208
}

/**
 * @brief Decode a request_data_stream message into a struct
 *
 * @param msg The message to decode
 * @param request_data_stream C-struct to decode the message contents into
 */
static inline void mavlink_msg_request_data_stream_decode(const mavlink_message_t* msg, mavlink_request_data_stream_t* request_data_stream)
{
lm's avatar
lm committed
209 210 211 212 213 214 215 216 217
#if MAVLINK_NEED_BYTE_SWAP
	request_data_stream->req_message_rate = mavlink_msg_request_data_stream_get_req_message_rate(msg);
	request_data_stream->target_system = mavlink_msg_request_data_stream_get_target_system(msg);
	request_data_stream->target_component = mavlink_msg_request_data_stream_get_target_component(msg);
	request_data_stream->req_stream_id = mavlink_msg_request_data_stream_get_req_stream_id(msg);
	request_data_stream->start_stop = mavlink_msg_request_data_stream_get_start_stop(msg);
#else
	memcpy(request_data_stream, MAVLINK_PAYLOAD(msg), 6);
#endif
James Goppert's avatar
James Goppert committed
218
}