lib/main/MAVLink/common/mavlink_msg_open_drone_id_self_id.h

   1 #pragma once
   2 // MESSAGE OPEN_DRONE_ID_SELF_ID PACKING
   3
   4 #define MAVLINK_MSG_ID_OPEN_DRONE_ID_SELF_ID 12903
   5
   6
   7 typedef struct __mavlink_open_drone_id_self_id_t {
   8  uint8_t target_system; /*<  System ID (0 for broadcast).*/
   9  uint8_t target_component; /*<  Component ID (0 for broadcast).*/
  10  uint8_t id_or_mac[20]; /*<  Only used for drone ID data received from other UAs. See detailed description at https://mavlink.io/en/services/opendroneid.html. */
  11  uint8_t description_type; /*<  Indicates the type of the description field.*/
  12  char description[23]; /*<  Text description or numeric value expressed as ASCII characters. Shall be filled with nulls in the unused portion of the field.*/
  13 } mavlink_open_drone_id_self_id_t;
  14
  15 #define MAVLINK_MSG_ID_OPEN_DRONE_ID_SELF_ID_LEN 46
  16 #define MAVLINK_MSG_ID_OPEN_DRONE_ID_SELF_ID_MIN_LEN 46
  17 #define MAVLINK_MSG_ID_12903_LEN 46
  18 #define MAVLINK_MSG_ID_12903_MIN_LEN 46
  19
  20 #define MAVLINK_MSG_ID_OPEN_DRONE_ID_SELF_ID_CRC 249
  21 #define MAVLINK_MSG_ID_12903_CRC 249
  22
  23 #define MAVLINK_MSG_OPEN_DRONE_ID_SELF_ID_FIELD_ID_OR_MAC_LEN 20
  24 #define MAVLINK_MSG_OPEN_DRONE_ID_SELF_ID_FIELD_DESCRIPTION_LEN 23
  25
  26 #if MAVLINK_COMMAND_24BIT
  27 #define MAVLINK_MESSAGE_INFO_OPEN_DRONE_ID_SELF_ID { \
  28     12903, \
  29     "OPEN_DRONE_ID_SELF_ID", \
  30     5, \
  31     {  { "target_system", NULL, MAVLINK_TYPE_UINT8_T, 0, 0, offsetof(mavlink_open_drone_id_self_id_t, target_system) }, \
  32          { "target_component", NULL, MAVLINK_TYPE_UINT8_T, 0, 1, offsetof(mavlink_open_drone_id_self_id_t, target_component) }, \
  33          { "id_or_mac", NULL, MAVLINK_TYPE_UINT8_T, 20, 2, offsetof(mavlink_open_drone_id_self_id_t, id_or_mac) }, \
  34          { "description_type", NULL, MAVLINK_TYPE_UINT8_T, 0, 22, offsetof(mavlink_open_drone_id_self_id_t, description_type) }, \
  35          { "description", NULL, MAVLINK_TYPE_CHAR, 23, 23, offsetof(mavlink_open_drone_id_self_id_t, description) }, \
  36          } \
  37 }
  38 #else
  39 #define MAVLINK_MESSAGE_INFO_OPEN_DRONE_ID_SELF_ID { \
  40     "OPEN_DRONE_ID_SELF_ID", \
  41     5, \
  42     {  { "target_system", NULL, MAVLINK_TYPE_UINT8_T, 0, 0, offsetof(mavlink_open_drone_id_self_id_t, target_system) }, \
  43          { "target_component", NULL, MAVLINK_TYPE_UINT8_T, 0, 1, offsetof(mavlink_open_drone_id_self_id_t, target_component) }, \
  44          { "id_or_mac", NULL, MAVLINK_TYPE_UINT8_T, 20, 2, offsetof(mavlink_open_drone_id_self_id_t, id_or_mac) }, \
  45          { "description_type", NULL, MAVLINK_TYPE_UINT8_T, 0, 22, offsetof(mavlink_open_drone_id_self_id_t, description_type) }, \
  46          { "description", NULL, MAVLINK_TYPE_CHAR, 23, 23, offsetof(mavlink_open_drone_id_self_id_t, description) }, \
  47          } \
  48 }
  49 #endif
  50
  51 /**
  52  * @brief Pack a open_drone_id_self_id message
  53  * @param system_id ID of this system
  54  * @param component_id ID of this component (e.g. 200 for IMU)
  55  * @param msg The MAVLink message to compress the data into
  56  *
  57  * @param target_system  System ID (0 for broadcast).
  58  * @param target_component  Component ID (0 for broadcast).
  59  * @param id_or_mac  Only used for drone ID data received from other UAs. See detailed description at https://mavlink.io/en/services/opendroneid.html.
  60  * @param description_type  Indicates the type of the description field.
  61  * @param description  Text description or numeric value expressed as ASCII characters. Shall be filled with nulls in the unused portion of the field.
  62  * @return length of the message in bytes (excluding serial stream start sign)
  63  */
  64 static inline uint16_t mavlink_msg_open_drone_id_self_id_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg,
  65                                uint8_t target_system, uint8_t target_component, const uint8_t *id_or_mac, uint8_t description_type, const char *description)
  66 {
  67 #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  68     char buf[MAVLINK_MSG_ID_OPEN_DRONE_ID_SELF_ID_LEN];
  69     _mav_put_uint8_t(buf, 0, target_system);
  70     _mav_put_uint8_t(buf, 1, target_component);
  71     _mav_put_uint8_t(buf, 22, description_type);
  72     _mav_put_uint8_t_array(buf, 2, id_or_mac, 20);
  73     _mav_put_char_array(buf, 23, description, 23);
  74         memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_OPEN_DRONE_ID_SELF_ID_LEN);
  75 #else
  76     mavlink_open_drone_id_self_id_t packet;
  77     packet.target_system = target_system;
  78     packet.target_component = target_component;
  79     packet.description_type = description_type;
  80     mav_array_memcpy(packet.id_or_mac, id_or_mac, sizeof(uint8_t)*20);
  81     mav_array_memcpy(packet.description, description, sizeof(char)*23);
  82         memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_OPEN_DRONE_ID_SELF_ID_LEN);
  83 #endif
  84
  85     msg->msgid = MAVLINK_MSG_ID_OPEN_DRONE_ID_SELF_ID;
  86     return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_OPEN_DRONE_ID_SELF_ID_MIN_LEN, MAVLINK_MSG_ID_OPEN_DRONE_ID_SELF_ID_LEN, MAVLINK_MSG_ID_OPEN_DRONE_ID_SELF_ID_CRC);
  87 }
  88
  89 /**
  90  * @brief Pack a open_drone_id_self_id message on a channel
  91  * @param system_id ID of this system
  92  * @param component_id ID of this component (e.g. 200 for IMU)
  93  * @param chan The MAVLink channel this message will be sent over
  94  * @param msg The MAVLink message to compress the data into
  95  * @param target_system  System ID (0 for broadcast).
  96  * @param target_component  Component ID (0 for broadcast).
  97  * @param id_or_mac  Only used for drone ID data received from other UAs. See detailed description at https://mavlink.io/en/services/opendroneid.html.
  98  * @param description_type  Indicates the type of the description field.
  99  * @param description  Text description or numeric value expressed as ASCII characters. Shall be filled with nulls in the unused portion of the field.
 100  * @return length of the message in bytes (excluding serial stream start sign)
 101  */
 102 static inline uint16_t mavlink_msg_open_drone_id_self_id_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan,
 103                                mavlink_message_t* msg,
 104                                    uint8_t target_system,uint8_t target_component,const uint8_t *id_or_mac,uint8_t description_type,const char *description)
 105 {
 106 #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
 107     char buf[MAVLINK_MSG_ID_OPEN_DRONE_ID_SELF_ID_LEN];
 108     _mav_put_uint8_t(buf, 0, target_system);
 109     _mav_put_uint8_t(buf, 1, target_component);
 110     _mav_put_uint8_t(buf, 22, description_type);
 111     _mav_put_uint8_t_array(buf, 2, id_or_mac, 20);
 112     _mav_put_char_array(buf, 23, description, 23);
 113         memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_OPEN_DRONE_ID_SELF_ID_LEN);
 114 #else
 115     mavlink_open_drone_id_self_id_t packet;
 116     packet.target_system = target_system;
 117     packet.target_component = target_component;
 118     packet.description_type = description_type;
 119     mav_array_memcpy(packet.id_or_mac, id_or_mac, sizeof(uint8_t)*20);
 120     mav_array_memcpy(packet.description, description, sizeof(char)*23);
 121         memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_OPEN_DRONE_ID_SELF_ID_LEN);
 122 #endif
 123
 124     msg->msgid = MAVLINK_MSG_ID_OPEN_DRONE_ID_SELF_ID;
 125     return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_OPEN_DRONE_ID_SELF_ID_MIN_LEN, MAVLINK_MSG_ID_OPEN_DRONE_ID_SELF_ID_LEN, MAVLINK_MSG_ID_OPEN_DRONE_ID_SELF_ID_CRC);
 126 }
 127
 128 /**
 129  * @brief Encode a open_drone_id_self_id struct
 130  *
 131  * @param system_id ID of this system
 132  * @param component_id ID of this component (e.g. 200 for IMU)
 133  * @param msg The MAVLink message to compress the data into
 134  * @param open_drone_id_self_id C-struct to read the message contents from
 135  */
 136 static inline uint16_t mavlink_msg_open_drone_id_self_id_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_open_drone_id_self_id_t* open_drone_id_self_id)
 137 {
 138     return mavlink_msg_open_drone_id_self_id_pack(system_id, component_id, msg, open_drone_id_self_id->target_system, open_drone_id_self_id->target_component, open_drone_id_self_id->id_or_mac, open_drone_id_self_id->description_type, open_drone_id_self_id->description);
 139 }
 140
 141 /**
 142  * @brief Encode a open_drone_id_self_id struct on a channel
 143  *
 144  * @param system_id ID of this system
 145  * @param component_id ID of this component (e.g. 200 for IMU)
 146  * @param chan The MAVLink channel this message will be sent over
 147  * @param msg The MAVLink message to compress the data into
 148  * @param open_drone_id_self_id C-struct to read the message contents from
 149  */
 150 static inline uint16_t mavlink_msg_open_drone_id_self_id_encode_chan(uint8_t system_id, uint8_t component_id, uint8_t chan, mavlink_message_t* msg, const mavlink_open_drone_id_self_id_t* open_drone_id_self_id)
 151 {
 152     return mavlink_msg_open_drone_id_self_id_pack_chan(system_id, component_id, chan, msg, open_drone_id_self_id->target_system, open_drone_id_self_id->target_component, open_drone_id_self_id->id_or_mac, open_drone_id_self_id->description_type, open_drone_id_self_id->description);
 153 }
 154
 155 /**
 156  * @brief Send a open_drone_id_self_id message
 157  * @param chan MAVLink channel to send the message
 158  *
 159  * @param target_system  System ID (0 for broadcast).
 160  * @param target_component  Component ID (0 for broadcast).
 161  * @param id_or_mac  Only used for drone ID data received from other UAs. See detailed description at https://mavlink.io/en/services/opendroneid.html.
 162  * @param description_type  Indicates the type of the description field.
 163  * @param description  Text description or numeric value expressed as ASCII characters. Shall be filled with nulls in the unused portion of the field.
 164  */
 165 #ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS
 166
 167 static inline void mavlink_msg_open_drone_id_self_id_send(mavlink_channel_t chan, uint8_t target_system, uint8_t target_component, const uint8_t *id_or_mac, uint8_t description_type, const char *description)
 168 {
 169 #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
 170     char buf[MAVLINK_MSG_ID_OPEN_DRONE_ID_SELF_ID_LEN];
 171     _mav_put_uint8_t(buf, 0, target_system);
 172     _mav_put_uint8_t(buf, 1, target_component);
 173     _mav_put_uint8_t(buf, 22, description_type);
 174     _mav_put_uint8_t_array(buf, 2, id_or_mac, 20);
 175     _mav_put_char_array(buf, 23, description, 23);
 176     _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_OPEN_DRONE_ID_SELF_ID, buf, MAVLINK_MSG_ID_OPEN_DRONE_ID_SELF_ID_MIN_LEN, MAVLINK_MSG_ID_OPEN_DRONE_ID_SELF_ID_LEN, MAVLINK_MSG_ID_OPEN_DRONE_ID_SELF_ID_CRC);
 177 #else
 178     mavlink_open_drone_id_self_id_t packet;
 179     packet.target_system = target_system;
 180     packet.target_component = target_component;
 181     packet.description_type = description_type;
 182     mav_array_memcpy(packet.id_or_mac, id_or_mac, sizeof(uint8_t)*20);
 183     mav_array_memcpy(packet.description, description, sizeof(char)*23);
 184     _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_OPEN_DRONE_ID_SELF_ID, (const char *)&packet, MAVLINK_MSG_ID_OPEN_DRONE_ID_SELF_ID_MIN_LEN, MAVLINK_MSG_ID_OPEN_DRONE_ID_SELF_ID_LEN, MAVLINK_MSG_ID_OPEN_DRONE_ID_SELF_ID_CRC);
 185 #endif
 186 }
 187
 188 /**
 189  * @brief Send a open_drone_id_self_id message
 190  * @param chan MAVLink channel to send the message
 191  * @param struct The MAVLink struct to serialize
 192  */
 193 static inline void mavlink_msg_open_drone_id_self_id_send_struct(mavlink_channel_t chan, const mavlink_open_drone_id_self_id_t* open_drone_id_self_id)
 194 {
 195 #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
 196     mavlink_msg_open_drone_id_self_id_send(chan, open_drone_id_self_id->target_system, open_drone_id_self_id->target_component, open_drone_id_self_id->id_or_mac, open_drone_id_self_id->description_type, open_drone_id_self_id->description);
 197 #else
 198     _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_OPEN_DRONE_ID_SELF_ID, (const char *)open_drone_id_self_id, MAVLINK_MSG_ID_OPEN_DRONE_ID_SELF_ID_MIN_LEN, MAVLINK_MSG_ID_OPEN_DRONE_ID_SELF_ID_LEN, MAVLINK_MSG_ID_OPEN_DRONE_ID_SELF_ID_CRC);
 199 #endif
 200 }
 201
 202 #if MAVLINK_MSG_ID_OPEN_DRONE_ID_SELF_ID_LEN <= MAVLINK_MAX_PAYLOAD_LEN
 203 /*
 204   This varient of _send() can be used to save stack space by re-using
 205   memory from the receive buffer.  The caller provides a
 206   mavlink_message_t which is the size of a full mavlink message. This
 207   is usually the receive buffer for the channel, and allows a reply to an
 208   incoming message with minimum stack space usage.
 209  */
 210 static inline void mavlink_msg_open_drone_id_self_id_send_buf(mavlink_message_t *msgbuf, mavlink_channel_t chan,  uint8_t target_system, uint8_t target_component, const uint8_t *id_or_mac, uint8_t description_type, const char *description)
 211 {
 212 #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
 213     char *buf = (char *)msgbuf;
 214     _mav_put_uint8_t(buf, 0, target_system);
 215     _mav_put_uint8_t(buf, 1, target_component);
 216     _mav_put_uint8_t(buf, 22, description_type);
 217     _mav_put_uint8_t_array(buf, 2, id_or_mac, 20);
 218     _mav_put_char_array(buf, 23, description, 23);
 219     _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_OPEN_DRONE_ID_SELF_ID, buf, MAVLINK_MSG_ID_OPEN_DRONE_ID_SELF_ID_MIN_LEN, MAVLINK_MSG_ID_OPEN_DRONE_ID_SELF_ID_LEN, MAVLINK_MSG_ID_OPEN_DRONE_ID_SELF_ID_CRC);
 220 #else
 221     mavlink_open_drone_id_self_id_t *packet = (mavlink_open_drone_id_self_id_t *)msgbuf;
 222     packet->target_system = target_system;
 223     packet->target_component = target_component;
 224     packet->description_type = description_type;
 225     mav_array_memcpy(packet->id_or_mac, id_or_mac, sizeof(uint8_t)*20);
 226     mav_array_memcpy(packet->description, description, sizeof(char)*23);
 227     _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_OPEN_DRONE_ID_SELF_ID, (const char *)packet, MAVLINK_MSG_ID_OPEN_DRONE_ID_SELF_ID_MIN_LEN, MAVLINK_MSG_ID_OPEN_DRONE_ID_SELF_ID_LEN, MAVLINK_MSG_ID_OPEN_DRONE_ID_SELF_ID_CRC);
 228 #endif
 229 }
 230 #endif
 231
 232 #endif
 233
 234 // MESSAGE OPEN_DRONE_ID_SELF_ID UNPACKING
 235
 236
 237 /**
 238  * @brief Get field target_system from open_drone_id_self_id message
 239  *
 240  * @return  System ID (0 for broadcast).
 241  */
 242 static inline uint8_t mavlink_msg_open_drone_id_self_id_get_target_system(const mavlink_message_t* msg)
 243 {
 244     return _MAV_RETURN_uint8_t(msg,  0);
 245 }
 246
 247 /**
 248  * @brief Get field target_component from open_drone_id_self_id message
 249  *
 250  * @return  Component ID (0 for broadcast).
 251  */
 252 static inline uint8_t mavlink_msg_open_drone_id_self_id_get_target_component(const mavlink_message_t* msg)
 253 {
 254     return _MAV_RETURN_uint8_t(msg,  1);
 255 }
 256
 257 /**
 258  * @brief Get field id_or_mac from open_drone_id_self_id message
 259  *
 260  * @return  Only used for drone ID data received from other UAs. See detailed description at https://mavlink.io/en/services/opendroneid.html.
 261  */
 262 static inline uint16_t mavlink_msg_open_drone_id_self_id_get_id_or_mac(const mavlink_message_t* msg, uint8_t *id_or_mac)
 263 {
 264     return _MAV_RETURN_uint8_t_array(msg, id_or_mac, 20,  2);
 265 }
 266
 267 /**
 268  * @brief Get field description_type from open_drone_id_self_id message
 269  *
 270  * @return  Indicates the type of the description field.
 271  */
 272 static inline uint8_t mavlink_msg_open_drone_id_self_id_get_description_type(const mavlink_message_t* msg)
 273 {
 274     return _MAV_RETURN_uint8_t(msg,  22);
 275 }
 276
 277 /**
 278  * @brief Get field description from open_drone_id_self_id message
 279  *
 280  * @return  Text description or numeric value expressed as ASCII characters. Shall be filled with nulls in the unused portion of the field.
 281  */
 282 static inline uint16_t mavlink_msg_open_drone_id_self_id_get_description(const mavlink_message_t* msg, char *description)
 283 {
 284     return _MAV_RETURN_char_array(msg, description, 23,  23);
 285 }
 286
 287 /**
 288  * @brief Decode a open_drone_id_self_id message into a struct
 289  *
 290  * @param msg The message to decode
 291  * @param open_drone_id_self_id C-struct to decode the message contents into
 292  */
 293 static inline void mavlink_msg_open_drone_id_self_id_decode(const mavlink_message_t* msg, mavlink_open_drone_id_self_id_t* open_drone_id_self_id)
 294 {
 295 #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
 296     open_drone_id_self_id->target_system = mavlink_msg_open_drone_id_self_id_get_target_system(msg);
 297     open_drone_id_self_id->target_component = mavlink_msg_open_drone_id_self_id_get_target_component(msg);
 298     mavlink_msg_open_drone_id_self_id_get_id_or_mac(msg, open_drone_id_self_id->id_or_mac);
 299     open_drone_id_self_id->description_type = mavlink_msg_open_drone_id_self_id_get_description_type(msg);
 300     mavlink_msg_open_drone_id_self_id_get_description(msg, open_drone_id_self_id->description);
 301 #else
 302         uint8_t len = msg->len < MAVLINK_MSG_ID_OPEN_DRONE_ID_SELF_ID_LEN? msg->len : MAVLINK_MSG_ID_OPEN_DRONE_ID_SELF_ID_LEN;
 303         memset(open_drone_id_self_id, 0, MAVLINK_MSG_ID_OPEN_DRONE_ID_SELF_ID_LEN);
 304     memcpy(open_drone_id_self_id, _MAV_PAYLOAD(msg), len);
 305 #endif
 306 }