mavlink_msg_ping.h 7.66 KB
Newer Older
James Goppert's avatar
James Goppert committed
1 2
// MESSAGE PING PACKING

3
#define MAVLINK_MSG_ID_PING 4
James Goppert's avatar
James Goppert committed
4

lm's avatar
lm committed
5
typedef struct __mavlink_ping_t
James Goppert's avatar
James Goppert committed
6
{
7
 uint64_t time_usec; ///< Unix timestamp in microseconds
lm's avatar
lm committed
8 9 10
 uint32_t seq; ///< PING sequence
 uint8_t target_system; ///< 0: request ping from all receiving systems, if greater than 0: message is a ping response and number is the system id of the requesting system
 uint8_t target_component; ///< 0: request ping from all receiving components, if greater than 0: message is a ping response and number is the system id of the requesting system
James Goppert's avatar
James Goppert committed
11 12
} mavlink_ping_t;

lm's avatar
lm committed
13 14 15 16 17 18 19 20
#define MAVLINK_MSG_ID_PING_LEN 14
#define MAVLINK_MSG_ID_4_LEN 14



#define MAVLINK_MESSAGE_INFO_PING { \
	"PING", \
	4, \
lm's avatar
lm committed
21 22 23 24
	{  { "time_usec", NULL, MAVLINK_TYPE_UINT64_T, 0, 0, offsetof(mavlink_ping_t, time_usec) }, \
         { "seq", NULL, MAVLINK_TYPE_UINT32_T, 0, 8, offsetof(mavlink_ping_t, seq) }, \
         { "target_system", NULL, MAVLINK_TYPE_UINT8_T, 0, 12, offsetof(mavlink_ping_t, target_system) }, \
         { "target_component", NULL, MAVLINK_TYPE_UINT8_T, 0, 13, offsetof(mavlink_ping_t, target_component) }, \
lm's avatar
lm committed
25 26 27 28
         } \
}


James Goppert's avatar
James Goppert committed
29 30 31 32 33 34
/**
 * @brief Pack a ping 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
 *
35
 * @param time_usec Unix timestamp in microseconds
James Goppert's avatar
James Goppert committed
36 37 38 39 40
 * @param seq PING sequence
 * @param target_system 0: request ping from all receiving systems, if greater than 0: message is a ping response and number is the system id of the requesting system
 * @param target_component 0: request ping from all receiving components, if greater than 0: message is a ping response and number is the system id of the requesting system
 * @return length of the message in bytes (excluding serial stream start sign)
 */
lm's avatar
lm committed
41
static inline uint16_t mavlink_msg_ping_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg,
42
						       uint64_t time_usec, uint32_t seq, uint8_t target_system, uint8_t target_component)
James Goppert's avatar
James Goppert committed
43
{
LM's avatar
LM committed
44 45 46 47 48 49 50
#if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
	char buf[14];
	_mav_put_uint64_t(buf, 0, time_usec);
	_mav_put_uint32_t(buf, 8, seq);
	_mav_put_uint8_t(buf, 12, target_system);
	_mav_put_uint8_t(buf, 13, target_component);

51
        memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, 14);
LM's avatar
LM committed
52 53 54 55 56 57
#else
	mavlink_ping_t packet;
	packet.time_usec = time_usec;
	packet.seq = seq;
	packet.target_system = target_system;
	packet.target_component = target_component;
James Goppert's avatar
James Goppert committed
58

59
        memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, 14);
LM's avatar
LM committed
60
#endif
James Goppert's avatar
James Goppert committed
61

LM's avatar
LM committed
62
	msg->msgid = MAVLINK_MSG_ID_PING;
63
	return mavlink_finalize_message(msg, system_id, component_id, 14, 237);
James Goppert's avatar
James Goppert committed
64 65 66
}

/**
lm's avatar
lm committed
67
 * @brief Pack a ping message on a channel
James Goppert's avatar
James Goppert committed
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
72
 * @param time_usec Unix timestamp in microseconds
James Goppert's avatar
James Goppert committed
73 74 75 76 77
 * @param seq PING sequence
 * @param target_system 0: request ping from all receiving systems, if greater than 0: message is a ping response and number is the system id of the requesting system
 * @param target_component 0: request ping from all receiving components, if greater than 0: message is a ping response and number is the system id of the requesting system
 * @return length of the message in bytes (excluding serial stream start sign)
 */
lm's avatar
lm committed
78 79
static inline uint16_t mavlink_msg_ping_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan,
							   mavlink_message_t* msg,
80
						           uint64_t time_usec,uint32_t seq,uint8_t target_system,uint8_t target_component)
lm's avatar
lm committed
81
{
LM's avatar
LM committed
82 83 84 85 86 87 88
#if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
	char buf[14];
	_mav_put_uint64_t(buf, 0, time_usec);
	_mav_put_uint32_t(buf, 8, seq);
	_mav_put_uint8_t(buf, 12, target_system);
	_mav_put_uint8_t(buf, 13, target_component);

89
        memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, 14);
LM's avatar
LM committed
90 91 92 93 94 95
#else
	mavlink_ping_t packet;
	packet.time_usec = time_usec;
	packet.seq = seq;
	packet.target_system = target_system;
	packet.target_component = target_component;
