mavlink_msg_heartbeat.h 10.3 KB
Newer Older
James Goppert's avatar
James Goppert committed
1 2 3 4
// MESSAGE HEARTBEAT PACKING

#define MAVLINK_MSG_ID_HEARTBEAT 0

lm's avatar
lm committed
5
typedef struct __mavlink_heartbeat_t
James Goppert's avatar
James Goppert committed
6
{
7
 uint32_t custom_mode; ///< A bitfield for use for autopilot-specific flags.
lm's avatar
lm committed
8
 uint8_t type; ///< Type of the MAV (quadrotor, helicopter, etc., up to 15 types, defined in MAV_TYPE ENUM)
9
 uint8_t autopilot; ///< Autopilot type / class. defined in MAV_AUTOPILOT ENUM
10
 uint8_t base_mode; ///< System mode bitfield, see MAV_MODE_FLAGS ENUM in mavlink/include/mavlink_types.h
11 12
 uint8_t system_status; ///< System status flag, see MAV_STATE ENUM
 uint8_t mavlink_version; ///< MAVLink version, not writable by user, gets added by protocol because of magic data type: uint8_t_mavlink_version
James Goppert's avatar
James Goppert committed
13 14
} mavlink_heartbeat_t;

lm's avatar
lm committed
15 16
#define MAVLINK_MSG_ID_HEARTBEAT_LEN 9
#define MAVLINK_MSG_ID_0_LEN 9
lm's avatar
lm committed
17

Lorenz Meier's avatar
Lorenz Meier committed
18 19 20
#define MAVLINK_MSG_ID_HEARTBEAT_CRC 50
#define MAVLINK_MSG_ID_0_CRC 50

lm's avatar
lm committed
21 22 23 24


#define MAVLINK_MESSAGE_INFO_HEARTBEAT { \
	"HEARTBEAT", \
25
	6, \
lm's avatar
lm committed
26 27 28 29 30 31
	{  { "custom_mode", NULL, MAVLINK_TYPE_UINT32_T, 0, 0, offsetof(mavlink_heartbeat_t, custom_mode) }, \
         { "type", NULL, MAVLINK_TYPE_UINT8_T, 0, 4, offsetof(mavlink_heartbeat_t, type) }, \
         { "autopilot", NULL, MAVLINK_TYPE_UINT8_T, 0, 5, offsetof(mavlink_heartbeat_t, autopilot) }, \
         { "base_mode", NULL, MAVLINK_TYPE_UINT8_T, 0, 6, offsetof(mavlink_heartbeat_t, base_mode) }, \
         { "system_status", NULL, MAVLINK_TYPE_UINT8_T, 0, 7, offsetof(mavlink_heartbeat_t, system_status) }, \
         { "mavlink_version", NULL, MAVLINK_TYPE_UINT8_T, 0, 8, offsetof(mavlink_heartbeat_t, mavlink_version) }, \
lm's avatar
lm committed
32 33 34 35
         } \
}


James Goppert's avatar
James Goppert committed
36 37 38 39 40 41 42
/**
 * @brief Pack a heartbeat 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 type Type of the MAV (quadrotor, helicopter, etc., up to 15 types, defined in MAV_TYPE ENUM)
43
 * @param autopilot Autopilot type / class. defined in MAV_AUTOPILOT ENUM
44
 * @param base_mode System mode bitfield, see MAV_MODE_FLAGS ENUM in mavlink/include/mavlink_types.h
45 46
 * @param custom_mode A bitfield for use for autopilot-specific flags.
 * @param system_status System status flag, see MAV_STATE ENUM
James Goppert's avatar
James Goppert committed
47 48
 * @return length of the message in bytes (excluding serial stream start sign)
 */
lm's avatar
lm committed
49
static inline uint16_t mavlink_msg_heartbeat_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg,
lm's avatar
lm committed
50
						       uint8_t type, uint8_t autopilot, uint8_t base_mode, uint32_t custom_mode, uint8_t system_status)
