lib/main/MAVLink/common/mavlink_msg_fence_status.h

   1 #pragma once
   2 // MESSAGE FENCE_STATUS PACKING
   3
   4 #define MAVLINK_MSG_ID_FENCE_STATUS 162
   5
   6
   7 typedef struct __mavlink_fence_status_t {
   8  uint32_t breach_time; /*< [ms] Time (since boot) of last breach.*/
   9  uint16_t breach_count; /*<  Number of fence breaches.*/
  10  uint8_t breach_status; /*<  Breach status (0 if currently inside fence, 1 if outside).*/
  11  uint8_t breach_type; /*<  Last breach type.*/
  12  uint8_t breach_mitigation; /*<  Active action to prevent fence breach*/
  13 } mavlink_fence_status_t;
  14
  15 #define MAVLINK_MSG_ID_FENCE_STATUS_LEN 9
  16 #define MAVLINK_MSG_ID_FENCE_STATUS_MIN_LEN 8
  17 #define MAVLINK_MSG_ID_162_LEN 9
  18 #define MAVLINK_MSG_ID_162_MIN_LEN 8
  19
  20 #define MAVLINK_MSG_ID_FENCE_STATUS_CRC 189
  21 #define MAVLINK_MSG_ID_162_CRC 189
  22
  23
  24
  25 #if MAVLINK_COMMAND_24BIT
  26 #define MAVLINK_MESSAGE_INFO_FENCE_STATUS { \
  27     162, \
  28     "FENCE_STATUS", \
  29     5, \
  30     {  { "breach_status", NULL, MAVLINK_TYPE_UINT8_T, 0, 6, offsetof(mavlink_fence_status_t, breach_status) }, \
  31          { "breach_count", NULL, MAVLINK_TYPE_UINT16_T, 0, 4, offsetof(mavlink_fence_status_t, breach_count) }, \
  32          { "breach_type", NULL, MAVLINK_TYPE_UINT8_T, 0, 7, offsetof(mavlink_fence_status_t, breach_type) }, \
  33          { "breach_time", NULL, MAVLINK_TYPE_UINT32_T, 0, 0, offsetof(mavlink_fence_status_t, breach_time) }, \
  34          { "breach_mitigation", NULL, MAVLINK_TYPE_UINT8_T, 0, 8, offsetof(mavlink_fence_status_t, breach_mitigation) }, \
  35          } \
  36 }
  37 #else
  38 #define MAVLINK_MESSAGE_INFO_FENCE_STATUS { \
  39     "FENCE_STATUS", \
  40     5, \
  41     {  { "breach_status", NULL, MAVLINK_TYPE_UINT8_T, 0, 6, offsetof(mavlink_fence_status_t, breach_status) }, \
  42          { "breach_count", NULL, MAVLINK_TYPE_UINT16_T, 0, 4, offsetof(mavlink_fence_status_t, breach_count) }, \
  43          { "breach_type", NULL, MAVLINK_TYPE_UINT8_T, 0, 7, offsetof(mavlink_fence_status_t, breach_type) }, \
  44          { "breach_time", NULL, MAVLINK_TYPE_UINT32_T, 0, 0, offsetof(mavlink_fence_status_t, breach_time) }, \
  45          { "breach_mitigation", NULL, MAVLINK_TYPE_UINT8_T, 0, 8, offsetof(mavlink_fence_status_t, breach_mitigation) }, \
  46          } \
  47 }
  48 #endif
  49
  50 /**
  51  * @brief Pack a fence_status message
  52  * @param system_id ID of this system
  53  * @param component_id ID of this component (e.g. 200 for IMU)
  54  * @param msg The MAVLink message to compress the data into
  55  *
  56  * @param breach_status  Breach status (0 if currently inside fence, 1 if outside).
  57  * @param breach_count  Number of fence breaches.
  58  * @param breach_type  Last breach type.
  59  * @param breach_time [ms] Time (since boot) of last breach.
  60  * @param breach_mitigation  Active action to prevent fence breach
  61  * @return length of the message in bytes (excluding serial stream start sign)
  62  */
  63 static inline uint16_t mavlink_msg_fence_status_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg,
  64                                uint8_t breach_status, uint16_t breach_count, uint8_t breach_type, uint32_t breach_time, uint8_t breach_mitigation)
  65 {
  66 #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  67     char buf[MAVLINK_MSG_ID_FENCE_STATUS_LEN];
  68     _mav_put_uint32_t(buf, 0, breach_time);
  69     _mav_put_uint16_t(buf, 4, breach_count);
  70     _mav_put_uint8_t(buf, 6, breach_status);
  71     _mav_put_uint8_t(buf, 7, breach_type);
  72     _mav_put_uint8_t(buf, 8, breach_mitigation);
  73
  74         memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_FENCE_STATUS_LEN);
  75 #else
  76     mavlink_fence_status_t packet;
  77     packet.breach_time = breach_time;
  78     packet.breach_count = breach_count;
  79     packet.breach_status = breach_status;
  80     packet.breach_type = breach_type;
  81     packet.breach_mitigation = breach_mitigation;
  82
  83         memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_FENCE_STATUS_LEN);
  84 #endif
  85
  86     msg->msgid = MAVLINK_MSG_ID_FENCE_STATUS;
  87     return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_FENCE_STATUS_MIN_LEN, MAVLINK_MSG_ID_FENCE_STATUS_LEN, MAVLINK_MSG_ID_FENCE_STATUS_CRC);
  88 }
  89
  90 /**
  91  * @brief Pack a fence_status message on a channel
  92  * @param system_id ID of this system
  93  * @param component_id ID of this component (e.g. 200 for IMU)
  94  * @param chan The MAVLink channel this message will be sent over
  95  * @param msg The MAVLink message to compress the data into
  96  * @param breach_status  Breach status (0 if currently inside fence, 1 if outside).
  97  * @param breach_count  Number of fence breaches.
  98  * @param breach_type  Last breach type.
  99  * @param breach_time [ms] Time (since boot) of last breach.
 100  * @param breach_mitigation  Active action to prevent fence breach
 101  * @return length of the message in bytes (excluding serial stream start sign)
 102  */
 103 static inline uint16_t mavlink_msg_fence_status_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan,
 104                                mavlink_message_t* msg,
 105                                    uint8_t breach_status,uint16_t breach_count,uint8_t breach_type,uint32_t breach_time,uint8_t breach_mitigation)
 106 {
 107 #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
 108     char buf[MAVLINK_MSG_ID_FENCE_STATUS_LEN];
 109     _mav_put_uint32_t(buf, 0, breach_time);
 110     _mav_put_uint16_t(buf, 4, breach_count);
 111     _mav_put_uint8_t(buf, 6, breach_status);
 112     _mav_put_uint8_t(buf, 7, breach_type);
 113     _mav_put_uint8_t(buf, 8, breach_mitigation);
 114
 115         memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_FENCE_STATUS_LEN);
 116 #else
 117     mavlink_fence_status_t packet;
 118     packet.breach_time = breach_time;
 119     packet.breach_count = breach_count;
 120     packet.breach_status = breach_status;
 121     packet.breach_type = breach_type;
 122     packet.breach_mitigation = breach_mitigation;
 123
 124         memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_FENCE_STATUS_LEN);
 125 #endif
 126
 127     msg->msgid = MAVLINK_MSG_ID_FENCE_STATUS;
 128     return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_FENCE_STATUS_MIN_LEN, MAVLINK_MSG_ID_FENCE_STATUS_LEN, MAVLINK_MSG_ID_FENCE_STATUS_CRC);
 129 }
 130
 131 /**
 132  * @brief Encode a fence_status struct
 133  *
 134  * @param system_id ID of this system
 135  * @param component_id ID of this component (e.g. 200 for IMU)
 136  * @param msg The MAVLink message to compress the data into
 137  * @param fence_status C-struct to read the message contents from
 138  */
 139 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)
 140 {
 141     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, fence_status->breach_mitigation);
 142 }
 143
 144 /**
 145  * @brief Encode a fence_status struct on a channel
 146  *
 147  * @param system_id ID of this system
 148  * @param component_id ID of this component (e.g. 200 for IMU)
 149  * @param chan The MAVLink channel this message will be sent over
 150  * @param msg The MAVLink message to compress the data into
 151  * @param fence_status C-struct to read the message contents from
 152  */
 153 static inline uint16_t mavlink_msg_fence_status_encode_chan(uint8_t system_id, uint8_t component_id, uint8_t chan, mavlink_message_t* msg, const mavlink_fence_status_t* fence_status)
 154 {
 155     return mavlink_msg_fence_status_pack_chan(system_id, component_id, chan, msg, fence_status->breach_status, fence_status->breach_count, fence_status->breach_type, fence_status->breach_time, fence_status->breach_mitigation);
 156 }
 157
 158 /**
 159  * @brief Send a fence_status message
 160  * @param chan MAVLink channel to send the message
 161  *
 162  * @param breach_status  Breach status (0 if currently inside fence, 1 if outside).
 163  * @param breach_count  Number of fence breaches.
 164  * @param breach_type  Last breach type.
 165  * @param breach_time [ms] Time (since boot) of last breach.
 166  * @param breach_mitigation  Active action to prevent fence breach
 167  */
 168 #ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS
 169
 170 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, uint8_t breach_mitigation)
 171 {
 172 #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
 173     char buf[MAVLINK_MSG_ID_FENCE_STATUS_LEN];
 174     _mav_put_uint32_t(buf, 0, breach_time);
 175     _mav_put_uint16_t(buf, 4, breach_count);
 176     _mav_put_uint8_t(buf, 6, breach_status);
 177     _mav_put_uint8_t(buf, 7, breach_type);
 178     _mav_put_uint8_t(buf, 8, breach_mitigation);
 179
 180     _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_FENCE_STATUS, buf, MAVLINK_MSG_ID_FENCE_STATUS_MIN_LEN, MAVLINK_MSG_ID_FENCE_STATUS_LEN, MAVLINK_MSG_ID_FENCE_STATUS_CRC);
 181 #else
 182     mavlink_fence_status_t packet;
 183     packet.breach_time = breach_time;
 184     packet.breach_count = breach_count;
 185     packet.breach_status = breach_status;
 186     packet.breach_type = breach_type;
 187     packet.breach_mitigation = breach_mitigation;
 188
 189     _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_FENCE_STATUS, (const char *)&packet, MAVLINK_MSG_ID_FENCE_STATUS_MIN_LEN, MAVLINK_MSG_ID_FENCE_STATUS_LEN, MAVLINK_MSG_ID_FENCE_STATUS_CRC);
 190 #endif
 191 }
 192
 193 /**
 194  * @brief Send a fence_status message
 195  * @param chan MAVLink channel to send the message
 196  * @param struct The MAVLink struct to serialize
 197  */
 198 static inline void mavlink_msg_fence_status_send_struct(mavlink_channel_t chan, const mavlink_fence_status_t* fence_status)
 199 {
 200 #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
 201     mavlink_msg_fence_status_send(chan, fence_status->breach_status, fence_status->breach_count, fence_status->breach_type, fence_status->breach_time, fence_status->breach_mitigation);
 202 #else
 203     _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_FENCE_STATUS, (const char *)fence_status, MAVLINK_MSG_ID_FENCE_STATUS_MIN_LEN, MAVLINK_MSG_ID_FENCE_STATUS_LEN, MAVLINK_MSG_ID_FENCE_STATUS_CRC);
 204 #endif
 205 }
 206
 207 #if MAVLINK_MSG_ID_FENCE_STATUS_LEN <= MAVLINK_MAX_PAYLOAD_LEN
 208 /*
 209   This varient of _send() can be used to save stack space by re-using
 210   memory from the receive buffer.  The caller provides a
 211   mavlink_message_t which is the size of a full mavlink message. This
 212   is usually the receive buffer for the channel, and allows a reply to an
 213   incoming message with minimum stack space usage.
 214  */
 215 static inline void mavlink_msg_fence_status_send_buf(mavlink_message_t *msgbuf, mavlink_channel_t chan,  uint8_t breach_status, uint16_t breach_count, uint8_t breach_type, uint32_t breach_time, uint8_t breach_mitigation)
 216 {
 217 #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
 218     char *buf = (char *)msgbuf;
 219     _mav_put_uint32_t(buf, 0, breach_time);
 220     _mav_put_uint16_t(buf, 4, breach_count);
 221     _mav_put_uint8_t(buf, 6, breach_status);
 222     _mav_put_uint8_t(buf, 7, breach_type);
 223     _mav_put_uint8_t(buf, 8, breach_mitigation);
 224
 225     _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_FENCE_STATUS, buf, MAVLINK_MSG_ID_FENCE_STATUS_MIN_LEN, MAVLINK_MSG_ID_FENCE_STATUS_LEN, MAVLINK_MSG_ID_FENCE_STATUS_CRC);
 226 #else
 227     mavlink_fence_status_t *packet = (mavlink_fence_status_t *)msgbuf;
 228     packet->breach_time = breach_time;
 229     packet->breach_count = breach_count;
 230     packet->breach_status = breach_status;
 231     packet->breach_type = breach_type;
 232     packet->breach_mitigation = breach_mitigation;
 233
 234     _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_FENCE_STATUS, (const char *)packet, MAVLINK_MSG_ID_FENCE_STATUS_MIN_LEN, MAVLINK_MSG_ID_FENCE_STATUS_LEN, MAVLINK_MSG_ID_FENCE_STATUS_CRC);
 235 #endif
 236 }
 237 #endif
 238
 239 #endif
 240
 241 // MESSAGE FENCE_STATUS UNPACKING
 242
 243
 244 /**
 245  * @brief Get field breach_status from fence_status message
 246  *
 247  * @return  Breach status (0 if currently inside fence, 1 if outside).
 248  */
 249 static inline uint8_t mavlink_msg_fence_status_get_breach_status(const mavlink_message_t* msg)
 250 {
 251     return _MAV_RETURN_uint8_t(msg,  6);
 252 }
 253
 254 /**
 255  * @brief Get field breach_count from fence_status message
 256  *
 257  * @return  Number of fence breaches.
 258  */
 259 static inline uint16_t mavlink_msg_fence_status_get_breach_count(const mavlink_message_t* msg)
 260 {
 261     return _MAV_RETURN_uint16_t(msg,  4);
 262 }
 263
 264 /**
 265  * @brief Get field breach_type from fence_status message
 266  *
 267  * @return  Last breach type.
 268  */
 269 static inline uint8_t mavlink_msg_fence_status_get_breach_type(const mavlink_message_t* msg)
 270 {
 271     return _MAV_RETURN_uint8_t(msg,  7);
 272 }
 273
 274 /**
 275  * @brief Get field breach_time from fence_status message
 276  *
 277  * @return [ms] Time (since boot) of last breach.
 278  */
 279 static inline uint32_t mavlink_msg_fence_status_get_breach_time(const mavlink_message_t* msg)
 280 {
 281     return _MAV_RETURN_uint32_t(msg,  0);
 282 }
 283
 284 /**
 285  * @brief Get field breach_mitigation from fence_status message
 286  *
 287  * @return  Active action to prevent fence breach
 288  */
 289 static inline uint8_t mavlink_msg_fence_status_get_breach_mitigation(const mavlink_message_t* msg)
 290 {
 291     return _MAV_RETURN_uint8_t(msg,  8);
 292 }
 293
 294 /**
 295  * @brief Decode a fence_status message into a struct
 296  *
 297  * @param msg The message to decode
 298  * @param fence_status C-struct to decode the message contents into
 299  */
 300 static inline void mavlink_msg_fence_status_decode(const mavlink_message_t* msg, mavlink_fence_status_t* fence_status)
 301 {
 302 #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
 303     fence_status->breach_time = mavlink_msg_fence_status_get_breach_time(msg);
 304     fence_status->breach_count = mavlink_msg_fence_status_get_breach_count(msg);
 305     fence_status->breach_status = mavlink_msg_fence_status_get_breach_status(msg);
 306     fence_status->breach_type = mavlink_msg_fence_status_get_breach_type(msg);
 307     fence_status->breach_mitigation = mavlink_msg_fence_status_get_breach_mitigation(msg);
 308 #else
 309         uint8_t len = msg->len < MAVLINK_MSG_ID_FENCE_STATUS_LEN? msg->len : MAVLINK_MSG_ID_FENCE_STATUS_LEN;
 310         memset(fence_status, 0, MAVLINK_MSG_ID_FENCE_STATUS_LEN);
 311     memcpy(fence_status, _MAV_PAYLOAD(msg), len);
 312 #endif
 313 }