mavlink_msg_fence_status.h 7.3 KB
Newer Older
1 2 3 4 5 6 7
// MESSAGE FENCE_STATUS PACKING

#define MAVLINK_MSG_ID_FENCE_STATUS 162

typedef struct __mavlink_fence_status_t
{
 uint8_t breach_status; ///< 0 if currently inside fence, 1 if outside
pixhawk's avatar
pixhawk committed
8
 uint16_t breach_count; ///< number of fence breaches
9
 uint8_t breach_type; ///< last breach type (see FENCE_BREACH_* enum)
pixhawk's avatar
pixhawk committed
10
 uint32_t breach_time; ///< time of last breach in milliseconds since boot
11 12 13 14 15 16 17 18 19 20
} mavlink_fence_status_t;

#define MAVLINK_MSG_ID_FENCE_STATUS_LEN 8
#define MAVLINK_MSG_ID_162_LEN 8



#define MAVLINK_MESSAGE_INFO_FENCE_STATUS { \
	"FENCE_STATUS", \
	4, \
pixhawk's avatar
pixhawk committed
21 22 23 24
	{  { "breach_status", NULL, MAVLINK_TYPE_UINT8_T, 0, 0, offsetof(mavlink_fence_status_t, breach_status) }, \
         { "breach_count", NULL, MAVLINK_TYPE_UINT16_T, 0, 1, offsetof(mavlink_fence_status_t, breach_count) }, \
         { "breach_type", NULL, MAVLINK_TYPE_UINT8_T, 0, 3, offsetof(mavlink_fence_status_t, breach_type) }, \
         { "breach_time", NULL, MAVLINK_TYPE_UINT32_T, 0, 4, offsetof(mavlink_fence_status_t, breach_time) }, \
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45
         } \
}


/**
 * @brief Pack a fence_status 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 breach_status 0 if currently inside fence, 1 if outside
 * @param breach_count number of fence breaches
 * @param breach_type last breach type (see FENCE_BREACH_* enum)
 * @param breach_time time of last breach in milliseconds since boot
 * @return length of the message in bytes (excluding serial stream start sign)
 */
static inline uint16_t mavlink_msg_fence_status_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg,
						       uint8_t breach_status, uint16_t breach_count, uint8_t breach_type, uint32_t breach_time)
{
#if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
	char buf[8];
pixhawk's avatar
pixhawk committed
46 47 48 49
	_mav_put_uint8_t(buf, 0, breach_status);
	_mav_put_uint16_t(buf, 1, breach_count);
	_mav_put_uint8_t(buf, 3, breach_type);
	_mav_put_uint32_t(buf, 4, breach_time);
50

pixhawk's avatar
pixhawk committed
51
        memcpy(_MAV_PAYLOAD(msg), buf, 8);
52 53 54
#else
	mavlink_fence_status_t packet;
	packet.breach_status = breach_status;
pixhawk's avatar
pixhawk committed
55
	packet.breach_count = breach_count;
56
	packet.breach_type = breach_type;
pixhawk's avatar
pixhawk committed
57
	packet.breach_time = breach_time;
58

pixhawk's avatar
pixhawk committed
59
        memcpy(_MAV_PAYLOAD(msg), &packet, 8);
60 61 62
#endif

	msg->msgid = MAVLINK_MSG_ID_FENCE_STATUS;
pixhawk's avatar
pixhawk committed
63
	return mavlink_finalize_message(msg, system_id, component_id, 8);
64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83
}

/**
 * @brief Pack a fence_status message on a channel
 * @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 breach_status 0 if currently inside fence, 1 if outside
 * @param breach_count number of fence breaches
 * @param breach_type last breach type (see FENCE_BREACH_* enum)
 * @param breach_time time of last breach in milliseconds since boot
 * @return length of the message in bytes (excluding serial stream start sign)
 */
static inline uint16_t mavlink_msg_fence_status_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan,
							   mavlink_message_t* msg,
						           uint8_t breach_status,uint16_t breach_count,uint8_t breach_type,uint32_t breach_time)
{
#if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
	char buf[8];
pixhawk's avatar
pixhawk committed
84 85 86 87
	_mav_put_uint8_t(buf, 0, breach_status);
	_mav_put_uint16_t(buf, 1, breach_count);
	_mav_put_uint8_t(buf, 3, breach_type);
	_mav_put_uint32_t(buf, 4, breach_time);
88

pixhawk's avatar
pixhawk committed
89
        memcpy(_MAV_PAYLOAD(msg), buf, 8);
90 91 92
#else
	mavlink_fence_status_t packet;
	packet.breach_status = breach_status;
pixhawk's avatar
pixhawk committed
93
	packet.breach_count = breach_count;
94
	packet.breach_type = breach_type;
pixhawk's avatar
pixhawk committed
95
	packet.breach_time = breach_time;
96

pixhawk's avatar
pixhawk committed
97
        memcpy(_MAV_PAYLOAD(msg), &packet, 8);
98 99 100
#endif

	msg->msgid = MAVLINK_MSG_ID_FENCE_STATUS;
pixhawk's avatar
pixhawk committed
101
	return mavlink_finalize_message_chan(msg, system_id, component_id, chan, 8);
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131
}