James Goppert's avatar
James Goppert committed
51
{
LM's avatar
LM committed
52
#if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
Lorenz Meier's avatar
Lorenz Meier committed
53
	char buf[MAVLINK_MSG_ID_HEARTBEAT_LEN];
lm's avatar
lm committed
54 55 56 57 58 59 60
	_mav_put_uint32_t(buf, 0, custom_mode);
	_mav_put_uint8_t(buf, 4, type);
	_mav_put_uint8_t(buf, 5, autopilot);
	_mav_put_uint8_t(buf, 6, base_mode);
	_mav_put_uint8_t(buf, 7, system_status);
	_mav_put_uint8_t(buf, 8, 3);

Lorenz Meier's avatar
Lorenz Meier committed
61
        memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_HEARTBEAT_LEN);
LM's avatar
LM committed
62 63 64 65 66 67 68 69 70
#else
	mavlink_heartbeat_t packet;
	packet.custom_mode = custom_mode;
	packet.type = type;
	packet.autopilot = autopilot;
	packet.base_mode = base_mode;
	packet.system_status = system_status;
	packet.mavlink_version = 3;

Lorenz Meier's avatar
Lorenz Meier committed
71
        memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_HEARTBEAT_LEN);
LM's avatar
LM committed
72
#endif
James Goppert's avatar
James Goppert committed
73

LM's avatar
LM committed
74
	msg->msgid = MAVLINK_MSG_ID_HEARTBEAT;
Lorenz Meier's avatar
Lorenz Meier committed
75 76 77 78 79
#if MAVLINK_CRC_EXTRA
    return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_HEARTBEAT_LEN, MAVLINK_MSG_ID_HEARTBEAT_CRC);
#else
    return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_HEARTBEAT_LEN);
#endif
James Goppert's avatar
James Goppert committed
80 81 82
}

/**
lm's avatar
lm committed
83
 * @brief Pack a heartbeat message on a channel
James Goppert's avatar
James Goppert committed
84 85 86 87 88
 * @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 type Type of the MAV (quadrotor, helicopter, etc., up to 15 types, defined in MAV_TYPE ENUM)
89
 * @param autopilot Autopilot type / class. defined in MAV_AUTOPILOT ENUM
90
 * @param base_mode System mode bitfield, see MAV_MODE_FLAGS ENUM in mavlink/include/mavlink_types.h
91 92
 * @param custom_mode A bitfield for use for autopilot-specific flags.
 * @param system_status System status flag, see MAV_STATE ENUM
James Goppert's avatar
James Goppert committed
93 94
 * @return length of the message in bytes (excluding serial stream start sign)
 */
lm's avatar
lm committed
95 96
static inline uint16_t mavlink_msg_heartbeat_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan,
							   mavlink_message_t* msg,
lm's avatar
lm committed
97
						           uint8_t type,uint8_t autopilot,uint8_t base_mode,uint32_t custom_mode,uint8_t system_status)
James Goppert's avatar
James Goppert committed
98
{
LM's avatar
LM committed
99
#if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
Lorenz Meier's avatar
Lorenz Meier committed
100
	char buf[MAVLINK_MSG_ID_HEARTBEAT_LEN];
lm's avatar
lm committed
101 102 103 104 105 106 107
	_mav_put_uint32_t(buf, 0, custom_mode);
	_mav_put_uint8_t(buf, 4, type);
	_mav_put_uint8_t(buf, 5, autopilot);
	_mav_put_uint8_t(buf, 6, base_mode);
	_mav_put_uint8_t(buf, 7, system_status);
	_mav_put_uint8_t(buf, 8, 3);

Lorenz Meier's avatar
Lorenz Meier committed
108
        memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_HEARTBEAT_LEN);
LM's avatar
LM committed
109 110 111 112 113 114 115 116 117
#else
	mavlink_heartbeat_t packet;
	packet.custom_mode = custom_mode;
	packet.type = type;
	packet.autopilot = autopilot;
	packet.base_mode = base_mode;
	packet.system_status = system_status;
	packet.mavlink_version = 3;

Lorenz Meier's avatar
Lorenz Meier committed
118
        memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_HEARTBEAT_LEN);
LM's avatar
LM committed
119
#endif
James Goppert's avatar
James Goppert committed
120

LM's avatar
LM committed
121
	msg->msgid = MAVLINK_MSG_ID_HEARTBEAT;
