mavlink_msg_system_time.h 5.74 KB
Newer Older
James Goppert's avatar
James Goppert committed
1 2 3
// MESSAGE SYSTEM_TIME PACKING

#define MAVLINK_MSG_ID_SYSTEM_TIME 2
4 5 6 7
#define MAVLINK_MSG_ID_SYSTEM_TIME_LEN 12
#define MAVLINK_MSG_2_LEN 12
#define MAVLINK_MSG_ID_SYSTEM_TIME_KEY 0x16
#define MAVLINK_MSG_2_KEY 0x16
James Goppert's avatar
James Goppert committed
8 9 10

typedef struct __mavlink_system_time_t 
{
lm's avatar
lm committed
11
	uint64_t time_usec;	///< Timestamp of the master clock in microseconds since UNIX epoch.
12
	uint32_t time_boot_ms;	///< Timestamp of the component clock since boot time in milliseconds.
James Goppert's avatar
James Goppert committed
13 14 15 16 17 18 19 20 21 22

} mavlink_system_time_t;

/**
 * @brief Pack a system_time 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 time_usec Timestamp of the master clock in microseconds since UNIX epoch.
23
 * @param time_boot_ms Timestamp of the component clock since boot time in milliseconds.
James Goppert's avatar
James Goppert committed
24 25
 * @return length of the message in bytes (excluding serial stream start sign)
 */
26
static inline uint16_t mavlink_msg_system_time_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, uint64_t time_usec, uint32_t time_boot_ms)
James Goppert's avatar
James Goppert committed
27
{
lm's avatar
lm committed
28
	mavlink_system_time_t *p = (mavlink_system_time_t *)&msg->payload[0];
James Goppert's avatar
James Goppert committed
29 30
	msg->msgid = MAVLINK_MSG_ID_SYSTEM_TIME;

lm's avatar
lm committed
31
	p->time_usec = time_usec;	// uint64_t:Timestamp of the master clock in microseconds since UNIX epoch.
32
	p->time_boot_ms = time_boot_ms;	// uint32_t:Timestamp of the component clock since boot time in milliseconds.
James Goppert's avatar
James Goppert committed
33

lm's avatar
lm committed
34
	return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_SYSTEM_TIME_LEN);
James Goppert's avatar
James Goppert committed
35 36 37 38 39 40 41 42 43
}

/**
 * @brief Pack a system_time 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 time_usec Timestamp of the master clock in microseconds since UNIX epoch.
44
 * @param time_boot_ms Timestamp of the component clock since boot time in milliseconds.
James Goppert's avatar
James Goppert committed
45 46
 * @return length of the message in bytes (excluding serial stream start sign)
 */
47
static inline uint16_t mavlink_msg_system_time_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan, mavlink_message_t* msg, uint64_t time_usec, uint32_t time_boot_ms)
James Goppert's avatar
James Goppert committed
48
{
lm's avatar
lm committed
49
	mavlink_system_time_t *p = (mavlink_system_time_t *)&msg->payload[0];
James Goppert's avatar
James Goppert committed
50 51
	msg->msgid = MAVLINK_MSG_ID_SYSTEM_TIME;

lm's avatar
lm committed
52
	p->time_usec = time_usec;	// uint64_t:Timestamp of the master clock in microseconds since UNIX epoch.
53
	p->time_boot_ms = time_boot_ms;	// uint32_t:Timestamp of the component clock since boot time in milliseconds.
James Goppert's avatar
James Goppert committed
54

lm's avatar
lm committed
55
	return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_SYSTEM_TIME_LEN);
James Goppert's avatar
James Goppert committed
56 57 58 59 60 61 62 63 64 65 66 67
}

/**
 * @brief Encode a system_time 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 system_time C-struct to read the message contents from
 */
static inline uint16_t mavlink_msg_system_time_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_system_time_t* system_time)
{
68
	return mavlink_msg_system_time_pack(system_id, component_id, msg, system_time->time_usec, system_time->time_boot_ms);
James Goppert's avatar
James Goppert committed
69 70
}

lm's avatar
lm committed
71 72

#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS
James Goppert's avatar
James Goppert committed
73 74 75 76 77
/**
 * @brief Send a system_time message
 * @param chan MAVLink channel to send the message
 *
 * @param time_usec Timestamp of the master clock in microseconds since UNIX epoch.
78
 * @param time_boot_ms Timestamp of the component clock since boot time in milliseconds.
James Goppert's avatar
James Goppert committed
79
 */
80
static inline void mavlink_msg_system_time_send(mavlink_channel_t chan, uint64_t time_usec, uint32_t time_boot_ms)
lm's avatar
lm committed
81 82 83 84
{
	mavlink_header_t hdr;
	mavlink_system_time_t payload;

lm's avatar
lm committed
85 86
	MAVLINK_BUFFER_CHECK_START( chan, MAVLINK_MSG_ID_SYSTEM_TIME_LEN )
	payload.time_usec = time_usec;	// uint64_t:Timestamp of the master clock in microseconds since UNIX epoch.
87
	payload.time_boot_ms = time_boot_ms;	// uint32_t:Timestamp of the component clock since boot time in milliseconds.
lm's avatar
lm committed
88 89 90 91 92 93 94 95 96

	hdr.STX = MAVLINK_STX;
	hdr.len = MAVLINK_MSG_ID_SYSTEM_TIME_LEN;
	hdr.msgid = MAVLINK_MSG_ID_SYSTEM_TIME;
	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 );
97
	mavlink_send_mem(chan, (uint8_t *)&payload, sizeof(payload) );
lm's avatar
lm committed
98

lm's avatar
lm committed
99 100 101
	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 );
102
	crc_accumulate( 0x16, &hdr.ck); /// include key in X25 checksum
lm's avatar
lm committed
103 104
	mavlink_send_mem(chan, (uint8_t *)&hdr.ck, MAVLINK_NUM_CHECKSUM_BYTES);
	MAVLINK_BUFFER_CHECK_END
James Goppert's avatar
James Goppert committed
105 106 107 108 109 110 111 112 113 114 115 116
}

#endif
// MESSAGE SYSTEM_TIME UNPACKING

/**
 * @brief Get field time_usec from system_time message
 *
 * @return Timestamp of the master clock in microseconds since UNIX epoch.
 */
static inline uint64_t mavlink_msg_system_time_get_time_usec(const mavlink_message_t* msg)
{
lm's avatar
lm committed
117 118
	mavlink_system_time_t *p = (mavlink_system_time_t *)&msg->payload[0];
	return (uint64_t)(p->time_usec);
James Goppert's avatar
James Goppert committed
119 120
}

121 122 123 124 125 126 127 128 129 130 131
/**
 * @brief Get field time_boot_ms from system_time message
 *
 * @return Timestamp of the component clock since boot time in milliseconds.
 */
static inline uint32_t mavlink_msg_system_time_get_time_boot_ms(const mavlink_message_t* msg)
{
	mavlink_system_time_t *p = (mavlink_system_time_t *)&msg->payload[0];
	return (uint32_t)(p->time_boot_ms);
}

James Goppert's avatar
James Goppert committed
132 133 134 135 136 137 138 139
/**
 * @brief Decode a system_time message into a struct
 *
 * @param msg The message to decode
 * @param system_time C-struct to decode the message contents into
 */
static inline void mavlink_msg_system_time_decode(const mavlink_message_t* msg, mavlink_system_time_t* system_time)
{
lm's avatar
lm committed
140
	memcpy( system_time, msg->payload, sizeof(mavlink_system_time_t));
James Goppert's avatar
James Goppert committed
141
}