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
lm's avatar
lm committed
6 7
#define MAVLINK_MSG_ID_PING_KEY 0xE2
#define MAVLINK_MSG_3_KEY 0xE2
James Goppert's avatar
James Goppert committed
8 9 10

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

} 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
32
	mavlink_ping_t *p = (mavlink_ping_t *)&msg->payload[0];
James Goppert's avatar
James Goppert committed
33 34
	msg->msgid = MAVLINK_MSG_ID_PING;

lm's avatar
lm committed
35 36 37 38
	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
39

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

/**
 * @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
57
	mavlink_ping_t *p = (mavlink_ping_t *)&msg->payload[0];
James Goppert's avatar
James Goppert committed
58 59
	msg->msgid = MAVLINK_MSG_ID_PING;

lm's avatar
lm committed
60 61 62 63
	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
64

lm's avatar
lm committed
65
	return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_PING_LEN);
James Goppert's avatar
James Goppert committed
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80
}

/**
 * @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);
}

lm's avatar
lm committed
81 82

#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS
James Goppert's avatar
James Goppert committed
83 84 85 86 87 88 89 90 91
/**
 * @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
92 93 94 95 96
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;

lm's avatar
lm committed
97 98 99 100 101
	MAVLINK_BUFFER_CHECK_START( chan, MAVLINK_MSG_ID_PING_LEN )
	payload.seq = seq;	// uint32_t:PING sequence
	payload.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
	payload.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
	payload.time = time;	// uint64_t:Unix timestamp in microseconds
lm's avatar
lm committed
102 103 104 105 106 107 108 109 110 111

	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 );

lm's avatar
lm committed
112 113 114 115 116 117
	crc_init(&hdr.ck);
	crc_calculate_mem((uint8_t *)&hdr.len, &hdr.ck, MAVLINK_CORE_HEADER_LEN);
	crc_calculate_mem((uint8_t *)&payload, &hdr.ck, hdr.len );
	crc_accumulate( 0xE2, &hdr.ck); /// include key in X25 checksum
	mavlink_send_mem(chan, (uint8_t *)&hdr.ck, MAVLINK_NUM_CHECKSUM_BYTES);
	MAVLINK_BUFFER_CHECK_END
James Goppert's avatar
James Goppert committed
118 119 120 121 122 123 124 125 126 127 128 129
}

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

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

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

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

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