mavlink_msg_param_value.h 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362
  1. #pragma once
  2. // MESSAGE PARAM_VALUE PACKING
  3. #define MAVLINK_MSG_ID_PARAM_VALUE 22
  4. typedef struct __mavlink_param_value_t {
  5. float param_value; /*< Onboard parameter value*/
  6. uint16_t param_count; /*< Total number of onboard parameters*/
  7. uint16_t param_index; /*< Index of this onboard parameter*/
  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_value_t;
  11. #define MAVLINK_MSG_ID_PARAM_VALUE_LEN 25
  12. #define MAVLINK_MSG_ID_PARAM_VALUE_MIN_LEN 25
  13. #define MAVLINK_MSG_ID_22_LEN 25
  14. #define MAVLINK_MSG_ID_22_MIN_LEN 25
  15. #define MAVLINK_MSG_ID_PARAM_VALUE_CRC 220
  16. #define MAVLINK_MSG_ID_22_CRC 220
  17. #define MAVLINK_MSG_PARAM_VALUE_FIELD_PARAM_ID_LEN 16
  18. #if MAVLINK_COMMAND_24BIT
  19. #define MAVLINK_MESSAGE_INFO_PARAM_VALUE { \
  20. 22, \
  21. "PARAM_VALUE", \
  22. 5, \
  23. { { "param_id", NULL, MAVLINK_TYPE_CHAR, 16, 8, offsetof(mavlink_param_value_t, param_id) }, \
  24. { "param_value", NULL, MAVLINK_TYPE_FLOAT, 0, 0, offsetof(mavlink_param_value_t, param_value) }, \
  25. { "param_type", NULL, MAVLINK_TYPE_UINT8_T, 0, 24, offsetof(mavlink_param_value_t, param_type) }, \
  26. { "param_count", NULL, MAVLINK_TYPE_UINT16_T, 0, 4, offsetof(mavlink_param_value_t, param_count) }, \
  27. { "param_index", NULL, MAVLINK_TYPE_UINT16_T, 0, 6, offsetof(mavlink_param_value_t, param_index) }, \
  28. } \
  29. }
  30. #else
  31. #define MAVLINK_MESSAGE_INFO_PARAM_VALUE { \
  32. "PARAM_VALUE", \
  33. 5, \
  34. { { "param_id", NULL, MAVLINK_TYPE_CHAR, 16, 8, offsetof(mavlink_param_value_t, param_id) }, \
  35. { "param_value", NULL, MAVLINK_TYPE_FLOAT, 0, 0, offsetof(mavlink_param_value_t, param_value) }, \
  36. { "param_type", NULL, MAVLINK_TYPE_UINT8_T, 0, 24, offsetof(mavlink_param_value_t, param_type) }, \
  37. { "param_count", NULL, MAVLINK_TYPE_UINT16_T, 0, 4, offsetof(mavlink_param_value_t, param_count) }, \
  38. { "param_index", NULL, MAVLINK_TYPE_UINT16_T, 0, 6, offsetof(mavlink_param_value_t, param_index) }, \
  39. } \
  40. }
  41. #endif
  42. /**
  43. * @brief Pack a param_value 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 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
  49. * @param param_value Onboard parameter value
  50. * @param param_type Onboard parameter type.
  51. * @param param_count Total number of onboard parameters
  52. * @param param_index Index of this onboard parameter
  53. * @return length of the message in bytes (excluding serial stream start sign)
  54. */
  55. static inline uint16_t mavlink_msg_param_value_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg,
  56. const char *param_id, float param_value, uint8_t param_type, uint16_t param_count, uint16_t param_index)
  57. {
  58. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  59. char buf[MAVLINK_MSG_ID_PARAM_VALUE_LEN];
  60. _mav_put_float(buf, 0, param_value);
  61. _mav_put_uint16_t(buf, 4, param_count);
  62. _mav_put_uint16_t(buf, 6, param_index);
  63. _mav_put_uint8_t(buf, 24, param_type);
  64. _mav_put_char_array(buf, 8, param_id, 16);
  65. memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_PARAM_VALUE_LEN);
  66. #else
  67. mavlink_param_value_t packet;
  68. packet.param_value = param_value;
  69. packet.param_count = param_count;
  70. packet.param_index = param_index;
  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_VALUE_LEN);
  74. #endif
  75. msg->msgid = MAVLINK_MSG_ID_PARAM_VALUE;
  76. return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_PARAM_VALUE_MIN_LEN, MAVLINK_MSG_ID_PARAM_VALUE_LEN, MAVLINK_MSG_ID_PARAM_VALUE_CRC);
  77. }
  78. /**
  79. * @brief Pack a param_value message
  80. * @param system_id ID of this system
  81. * @param component_id ID of this component (e.g. 200 for IMU)
  82. * @param status MAVLink status structure
  83. * @param msg The MAVLink message to compress the data into
  84. *
  85. * @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
  86. * @param param_value Onboard parameter value
  87. * @param param_type Onboard parameter type.
  88. * @param param_count Total number of onboard parameters
  89. * @param param_index Index of this onboard parameter
  90. * @return length of the message in bytes (excluding serial stream start sign)
  91. */
  92. static inline uint16_t mavlink_msg_param_value_pack_status(uint8_t system_id, uint8_t component_id, mavlink_status_t *_status, mavlink_message_t* msg,
  93. const char *param_id, float param_value, uint8_t param_type, uint16_t param_count, uint16_t param_index)
  94. {
  95. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  96. char buf[MAVLINK_MSG_ID_PARAM_VALUE_LEN];
  97. _mav_put_float(buf, 0, param_value);
  98. _mav_put_uint16_t(buf, 4, param_count);
  99. _mav_put_uint16_t(buf, 6, param_index);
  100. _mav_put_uint8_t(buf, 24, param_type);
  101. _mav_put_char_array(buf, 8, param_id, 16);
  102. memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_PARAM_VALUE_LEN);
  103. #else
  104. mavlink_param_value_t packet;
  105. packet.param_value = param_value;
  106. packet.param_count = param_count;
  107. packet.param_index = param_index;
  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_VALUE_LEN);
  111. #endif
  112. msg->msgid = MAVLINK_MSG_ID_PARAM_VALUE;
  113. #if MAVLINK_CRC_EXTRA
  114. return mavlink_finalize_message_buffer(msg, system_id, component_id, _status, MAVLINK_MSG_ID_PARAM_VALUE_MIN_LEN, MAVLINK_MSG_ID_PARAM_VALUE_LEN, MAVLINK_MSG_ID_PARAM_VALUE_CRC);
  115. #else
  116. return mavlink_finalize_message_buffer(msg, system_id, component_id, _status, MAVLINK_MSG_ID_PARAM_VALUE_MIN_LEN, MAVLINK_MSG_ID_PARAM_VALUE_LEN);
  117. #endif
  118. }
  119. /**
  120. * @brief Pack a param_value message on a channel
  121. * @param system_id ID of this system
  122. * @param component_id ID of this component (e.g. 200 for IMU)
  123. * @param chan The MAVLink channel this message will be sent over
  124. * @param msg The MAVLink message to compress the data into
  125. * @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
  126. * @param param_value Onboard parameter value
  127. * @param param_type Onboard parameter type.
  128. * @param param_count Total number of onboard parameters
  129. * @param param_index Index of this onboard parameter
  130. * @return length of the message in bytes (excluding serial stream start sign)
  131. */
  132. static inline uint16_t mavlink_msg_param_value_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan,
  133. mavlink_message_t* msg,
  134. const char *param_id,float param_value,uint8_t param_type,uint16_t param_count,uint16_t param_index)
  135. {
  136. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  137. char buf[MAVLINK_MSG_ID_PARAM_VALUE_LEN];
  138. _mav_put_float(buf, 0, param_value);
  139. _mav_put_uint16_t(buf, 4, param_count);
  140. _mav_put_uint16_t(buf, 6, param_index);
  141. _mav_put_uint8_t(buf, 24, param_type);
  142. _mav_put_char_array(buf, 8, param_id, 16);
  143. memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_PARAM_VALUE_LEN);
  144. #else
  145. mavlink_param_value_t packet;
  146. packet.param_value = param_value;
  147. packet.param_count = param_count;
  148. packet.param_index = param_index;
  149. packet.param_type = param_type;
  150. mav_array_memcpy(packet.param_id, param_id, sizeof(char)*16);
  151. memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_PARAM_VALUE_LEN);
  152. #endif
  153. msg->msgid = MAVLINK_MSG_ID_PARAM_VALUE;
  154. return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_PARAM_VALUE_MIN_LEN, MAVLINK_MSG_ID_PARAM_VALUE_LEN, MAVLINK_MSG_ID_PARAM_VALUE_CRC);
  155. }
  156. /**
  157. * @brief Encode a param_value struct
  158. *
  159. * @param system_id ID of this system
  160. * @param component_id ID of this component (e.g. 200 for IMU)
  161. * @param msg The MAVLink message to compress the data into
  162. * @param param_value C-struct to read the message contents from
  163. */
  164. static inline uint16_t mavlink_msg_param_value_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_param_value_t* param_value)
  165. {
  166. return mavlink_msg_param_value_pack(system_id, component_id, msg, param_value->param_id, param_value->param_value, param_value->param_type, param_value->param_count, param_value->param_index);
  167. }
  168. /**
  169. * @brief Encode a param_value struct on a channel
  170. *
  171. * @param system_id ID of this system
  172. * @param component_id ID of this component (e.g. 200 for IMU)
  173. * @param chan The MAVLink channel this message will be sent over
  174. * @param msg The MAVLink message to compress the data into
  175. * @param param_value C-struct to read the message contents from
  176. */
  177. static inline uint16_t mavlink_msg_param_value_encode_chan(uint8_t system_id, uint8_t component_id, uint8_t chan, mavlink_message_t* msg, const mavlink_param_value_t* param_value)
  178. {
  179. return mavlink_msg_param_value_pack_chan(system_id, component_id, chan, msg, param_value->param_id, param_value->param_value, param_value->param_type, param_value->param_count, param_value->param_index);
  180. }
  181. /**
  182. * @brief Encode a param_value struct with provided status structure
  183. *
  184. * @param system_id ID of this system
  185. * @param component_id ID of this component (e.g. 200 for IMU)
  186. * @param status MAVLink status structure
  187. * @param msg The MAVLink message to compress the data into
  188. * @param param_value C-struct to read the message contents from
  189. */
  190. static inline uint16_t mavlink_msg_param_value_encode_status(uint8_t system_id, uint8_t component_id, mavlink_status_t* _status, mavlink_message_t* msg, const mavlink_param_value_t* param_value)
  191. {
  192. return mavlink_msg_param_value_pack_status(system_id, component_id, _status, msg, param_value->param_id, param_value->param_value, param_value->param_type, param_value->param_count, param_value->param_index);
  193. }
  194. /**
  195. * @brief Send a param_value message
  196. * @param chan MAVLink channel to send the message
  197. *
  198. * @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
  199. * @param param_value Onboard parameter value
  200. * @param param_type Onboard parameter type.
  201. * @param param_count Total number of onboard parameters
  202. * @param param_index Index of this onboard parameter
  203. */
  204. #ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS
  205. static inline void mavlink_msg_param_value_send(mavlink_channel_t chan, const char *param_id, float param_value, uint8_t param_type, uint16_t param_count, uint16_t param_index)
  206. {
  207. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  208. char buf[MAVLINK_MSG_ID_PARAM_VALUE_LEN];
  209. _mav_put_float(buf, 0, param_value);
  210. _mav_put_uint16_t(buf, 4, param_count);
  211. _mav_put_uint16_t(buf, 6, param_index);
  212. _mav_put_uint8_t(buf, 24, param_type);
  213. _mav_put_char_array(buf, 8, param_id, 16);
  214. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_PARAM_VALUE, buf, MAVLINK_MSG_ID_PARAM_VALUE_MIN_LEN, MAVLINK_MSG_ID_PARAM_VALUE_LEN, MAVLINK_MSG_ID_PARAM_VALUE_CRC);
  215. #else
  216. mavlink_param_value_t packet;
  217. packet.param_value = param_value;
  218. packet.param_count = param_count;
  219. packet.param_index = param_index;
  220. packet.param_type = param_type;
  221. mav_array_memcpy(packet.param_id, param_id, sizeof(char)*16);
  222. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_PARAM_VALUE, (const char *)&packet, MAVLINK_MSG_ID_PARAM_VALUE_MIN_LEN, MAVLINK_MSG_ID_PARAM_VALUE_LEN, MAVLINK_MSG_ID_PARAM_VALUE_CRC);
  223. #endif
  224. }
  225. /**
  226. * @brief Send a param_value message
  227. * @param chan MAVLink channel to send the message
  228. * @param struct The MAVLink struct to serialize
  229. */
  230. static inline void mavlink_msg_param_value_send_struct(mavlink_channel_t chan, const mavlink_param_value_t* param_value)
  231. {
  232. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  233. mavlink_msg_param_value_send(chan, param_value->param_id, param_value->param_value, param_value->param_type, param_value->param_count, param_value->param_index);
  234. #else
  235. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_PARAM_VALUE, (const char *)param_value, MAVLINK_MSG_ID_PARAM_VALUE_MIN_LEN, MAVLINK_MSG_ID_PARAM_VALUE_LEN, MAVLINK_MSG_ID_PARAM_VALUE_CRC);
  236. #endif
  237. }
  238. #if MAVLINK_MSG_ID_PARAM_VALUE_LEN <= MAVLINK_MAX_PAYLOAD_LEN
  239. /*
  240. This variant of _send() can be used to save stack space by re-using
  241. memory from the receive buffer. The caller provides a
  242. mavlink_message_t which is the size of a full mavlink message. This
  243. is usually the receive buffer for the channel, and allows a reply to an
  244. incoming message with minimum stack space usage.
  245. */
  246. static inline void mavlink_msg_param_value_send_buf(mavlink_message_t *msgbuf, mavlink_channel_t chan, const char *param_id, float param_value, uint8_t param_type, uint16_t param_count, uint16_t param_index)
  247. {
  248. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  249. char *buf = (char *)msgbuf;
  250. _mav_put_float(buf, 0, param_value);
  251. _mav_put_uint16_t(buf, 4, param_count);
  252. _mav_put_uint16_t(buf, 6, param_index);
  253. _mav_put_uint8_t(buf, 24, param_type);
  254. _mav_put_char_array(buf, 8, param_id, 16);
  255. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_PARAM_VALUE, buf, MAVLINK_MSG_ID_PARAM_VALUE_MIN_LEN, MAVLINK_MSG_ID_PARAM_VALUE_LEN, MAVLINK_MSG_ID_PARAM_VALUE_CRC);
  256. #else
  257. mavlink_param_value_t *packet = (mavlink_param_value_t *)msgbuf;
  258. packet->param_value = param_value;
  259. packet->param_count = param_count;
  260. packet->param_index = param_index;
  261. packet->param_type = param_type;
  262. mav_array_memcpy(packet->param_id, param_id, sizeof(char)*16);
  263. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_PARAM_VALUE, (const char *)packet, MAVLINK_MSG_ID_PARAM_VALUE_MIN_LEN, MAVLINK_MSG_ID_PARAM_VALUE_LEN, MAVLINK_MSG_ID_PARAM_VALUE_CRC);
  264. #endif
  265. }
  266. #endif
  267. #endif
  268. // MESSAGE PARAM_VALUE UNPACKING
  269. /**
  270. * @brief Get field param_id from param_value message
  271. *
  272. * @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
  273. */
  274. static inline uint16_t mavlink_msg_param_value_get_param_id(const mavlink_message_t* msg, char *param_id)
  275. {
  276. return _MAV_RETURN_char_array(msg, param_id, 16, 8);
  277. }
  278. /**
  279. * @brief Get field param_value from param_value message
  280. *
  281. * @return Onboard parameter value
  282. */
  283. static inline float mavlink_msg_param_value_get_param_value(const mavlink_message_t* msg)
  284. {
  285. return _MAV_RETURN_float(msg, 0);
  286. }
  287. /**
  288. * @brief Get field param_type from param_value message
  289. *
  290. * @return Onboard parameter type.
  291. */
  292. static inline uint8_t mavlink_msg_param_value_get_param_type(const mavlink_message_t* msg)
  293. {
  294. return _MAV_RETURN_uint8_t(msg, 24);
  295. }
  296. /**
  297. * @brief Get field param_count from param_value message
  298. *
  299. * @return Total number of onboard parameters
  300. */
  301. static inline uint16_t mavlink_msg_param_value_get_param_count(const mavlink_message_t* msg)
  302. {
  303. return _MAV_RETURN_uint16_t(msg, 4);
  304. }
  305. /**
  306. * @brief Get field param_index from param_value message
  307. *
  308. * @return Index of this onboard parameter
  309. */
  310. static inline uint16_t mavlink_msg_param_value_get_param_index(const mavlink_message_t* msg)
  311. {
  312. return _MAV_RETURN_uint16_t(msg, 6);
  313. }
  314. /**
  315. * @brief Decode a param_value message into a struct
  316. *
  317. * @param msg The message to decode
  318. * @param param_value C-struct to decode the message contents into
  319. */
  320. static inline void mavlink_msg_param_value_decode(const mavlink_message_t* msg, mavlink_param_value_t* param_value)
  321. {
  322. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  323. param_value->param_value = mavlink_msg_param_value_get_param_value(msg);
  324. param_value->param_count = mavlink_msg_param_value_get_param_count(msg);
  325. param_value->param_index = mavlink_msg_param_value_get_param_index(msg);
  326. mavlink_msg_param_value_get_param_id(msg, param_value->param_id);
  327. param_value->param_type = mavlink_msg_param_value_get_param_type(msg);
  328. #else
  329. uint8_t len = msg->len < MAVLINK_MSG_ID_PARAM_VALUE_LEN? msg->len : MAVLINK_MSG_ID_PARAM_VALUE_LEN;
  330. memset(param_value, 0, MAVLINK_MSG_ID_PARAM_VALUE_LEN);
  331. memcpy(param_value, _MAV_PAYLOAD(msg), len);
  332. #endif
  333. }