mavlink_msg_data_stream.h 6.14 KB
Newer Older
1 2 3 4
// MESSAGE DATA_STREAM PACKING

#define MAVLINK_MSG_ID_DATA_STREAM 67

lm's avatar
lm committed
5
typedef struct __mavlink_data_stream_t
6
{
lm's avatar
lm committed
7 8 9
 uint16_t message_rate; ///< The requested interval between two messages of this type
 uint8_t stream_id; ///< The ID of the requested data stream
 uint8_t on_off; ///< 1 stream is enabled, 0 stream is stopped.
10 11
} mavlink_data_stream_t;

lm's avatar
lm committed
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
#define MAVLINK_MSG_ID_DATA_STREAM_LEN 4
#define MAVLINK_MSG_ID_67_LEN 4



#define MAVLINK_MESSAGE_INFO_DATA_STREAM { \
	"DATA_STREAM", \
	3, \
	{  { "message_rate", MAVLINK_TYPE_UINT16_T, 0, 0, offsetof(mavlink_data_stream_t, message_rate) }, \
         { "stream_id", MAVLINK_TYPE_UINT8_T, 0, 2, offsetof(mavlink_data_stream_t, stream_id) }, \
         { "on_off", MAVLINK_TYPE_UINT8_T, 0, 3, offsetof(mavlink_data_stream_t, on_off) }, \
         } \
}


27 28 29 30 31 32 33 34 35 36 37
/**
 * @brief Pack a 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 stream_id The ID of the requested data stream
 * @param message_rate The requested interval between two messages of this type
 * @param on_off 1 stream is enabled, 0 stream is stopped.
 * @return length of the message in bytes (excluding serial stream start sign)
 */
lm's avatar
lm committed
38 39
static inline uint16_t mavlink_msg_data_stream_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg,
						       uint8_t stream_id, uint16_t message_rate, uint8_t on_off)
40
{
LM's avatar
LM committed
41 42 43 44 45 46 47 48 49 50 51 52
#if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
	char buf[4];
	_mav_put_uint16_t(buf, 0, message_rate);
	_mav_put_uint8_t(buf, 2, stream_id);
	_mav_put_uint8_t(buf, 3, on_off);

        memcpy(_MAV_PAYLOAD(msg), buf, 4);
#else
	mavlink_data_stream_t packet;
	packet.message_rate = message_rate;
	packet.stream_id = stream_id;
	packet.on_off = on_off;
53

LM's avatar
LM committed
54 55
        memcpy(_MAV_PAYLOAD(msg), &packet, 4);
#endif
56

LM's avatar
LM committed
57
	msg->msgid = MAVLINK_MSG_ID_DATA_STREAM;
lm's avatar
lm committed
58
	return mavlink_finalize_message(msg, system_id, component_id, 4, 21);
59 60 61
}

/**
lm's avatar
lm committed
62
 * @brief Pack a data_stream message on a channel
63 64 65 66 67 68 69 70 71
 * @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 stream_id The ID of the requested data stream
 * @param message_rate The requested interval between two messages of this type
 * @param on_off 1 stream is enabled, 0 stream is stopped.
 * @return length of the message in bytes (excluding serial stream start sign)
 */
lm's avatar
lm committed
72 73 74
static inline uint16_t mavlink_msg_data_stream_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan,
							   mavlink_message_t* msg,
						           uint8_t stream_id,uint16_t message_rate,uint8_t on_off)
75
{
LM's avatar
LM committed
76 77 78 79 80
#if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
	char buf[4];
	_mav_put_uint16_t(buf, 0, message_rate);
	_mav_put_uint8_t(buf, 2, stream_id);
	_mav_put_uint8_t(buf, 3, on_off);
81

LM's avatar
LM committed
82 83 84 85 86 87
        memcpy(_MAV_PAYLOAD(msg), buf, 4);
#else
	mavlink_data_stream_t packet;
	packet.message_rate = message_rate;
	packet.stream_id = stream_id;
	packet.on_off = on_off;
88

LM's avatar
LM committed
89 90 91 92
        memcpy(_MAV_PAYLOAD(msg), &packet, 4);
#endif

	msg->msgid = MAVLINK_MSG_ID_DATA_STREAM;
lm's avatar
lm committed
93
	return mavlink_finalize_message_chan(msg, system_id, component_id, chan, 4, 21);
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116
}