lm's avatar
lm committed
96

97
        memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, 14);
LM's avatar
LM committed
98
#endif
lm's avatar
lm committed
99

LM's avatar
LM committed
100
	msg->msgid = MAVLINK_MSG_ID_PING;
101
	return mavlink_finalize_message_chan(msg, system_id, component_id, chan, 14, 237);
lm's avatar
lm committed
102 103
}

James Goppert's avatar
James Goppert committed
104 105 106 107 108 109 110 111 112 113
/**
 * @brief Encode a ping 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 ping C-struct to read the message contents from
 */
static inline uint16_t mavlink_msg_ping_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_ping_t* ping)
{
114
	return mavlink_msg_ping_pack(system_id, component_id, msg, ping->time_usec, ping->seq, ping->target_system, ping->target_component);
James Goppert's avatar
James Goppert committed
115 116 117 118 119 120
}

/**
 * @brief Send a ping message
 * @param chan MAVLink channel to send the message
 *
121
 * @param time_usec Unix timestamp in microseconds
James Goppert's avatar
James Goppert committed
122 123 124 125
 * @param seq PING sequence
 * @param target_system 0: request ping from all receiving systems, if greater than 0: message is a ping response and number is the system id of the requesting system
 * @param target_component 0: request ping from all receiving components, if greater than 0: message is a ping response and number is the system id of the requesting system
 */
lm's avatar
lm committed
126 127
#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS

128
static inline void mavlink_msg_ping_send(mavlink_channel_t chan, uint64_t time_usec, uint32_t seq, uint8_t target_system, uint8_t target_component)
lm's avatar
lm committed
129
{
LM's avatar
LM committed
130 131 132 133 134 135 136 137 138 139 140 141 142 143
#if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
	char buf[14];
	_mav_put_uint64_t(buf, 0, time_usec);
	_mav_put_uint32_t(buf, 8, seq);
	_mav_put_uint8_t(buf, 12, target_system);
	_mav_put_uint8_t(buf, 13, target_component);

	_mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_PING, buf, 14, 237);
#else
	mavlink_ping_t packet;
	packet.time_usec = time_usec;
	packet.seq = seq;
	packet.target_system = target_system;
	packet.target_component = target_component;
LM's avatar
LM committed
144

LM's avatar
LM committed
145 146
	_mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_PING, (const char *)&packet, 14, 237);
#endif
James Goppert's avatar
James Goppert committed
147 148 149
}

#endif
lm's avatar
lm committed
150

James Goppert's avatar
James Goppert committed
151 152
// MESSAGE PING UNPACKING

lm's avatar
lm committed
153

154 155 156 157 158 159 160
/**
 * @brief Get field time_usec from ping message
 *
 * @return Unix timestamp in microseconds
 */
static inline uint64_t mavlink_msg_ping_get_time_usec(const mavlink_message_t* msg)
{
LM's avatar
LM committed
161
	return _MAV_RETURN_uint64_t(msg,  0);
162 163
}

James Goppert's avatar
James Goppert committed
164 165 166 167 168 169 170
/**
 * @brief Get field seq from ping message
 *
 * @return PING sequence
 */
static inline uint32_t mavlink_msg_ping_get_seq(const mavlink_message_t* msg)
{
LM's avatar
LM committed
171
	return _MAV_RETURN_uint32_t(msg,  8);
James Goppert's avatar
James Goppert committed
172 173 174 175 176 177 178 179 180
}

/**
 * @brief Get field target_system from ping message
 *
 * @return 0: request ping from all receiving systems, if greater than 0: message is a ping response and number is the system id of the requesting system
 */
static inline uint8_t mavlink_msg_ping_get_target_system(const mavlink_message_t* msg)
{
LM's avatar
LM committed
181
	return _MAV_RETURN_uint8_t(msg,  12);
James Goppert's avatar
James Goppert committed
182 183 184 185 186 187 188 189 190
}

/**
 * @brief Get field target_component from ping message
 *
 * @return 0: request ping from all receiving components, if greater than 0: message is a ping response and number is the system id of the requesting system
 */
static inline uint8_t mavlink_msg_ping_get_target_component(const mavlink_message_t* msg)
{
LM's avatar
LM committed
191
	return _MAV_RETURN_uint8_t(msg,  13);
James Goppert's avatar
James Goppert committed
192 193 194 195 196 197 198 199 200 201
}

/**
 * @brief Decode a ping message into a struct
 *
 * @param msg The message to decode
 * @param ping C-struct to decode the message contents into
 */
static inline void mavlink_msg_ping_decode(const mavlink_message_t* msg, mavlink_ping_t* ping)
{
lm's avatar
lm committed
202
#if MAVLINK_NEED_BYTE_SWAP
203
	ping->time_usec = mavlink_msg_ping_get_time_usec(msg);
lm's avatar
lm committed
204 205 206 207
	ping->seq = mavlink_msg_ping_get_seq(msg);
	ping->target_system = mavlink_msg_ping_get_target_system(msg);
	ping->target_component = mavlink_msg_ping_get_target_component(msg);
#else
LM's avatar
LM committed
208
	memcpy(ping, _MAV_PAYLOAD(msg), 14);
lm's avatar
lm committed
209
#endif
James Goppert's avatar
James Goppert committed
210
}