mavlink_msg_param_set.h 14 KB

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