/**
 * @brief Encode a 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 data_stream C-struct to read the message contents from
 */
static inline uint16_t mavlink_msg_data_stream_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_data_stream_t* data_stream)
{
	return mavlink_msg_data_stream_pack(system_id, component_id, msg, data_stream->stream_id, data_stream->message_rate, data_stream->on_off);
}

/**
 * @brief Send a data_stream message
 * @param chan MAVLink channel to send the message
 *
 * @param stream_id The ID of the requested data stream
 * @param message_rate The requested interval between two messages of this type
 * @param on_off 1 stream is enabled, 0 stream is stopped.
 */
lm's avatar
lm committed
117 118
#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS

119 120
static inline void mavlink_msg_data_stream_send(mavlink_channel_t chan, uint8_t stream_id, uint16_t message_rate, uint8_t on_off)
{
LM's avatar
LM committed
121 122 123 124 125
#if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
	char buf[4];
	_mav_put_uint16_t(buf, 0, message_rate);
	_mav_put_uint8_t(buf, 2, stream_id);
	_mav_put_uint8_t(buf, 3, on_off);
LM's avatar
LM committed
126

LM's avatar
LM committed
127 128 129 130 131 132
	_mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_DATA_STREAM, buf, 4, 21);
#else
	mavlink_data_stream_t packet;
	packet.message_rate = message_rate;
	packet.stream_id = stream_id;
	packet.on_off = on_off;
LM's avatar
LM committed
133

LM's avatar
LM committed
134 135
	_mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_DATA_STREAM, (const char *)&packet, 4, 21);
#endif
136 137 138
}

#endif
lm's avatar
lm committed
139

140 141
// MESSAGE DATA_STREAM UNPACKING

lm's avatar
lm committed
142

143 144 145 146 147 148 149
/**
 * @brief Get field stream_id from data_stream message
 *
 * @return The ID of the requested data stream
 */
static inline uint8_t mavlink_msg_data_stream_get_stream_id(const mavlink_message_t* msg)
{
LM's avatar
LM committed
150
	return _MAV_RETURN_uint8_t(msg,  2);
151 152 153 154 155 156 157 158 159
}

/**
 * @brief Get field message_rate from data_stream message
 *
 * @return The requested interval between two messages of this type
 */
static inline uint16_t mavlink_msg_data_stream_get_message_rate(const mavlink_message_t* msg)
{
LM's avatar
LM committed
160
	return _MAV_RETURN_uint16_t(msg,  0);
161 162 163 164 165 166 167 168 169
}

/**
 * @brief Get field on_off from data_stream message
 *
 * @return 1 stream is enabled, 0 stream is stopped.
 */
static inline uint8_t mavlink_msg_data_stream_get_on_off(const mavlink_message_t* msg)
{
LM's avatar
LM committed
170
	return _MAV_RETURN_uint8_t(msg,  3);
171 172 173 174 175 176 177 178 179 180
}

/**
 * @brief Decode a data_stream message into a struct
 *
 * @param msg The message to decode
 * @param data_stream C-struct to decode the message contents into
 */
static inline void mavlink_msg_data_stream_decode(const mavlink_message_t* msg, mavlink_data_stream_t* data_stream)
{
lm's avatar
lm committed
181 182 183 184 185
#if MAVLINK_NEED_BYTE_SWAP
	data_stream->message_rate = mavlink_msg_data_stream_get_message_rate(msg);
	data_stream->stream_id = mavlink_msg_data_stream_get_stream_id(msg);
	data_stream->on_off = mavlink_msg_data_stream_get_on_off(msg);
#else
LM's avatar
LM committed
186
	memcpy(data_stream, _MAV_PAYLOAD(msg), 4);
lm's avatar
lm committed
187
#endif
188
}