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

#define MAVLINK_MSG_ID_PING 3
lm's avatar
lm committed
4 5
#define MAVLINK_MSG_ID_PING_LEN 14
#define MAVLINK_MSG_3_LEN 14
James Goppert's avatar
James Goppert committed
6 7 8

typedef struct __mavlink_ping_t 
{
9
	uint64_t time; ///< Unix timestamp in microseconds
James Goppert's avatar
James Goppert committed
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
	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

} mavlink_ping_t;

/**
 * @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
 * @param time Unix timestamp in microseconds
 * @return length of the message in bytes (excluding serial stream start sign)
 */
static inline uint16_t mavlink_msg_ping_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, uint32_t seq, uint8_t target_system, uint8_t target_component, uint64_t time)
{
lm's avatar
lm committed
30
	mavlink_ping_t *p = (mavlink_ping_t *)&msg->payload[0];
James Goppert's avatar
James Goppert committed
31 32
	msg->msgid = MAVLINK_MSG_ID_PING;

lm's avatar
lm committed
33 34 35 36
	p->seq = seq; // uint32_t:PING sequence
	p->target_system = target_system; // uint8_t: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
	p->target_component = target_component; // uint8_t: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
	p->time = time; // uint64_t:Unix timestamp in microseconds
James Goppert's avatar
James Goppert committed
37

lm's avatar
lm committed
38
	return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_PING_LEN);
James Goppert's avatar
James Goppert committed
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54
}

/**
 * @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 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
 * @param time Unix timestamp in microseconds
 * @return length of the message in bytes (excluding serial stream start sign)
 */
static inline uint16_t mavlink_msg_ping_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan, mavlink_message_t* msg, uint32_t seq, uint8_t target_system, uint8_t target_component, uint64_t time)
{
lm's avatar
lm committed
55
	mavlink_ping_t *p = (mavlink_ping_t *)&msg->payload[0];
James Goppert's avatar
James Goppert committed
56 57
	msg->msgid = MAVLINK_MSG_ID_PING;

lm's avatar
lm committed
58 59 60 61
	p->seq = seq; // uint32_t:PING sequence
	p->target_system = target_system; // uint8_t: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
	p->target_component = target_component; // uint8_t: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
	p->time = time; // uint64_t:Unix timestamp in microseconds
James Goppert's avatar
James Goppert committed
62

lm's avatar
lm committed
63
	return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_PING_LEN);
James Goppert's avatar
James Goppert committed
64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87
}

/**
 * @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)
{
	return mavlink_msg_ping_pack(system_id, component_id, msg, ping->seq, ping->target_system, ping->target_component, ping->time);
}

/**
 * @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
 * @param time Unix timestamp in microseconds
 */
lm's avatar
lm committed
88 89


90
#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS
lm's avatar
lm committed
91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119
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)
{
	mavlink_header_t hdr;
	mavlink_ping_t payload;
	uint16_t checksum;
	mavlink_ping_t *p = &payload;

	p->seq = seq; // uint32_t:PING sequence
	p->target_system = target_system; // uint8_t: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
	p->target_component = target_component; // uint8_t: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
	p->time = time; // uint64_t:Unix timestamp in microseconds

	hdr.STX = MAVLINK_STX;
	hdr.len = MAVLINK_MSG_ID_PING_LEN;
	hdr.msgid = MAVLINK_MSG_ID_PING;
	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 );

	crc_init(&checksum);
	checksum = crc_calculate_mem((uint8_t *)&hdr.len, &checksum, MAVLINK_CORE_HEADER_LEN);
	checksum = crc_calculate_mem((uint8_t *)&payload, &checksum, hdr.len );
	hdr.ck_a = (uint8_t)(checksum & 0xFF); ///< Low byte
	hdr.ck_b = (uint8_t)(checksum >> 8); ///< High byte

	mavlink_send_mem(chan, (uint8_t *)&payload, hdr.len);
	mavlink_send_mem(chan, (uint8_t *)&hdr.ck_a, MAVLINK_NUM_CHECKSUM_BYTES);
James Goppert's avatar
James Goppert committed
120 121 122 123 124 125 126 127 128 129 130 131
}

#endif
// MESSAGE PING UNPACKING

/**
 * @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
132 133
	mavlink_ping_t *p = (mavlink_ping_t *)&msg->payload[0];
	return (uint32_t)(p->seq);
James Goppert's avatar
James Goppert committed
134 135 136 137 138 139 140 141 142
}

/**
 * @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
143 144
	mavlink_ping_t *p = (mavlink_ping_t *)&msg->payload[0];
	return (uint8_t)(p->target_system);
James Goppert's avatar
James Goppert committed
145 146 147 148 149 150 151 152 153
}

/**
 * @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
154 155
	mavlink_ping_t *p = (mavlink_ping_t *)&msg->payload[0];
	return (uint8_t)(p->target_component);
James Goppert's avatar
James Goppert committed
156 157 158 159 160 161 162 163 164
}

/**
 * @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)
{
lm's avatar
lm committed
165 166
	mavlink_ping_t *p = (mavlink_ping_t *)&msg->payload[0];
	return (uint64_t)(p->time);
James Goppert's avatar
James Goppert committed
167 168 169 170 171 172 173 174 175 176
}

/**
 * @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
177
	memcpy( ping, msg->payload, sizeof(mavlink_ping_t));
James Goppert's avatar
James Goppert committed
178
}