/**
 * @brief Encode a fence_status 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 fence_status C-struct to read the message contents from
 */
static inline uint16_t mavlink_msg_fence_status_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_fence_status_t* fence_status)
{
	return mavlink_msg_fence_status_pack(system_id, component_id, msg, fence_status->breach_status, fence_status->breach_count, fence_status->breach_type, fence_status->breach_time);
}

/**
 * @brief Send a fence_status message
 * @param chan MAVLink channel to send the message
 *
 * @param breach_status 0 if currently inside fence, 1 if outside
 * @param breach_count number of fence breaches
 * @param breach_type last breach type (see FENCE_BREACH_* enum)
 * @param breach_time time of last breach in milliseconds since boot
 */
#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS

static inline void mavlink_msg_fence_status_send(mavlink_channel_t chan, uint8_t breach_status, uint16_t breach_count, uint8_t breach_type, uint32_t breach_time)
{
#if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
	char buf[8];
pixhawk's avatar
pixhawk committed
132 133 134 135
	_mav_put_uint8_t(buf, 0, breach_status);
	_mav_put_uint16_t(buf, 1, breach_count);
	_mav_put_uint8_t(buf, 3, breach_type);
	_mav_put_uint32_t(buf, 4, breach_time);
136

pixhawk's avatar
pixhawk committed
137
	_mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_FENCE_STATUS, buf, 8);
138 139 140
#else
	mavlink_fence_status_t packet;
	packet.breach_status = breach_status;
pixhawk's avatar
pixhawk committed
141
	packet.breach_count = breach_count;
142
	packet.breach_type = breach_type;
pixhawk's avatar
pixhawk committed
143
	packet.breach_time = breach_time;
144

pixhawk's avatar
pixhawk committed
145
	_mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_FENCE_STATUS, (const char *)&packet, 8);
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160
#endif
}

#endif

// MESSAGE FENCE_STATUS UNPACKING


/**
 * @brief Get field breach_status from fence_status message
 *
 * @return 0 if currently inside fence, 1 if outside
 */
static inline uint8_t mavlink_msg_fence_status_get_breach_status(const mavlink_message_t* msg)
{
pixhawk's avatar
pixhawk committed
161
	return _MAV_RETURN_uint8_t(msg,  0);
162 163 164 165 166 167 168 169 170
}

/**
 * @brief Get field breach_count from fence_status message
 *
 * @return number of fence breaches
 */
static inline uint16_t mavlink_msg_fence_status_get_breach_count(const mavlink_message_t* msg)
{
pixhawk's avatar
pixhawk committed
171
	return _MAV_RETURN_uint16_t(msg,  1);
172 173 174 175 176 177 178 179 180
}

/**
 * @brief Get field breach_type from fence_status message
 *
 * @return last breach type (see FENCE_BREACH_* enum)
 */
static inline uint8_t mavlink_msg_fence_status_get_breach_type(const mavlink_message_t* msg)
{
pixhawk's avatar
pixhawk committed
181
	return _MAV_RETURN_uint8_t(msg,  3);
182 183 184 185 186 187 188 189 190
}

/**
 * @brief Get field breach_time from fence_status message
 *
 * @return time of last breach in milliseconds since boot
 */
static inline uint32_t mavlink_msg_fence_status_get_breach_time(const mavlink_message_t* msg)
{
pixhawk's avatar
pixhawk committed
191
	return _MAV_RETURN_uint32_t(msg,  4);
192 193 194 195 196 197 198 199 200 201 202 203
}

/**
 * @brief Decode a fence_status message into a struct
 *
 * @param msg The message to decode
 * @param fence_status C-struct to decode the message contents into
 */
static inline void mavlink_msg_fence_status_decode(const mavlink_message_t* msg, mavlink_fence_status_t* fence_status)
{
#if MAVLINK_NEED_BYTE_SWAP
	fence_status->breach_status = mavlink_msg_fence_status_get_breach_status(msg);
pixhawk's avatar
pixhawk committed
204
	fence_status->breach_count = mavlink_msg_fence_status_get_breach_count(msg);
205
	fence_status->breach_type = mavlink_msg_fence_status_get_breach_type(msg);
pixhawk's avatar
pixhawk committed
206
	fence_status->breach_time = mavlink_msg_fence_status_get_breach_time(msg);
207 208 209 210
#else
	memcpy(fence_status, _MAV_PAYLOAD(msg), 8);
#endif
}