lib/main/MAVLink/common/mavlink_msg_param_ext_value.h

   1 #pragma once
   2 // MESSAGE PARAM_EXT_VALUE PACKING
   3
   4 #define MAVLINK_MSG_ID_PARAM_EXT_VALUE 322
   5
   6
   7 typedef struct __mavlink_param_ext_value_t {
   8  uint16_t param_count; /*<  Total number of parameters*/
   9  uint16_t param_index; /*<  Index of this parameter*/
  10  char param_id[16]; /*<  Parameter id, terminated by NULL if the length is less than 16 human-readable chars and WITHOUT null termination (NULL) byte if the length is exactly 16 chars - applications have to provide 16+1 bytes storage if the ID is stored as string*/
  11  char param_value[128]; /*<  Parameter value*/
  12  uint8_t param_type; /*<  Parameter type.*/
  13 } mavlink_param_ext_value_t;
  14
  15 #define MAVLINK_MSG_ID_PARAM_EXT_VALUE_LEN 149
  16 #define MAVLINK_MSG_ID_PARAM_EXT_VALUE_MIN_LEN 149
  17 #define MAVLINK_MSG_ID_322_LEN 149
  18 #define MAVLINK_MSG_ID_322_MIN_LEN 149
  19
  20 #define MAVLINK_MSG_ID_PARAM_EXT_VALUE_CRC 243
  21 #define MAVLINK_MSG_ID_322_CRC 243
  22
  23 #define MAVLINK_MSG_PARAM_EXT_VALUE_FIELD_PARAM_ID_LEN 16
  24 #define MAVLINK_MSG_PARAM_EXT_VALUE_FIELD_PARAM_VALUE_LEN 128
  25
  26 #if MAVLINK_COMMAND_24BIT
  27 #define MAVLINK_MESSAGE_INFO_PARAM_EXT_VALUE { \
  28     322, \
  29     "PARAM_EXT_VALUE", \
  30     5, \
  31     {  { "param_id", NULL, MAVLINK_TYPE_CHAR, 16, 4, offsetof(mavlink_param_ext_value_t, param_id) }, \
  32          { "param_value", NULL, MAVLINK_TYPE_CHAR, 128, 20, offsetof(mavlink_param_ext_value_t, param_value) }, \
  33          { "param_type", NULL, MAVLINK_TYPE_UINT8_T, 0, 148, offsetof(mavlink_param_ext_value_t, param_type) }, \
  34          { "param_count", NULL, MAVLINK_TYPE_UINT16_T, 0, 0, offsetof(mavlink_param_ext_value_t, param_count) }, \
  35          { "param_index", NULL, MAVLINK_TYPE_UINT16_T, 0, 2, offsetof(mavlink_param_ext_value_t, param_index) }, \
  36          } \
  37 }
  38 #else
  39 #define MAVLINK_MESSAGE_INFO_PARAM_EXT_VALUE { \
  40     "PARAM_EXT_VALUE", \
  41     5, \
  42     {  { "param_id", NULL, MAVLINK_TYPE_CHAR, 16, 4, offsetof(mavlink_param_ext_value_t, param_id) }, \
  43          { "param_value", NULL, MAVLINK_TYPE_CHAR, 128, 20, offsetof(mavlink_param_ext_value_t, param_value) }, \
  44          { "param_type", NULL, MAVLINK_TYPE_UINT8_T, 0, 148, offsetof(mavlink_param_ext_value_t, param_type) }, \
  45          { "param_count", NULL, MAVLINK_TYPE_UINT16_T, 0, 0, offsetof(mavlink_param_ext_value_t, param_count) }, \
  46          { "param_index", NULL, MAVLINK_TYPE_UINT16_T, 0, 2, offsetof(mavlink_param_ext_value_t, param_index) }, \
  47          } \
  48 }
  49 #endif
  50
  51 /**
  52  * @brief Pack a param_ext_value 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 param_id  Parameter id, terminated by NULL if the length is less than 16 human-readable chars and WITHOUT null termination (NULL) byte if the length is exactly 16 chars - applications have to provide 16+1 bytes storage if the ID is stored as string
  58  * @param param_value  Parameter value
  59  * @param param_type  Parameter type.
  60  * @param param_count  Total number of parameters
  61  * @param param_index  Index of this parameter
  62  * @return length of the message in bytes (excluding serial stream start sign)
  63  */
  64 static inline uint16_t mavlink_msg_param_ext_value_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg,
  65                                const char *param_id, const char *param_value, uint8_t param_type, uint16_t param_count, uint16_t param_index)
  66 {
  67 #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  68     char buf[MAVLINK_MSG_ID_PARAM_EXT_VALUE_LEN];
  69     _mav_put_uint16_t(buf, 0, param_count);
  70     _mav_put_uint16_t(buf, 2, param_index);
  71     _mav_put_uint8_t(buf, 148, param_type);
  72     _mav_put_char_array(buf, 4, param_id, 16);
  73     _mav_put_char_array(buf, 20, param_value, 128);
  74         memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_PARAM_EXT_VALUE_LEN);
  75 #else
  76     mavlink_param_ext_value_t packet;
  77     packet.param_count = param_count;
  78     packet.param_index = param_index;
  79     packet.param_type = param_type;
  80     mav_array_memcpy(packet.param_id, param_id, sizeof(char)*16);
  81     mav_array_memcpy(packet.param_value, param_value, sizeof(char)*128);
  82         memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_PARAM_EXT_VALUE_LEN);
  83 #endif
  84
  85     msg->msgid = MAVLINK_MSG_ID_PARAM_EXT_VALUE;
  86     return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_PARAM_EXT_VALUE_MIN_LEN, MAVLINK_MSG_ID_PARAM_EXT_VALUE_LEN, MAVLINK_MSG_ID_PARAM_EXT_VALUE_CRC);
  87 }
  88
  89 /**
  90  * @brief Pack a param_ext_value 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 param_id  Parameter id, terminated by NULL if the length is less than 16 human-readable chars and WITHOUT null termination (NULL) byte if the length is exactly 16 chars - applications have to provide 16+1 bytes storage if the ID is stored as string
  96  * @param param_value  Parameter value
  97  * @param param_type  Parameter type.
  98  * @param param_count  Total number of parameters
  99  * @param param_index  Index of this parameter
 100  * @return length of the message in bytes (excluding serial stream start sign)
 101  */
 102 static inline uint16_t mavlink_msg_param_ext_value_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan,
 103                                mavlink_message_t* msg,
 104                                    const char *param_id,const char *param_value,uint8_t param_type,uint16_t param_count,uint16_t param_index)
 105 {
 106 #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
 107     char buf[MAVLINK_MSG_ID_PARAM_EXT_VALUE_LEN];
 108     _mav_put_uint16_t(buf, 0, param_count);
 109     _mav_put_uint16_t(buf, 2, param_index);
 110     _mav_put_uint8_t(buf, 148, param_type);
 111     _mav_put_char_array(buf, 4, param_id, 16);
 112     _mav_put_char_array(buf, 20, param_value, 128);
 113         memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_PARAM_EXT_VALUE_LEN);
 114 #else
 115     mavlink_param_ext_value_t packet;
 116     packet.param_count = param_count;
 117     packet.param_index = param_index;
 118     packet.param_type = param_type;
 119     mav_array_memcpy(packet.param_id, param_id, sizeof(char)*16);
 120     mav_array_memcpy(packet.param_value, param_value, sizeof(char)*128);
 121         memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_PARAM_EXT_VALUE_LEN);
 122 #endif
 123
 124     msg->msgid = MAVLINK_MSG_ID_PARAM_EXT_VALUE;
 125     return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_PARAM_EXT_VALUE_MIN_LEN, MAVLINK_MSG_ID_PARAM_EXT_VALUE_LEN, MAVLINK_MSG_ID_PARAM_EXT_VALUE_CRC);
 126 }
 127
 128 /**
 129  * @brief Encode a param_ext_value 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 param_ext_value C-struct to read the message contents from
 135  */
 136 static inline uint16_t mavlink_msg_param_ext_value_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_param_ext_value_t* param_ext_value)
 137 {
 138     return mavlink_msg_param_ext_value_pack(system_id, component_id, msg, param_ext_value->param_id, param_ext_value->param_value, param_ext_value->param_type, param_ext_value->param_count, param_ext_value->param_index);
 139 }
 140
 141 /**
 142  * @brief Encode a param_ext_value 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 param_ext_value C-struct to read the message contents from
 149  */
 150 static inline uint16_t mavlink_msg_param_ext_value_encode_chan(uint8_t system_id, uint8_t component_id, uint8_t chan, mavlink_message_t* msg, const mavlink_param_ext_value_t* param_ext_value)
 151 {
 152     return mavlink_msg_param_ext_value_pack_chan(system_id, component_id, chan, msg, param_ext_value->param_id, param_ext_value->param_value, param_ext_value->param_type, param_ext_value->param_count, param_ext_value->param_index);
 153 }
 154
 155 /**
 156  * @brief Send a param_ext_value message
 157  * @param chan MAVLink channel to send the message
 158  *
 159  * @param param_id  Parameter id, terminated by NULL if the length is less than 16 human-readable chars and WITHOUT null termination (NULL) byte if the length is exactly 16 chars - applications have to provide 16+1 bytes storage if the ID is stored as string
 160  * @param param_value  Parameter value
 161  * @param param_type  Parameter type.
 162  * @param param_count  Total number of parameters
 163  * @param param_index  Index of this parameter
 164  */
 165 #ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS
 166
 167 static inline void mavlink_msg_param_ext_value_send(mavlink_channel_t chan, const char *param_id, const char *param_value, uint8_t param_type, uint16_t param_count, uint16_t param_index)
 168 {
 169 #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
 170     char buf[MAVLINK_MSG_ID_PARAM_EXT_VALUE_LEN];
 171     _mav_put_uint16_t(buf, 0, param_count);
 172     _mav_put_uint16_t(buf, 2, param_index);
 173     _mav_put_uint8_t(buf, 148, param_type);
 174     _mav_put_char_array(buf, 4, param_id, 16);
 175     _mav_put_char_array(buf, 20, param_value, 128);
 176     _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_PARAM_EXT_VALUE, buf, MAVLINK_MSG_ID_PARAM_EXT_VALUE_MIN_LEN, MAVLINK_MSG_ID_PARAM_EXT_VALUE_LEN, MAVLINK_MSG_ID_PARAM_EXT_VALUE_CRC);
 177 #else
 178     mavlink_param_ext_value_t packet;
 179     packet.param_count = param_count;
 180     packet.param_index = param_index;
 181     packet.param_type = param_type;
 182     mav_array_memcpy(packet.param_id, param_id, sizeof(char)*16);
 183     mav_array_memcpy(packet.param_value, param_value, sizeof(char)*128);
 184     _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_PARAM_EXT_VALUE, (const char *)&packet, MAVLINK_MSG_ID_PARAM_EXT_VALUE_MIN_LEN, MAVLINK_MSG_ID_PARAM_EXT_VALUE_LEN, MAVLINK_MSG_ID_PARAM_EXT_VALUE_CRC);
 185 #endif
 186 }
 187
 188 /**
 189  * @brief Send a param_ext_value 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_param_ext_value_send_struct(mavlink_channel_t chan, const mavlink_param_ext_value_t* param_ext_value)
 194 {
 195 #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
 196     mavlink_msg_param_ext_value_send(chan, param_ext_value->param_id, param_ext_value->param_value, param_ext_value->param_type, param_ext_value->param_count, param_ext_value->param_index);
 197 #else
 198     _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_PARAM_EXT_VALUE, (const char *)param_ext_value, MAVLINK_MSG_ID_PARAM_EXT_VALUE_MIN_LEN, MAVLINK_MSG_ID_PARAM_EXT_VALUE_LEN, MAVLINK_MSG_ID_PARAM_EXT_VALUE_CRC);
 199 #endif
 200 }
 201
 202 #if MAVLINK_MSG_ID_PARAM_EXT_VALUE_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_param_ext_value_send_buf(mavlink_message_t *msgbuf, mavlink_channel_t chan,  const char *param_id, const char *param_value, uint8_t param_type, uint16_t param_count, uint16_t param_index)
 211 {
 212 #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
 213     char *buf = (char *)msgbuf;
 214     _mav_put_uint16_t(buf, 0, param_count);
 215     _mav_put_uint16_t(buf, 2, param_index);
 216     _mav_put_uint8_t(buf, 148, param_type);
 217     _mav_put_char_array(buf, 4, param_id, 16);
 218     _mav_put_char_array(buf, 20, param_value, 128);
 219     _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_PARAM_EXT_VALUE, buf, MAVLINK_MSG_ID_PARAM_EXT_VALUE_MIN_LEN, MAVLINK_MSG_ID_PARAM_EXT_VALUE_LEN, MAVLINK_MSG_ID_PARAM_EXT_VALUE_CRC);
 220 #else
 221     mavlink_param_ext_value_t *packet = (mavlink_param_ext_value_t *)msgbuf;
 222     packet->param_count = param_count;
 223     packet->param_index = param_index;
 224     packet->param_type = param_type;
 225     mav_array_memcpy(packet->param_id, param_id, sizeof(char)*16);
 226     mav_array_memcpy(packet->param_value, param_value, sizeof(char)*128);
 227     _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_PARAM_EXT_VALUE, (const char *)packet, MAVLINK_MSG_ID_PARAM_EXT_VALUE_MIN_LEN, MAVLINK_MSG_ID_PARAM_EXT_VALUE_LEN, MAVLINK_MSG_ID_PARAM_EXT_VALUE_CRC);
 228 #endif
 229 }
 230 #endif
 231
 232 #endif
 233
 234 // MESSAGE PARAM_EXT_VALUE UNPACKING
 235
 236
 237 /**
 238  * @brief Get field param_id from param_ext_value message
 239  *
 240  * @return  Parameter id, terminated by NULL if the length is less than 16 human-readable chars and WITHOUT null termination (NULL) byte if the length is exactly 16 chars - applications have to provide 16+1 bytes storage if the ID is stored as string
 241  */
 242 static inline uint16_t mavlink_msg_param_ext_value_get_param_id(const mavlink_message_t* msg, char *param_id)
 243 {
 244     return _MAV_RETURN_char_array(msg, param_id, 16,  4);
 245 }
 246
 247 /**
 248  * @brief Get field param_value from param_ext_value message
 249  *
 250  * @return  Parameter value
 251  */
 252 static inline uint16_t mavlink_msg_param_ext_value_get_param_value(const mavlink_message_t* msg, char *param_value)
 253 {
 254     return _MAV_RETURN_char_array(msg, param_value, 128,  20);
 255 }
 256
 257 /**
 258  * @brief Get field param_type from param_ext_value message
 259  *
 260  * @return  Parameter type.
 261  */
 262 static inline uint8_t mavlink_msg_param_ext_value_get_param_type(const mavlink_message_t* msg)
 263 {
 264     return _MAV_RETURN_uint8_t(msg,  148);
 265 }
 266
 267 /**
 268  * @brief Get field param_count from param_ext_value message
 269  *
 270  * @return  Total number of parameters
 271  */
 272 static inline uint16_t mavlink_msg_param_ext_value_get_param_count(const mavlink_message_t* msg)
 273 {
 274     return _MAV_RETURN_uint16_t(msg,  0);
 275 }
 276
 277 /**
 278  * @brief Get field param_index from param_ext_value message
 279  *
 280  * @return  Index of this parameter
 281  */
 282 static inline uint16_t mavlink_msg_param_ext_value_get_param_index(const mavlink_message_t* msg)
 283 {
 284     return _MAV_RETURN_uint16_t(msg,  2);
 285 }
 286
 287 /**
 288  * @brief Decode a param_ext_value message into a struct
 289  *
 290  * @param msg The message to decode
 291  * @param param_ext_value C-struct to decode the message contents into
 292  */
 293 static inline void mavlink_msg_param_ext_value_decode(const mavlink_message_t* msg, mavlink_param_ext_value_t* param_ext_value)
 294 {
 295 #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
 296     param_ext_value->param_count = mavlink_msg_param_ext_value_get_param_count(msg);
 297     param_ext_value->param_index = mavlink_msg_param_ext_value_get_param_index(msg);
 298     mavlink_msg_param_ext_value_get_param_id(msg, param_ext_value->param_id);
 299     mavlink_msg_param_ext_value_get_param_value(msg, param_ext_value->param_value);
 300     param_ext_value->param_type = mavlink_msg_param_ext_value_get_param_type(msg);
 301 #else
 302         uint8_t len = msg->len < MAVLINK_MSG_ID_PARAM_EXT_VALUE_LEN? msg->len : MAVLINK_MSG_ID_PARAM_EXT_VALUE_LEN;
 303         memset(param_ext_value, 0, MAVLINK_MSG_ID_PARAM_EXT_VALUE_LEN);
 304     memcpy(param_ext_value, _MAV_PAYLOAD(msg), len);
 305 #endif
 306 }