Lorenz Meier's avatar
Lorenz Meier committed
122 123 124 125 126
#if MAVLINK_CRC_EXTRA
    return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_HEARTBEAT_LEN, MAVLINK_MSG_ID_HEARTBEAT_CRC);
#else
    return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_HEARTBEAT_LEN);
#endif
James Goppert's avatar
James Goppert committed
127 128 129 130 131 132 133 134 135 136 137 138
}

/**
 * @brief Encode a heartbeat 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 heartbeat C-struct to read the message contents from
 */
static inline uint16_t mavlink_msg_heartbeat_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_heartbeat_t* heartbeat)
{
139
	return mavlink_msg_heartbeat_pack(system_id, component_id, msg, heartbeat->type, heartbeat->autopilot, heartbeat->base_mode, heartbeat->custom_mode, heartbeat->system_status);
James Goppert's avatar
James Goppert committed
140 141 142 143 144 145 146
}

/**
 * @brief Send a heartbeat message
 * @param chan MAVLink channel to send the message
 *
 * @param type Type of the MAV (quadrotor, helicopter, etc., up to 15 types, defined in MAV_TYPE ENUM)
147
 * @param autopilot Autopilot type / class. defined in MAV_AUTOPILOT ENUM
148
 * @param base_mode System mode bitfield, see MAV_MODE_FLAGS ENUM in mavlink/include/mavlink_types.h
149 150
 * @param custom_mode A bitfield for use for autopilot-specific flags.
 * @param system_status System status flag, see MAV_STATE ENUM
James Goppert's avatar
James Goppert committed
151
 */
lm's avatar
lm committed
152 153
#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS

lm's avatar
lm committed
154
static inline void mavlink_msg_heartbeat_send(mavlink_channel_t chan, uint8_t type, uint8_t autopilot, uint8_t base_mode, uint32_t custom_mode, uint8_t system_status)
lm's avatar
lm committed
155
{
LM's avatar
LM committed
156
#if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
Lorenz Meier's avatar
Lorenz Meier committed
157
	char buf[MAVLINK_MSG_ID_HEARTBEAT_LEN];
lm's avatar
lm committed
158 159 160 161 162 163 164
	_mav_put_uint32_t(buf, 0, custom_mode);
	_mav_put_uint8_t(buf, 4, type);
	_mav_put_uint8_t(buf, 5, autopilot);
	_mav_put_uint8_t(buf, 6, base_mode);
	_mav_put_uint8_t(buf, 7, system_status);
	_mav_put_uint8_t(buf, 8, 3);

Lorenz Meier's avatar
Lorenz Meier committed
165 166 167 168 169
#if MAVLINK_CRC_EXTRA
    _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_HEARTBEAT, buf, MAVLINK_MSG_ID_HEARTBEAT_LEN, MAVLINK_MSG_ID_HEARTBEAT_CRC);
#else
    _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_HEARTBEAT, buf, MAVLINK_MSG_ID_HEARTBEAT_LEN);
#endif
LM's avatar
LM committed
170 171 172 173 174 175 176 177 178
#else
	mavlink_heartbeat_t packet;
	packet.custom_mode = custom_mode;
	packet.type = type;
	packet.autopilot = autopilot;
	packet.base_mode = base_mode;
	packet.system_status = system_status;
	packet.mavlink_version = 3;

Lorenz Meier's avatar
Lorenz Meier committed
179 180 181 182 183
#if MAVLINK_CRC_EXTRA
    _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_HEARTBEAT, (const char *)&packet, MAVLINK_MSG_ID_HEARTBEAT_LEN, MAVLINK_MSG_ID_HEARTBEAT_CRC);
#else
    _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_HEARTBEAT, (const char *)&packet, MAVLINK_MSG_ID_HEARTBEAT_LEN);
#endif
LM's avatar
LM committed
184
#endif
James Goppert's avatar
James Goppert committed
185 186 187
}

#endif
lm's avatar
lm committed
188

James Goppert's avatar
James Goppert committed
189 190
// MESSAGE HEARTBEAT UNPACKING

lm's avatar
lm committed
191

