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

pixhawk's avatar
pixhawk committed
3
#define MAVLINK_MSG_ID_PING 3
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
{
lm's avatar
lm committed
7 8 9
 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
pixhawk's avatar
pixhawk committed
10
 uint64_t time; ///< Unix timestamp in microseconds
James Goppert's avatar
James Goppert committed
11 12
} mavlink_ping_t;

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



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


James Goppert's avatar
James Goppert committed
29 30 31 32 33 34 35 36 37
/**
 * @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
 *
 * @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
pixhawk's avatar
pixhawk committed
38
 * @param time Unix timestamp in microseconds
James Goppert's avatar
James Goppert committed
39 40
 * @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,
pixhawk's avatar
pixhawk committed
42
						       uint32_t seq, uint8_t target_system, uint8_t target_component, uint64_t time)
James Goppert's avatar
James Goppert committed
43
{
LM's avatar
LM committed
44 45
#if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
	char buf[14];
pixhawk's avatar
pixhawk committed
46 47 48 49
	_mav_put_uint32_t(buf, 0, seq);
	_mav_put_uint8_t(buf, 4, target_system);
	_mav_put_uint8_t(buf, 5, target_component);
	_mav_put_uint64_t(buf, 6, time);
LM's avatar
LM committed
50

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

pixhawk's avatar
pixhawk committed
59
        memcpy(_MAV_PAYLOAD(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;
pixhawk's avatar
pixhawk committed
63
	return mavlink_finalize_message(msg, system_id, component_id, 14);
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 72 73 74
 * @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 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
pixhawk's avatar
pixhawk committed
75
 * @param time Unix timestamp in microseconds
James Goppert's avatar
James Goppert committed
76 77
 * @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,
pixhawk's avatar
pixhawk committed
80
						           uint32_t seq,uint8_t target_system,uint8_t target_component,uint64_t time)
lm's avatar
lm committed
81
{
LM's avatar
LM committed
82 83
#if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
	char buf[14];
pixhawk's avatar
pixhawk committed
84 85 86 87
	_mav_put_uint32_t(buf, 0, seq);
	_mav_put_uint8_t(buf, 4, target_system);
	_mav_put_uint8_t(buf, 5, target_component);
	_mav_put_uint64_t(buf, 6, time);
LM's avatar
LM committed
88

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

pixhawk's avatar
pixhawk committed
97
        memcpy(_MAV_PAYLOAD(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;
pixhawk's avatar
pixhawk committed
101
	return mavlink_finalize_message_chan(msg, system_id, component_id, chan, 14);
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)
{
pixhawk's avatar
pixhawk committed
114
	return mavlink_msg_ping_pack(system_id, component_id, msg, ping->seq, ping->target_system, ping->target_component, ping->time);
James Goppert's avatar
James Goppert committed
115 116 117 118 119 120 121 122 123
}

/**
 * @brief Send a ping message
 * @param chan MAVLink channel to send the message
 *
 * @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
pixhawk's avatar
pixhawk committed
124
 * @param time Unix timestamp in microseconds
James Goppert's avatar
James Goppert committed
125
 */
lm's avatar
lm committed
126 127
#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS

pixhawk's avatar
pixhawk committed
128
static inline void mavlink_msg_ping_send(mavlink_channel_t chan, uint32_t seq, uint8_t target_system, uint8_t target_component, uint64_t time)
lm's avatar
lm committed
129
{
LM's avatar
LM committed
130 131
#if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
	char buf[14];
pixhawk's avatar
pixhawk committed
132 133 134 135
	_mav_put_uint32_t(buf, 0, seq);
	_mav_put_uint8_t(buf, 4, target_system);
	_mav_put_uint8_t(buf, 5, target_component);
	_mav_put_uint64_t(buf, 6, time);
LM's avatar
LM committed
136

pixhawk's avatar
pixhawk committed
137
	_mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_PING, buf, 14);
LM's avatar
LM committed
138 139 140 141 142
#else
	mavlink_ping_t packet;
	packet.seq = seq;
	packet.target_system = target_system;
	packet.target_component = target_component;
pixhawk's avatar
pixhawk committed
143
	packet.time = time;
LM's avatar
LM committed
144

pixhawk's avatar
pixhawk committed
145
	_mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_PING, (const char *)&packet, 14);
LM's avatar
LM committed
146
#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

James Goppert's avatar
James Goppert committed
154 155 156 157 158 159 160
/**
 * @brief Get field seq from ping message
 *
 * @return PING sequence
 */
static inline uint32_t mavlink_msg_ping_get_seq(const mavlink_message_t* msg)
{
pixhawk's avatar
pixhawk committed
161
	return _MAV_RETURN_uint32_t(msg,  0);
James Goppert's avatar
James Goppert committed
162 163 164 165 166 167 168 169 170
}

/**
 * @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)
{
pixhawk's avatar
pixhawk committed
171
	return _MAV_RETURN_uint8_t(msg,  4);
James Goppert's avatar
James Goppert committed
172 173 174 175 176 177 178 179 180
}

/**
 * @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)
{
pixhawk's avatar
pixhawk committed
181 182 183 184 185 186 187 188 189 190 191
	return _MAV_RETURN_uint8_t(msg,  5);
}

/**
 * @brief Get field time from ping message
 *
 * @return Unix timestamp in microseconds
 */
static inline uint64_t mavlink_msg_ping_get_time(const mavlink_message_t* msg)
{
	return _MAV_RETURN_uint64_t(msg,  6);
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 203 204 205
#if MAVLINK_NEED_BYTE_SWAP
	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);
pixhawk's avatar
pixhawk committed
206
	ping->time = mavlink_msg_ping_get_time(msg);
lm's avatar
lm committed
207
#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
}