mavlink_msg_pattern_detected.h 6.42 KB
Newer Older
James Goppert's avatar
James Goppert committed
1 2
// MESSAGE PATTERN_DETECTED PACKING

lm's avatar
lm committed
3
#define MAVLINK_MSG_ID_PATTERN_DETECTED 190
James Goppert's avatar
James Goppert committed
4

lm's avatar
lm committed
5
typedef struct __mavlink_pattern_detected_t
James Goppert's avatar
James Goppert committed
6
{
lm's avatar
lm committed
7 8 9 10
 float confidence; ///< Confidence of detection
 uint8_t type; ///< 0: Pattern, 1: Letter
 char file[100]; ///< Pattern file name
 uint8_t detected; ///< Accepted as true detection, 0 no, 1 yes
James Goppert's avatar
James Goppert committed
11
} mavlink_pattern_detected_t;
lm's avatar
lm committed
12 13 14 15

#define MAVLINK_MSG_ID_PATTERN_DETECTED_LEN 106
#define MAVLINK_MSG_ID_190_LEN 106

James Goppert's avatar
James Goppert committed
16 17
#define MAVLINK_MSG_PATTERN_DETECTED_FIELD_FILE_LEN 100

lm's avatar
lm committed
18 19 20 21 22 23 24 25 26 27 28
#define MAVLINK_MESSAGE_INFO_PATTERN_DETECTED { \
	"PATTERN_DETECTED", \
	4, \
	{  { "confidence", MAVLINK_TYPE_FLOAT, 0, 0, offsetof(mavlink_pattern_detected_t, confidence) }, \
         { "type", MAVLINK_TYPE_UINT8_T, 0, 4, offsetof(mavlink_pattern_detected_t, type) }, \
         { "file", MAVLINK_TYPE_CHAR, 100, 5, offsetof(mavlink_pattern_detected_t, file) }, \
         { "detected", MAVLINK_TYPE_UINT8_T, 0, 105, offsetof(mavlink_pattern_detected_t, detected) }, \
         } \
}


James Goppert's avatar
James Goppert committed
29 30 31 32 33 34 35 36 37 38 39 40
/**
 * @brief Pack a pattern_detected 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 0: Pattern, 1: Letter
 * @param confidence Confidence of detection
 * @param file Pattern file name
 * @param detected Accepted as true detection, 0 no, 1 yes
 * @return length of the message in bytes (excluding serial stream start sign)
 */
lm's avatar
lm committed
41 42
static inline uint16_t mavlink_msg_pattern_detected_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg,
						       uint8_t type, float confidence, const char *file, uint8_t detected)
James Goppert's avatar
James Goppert committed
43 44 45
{
	msg->msgid = MAVLINK_MSG_ID_PATTERN_DETECTED;

lm's avatar
lm committed
46 47 48 49
	put_float_by_index(msg, 0, confidence); // Confidence of detection
	put_uint8_t_by_index(msg, 4, type); // 0: Pattern, 1: Letter
	put_char_array_by_index(msg, 5, file, 100); // Pattern file name
	put_uint8_t_by_index(msg, 105, detected); // Accepted as true detection, 0 no, 1 yes
James Goppert's avatar
James Goppert committed
50

lm's avatar
lm committed
51
	return mavlink_finalize_message(msg, system_id, component_id, 106, 90);
James Goppert's avatar
James Goppert committed
52 53 54
}

/**
lm's avatar
lm committed
55
 * @brief Pack a pattern_detected message on a channel
James Goppert's avatar
James Goppert committed
56 57 58 59 60 61 62 63 64 65
 * @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 0: Pattern, 1: Letter
 * @param confidence Confidence of detection
 * @param file Pattern file name
 * @param detected Accepted as true detection, 0 no, 1 yes
 * @return length of the message in bytes (excluding serial stream start sign)
 */
lm's avatar
lm committed
66 67 68 69 70 71 72 73 74 75 76 77 78 79
static inline uint16_t mavlink_msg_pattern_detected_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan,
							   mavlink_message_t* msg,
						           uint8_t type,float confidence,const char *file,uint8_t detected)
{
	msg->msgid = MAVLINK_MSG_ID_PATTERN_DETECTED;

	put_float_by_index(msg, 0, confidence); // Confidence of detection
	put_uint8_t_by_index(msg, 4, type); // 0: Pattern, 1: Letter
	put_char_array_by_index(msg, 5, file, 100); // Pattern file name
	put_uint8_t_by_index(msg, 105, detected); // Accepted as true detection, 0 no, 1 yes

	return mavlink_finalize_message_chan(msg, system_id, component_id, chan, 106, 90);
}

