mavlink_msg_param_ext_ack.h 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281
  1. #pragma once
  2. // MESSAGE PARAM_EXT_ACK PACKING
  3. #define MAVLINK_MSG_ID_PARAM_EXT_ACK 324
  4. typedef struct __mavlink_param_ext_ack_t {
  5. 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*/
  6. char param_value[128]; /*< Parameter value (new value if PARAM_ACK_ACCEPTED, current value otherwise)*/
  7. uint8_t param_type; /*< Parameter type.*/
  8. uint8_t param_result; /*< Result code.*/
  9. } mavlink_param_ext_ack_t;
  10. #define MAVLINK_MSG_ID_PARAM_EXT_ACK_LEN 146
  11. #define MAVLINK_MSG_ID_PARAM_EXT_ACK_MIN_LEN 146
  12. #define MAVLINK_MSG_ID_324_LEN 146
  13. #define MAVLINK_MSG_ID_324_MIN_LEN 146
  14. #define MAVLINK_MSG_ID_PARAM_EXT_ACK_CRC 132
  15. #define MAVLINK_MSG_ID_324_CRC 132
  16. #define MAVLINK_MSG_PARAM_EXT_ACK_FIELD_PARAM_ID_LEN 16
  17. #define MAVLINK_MSG_PARAM_EXT_ACK_FIELD_PARAM_VALUE_LEN 128
  18. #if MAVLINK_COMMAND_24BIT
  19. #define MAVLINK_MESSAGE_INFO_PARAM_EXT_ACK { \
  20. 324, \
  21. "PARAM_EXT_ACK", \
  22. 4, \
  23. { { "param_id", NULL, MAVLINK_TYPE_CHAR, 16, 0, offsetof(mavlink_param_ext_ack_t, param_id) }, \
  24. { "param_value", NULL, MAVLINK_TYPE_CHAR, 128, 16, offsetof(mavlink_param_ext_ack_t, param_value) }, \
  25. { "param_type", NULL, MAVLINK_TYPE_UINT8_T, 0, 144, offsetof(mavlink_param_ext_ack_t, param_type) }, \
  26. { "param_result", NULL, MAVLINK_TYPE_UINT8_T, 0, 145, offsetof(mavlink_param_ext_ack_t, param_result) }, \
  27. } \
  28. }
  29. #else
  30. #define MAVLINK_MESSAGE_INFO_PARAM_EXT_ACK { \
  31. "PARAM_EXT_ACK", \
  32. 4, \
  33. { { "param_id", NULL, MAVLINK_TYPE_CHAR, 16, 0, offsetof(mavlink_param_ext_ack_t, param_id) }, \
  34. { "param_value", NULL, MAVLINK_TYPE_CHAR, 128, 16, offsetof(mavlink_param_ext_ack_t, param_value) }, \
  35. { "param_type", NULL, MAVLINK_TYPE_UINT8_T, 0, 144, offsetof(mavlink_param_ext_ack_t, param_type) }, \
  36. { "param_result", NULL, MAVLINK_TYPE_UINT8_T, 0, 145, offsetof(mavlink_param_ext_ack_t, param_result) }, \
  37. } \
  38. }
  39. #endif
  40. /**
  41. * @brief Pack a param_ext_ack message
  42. * @param system_id ID of this system
  43. * @param component_id ID of this component (e.g. 200 for IMU)
  44. * @param msg The MAVLink message to compress the data into
  45. *
  46. * @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
  47. * @param param_value Parameter value (new value if PARAM_ACK_ACCEPTED, current value otherwise)
  48. * @param param_type Parameter type.
  49. * @param param_result Result code.
  50. * @return length of the message in bytes (excluding serial stream start sign)
  51. */
  52. static inline uint16_t mavlink_msg_param_ext_ack_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg,
  53. const char *param_id, const char *param_value, uint8_t param_type, uint8_t param_result)
  54. {
  55. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  56. char buf[MAVLINK_MSG_ID_PARAM_EXT_ACK_LEN];
  57. _mav_put_uint8_t(buf, 144, param_type);
  58. _mav_put_uint8_t(buf, 145, param_result);
  59. _mav_put_char_array(buf, 0, param_id, 16);
  60. _mav_put_char_array(buf, 16, param_value, 128);
  61. memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_PARAM_EXT_ACK_LEN);
  62. #else
  63. mavlink_param_ext_ack_t packet;
  64. packet.param_type = param_type;
  65. packet.param_result = param_result;
  66. mav_array_memcpy(packet.param_id, param_id, sizeof(char)*16);
  67. mav_array_memcpy(packet.param_value, param_value, sizeof(char)*128);
  68. memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_PARAM_EXT_ACK_LEN);
  69. #endif
  70. msg->msgid = MAVLINK_MSG_ID_PARAM_EXT_ACK;
  71. return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_PARAM_EXT_ACK_MIN_LEN, MAVLINK_MSG_ID_PARAM_EXT_ACK_LEN, MAVLINK_MSG_ID_PARAM_EXT_ACK_CRC);
  72. }
  73. /**
  74. * @brief Pack a param_ext_ack message on a channel
  75. * @param system_id ID of this system
  76. * @param component_id ID of this component (e.g. 200 for IMU)
  77. * @param chan The MAVLink channel this message will be sent over
  78. * @param msg The MAVLink message to compress the data into
  79. * @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
  80. * @param param_value Parameter value (new value if PARAM_ACK_ACCEPTED, current value otherwise)
  81. * @param param_type Parameter type.
  82. * @param param_result Result code.
  83. * @return length of the message in bytes (excluding serial stream start sign)
  84. */
  85. static inline uint16_t mavlink_msg_param_ext_ack_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan,
  86. mavlink_message_t* msg,
  87. const char *param_id,const char *param_value,uint8_t param_type,uint8_t param_result)
  88. {
  89. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  90. char buf[MAVLINK_MSG_ID_PARAM_EXT_ACK_LEN];
  91. _mav_put_uint8_t(buf, 144, param_type);
  92. _mav_put_uint8_t(buf, 145, param_result);
  93. _mav_put_char_array(buf, 0, param_id, 16);
  94. _mav_put_char_array(buf, 16, param_value, 128);
  95. memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_PARAM_EXT_ACK_LEN);
  96. #else
  97. mavlink_param_ext_ack_t packet;
  98. packet.param_type = param_type;
  99. packet.param_result = param_result;
  100. mav_array_memcpy(packet.param_id, param_id, sizeof(char)*16);
  101. mav_array_memcpy(packet.param_value, param_value, sizeof(char)*128);
  102. memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_PARAM_EXT_ACK_LEN);
  103. #endif
  104. msg->msgid = MAVLINK_MSG_ID_PARAM_EXT_ACK;
  105. return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_PARAM_EXT_ACK_MIN_LEN, MAVLINK_MSG_ID_PARAM_EXT_ACK_LEN, MAVLINK_MSG_ID_PARAM_EXT_ACK_CRC);
  106. }
  107. /**
  108. * @brief Encode a param_ext_ack struct
  109. *
  110. * @param system_id ID of this system
  111. * @param component_id ID of this component (e.g. 200 for IMU)
  112. * @param msg The MAVLink message to compress the data into
  113. * @param param_ext_ack C-struct to read the message contents from
  114. */
  115. static inline uint16_t mavlink_msg_param_ext_ack_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_param_ext_ack_t* param_ext_ack)
  116. {
  117. return mavlink_msg_param_ext_ack_pack(system_id, component_id, msg, param_ext_ack->param_id, param_ext_ack->param_value, param_ext_ack->param_type, param_ext_ack->param_result);
  118. }
  119. /**
  120. * @brief Encode a param_ext_ack struct on a channel
  121. *
  122. * @param system_id ID of this system
  123. * @param component_id ID of this component (e.g. 200 for IMU)
  124. * @param chan The MAVLink channel this message will be sent over
  125. * @param msg The MAVLink message to compress the data into
  126. * @param param_ext_ack C-struct to read the message contents from
  127. */
  128. static inline uint16_t mavlink_msg_param_ext_ack_encode_chan(uint8_t system_id, uint8_t component_id, uint8_t chan, mavlink_message_t* msg, const mavlink_param_ext_ack_t* param_ext_ack)
  129. {
  130. return mavlink_msg_param_ext_ack_pack_chan(system_id, component_id, chan, msg, param_ext_ack->param_id, param_ext_ack->param_value, param_ext_ack->param_type, param_ext_ack->param_result);
  131. }
  132. /**
  133. * @brief Send a param_ext_ack message
  134. * @param chan MAVLink channel to send the message
  135. *
  136. * @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
  137. * @param param_value Parameter value (new value if PARAM_ACK_ACCEPTED, current value otherwise)
  138. * @param param_type Parameter type.
  139. * @param param_result Result code.
  140. */
  141. #ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS
  142. static inline void mavlink_msg_param_ext_ack_send(mavlink_channel_t chan, const char *param_id, const char *param_value, uint8_t param_type, uint8_t param_result)
  143. {
  144. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  145. char buf[MAVLINK_MSG_ID_PARAM_EXT_ACK_LEN];
  146. _mav_put_uint8_t(buf, 144, param_type);
  147. _mav_put_uint8_t(buf, 145, param_result);
  148. _mav_put_char_array(buf, 0, param_id, 16);
  149. _mav_put_char_array(buf, 16, param_value, 128);
  150. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_PARAM_EXT_ACK, buf, MAVLINK_MSG_ID_PARAM_EXT_ACK_MIN_LEN, MAVLINK_MSG_ID_PARAM_EXT_ACK_LEN, MAVLINK_MSG_ID_PARAM_EXT_ACK_CRC);
  151. #else
  152. mavlink_param_ext_ack_t packet;
  153. packet.param_type = param_type;
  154. packet.param_result = param_result;
  155. mav_array_memcpy(packet.param_id, param_id, sizeof(char)*16);
  156. mav_array_memcpy(packet.param_value, param_value, sizeof(char)*128);
  157. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_PARAM_EXT_ACK, (const char *)&packet, MAVLINK_MSG_ID_PARAM_EXT_ACK_MIN_LEN, MAVLINK_MSG_ID_PARAM_EXT_ACK_LEN, MAVLINK_MSG_ID_PARAM_EXT_ACK_CRC);
  158. #endif
  159. }
  160. /**
  161. * @brief Send a param_ext_ack message
  162. * @param chan MAVLink channel to send the message
  163. * @param struct The MAVLink struct to serialize
  164. */
  165. static inline void mavlink_msg_param_ext_ack_send_struct(mavlink_channel_t chan, const mavlink_param_ext_ack_t* param_ext_ack)
  166. {
  167. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  168. mavlink_msg_param_ext_ack_send(chan, param_ext_ack->param_id, param_ext_ack->param_value, param_ext_ack->param_type, param_ext_ack->param_result);
  169. #else
  170. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_PARAM_EXT_ACK, (const char *)param_ext_ack, MAVLINK_MSG_ID_PARAM_EXT_ACK_MIN_LEN, MAVLINK_MSG_ID_PARAM_EXT_ACK_LEN, MAVLINK_MSG_ID_PARAM_EXT_ACK_CRC);
  171. #endif
  172. }
  173. #if MAVLINK_MSG_ID_PARAM_EXT_ACK_LEN <= MAVLINK_MAX_PAYLOAD_LEN
  174. /*
  175. This variant of _send() can be used to save stack space by re-using
  176. memory from the receive buffer. The caller provides a
  177. mavlink_message_t which is the size of a full mavlink message. This
  178. is usually the receive buffer for the channel, and allows a reply to an
  179. incoming message with minimum stack space usage.
  180. */
  181. static inline void mavlink_msg_param_ext_ack_send_buf(mavlink_message_t *msgbuf, mavlink_channel_t chan, const char *param_id, const char *param_value, uint8_t param_type, uint8_t param_result)
  182. {
  183. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  184. char *buf = (char *)msgbuf;
  185. _mav_put_uint8_t(buf, 144, param_type);
  186. _mav_put_uint8_t(buf, 145, param_result);
  187. _mav_put_char_array(buf, 0, param_id, 16);
  188. _mav_put_char_array(buf, 16, param_value, 128);
  189. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_PARAM_EXT_ACK, buf, MAVLINK_MSG_ID_PARAM_EXT_ACK_MIN_LEN, MAVLINK_MSG_ID_PARAM_EXT_ACK_LEN, MAVLINK_MSG_ID_PARAM_EXT_ACK_CRC);
  190. #else
  191. mavlink_param_ext_ack_t *packet = (mavlink_param_ext_ack_t *)msgbuf;
  192. packet->param_type = param_type;
  193. packet->param_result = param_result;
  194. mav_array_memcpy(packet->param_id, param_id, sizeof(char)*16);
  195. mav_array_memcpy(packet->param_value, param_value, sizeof(char)*128);
  196. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_PARAM_EXT_ACK, (const char *)packet, MAVLINK_MSG_ID_PARAM_EXT_ACK_MIN_LEN, MAVLINK_MSG_ID_PARAM_EXT_ACK_LEN, MAVLINK_MSG_ID_PARAM_EXT_ACK_CRC);
  197. #endif
  198. }
  199. #endif
  200. #endif
  201. // MESSAGE PARAM_EXT_ACK UNPACKING
  202. /**
  203. * @brief Get field param_id from param_ext_ack message
  204. *
  205. * @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
  206. */
  207. static inline uint16_t mavlink_msg_param_ext_ack_get_param_id(const mavlink_message_t* msg, char *param_id)
  208. {
  209. return _MAV_RETURN_char_array(msg, param_id, 16, 0);
  210. }
  211. /**
  212. * @brief Get field param_value from param_ext_ack message
  213. *
  214. * @return Parameter value (new value if PARAM_ACK_ACCEPTED, current value otherwise)
  215. */
  216. static inline uint16_t mavlink_msg_param_ext_ack_get_param_value(const mavlink_message_t* msg, char *param_value)
  217. {
  218. return _MAV_RETURN_char_array(msg, param_value, 128, 16);
  219. }
  220. /**
  221. * @brief Get field param_type from param_ext_ack message
  222. *
  223. * @return Parameter type.
  224. */
  225. static inline uint8_t mavlink_msg_param_ext_ack_get_param_type(const mavlink_message_t* msg)
  226. {
  227. return _MAV_RETURN_uint8_t(msg, 144);
  228. }
  229. /**
  230. * @brief Get field param_result from param_ext_ack message
  231. *
  232. * @return Result code.
  233. */
  234. static inline uint8_t mavlink_msg_param_ext_ack_get_param_result(const mavlink_message_t* msg)
  235. {
  236. return _MAV_RETURN_uint8_t(msg, 145);
  237. }
  238. /**
  239. * @brief Decode a param_ext_ack message into a struct
  240. *
  241. * @param msg The message to decode
  242. * @param param_ext_ack C-struct to decode the message contents into
  243. */
  244. static inline void mavlink_msg_param_ext_ack_decode(const mavlink_message_t* msg, mavlink_param_ext_ack_t* param_ext_ack)
  245. {
  246. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  247. mavlink_msg_param_ext_ack_get_param_id(msg, param_ext_ack->param_id);
  248. mavlink_msg_param_ext_ack_get_param_value(msg, param_ext_ack->param_value);
  249. param_ext_ack->param_type = mavlink_msg_param_ext_ack_get_param_type(msg);
  250. param_ext_ack->param_result = mavlink_msg_param_ext_ack_get_param_result(msg);
  251. #else
  252. uint8_t len = msg->len < MAVLINK_MSG_ID_PARAM_EXT_ACK_LEN? msg->len : MAVLINK_MSG_ID_PARAM_EXT_ACK_LEN;
  253. memset(param_ext_ack, 0, MAVLINK_MSG_ID_PARAM_EXT_ACK_LEN);
  254. memcpy(param_ext_ack, _MAV_PAYLOAD(msg), len);
  255. #endif
  256. }