mavlink_msg_change_operator_control.h 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334
  1. #pragma once
  2. // MESSAGE CHANGE_OPERATOR_CONTROL PACKING
  3. #define MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL 5
  4. typedef struct __mavlink_change_operator_control_t {
  5. uint8_t target_system; /*< System the GCS requests control for*/
  6. uint8_t control_request; /*< 0: request control of this MAV, 1: Release control of this MAV*/
  7. uint8_t version; /*< [rad] 0: key as plaintext, 1-255: future, different hashing/encryption variants. The GCS should in general use the safest mode possible initially and then gradually move down the encryption level if it gets a NACK message indicating an encryption mismatch.*/
  8. char passkey[25]; /*< Password / Key, depending on version plaintext or encrypted. 25 or less characters, NULL terminated. The characters may involve A-Z, a-z, 0-9, and "!?,.-"*/
  9. } mavlink_change_operator_control_t;
  10. #define MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL_LEN 28
  11. #define MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL_MIN_LEN 28
  12. #define MAVLINK_MSG_ID_5_LEN 28
  13. #define MAVLINK_MSG_ID_5_MIN_LEN 28
  14. #define MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL_CRC 217
  15. #define MAVLINK_MSG_ID_5_CRC 217
  16. #define MAVLINK_MSG_CHANGE_OPERATOR_CONTROL_FIELD_PASSKEY_LEN 25
  17. #if MAVLINK_COMMAND_24BIT
  18. #define MAVLINK_MESSAGE_INFO_CHANGE_OPERATOR_CONTROL { \
  19. 5, \
  20. "CHANGE_OPERATOR_CONTROL", \
  21. 4, \
  22. { { "target_system", NULL, MAVLINK_TYPE_UINT8_T, 0, 0, offsetof(mavlink_change_operator_control_t, target_system) }, \
  23. { "control_request", NULL, MAVLINK_TYPE_UINT8_T, 0, 1, offsetof(mavlink_change_operator_control_t, control_request) }, \
  24. { "version", NULL, MAVLINK_TYPE_UINT8_T, 0, 2, offsetof(mavlink_change_operator_control_t, version) }, \
  25. { "passkey", NULL, MAVLINK_TYPE_CHAR, 25, 3, offsetof(mavlink_change_operator_control_t, passkey) }, \
  26. } \
  27. }
  28. #else
  29. #define MAVLINK_MESSAGE_INFO_CHANGE_OPERATOR_CONTROL { \
  30. "CHANGE_OPERATOR_CONTROL", \
  31. 4, \
  32. { { "target_system", NULL, MAVLINK_TYPE_UINT8_T, 0, 0, offsetof(mavlink_change_operator_control_t, target_system) }, \
  33. { "control_request", NULL, MAVLINK_TYPE_UINT8_T, 0, 1, offsetof(mavlink_change_operator_control_t, control_request) }, \
  34. { "version", NULL, MAVLINK_TYPE_UINT8_T, 0, 2, offsetof(mavlink_change_operator_control_t, version) }, \
  35. { "passkey", NULL, MAVLINK_TYPE_CHAR, 25, 3, offsetof(mavlink_change_operator_control_t, passkey) }, \
  36. } \
  37. }
  38. #endif
  39. /**
  40. * @brief Pack a change_operator_control message
  41. * @param system_id ID of this system
  42. * @param component_id ID of this component (e.g. 200 for IMU)
  43. * @param msg The MAVLink message to compress the data into
  44. *
  45. * @param target_system System the GCS requests control for
  46. * @param control_request 0: request control of this MAV, 1: Release control of this MAV
  47. * @param version [rad] 0: key as plaintext, 1-255: future, different hashing/encryption variants. The GCS should in general use the safest mode possible initially and then gradually move down the encryption level if it gets a NACK message indicating an encryption mismatch.
  48. * @param passkey Password / Key, depending on version plaintext or encrypted. 25 or less characters, NULL terminated. The characters may involve A-Z, a-z, 0-9, and "!?,.-"
  49. * @return length of the message in bytes (excluding serial stream start sign)
  50. */
  51. static inline uint16_t mavlink_msg_change_operator_control_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg,
  52. uint8_t target_system, uint8_t control_request, uint8_t version, const char *passkey)
  53. {
  54. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  55. char buf[MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL_LEN];
  56. _mav_put_uint8_t(buf, 0, target_system);
  57. _mav_put_uint8_t(buf, 1, control_request);
  58. _mav_put_uint8_t(buf, 2, version);
  59. _mav_put_char_array(buf, 3, passkey, 25);
  60. memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL_LEN);
  61. #else
  62. mavlink_change_operator_control_t packet;
  63. packet.target_system = target_system;
  64. packet.control_request = control_request;
  65. packet.version = version;
  66. mav_array_memcpy(packet.passkey, passkey, sizeof(char)*25);
  67. memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL_LEN);
  68. #endif
  69. msg->msgid = MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL;
  70. return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL_MIN_LEN, MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL_LEN, MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL_CRC);
  71. }
  72. /**
  73. * @brief Pack a change_operator_control message
  74. * @param system_id ID of this system
  75. * @param component_id ID of this component (e.g. 200 for IMU)
  76. * @param status MAVLink status structure
  77. * @param msg The MAVLink message to compress the data into
  78. *
  79. * @param target_system System the GCS requests control for
  80. * @param control_request 0: request control of this MAV, 1: Release control of this MAV
  81. * @param version [rad] 0: key as plaintext, 1-255: future, different hashing/encryption variants. The GCS should in general use the safest mode possible initially and then gradually move down the encryption level if it gets a NACK message indicating an encryption mismatch.
  82. * @param passkey Password / Key, depending on version plaintext or encrypted. 25 or less characters, NULL terminated. The characters may involve A-Z, a-z, 0-9, and "!?,.-"
  83. * @return length of the message in bytes (excluding serial stream start sign)
  84. */
  85. static inline uint16_t mavlink_msg_change_operator_control_pack_status(uint8_t system_id, uint8_t component_id, mavlink_status_t *_status, mavlink_message_t* msg,
  86. uint8_t target_system, uint8_t control_request, uint8_t version, const char *passkey)
  87. {
  88. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  89. char buf[MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL_LEN];
  90. _mav_put_uint8_t(buf, 0, target_system);
  91. _mav_put_uint8_t(buf, 1, control_request);
  92. _mav_put_uint8_t(buf, 2, version);
  93. _mav_put_char_array(buf, 3, passkey, 25);
  94. memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL_LEN);
  95. #else
  96. mavlink_change_operator_control_t packet;
  97. packet.target_system = target_system;
  98. packet.control_request = control_request;
  99. packet.version = version;
  100. mav_array_memcpy(packet.passkey, passkey, sizeof(char)*25);
  101. memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL_LEN);
  102. #endif
  103. msg->msgid = MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL;
  104. #if MAVLINK_CRC_EXTRA
  105. return mavlink_finalize_message_buffer(msg, system_id, component_id, _status, MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL_MIN_LEN, MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL_LEN, MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL_CRC);
  106. #else
  107. return mavlink_finalize_message_buffer(msg, system_id, component_id, _status, MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL_MIN_LEN, MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL_LEN);
  108. #endif
  109. }
  110. /**
  111. * @brief Pack a change_operator_control message on a channel
  112. * @param system_id ID of this system
  113. * @param component_id ID of this component (e.g. 200 for IMU)
  114. * @param chan The MAVLink channel this message will be sent over
  115. * @param msg The MAVLink message to compress the data into
  116. * @param target_system System the GCS requests control for
  117. * @param control_request 0: request control of this MAV, 1: Release control of this MAV
  118. * @param version [rad] 0: key as plaintext, 1-255: future, different hashing/encryption variants. The GCS should in general use the safest mode possible initially and then gradually move down the encryption level if it gets a NACK message indicating an encryption mismatch.
  119. * @param passkey Password / Key, depending on version plaintext or encrypted. 25 or less characters, NULL terminated. The characters may involve A-Z, a-z, 0-9, and "!?,.-"
  120. * @return length of the message in bytes (excluding serial stream start sign)
  121. */
  122. static inline uint16_t mavlink_msg_change_operator_control_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan,
  123. mavlink_message_t* msg,
  124. uint8_t target_system,uint8_t control_request,uint8_t version,const char *passkey)
  125. {
  126. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  127. char buf[MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL_LEN];
  128. _mav_put_uint8_t(buf, 0, target_system);
  129. _mav_put_uint8_t(buf, 1, control_request);
  130. _mav_put_uint8_t(buf, 2, version);
  131. _mav_put_char_array(buf, 3, passkey, 25);
  132. memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL_LEN);
  133. #else
  134. mavlink_change_operator_control_t packet;
  135. packet.target_system = target_system;
  136. packet.control_request = control_request;
  137. packet.version = version;
  138. mav_array_memcpy(packet.passkey, passkey, sizeof(char)*25);
  139. memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL_LEN);
  140. #endif
  141. msg->msgid = MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL;
  142. return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL_MIN_LEN, MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL_LEN, MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL_CRC);
  143. }
  144. /**
  145. * @brief Encode a change_operator_control struct
  146. *
  147. * @param system_id ID of this system
  148. * @param component_id ID of this component (e.g. 200 for IMU)
  149. * @param msg The MAVLink message to compress the data into
  150. * @param change_operator_control C-struct to read the message contents from
  151. */
  152. static inline uint16_t mavlink_msg_change_operator_control_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_change_operator_control_t* change_operator_control)
  153. {
  154. return mavlink_msg_change_operator_control_pack(system_id, component_id, msg, change_operator_control->target_system, change_operator_control->control_request, change_operator_control->version, change_operator_control->passkey);
  155. }
  156. /**
  157. * @brief Encode a change_operator_control struct on a channel
  158. *
  159. * @param system_id ID of this system
  160. * @param component_id ID of this component (e.g. 200 for IMU)
  161. * @param chan The MAVLink channel this message will be sent over
  162. * @param msg The MAVLink message to compress the data into
  163. * @param change_operator_control C-struct to read the message contents from
  164. */
  165. static inline uint16_t mavlink_msg_change_operator_control_encode_chan(uint8_t system_id, uint8_t component_id, uint8_t chan, mavlink_message_t* msg, const mavlink_change_operator_control_t* change_operator_control)
  166. {
  167. return mavlink_msg_change_operator_control_pack_chan(system_id, component_id, chan, msg, change_operator_control->target_system, change_operator_control->control_request, change_operator_control->version, change_operator_control->passkey);
  168. }
  169. /**
  170. * @brief Encode a change_operator_control struct with provided status structure
  171. *
  172. * @param system_id ID of this system
  173. * @param component_id ID of this component (e.g. 200 for IMU)
  174. * @param status MAVLink status structure
  175. * @param msg The MAVLink message to compress the data into
  176. * @param change_operator_control C-struct to read the message contents from
  177. */
  178. static inline uint16_t mavlink_msg_change_operator_control_encode_status(uint8_t system_id, uint8_t component_id, mavlink_status_t* _status, mavlink_message_t* msg, const mavlink_change_operator_control_t* change_operator_control)
  179. {
  180. return mavlink_msg_change_operator_control_pack_status(system_id, component_id, _status, msg, change_operator_control->target_system, change_operator_control->control_request, change_operator_control->version, change_operator_control->passkey);
  181. }
  182. /**
  183. * @brief Send a change_operator_control message
  184. * @param chan MAVLink channel to send the message
  185. *
  186. * @param target_system System the GCS requests control for
  187. * @param control_request 0: request control of this MAV, 1: Release control of this MAV
  188. * @param version [rad] 0: key as plaintext, 1-255: future, different hashing/encryption variants. The GCS should in general use the safest mode possible initially and then gradually move down the encryption level if it gets a NACK message indicating an encryption mismatch.
  189. * @param passkey Password / Key, depending on version plaintext or encrypted. 25 or less characters, NULL terminated. The characters may involve A-Z, a-z, 0-9, and "!?,.-"
  190. */
  191. #ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS
  192. static inline void mavlink_msg_change_operator_control_send(mavlink_channel_t chan, uint8_t target_system, uint8_t control_request, uint8_t version, const char *passkey)
  193. {
  194. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  195. char buf[MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL_LEN];
  196. _mav_put_uint8_t(buf, 0, target_system);
  197. _mav_put_uint8_t(buf, 1, control_request);
  198. _mav_put_uint8_t(buf, 2, version);
  199. _mav_put_char_array(buf, 3, passkey, 25);
  200. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL, buf, MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL_MIN_LEN, MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL_LEN, MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL_CRC);
  201. #else
  202. mavlink_change_operator_control_t packet;
  203. packet.target_system = target_system;
  204. packet.control_request = control_request;
  205. packet.version = version;
  206. mav_array_memcpy(packet.passkey, passkey, sizeof(char)*25);
  207. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL, (const char *)&packet, MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL_MIN_LEN, MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL_LEN, MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL_CRC);
  208. #endif
  209. }
  210. /**
  211. * @brief Send a change_operator_control message
  212. * @param chan MAVLink channel to send the message
  213. * @param struct The MAVLink struct to serialize
  214. */
  215. static inline void mavlink_msg_change_operator_control_send_struct(mavlink_channel_t chan, const mavlink_change_operator_control_t* change_operator_control)
  216. {
  217. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  218. mavlink_msg_change_operator_control_send(chan, change_operator_control->target_system, change_operator_control->control_request, change_operator_control->version, change_operator_control->passkey);
  219. #else
  220. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL, (const char *)change_operator_control, MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL_MIN_LEN, MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL_LEN, MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL_CRC);
  221. #endif
  222. }
  223. #if MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL_LEN <= MAVLINK_MAX_PAYLOAD_LEN
  224. /*
  225. This variant of _send() can be used to save stack space by re-using
  226. memory from the receive buffer. The caller provides a
  227. mavlink_message_t which is the size of a full mavlink message. This
  228. is usually the receive buffer for the channel, and allows a reply to an
  229. incoming message with minimum stack space usage.
  230. */
  231. static inline void mavlink_msg_change_operator_control_send_buf(mavlink_message_t *msgbuf, mavlink_channel_t chan, uint8_t target_system, uint8_t control_request, uint8_t version, const char *passkey)
  232. {
  233. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  234. char *buf = (char *)msgbuf;
  235. _mav_put_uint8_t(buf, 0, target_system);
  236. _mav_put_uint8_t(buf, 1, control_request);
  237. _mav_put_uint8_t(buf, 2, version);
  238. _mav_put_char_array(buf, 3, passkey, 25);
  239. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL, buf, MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL_MIN_LEN, MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL_LEN, MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL_CRC);
  240. #else
  241. mavlink_change_operator_control_t *packet = (mavlink_change_operator_control_t *)msgbuf;
  242. packet->target_system = target_system;
  243. packet->control_request = control_request;
  244. packet->version = version;
  245. mav_array_memcpy(packet->passkey, passkey, sizeof(char)*25);
  246. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL, (const char *)packet, MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL_MIN_LEN, MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL_LEN, MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL_CRC);
  247. #endif
  248. }
  249. #endif
  250. #endif
  251. // MESSAGE CHANGE_OPERATOR_CONTROL UNPACKING
  252. /**
  253. * @brief Get field target_system from change_operator_control message
  254. *
  255. * @return System the GCS requests control for
  256. */
  257. static inline uint8_t mavlink_msg_change_operator_control_get_target_system(const mavlink_message_t* msg)
  258. {
  259. return _MAV_RETURN_uint8_t(msg, 0);
  260. }
  261. /**
  262. * @brief Get field control_request from change_operator_control message
  263. *
  264. * @return 0: request control of this MAV, 1: Release control of this MAV
  265. */
  266. static inline uint8_t mavlink_msg_change_operator_control_get_control_request(const mavlink_message_t* msg)
  267. {
  268. return _MAV_RETURN_uint8_t(msg, 1);
  269. }
  270. /**
  271. * @brief Get field version from change_operator_control message
  272. *
  273. * @return [rad] 0: key as plaintext, 1-255: future, different hashing/encryption variants. The GCS should in general use the safest mode possible initially and then gradually move down the encryption level if it gets a NACK message indicating an encryption mismatch.
  274. */
  275. static inline uint8_t mavlink_msg_change_operator_control_get_version(const mavlink_message_t* msg)
  276. {
  277. return _MAV_RETURN_uint8_t(msg, 2);
  278. }
  279. /**
  280. * @brief Get field passkey from change_operator_control message
  281. *
  282. * @return Password / Key, depending on version plaintext or encrypted. 25 or less characters, NULL terminated. The characters may involve A-Z, a-z, 0-9, and "!?,.-"
  283. */
  284. static inline uint16_t mavlink_msg_change_operator_control_get_passkey(const mavlink_message_t* msg, char *passkey)
  285. {
  286. return _MAV_RETURN_char_array(msg, passkey, 25, 3);
  287. }
  288. /**
  289. * @brief Decode a change_operator_control message into a struct
  290. *
  291. * @param msg The message to decode
  292. * @param change_operator_control C-struct to decode the message contents into
  293. */
  294. static inline void mavlink_msg_change_operator_control_decode(const mavlink_message_t* msg, mavlink_change_operator_control_t* change_operator_control)
  295. {
  296. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  297. change_operator_control->target_system = mavlink_msg_change_operator_control_get_target_system(msg);
  298. change_operator_control->control_request = mavlink_msg_change_operator_control_get_control_request(msg);
  299. change_operator_control->version = mavlink_msg_change_operator_control_get_version(msg);
  300. mavlink_msg_change_operator_control_get_passkey(msg, change_operator_control->passkey);
  301. #else
  302. uint8_t len = msg->len < MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL_LEN? msg->len : MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL_LEN;
  303. memset(change_operator_control, 0, MAVLINK_MSG_ID_CHANGE_OPERATOR_CONTROL_LEN);
  304. memcpy(change_operator_control, _MAV_PAYLOAD(msg), len);
  305. #endif
  306. }