mavlink_msg_ping.h 7.77 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, \
21
	{  { "time_usec", MAVLINK_TYPE_UINT64_T, 0, 0, offsetof(mavlink_ping_t, time_usec) }, \
lm's avatar
lm committed
22 23 24 25 26 27 28
         { "seq", MAVLINK_TYPE_UINT32_T, 0, 8, offsetof(mavlink_ping_t, seq) }, \
         { "target_system", MAVLINK_TYPE_UINT8_T, 0, 12, offsetof(mavlink_ping_t, target_system) }, \
         { "target_component", MAVLINK_TYPE_UINT8_T, 0, 13, offsetof(mavlink_ping_t, target_component) }, \
         } \
}


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 44 45
{
	msg->msgid = MAVLINK_MSG_ID_PING;

46
	put_uint64_t_by_index(msg, 0, time_usec); // Unix timestamp in microseconds
lm's avatar
lm committed
47 48 49
	put_uint32_t_by_index(msg, 8, seq); // PING sequence
	put_uint8_t_by_index(msg, 12, 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
	put_uint8_t_by_index(msg, 13, 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
50

51
	return mavlink_finalize_message(msg, system_id, component_id, 14, 237);
James Goppert's avatar
James Goppert committed
52 53 54
}

/**
lm's avatar
lm committed
55
 * @brief Pack a ping message on a channel
James Goppert's avatar
James Goppert committed
56 57 58 59
 * @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
60
 * @param time_usec Unix timestamp in microseconds
James Goppert's avatar
James Goppert committed
61 62 63 64 65
 * @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
66 67
static inline uint16_t mavlink_msg_ping_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan,
							   mavlink_message_t* msg,
68
						           uint64_t time_usec,uint32_t seq,uint8_t target_system,uint8_t target_component)
lm's avatar
lm committed
69 70 71
{
	msg->msgid = MAVLINK_MSG_ID_PING;

72
	put_uint64_t_by_index(msg, 0, time_usec); // Unix timestamp in microseconds
lm's avatar
lm committed
73 74 75 76
	put_uint32_t_by_index(msg, 8, seq); // PING sequence
	put_uint8_t_by_index(msg, 12, 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
	put_uint8_t_by_index(msg, 13, 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

77
	return mavlink_finalize_message_chan(msg, system_id, component_id, chan, 14, 237);
lm's avatar
lm committed
78 79
}

James Goppert's avatar
James Goppert committed
80 81 82 83 84 85 86 87 88 89
/**
 * @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)
{
90
	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
91 92 93 94 95 96
}

/**
 * @brief Send a ping message
 * @param chan MAVLink channel to send the message
 *
97
 * @param time_usec Unix timestamp in microseconds
James Goppert's avatar
James Goppert committed
98 99 100 101
 * @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
102 103
#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS

104
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
105
{
lm's avatar
lm committed
106
	MAVLINK_ALIGNED_MESSAGE(msg, 14);
LM's avatar
LM committed
107 108
	msg->msgid = MAVLINK_MSG_ID_PING;

109
	put_uint64_t_by_index(msg, 0, time_usec); // Unix timestamp in microseconds
LM's avatar
LM committed
110 111 112 113
	put_uint32_t_by_index(msg, 8, seq); // PING sequence
	put_uint8_t_by_index(msg, 12, 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
	put_uint8_t_by_index(msg, 13, 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

114
	mavlink_finalize_message_chan_send(msg, chan, 14, 237);
James Goppert's avatar
James Goppert committed
115 116 117
}

#endif
lm's avatar
lm committed
118

James Goppert's avatar
James Goppert committed
119 120
// MESSAGE PING UNPACKING

lm's avatar
lm committed
121

122 123 124 125 126 127 128 129 130 131
/**
 * @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)
{
	return MAVLINK_MSG_RETURN_uint64_t(msg,  0);
}

James Goppert's avatar
James Goppert committed
132 133 134 135 136 137 138
/**
 * @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
139
	return MAVLINK_MSG_RETURN_uint32_t(msg,  8);
James Goppert's avatar
James Goppert committed
140 141 142 143 144 145 146 147 148
}

/**
 * @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
149
	return MAVLINK_MSG_RETURN_uint8_t(msg,  12);
James Goppert's avatar
James Goppert committed
150 151 152 153 154 155 156 157 158
}

/**
 * @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
159
	return MAVLINK_MSG_RETURN_uint8_t(msg,  13);
James Goppert's avatar
James Goppert committed
160 161 162 163 164 165 166 167 168 169
}

/**
 * @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
170
#if MAVLINK_NEED_BYTE_SWAP
171
	ping->time_usec = mavlink_msg_ping_get_time_usec(msg);
lm's avatar
lm committed
172 173 174 175 176 177
	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
	memcpy(ping, MAVLINK_PAYLOAD(msg), 14);
#endif
James Goppert's avatar
James Goppert committed
178
}