James Goppert's avatar
James Goppert committed
192 193 194 195 196 197 198
/**
 * @brief Get field type from heartbeat message
 *
 * @return Type of the MAV (quadrotor, helicopter, etc., up to 15 types, defined in MAV_TYPE ENUM)
 */
static inline uint8_t mavlink_msg_heartbeat_get_type(const mavlink_message_t* msg)
{
lm's avatar
lm committed
199
	return _MAV_RETURN_uint8_t(msg,  4);
James Goppert's avatar
James Goppert committed
200 201 202 203 204
}

/**
 * @brief Get field autopilot from heartbeat message
 *
205
 * @return Autopilot type / class. defined in MAV_AUTOPILOT ENUM
James Goppert's avatar
James Goppert committed
206 207 208
 */
static inline uint8_t mavlink_msg_heartbeat_get_autopilot(const mavlink_message_t* msg)
{
lm's avatar
lm committed
209
	return _MAV_RETURN_uint8_t(msg,  5);
James Goppert's avatar
James Goppert committed
210 211
}

212
/**
213
 * @brief Get field base_mode from heartbeat message
214
 *
215
 * @return System mode bitfield, see MAV_MODE_FLAGS ENUM in mavlink/include/mavlink_types.h
216
 */
217
static inline uint8_t mavlink_msg_heartbeat_get_base_mode(const mavlink_message_t* msg)
218
{
lm's avatar
lm committed
219
	return _MAV_RETURN_uint8_t(msg,  6);
220 221 222
}

/**
223
 * @brief Get field custom_mode from heartbeat message
224
 *
225
 * @return A bitfield for use for autopilot-specific flags.
226
 */
lm's avatar
lm committed
227
static inline uint32_t mavlink_msg_heartbeat_get_custom_mode(const mavlink_message_t* msg)
228
{
lm's avatar
lm committed
229
	return _MAV_RETURN_uint32_t(msg,  0);
230 231 232 233 234
}

/**
 * @brief Get field system_status from heartbeat message
 *
235
 * @return System status flag, see MAV_STATE ENUM
236 237 238
 */
static inline uint8_t mavlink_msg_heartbeat_get_system_status(const mavlink_message_t* msg)
{
lm's avatar
lm committed
239
	return _MAV_RETURN_uint8_t(msg,  7);
240 241
}

James Goppert's avatar
James Goppert committed
242 243 244
/**
 * @brief Get field mavlink_version from heartbeat message
 *
245
 * @return MAVLink version, not writable by user, gets added by protocol because of magic data type: uint8_t_mavlink_version
James Goppert's avatar
James Goppert committed
246 247 248
 */
static inline uint8_t mavlink_msg_heartbeat_get_mavlink_version(const mavlink_message_t* msg)
{
lm's avatar
lm committed
249
	return _MAV_RETURN_uint8_t(msg,  8);
James Goppert's avatar
James Goppert committed
250 251 252 253 254 255 256 257 258 259
}

/**
 * @brief Decode a heartbeat message into a struct
 *
 * @param msg The message to decode
 * @param heartbeat C-struct to decode the message contents into
 */
static inline void mavlink_msg_heartbeat_decode(const mavlink_message_t* msg, mavlink_heartbeat_t* heartbeat)
{
lm's avatar
lm committed
260
#if MAVLINK_NEED_BYTE_SWAP
261
	heartbeat->custom_mode = mavlink_msg_heartbeat_get_custom_mode(msg);
lm's avatar
lm committed
262 263
	heartbeat->type = mavlink_msg_heartbeat_get_type(msg);
	heartbeat->autopilot = mavlink_msg_heartbeat_get_autopilot(msg);
264
	heartbeat->base_mode = mavlink_msg_heartbeat_get_base_mode(msg);
lm's avatar
lm committed
265 266 267
	heartbeat->system_status = mavlink_msg_heartbeat_get_system_status(msg);
	heartbeat->mavlink_version = mavlink_msg_heartbeat_get_mavlink_version(msg);
#else
Lorenz Meier's avatar
Lorenz Meier committed
268
	memcpy(heartbeat, _MAV_PAYLOAD(msg), MAVLINK_MSG_ID_HEARTBEAT_LEN);
lm's avatar
lm committed
269
#endif
James Goppert's avatar
James Goppert committed
270
}