James Goppert's avatar
James Goppert committed
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101
/**
 * @brief Encode a pattern_detected 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 pattern_detected C-struct to read the message contents from
 */
static inline uint16_t mavlink_msg_pattern_detected_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_pattern_detected_t* pattern_detected)
{
	return mavlink_msg_pattern_detected_pack(system_id, component_id, msg, pattern_detected->type, pattern_detected->confidence, pattern_detected->file, pattern_detected->detected);
}

/**
 * @brief Send a pattern_detected message
 * @param chan MAVLink channel to send the message
 *
 * @param type 0: Pattern, 1: Letter
 * @param confidence Confidence of detection
 * @param file Pattern file name
 * @param detected Accepted as true detection, 0 no, 1 yes
 */
lm's avatar
lm committed
102 103 104
#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS

static inline void mavlink_msg_pattern_detected_send(mavlink_channel_t chan, uint8_t type, float confidence, const char *file, uint8_t detected)
lm's avatar
lm committed
105
{
lm's avatar
lm committed
106
	MAVLINK_ALIGNED_MESSAGE(msg, 106);
LM's avatar
LM committed
107 108 109 110 111 112 113 114
	msg->msgid = MAVLINK_MSG_ID_PATTERN_DETECTED;

	put_float_by_index(msg, 0, confidence); // Confidence of detection
	put_uint8_t_by_index(msg, 4, type); // 0: Pattern, 1: Letter
	put_char_array_by_index(msg, 5, file, 100); // Pattern file name
	put_uint8_t_by_index(msg, 105, detected); // Accepted as true detection, 0 no, 1 yes

	mavlink_finalize_message_chan_send(msg, chan, 106, 90);
James Goppert's avatar
James Goppert committed
115 116 117
}

#endif
lm's avatar
lm committed
118

James Goppert's avatar
James Goppert committed
119 120
// MESSAGE PATTERN_DETECTED UNPACKING

lm's avatar
lm committed
121

James Goppert's avatar
James Goppert committed
122 123 124 125 126 127 128
/**
 * @brief Get field type from pattern_detected message
 *
 * @return 0: Pattern, 1: Letter
 */
static inline uint8_t mavlink_msg_pattern_detected_get_type(const mavlink_message_t* msg)
{
lm's avatar
lm committed
129
	return MAVLINK_MSG_RETURN_uint8_t(msg,  4);
James Goppert's avatar
James Goppert committed
130 131 132 133 134 135 136 137 138
}

/**
 * @brief Get field confidence from pattern_detected message
 *
 * @return Confidence of detection
 */
static inline float mavlink_msg_pattern_detected_get_confidence(const mavlink_message_t* msg)
{
lm's avatar
lm committed
139
	return MAVLINK_MSG_RETURN_float(msg,  0);
James Goppert's avatar
James Goppert committed
140 141 142 143 144 145 146
}

/**
 * @brief Get field file from pattern_detected message
 *
 * @return Pattern file name
 */
lm's avatar
lm committed
147
static inline uint16_t mavlink_msg_pattern_detected_get_file(const mavlink_message_t* msg, char *file)
James Goppert's avatar
James Goppert committed
148
{
lm's avatar
lm committed
149
	return MAVLINK_MSG_RETURN_char_array(msg, file, 100,  5);
James Goppert's avatar
James Goppert committed
150 151 152 153 154 155 156 157 158
}

/**
 * @brief Get field detected from pattern_detected message
 *
 * @return Accepted as true detection, 0 no, 1 yes
 */
static inline uint8_t mavlink_msg_pattern_detected_get_detected(const mavlink_message_t* msg)
{
lm's avatar
lm committed
159
	return MAVLINK_MSG_RETURN_uint8_t(msg,  105);
James Goppert's avatar
James Goppert committed
160 161 162 163 164 165 166 167 168 169
}

/**
 * @brief Decode a pattern_detected message into a struct
 *
 * @param msg The message to decode
 * @param pattern_detected C-struct to decode the message contents into
 */
static inline void mavlink_msg_pattern_detected_decode(const mavlink_message_t* msg, mavlink_pattern_detected_t* pattern_detected)
{
lm's avatar
lm committed
170 171 172 173 174 175 176 177
#if MAVLINK_NEED_BYTE_SWAP
	pattern_detected->confidence = mavlink_msg_pattern_detected_get_confidence(msg);
	pattern_detected->type = mavlink_msg_pattern_detected_get_type(msg);
	mavlink_msg_pattern_detected_get_file(msg, pattern_detected->file);
	pattern_detected->detected = mavlink_msg_pattern_detected_get_detected(msg);
#else
	memcpy(pattern_detected, MAVLINK_PAYLOAD(msg), 106);
#endif
James Goppert's avatar
James Goppert committed
178
}