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

#define MAVLINK_MSG_ID_REQUEST_DATA_STREAM 66
lm's avatar
lm committed
4 5
#define MAVLINK_MSG_ID_REQUEST_DATA_STREAM_LEN 6
#define MAVLINK_MSG_66_LEN 6
lm's avatar
lm committed
6 7
#define MAVLINK_MSG_ID_REQUEST_DATA_STREAM_KEY 0x2A
#define MAVLINK_MSG_66_KEY 0x2A
James Goppert's avatar
James Goppert committed
8 9 10

typedef struct __mavlink_request_data_stream_t 
{
lm's avatar
lm committed
11 12 13
	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.
14
	uint8_t req_stream_id;	///< The ID of the requested data stream
lm's avatar
lm committed
15
	uint8_t start_stop;	///< 1 to start sending, 0 to stop sending.
James Goppert's avatar
James Goppert committed
16 17 18 19 20 21 22 23 24 25 26

} mavlink_request_data_stream_t;

/**
 * @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.
27
 * @param req_stream_id The ID of the requested data stream
James Goppert's avatar
James Goppert committed
28 29 30 31 32 33
 * @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)
 */
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)
{
lm's avatar
lm committed
34
	mavlink_request_data_stream_t *p = (mavlink_request_data_stream_t *)&msg->payload[0];
James Goppert's avatar
James Goppert committed
35 36
	msg->msgid = MAVLINK_MSG_ID_REQUEST_DATA_STREAM;

lm's avatar
lm committed
37 38
	p->target_system = target_system;	// uint8_t:The target requested to send the message stream.
	p->target_component = target_component;	// uint8_t:The target requested to send the message stream.
39
	p->req_stream_id = req_stream_id;	// uint8_t:The ID of the requested data stream
lm's avatar
lm committed
40 41
	p->req_message_rate = req_message_rate;	// uint16_t:The requested interval between two messages of this type
	p->start_stop = start_stop;	// uint8_t:1 to start sending, 0 to stop sending.
James Goppert's avatar
James Goppert committed
42

lm's avatar
lm committed
43
	return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_REQUEST_DATA_STREAM_LEN);
James Goppert's avatar
James Goppert committed
44 45 46 47 48 49 50 51 52 53
}

/**
 * @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 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.
54
 * @param req_stream_id The ID of the requested data stream
James Goppert's avatar
James Goppert committed
55 56 57 58 59 60
 * @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)
 */
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)
{
lm's avatar
lm committed
61
	mavlink_request_data_stream_t *p = (mavlink_request_data_stream_t *)&msg->payload[0];
James Goppert's avatar
James Goppert committed
62 63
	msg->msgid = MAVLINK_MSG_ID_REQUEST_DATA_STREAM;

lm's avatar
lm committed
64 65
	p->target_system = target_system;	// uint8_t:The target requested to send the message stream.
	p->target_component = target_component;	// uint8_t:The target requested to send the message stream.
66
	p->req_stream_id = req_stream_id;	// uint8_t:The ID of the requested data stream
lm's avatar
lm committed
67 68
	p->req_message_rate = req_message_rate;	// uint16_t:The requested interval between two messages of this type
	p->start_stop = start_stop;	// uint8_t:1 to start sending, 0 to stop sending.
James Goppert's avatar
James Goppert committed
69

lm's avatar
lm committed
70
	return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_REQUEST_DATA_STREAM_LEN);
James Goppert's avatar
James Goppert committed
71 72 73 74 75 76 77 78 79 80 81 82 83 84 85
}

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

lm's avatar
lm committed
86 87

#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS
James Goppert's avatar
James Goppert committed
88 89 90 91 92 93
/**
 * @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.
94
 * @param req_stream_id The ID of the requested data stream
James Goppert's avatar
James Goppert committed
95 96 97
 * @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
98 99 100 101 102
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)
{
	mavlink_header_t hdr;
	mavlink_request_data_stream_t payload;

lm's avatar
lm committed
103 104 105
	MAVLINK_BUFFER_CHECK_START( chan, MAVLINK_MSG_ID_REQUEST_DATA_STREAM_LEN )
	payload.target_system = target_system;	// uint8_t:The target requested to send the message stream.
	payload.target_component = target_component;	// uint8_t:The target requested to send the message stream.
106
	payload.req_stream_id = req_stream_id;	// uint8_t:The ID of the requested data stream
lm's avatar
lm committed
107 108
	payload.req_message_rate = req_message_rate;	// uint16_t:The requested interval between two messages of this type
	payload.start_stop = start_stop;	// uint8_t:1 to start sending, 0 to stop sending.
lm's avatar
lm committed
109 110 111 112 113 114 115 116 117

	hdr.STX = MAVLINK_STX;
	hdr.len = MAVLINK_MSG_ID_REQUEST_DATA_STREAM_LEN;
	hdr.msgid = MAVLINK_MSG_ID_REQUEST_DATA_STREAM;
	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 );
118
	mavlink_send_mem(chan, (uint8_t *)&payload, sizeof(payload) );
lm's avatar
lm committed
119

lm's avatar
lm committed
120 121 122 123 124 125
	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( 0x2A, &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
126 127 128 129 130 131 132 133 134 135 136 137
}

#endif
// MESSAGE REQUEST_DATA_STREAM UNPACKING

/**
 * @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
138 139
	mavlink_request_data_stream_t *p = (mavlink_request_data_stream_t *)&msg->payload[0];
	return (uint8_t)(p->target_system);
James Goppert's avatar
James Goppert committed
140 141 142 143 144 145 146 147 148
}

/**
 * @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
149 150
	mavlink_request_data_stream_t *p = (mavlink_request_data_stream_t *)&msg->payload[0];
	return (uint8_t)(p->target_component);
James Goppert's avatar
James Goppert committed
151 152 153 154 155
}

/**
 * @brief Get field req_stream_id from request_data_stream message
 *
156
 * @return The ID of the requested data stream
James Goppert's avatar
James Goppert committed
157 158 159
 */
static inline uint8_t mavlink_msg_request_data_stream_get_req_stream_id(const mavlink_message_t* msg)
{
lm's avatar
lm committed
160 161
	mavlink_request_data_stream_t *p = (mavlink_request_data_stream_t *)&msg->payload[0];
	return (uint8_t)(p->req_stream_id);
James Goppert's avatar
James Goppert committed
162 163 164 165 166 167 168 169 170
}

/**
 * @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
171 172
	mavlink_request_data_stream_t *p = (mavlink_request_data_stream_t *)&msg->payload[0];
	return (uint16_t)(p->req_message_rate);
James Goppert's avatar
James Goppert committed
173 174 175 176 177 178 179 180 181
}

/**
 * @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
182 183
	mavlink_request_data_stream_t *p = (mavlink_request_data_stream_t *)&msg->payload[0];
	return (uint8_t)(p->start_stop);
James Goppert's avatar
James Goppert committed
184 185 186 187 188 189 190 191 192 193
}

/**
 * @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
194
	memcpy( request_data_stream, msg->payload, sizeof(mavlink_request_data_stream_t));
James Goppert's avatar
James Goppert committed
195
}