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

#define MAVLINK_MSG_ID_SYSTEM_TIME 2

lm's avatar
lm committed
5
typedef struct __mavlink_system_time_t
James Goppert's avatar
James Goppert committed
6
{
7
 uint64_t time_unix_usec; ///< Timestamp of the master clock in microseconds since UNIX epoch.
lm's avatar
lm committed
8
 uint32_t time_boot_ms; ///< Timestamp of the component clock since boot time in milliseconds.
James Goppert's avatar
James Goppert committed
9 10
} mavlink_system_time_t;

lm's avatar
lm committed
11 12 13 14 15 16 17 18
#define MAVLINK_MSG_ID_SYSTEM_TIME_LEN 12
#define MAVLINK_MSG_ID_2_LEN 12



#define MAVLINK_MESSAGE_INFO_SYSTEM_TIME { \
	"SYSTEM_TIME", \
	2, \
19
	{  { "time_unix_usec", MAVLINK_TYPE_UINT64_T, 0, 0, offsetof(mavlink_system_time_t, time_unix_usec) }, \
lm's avatar
lm committed
20 21 22 23 24
         { "time_boot_ms", MAVLINK_TYPE_UINT32_T, 0, 8, offsetof(mavlink_system_time_t, time_boot_ms) }, \
         } \
}


James Goppert's avatar
James Goppert committed
25 26 27 28 29 30
/**
 * @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
 *
31
 * @param time_unix_usec Timestamp of the master clock in microseconds since UNIX epoch.
32
 * @param time_boot_ms Timestamp of the component clock since boot time in milliseconds.
James Goppert's avatar
James Goppert committed
33 34
 * @return length of the message in bytes (excluding serial stream start sign)
 */
lm's avatar
lm committed
35
static inline uint16_t mavlink_msg_system_time_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg,
36
						       uint64_t time_unix_usec, uint32_t time_boot_ms)
James Goppert's avatar
James Goppert committed
37 38 39
{
	msg->msgid = MAVLINK_MSG_ID_SYSTEM_TIME;

40
	put_uint64_t_by_index(msg, 0, time_unix_usec); // Timestamp of the master clock in microseconds since UNIX epoch.
lm's avatar
lm committed
41
	put_uint32_t_by_index(msg, 8, time_boot_ms); // Timestamp of the component clock since boot time in milliseconds.
James Goppert's avatar
James Goppert committed
42

43
	return mavlink_finalize_message(msg, system_id, component_id, 12, 137);
James Goppert's avatar
James Goppert committed
44 45 46
}

/**
lm's avatar
lm committed
47
 * @brief Pack a system_time message on a channel
James Goppert's avatar
James Goppert committed
48 49 50 51
 * @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
52
 * @param time_unix_usec Timestamp of the master clock in microseconds since UNIX epoch.
53
 * @param time_boot_ms Timestamp of the component clock since boot time in milliseconds.
James Goppert's avatar
James Goppert committed
54 55
 * @return length of the message in bytes (excluding serial stream start sign)
 */
lm's avatar
lm committed
56 57
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,
58
						           uint64_t time_unix_usec,uint32_t time_boot_ms)
lm's avatar
lm committed
59 60 61
{
	msg->msgid = MAVLINK_MSG_ID_SYSTEM_TIME;

62
	put_uint64_t_by_index(msg, 0, time_unix_usec); // Timestamp of the master clock in microseconds since UNIX epoch.
lm's avatar
lm committed
63 64
	put_uint32_t_by_index(msg, 8, time_boot_ms); // Timestamp of the component clock since boot time in milliseconds.

65
	return mavlink_finalize_message_chan(msg, system_id, component_id, chan, 12, 137);
lm's avatar
lm committed
66 67
}

James Goppert's avatar
James Goppert committed
68 69 70 71 72 73 74 75 76 77
/**
 * @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)
{
78
	return mavlink_msg_system_time_pack(system_id, component_id, msg, system_time->time_unix_usec, system_time->time_boot_ms);
James Goppert's avatar
James Goppert committed
79 80 81 82 83 84
}

/**
 * @brief Send a system_time message
 * @param chan MAVLink channel to send the message
 *
85
 * @param time_unix_usec Timestamp of the master clock in microseconds since UNIX epoch.
86
 * @param time_boot_ms Timestamp of the component clock since boot time in milliseconds.
James Goppert's avatar
James Goppert committed
87
 */
lm's avatar
lm committed
88 89
#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS

90
static inline void mavlink_msg_system_time_send(mavlink_channel_t chan, uint64_t time_unix_usec, uint32_t time_boot_ms)
lm's avatar
lm committed
91
{
lm's avatar
lm committed
92
	MAVLINK_ALIGNED_MESSAGE(msg, 12);
LM's avatar
LM committed
93 94
	msg->msgid = MAVLINK_MSG_ID_SYSTEM_TIME;

95
	put_uint64_t_by_index(msg, 0, time_unix_usec); // Timestamp of the master clock in microseconds since UNIX epoch.
LM's avatar
LM committed
96 97
	put_uint32_t_by_index(msg, 8, time_boot_ms); // Timestamp of the component clock since boot time in milliseconds.

98
	mavlink_finalize_message_chan_send(msg, chan, 12, 137);
James Goppert's avatar
James Goppert committed
99 100 101
}

#endif
lm's avatar
lm committed
102

James Goppert's avatar
James Goppert committed
103 104
// MESSAGE SYSTEM_TIME UNPACKING

lm's avatar
lm committed
105

James Goppert's avatar
James Goppert committed
106
/**
107
 * @brief Get field time_unix_usec from system_time message
James Goppert's avatar
James Goppert committed
108 109 110
 *
 * @return Timestamp of the master clock in microseconds since UNIX epoch.
 */
111
static inline uint64_t mavlink_msg_system_time_get_time_unix_usec(const mavlink_message_t* msg)
James Goppert's avatar
James Goppert committed
112
{
lm's avatar
lm committed
113
	return MAVLINK_MSG_RETURN_uint64_t(msg,  0);
James Goppert's avatar
James Goppert committed
114 115
}

116 117 118 119 120 121 122
/**
 * @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)
{
lm's avatar
lm committed
123
	return MAVLINK_MSG_RETURN_uint32_t(msg,  8);
124 125
}

James Goppert's avatar
James Goppert committed
126 127 128 129 130 131 132 133
/**
 * @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
134
#if MAVLINK_NEED_BYTE_SWAP
135
	system_time->time_unix_usec = mavlink_msg_system_time_get_time_unix_usec(msg);
lm's avatar
lm committed
136 137 138 139
	system_time->time_boot_ms = mavlink_msg_system_time_get_time_boot_ms(msg);
#else
	memcpy(system_time, MAVLINK_PAYLOAD(msg), 12);
#endif
James Goppert's avatar
James Goppert committed
140
}