mavlink_msg_cellular_status.h 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363
  1. #pragma once
  2. // MESSAGE CELLULAR_STATUS PACKING
  3. #define MAVLINK_MSG_ID_CELLULAR_STATUS 334
  4. typedef struct __mavlink_cellular_status_t {
  5. uint16_t mcc; /*< Mobile country code. If unknown, set to UINT16_MAX*/
  6. uint16_t mnc; /*< Mobile network code. If unknown, set to UINT16_MAX*/
  7. uint16_t lac; /*< Location area code. If unknown, set to 0*/
  8. uint8_t status; /*< Cellular modem status*/
  9. uint8_t failure_reason; /*< Failure reason when status in in CELLULAR_STATUS_FLAG_FAILED*/
  10. uint8_t type; /*< Cellular network radio type: gsm, cdma, lte...*/
  11. uint8_t quality; /*< Signal quality in percent. If unknown, set to UINT8_MAX*/
  12. } mavlink_cellular_status_t;
  13. #define MAVLINK_MSG_ID_CELLULAR_STATUS_LEN 10
  14. #define MAVLINK_MSG_ID_CELLULAR_STATUS_MIN_LEN 10
  15. #define MAVLINK_MSG_ID_334_LEN 10
  16. #define MAVLINK_MSG_ID_334_MIN_LEN 10
  17. #define MAVLINK_MSG_ID_CELLULAR_STATUS_CRC 72
  18. #define MAVLINK_MSG_ID_334_CRC 72
  19. #if MAVLINK_COMMAND_24BIT
  20. #define MAVLINK_MESSAGE_INFO_CELLULAR_STATUS { \
  21. 334, \
  22. "CELLULAR_STATUS", \
  23. 7, \
  24. { { "status", NULL, MAVLINK_TYPE_UINT8_T, 0, 6, offsetof(mavlink_cellular_status_t, status) }, \
  25. { "failure_reason", NULL, MAVLINK_TYPE_UINT8_T, 0, 7, offsetof(mavlink_cellular_status_t, failure_reason) }, \
  26. { "type", NULL, MAVLINK_TYPE_UINT8_T, 0, 8, offsetof(mavlink_cellular_status_t, type) }, \
  27. { "quality", NULL, MAVLINK_TYPE_UINT8_T, 0, 9, offsetof(mavlink_cellular_status_t, quality) }, \
  28. { "mcc", NULL, MAVLINK_TYPE_UINT16_T, 0, 0, offsetof(mavlink_cellular_status_t, mcc) }, \
  29. { "mnc", NULL, MAVLINK_TYPE_UINT16_T, 0, 2, offsetof(mavlink_cellular_status_t, mnc) }, \
  30. { "lac", NULL, MAVLINK_TYPE_UINT16_T, 0, 4, offsetof(mavlink_cellular_status_t, lac) }, \
  31. } \
  32. }
  33. #else
  34. #define MAVLINK_MESSAGE_INFO_CELLULAR_STATUS { \
  35. "CELLULAR_STATUS", \
  36. 7, \
  37. { { "status", NULL, MAVLINK_TYPE_UINT8_T, 0, 6, offsetof(mavlink_cellular_status_t, status) }, \
  38. { "failure_reason", NULL, MAVLINK_TYPE_UINT8_T, 0, 7, offsetof(mavlink_cellular_status_t, failure_reason) }, \
  39. { "type", NULL, MAVLINK_TYPE_UINT8_T, 0, 8, offsetof(mavlink_cellular_status_t, type) }, \
  40. { "quality", NULL, MAVLINK_TYPE_UINT8_T, 0, 9, offsetof(mavlink_cellular_status_t, quality) }, \
  41. { "mcc", NULL, MAVLINK_TYPE_UINT16_T, 0, 0, offsetof(mavlink_cellular_status_t, mcc) }, \
  42. { "mnc", NULL, MAVLINK_TYPE_UINT16_T, 0, 2, offsetof(mavlink_cellular_status_t, mnc) }, \
  43. { "lac", NULL, MAVLINK_TYPE_UINT16_T, 0, 4, offsetof(mavlink_cellular_status_t, lac) }, \
  44. } \
  45. }
  46. #endif
  47. /**
  48. * @brief Pack a cellular_status message
  49. * @param system_id ID of this system
  50. * @param component_id ID of this component (e.g. 200 for IMU)
  51. * @param msg The MAVLink message to compress the data into
  52. *
  53. * @param status Cellular modem status
  54. * @param failure_reason Failure reason when status in in CELLULAR_STATUS_FLAG_FAILED
  55. * @param type Cellular network radio type: gsm, cdma, lte...
  56. * @param quality Signal quality in percent. If unknown, set to UINT8_MAX
  57. * @param mcc Mobile country code. If unknown, set to UINT16_MAX
  58. * @param mnc Mobile network code. If unknown, set to UINT16_MAX
  59. * @param lac Location area code. If unknown, set to 0
  60. * @return length of the message in bytes (excluding serial stream start sign)
  61. */
  62. static inline uint16_t mavlink_msg_cellular_status_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg,
  63. uint8_t status, uint8_t failure_reason, uint8_t type, uint8_t quality, uint16_t mcc, uint16_t mnc, uint16_t lac)
  64. {
  65. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  66. char buf[MAVLINK_MSG_ID_CELLULAR_STATUS_LEN];
  67. _mav_put_uint16_t(buf, 0, mcc);
  68. _mav_put_uint16_t(buf, 2, mnc);
  69. _mav_put_uint16_t(buf, 4, lac);
  70. _mav_put_uint8_t(buf, 6, status);
  71. _mav_put_uint8_t(buf, 7, failure_reason);
  72. _mav_put_uint8_t(buf, 8, type);
  73. _mav_put_uint8_t(buf, 9, quality);
  74. memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_CELLULAR_STATUS_LEN);
  75. #else
  76. mavlink_cellular_status_t packet;
  77. packet.mcc = mcc;
  78. packet.mnc = mnc;
  79. packet.lac = lac;
  80. packet.status = status;
  81. packet.failure_reason = failure_reason;
  82. packet.type = type;
  83. packet.quality = quality;
  84. memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_CELLULAR_STATUS_LEN);
  85. #endif
  86. msg->msgid = MAVLINK_MSG_ID_CELLULAR_STATUS;
  87. return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_CELLULAR_STATUS_MIN_LEN, MAVLINK_MSG_ID_CELLULAR_STATUS_LEN, MAVLINK_MSG_ID_CELLULAR_STATUS_CRC);
  88. }
  89. /**
  90. * @brief Pack a cellular_status 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 status Cellular modem status
  96. * @param failure_reason Failure reason when status in in CELLULAR_STATUS_FLAG_FAILED
  97. * @param type Cellular network radio type: gsm, cdma, lte...
  98. * @param quality Signal quality in percent. If unknown, set to UINT8_MAX
  99. * @param mcc Mobile country code. If unknown, set to UINT16_MAX
  100. * @param mnc Mobile network code. If unknown, set to UINT16_MAX
  101. * @param lac Location area code. If unknown, set to 0
  102. * @return length of the message in bytes (excluding serial stream start sign)
  103. */
  104. static inline uint16_t mavlink_msg_cellular_status_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan,
  105. mavlink_message_t* msg,
  106. uint8_t status,uint8_t failure_reason,uint8_t type,uint8_t quality,uint16_t mcc,uint16_t mnc,uint16_t lac)
  107. {
  108. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  109. char buf[MAVLINK_MSG_ID_CELLULAR_STATUS_LEN];
  110. _mav_put_uint16_t(buf, 0, mcc);
  111. _mav_put_uint16_t(buf, 2, mnc);
  112. _mav_put_uint16_t(buf, 4, lac);
  113. _mav_put_uint8_t(buf, 6, status);
  114. _mav_put_uint8_t(buf, 7, failure_reason);
  115. _mav_put_uint8_t(buf, 8, type);
  116. _mav_put_uint8_t(buf, 9, quality);
  117. memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_CELLULAR_STATUS_LEN);
  118. #else
  119. mavlink_cellular_status_t packet;
  120. packet.mcc = mcc;
  121. packet.mnc = mnc;
  122. packet.lac = lac;
  123. packet.status = status;
  124. packet.failure_reason = failure_reason;
  125. packet.type = type;
  126. packet.quality = quality;
  127. memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_CELLULAR_STATUS_LEN);
  128. #endif
  129. msg->msgid = MAVLINK_MSG_ID_CELLULAR_STATUS;
  130. return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_CELLULAR_STATUS_MIN_LEN, MAVLINK_MSG_ID_CELLULAR_STATUS_LEN, MAVLINK_MSG_ID_CELLULAR_STATUS_CRC);
  131. }
  132. /**
  133. * @brief Encode a cellular_status struct
  134. *
  135. * @param system_id ID of this system
  136. * @param component_id ID of this component (e.g. 200 for IMU)
  137. * @param msg The MAVLink message to compress the data into
  138. * @param cellular_status C-struct to read the message contents from
  139. */
  140. static inline uint16_t mavlink_msg_cellular_status_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_cellular_status_t* cellular_status)
  141. {
  142. return mavlink_msg_cellular_status_pack(system_id, component_id, msg, cellular_status->status, cellular_status->failure_reason, cellular_status->type, cellular_status->quality, cellular_status->mcc, cellular_status->mnc, cellular_status->lac);
  143. }
  144. /**
  145. * @brief Encode a cellular_status struct on a channel
  146. *
  147. * @param system_id ID of this system
  148. * @param component_id ID of this component (e.g. 200 for IMU)
  149. * @param chan The MAVLink channel this message will be sent over
  150. * @param msg The MAVLink message to compress the data into
  151. * @param cellular_status C-struct to read the message contents from
  152. */
  153. static inline uint16_t mavlink_msg_cellular_status_encode_chan(uint8_t system_id, uint8_t component_id, uint8_t chan, mavlink_message_t* msg, const mavlink_cellular_status_t* cellular_status)
  154. {
  155. return mavlink_msg_cellular_status_pack_chan(system_id, component_id, chan, msg, cellular_status->status, cellular_status->failure_reason, cellular_status->type, cellular_status->quality, cellular_status->mcc, cellular_status->mnc, cellular_status->lac);
  156. }
  157. /**
  158. * @brief Send a cellular_status message
  159. * @param chan MAVLink channel to send the message
  160. *
  161. * @param status Cellular modem status
  162. * @param failure_reason Failure reason when status in in CELLULAR_STATUS_FLAG_FAILED
  163. * @param type Cellular network radio type: gsm, cdma, lte...
  164. * @param quality Signal quality in percent. If unknown, set to UINT8_MAX
  165. * @param mcc Mobile country code. If unknown, set to UINT16_MAX
  166. * @param mnc Mobile network code. If unknown, set to UINT16_MAX
  167. * @param lac Location area code. If unknown, set to 0
  168. */
  169. #ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS
  170. static inline void mavlink_msg_cellular_status_send(mavlink_channel_t chan, uint8_t status, uint8_t failure_reason, uint8_t type, uint8_t quality, uint16_t mcc, uint16_t mnc, uint16_t lac)
  171. {
  172. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  173. char buf[MAVLINK_MSG_ID_CELLULAR_STATUS_LEN];
  174. _mav_put_uint16_t(buf, 0, mcc);
  175. _mav_put_uint16_t(buf, 2, mnc);
  176. _mav_put_uint16_t(buf, 4, lac);
  177. _mav_put_uint8_t(buf, 6, status);
  178. _mav_put_uint8_t(buf, 7, failure_reason);
  179. _mav_put_uint8_t(buf, 8, type);
  180. _mav_put_uint8_t(buf, 9, quality);
  181. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_CELLULAR_STATUS, buf, MAVLINK_MSG_ID_CELLULAR_STATUS_MIN_LEN, MAVLINK_MSG_ID_CELLULAR_STATUS_LEN, MAVLINK_MSG_ID_CELLULAR_STATUS_CRC);
  182. #else
  183. mavlink_cellular_status_t packet;
  184. packet.mcc = mcc;
  185. packet.mnc = mnc;
  186. packet.lac = lac;
  187. packet.status = status;
  188. packet.failure_reason = failure_reason;
  189. packet.type = type;
  190. packet.quality = quality;
  191. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_CELLULAR_STATUS, (const char *)&packet, MAVLINK_MSG_ID_CELLULAR_STATUS_MIN_LEN, MAVLINK_MSG_ID_CELLULAR_STATUS_LEN, MAVLINK_MSG_ID_CELLULAR_STATUS_CRC);
  192. #endif
  193. }
  194. /**
  195. * @brief Send a cellular_status message
  196. * @param chan MAVLink channel to send the message
  197. * @param struct The MAVLink struct to serialize
  198. */
  199. static inline void mavlink_msg_cellular_status_send_struct(mavlink_channel_t chan, const mavlink_cellular_status_t* cellular_status)
  200. {
  201. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  202. mavlink_msg_cellular_status_send(chan, cellular_status->status, cellular_status->failure_reason, cellular_status->type, cellular_status->quality, cellular_status->mcc, cellular_status->mnc, cellular_status->lac);
  203. #else
  204. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_CELLULAR_STATUS, (const char *)cellular_status, MAVLINK_MSG_ID_CELLULAR_STATUS_MIN_LEN, MAVLINK_MSG_ID_CELLULAR_STATUS_LEN, MAVLINK_MSG_ID_CELLULAR_STATUS_CRC);
  205. #endif
  206. }
  207. #if MAVLINK_MSG_ID_CELLULAR_STATUS_LEN <= MAVLINK_MAX_PAYLOAD_LEN
  208. /*
  209. This variant of _send() can be used to save stack space by re-using
  210. memory from the receive buffer. The caller provides a
  211. mavlink_message_t which is the size of a full mavlink message. This
  212. is usually the receive buffer for the channel, and allows a reply to an
  213. incoming message with minimum stack space usage.
  214. */
  215. static inline void mavlink_msg_cellular_status_send_buf(mavlink_message_t *msgbuf, mavlink_channel_t chan, uint8_t status, uint8_t failure_reason, uint8_t type, uint8_t quality, uint16_t mcc, uint16_t mnc, uint16_t lac)
  216. {
  217. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  218. char *buf = (char *)msgbuf;
  219. _mav_put_uint16_t(buf, 0, mcc);
  220. _mav_put_uint16_t(buf, 2, mnc);
  221. _mav_put_uint16_t(buf, 4, lac);
  222. _mav_put_uint8_t(buf, 6, status);
  223. _mav_put_uint8_t(buf, 7, failure_reason);
  224. _mav_put_uint8_t(buf, 8, type);
  225. _mav_put_uint8_t(buf, 9, quality);
  226. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_CELLULAR_STATUS, buf, MAVLINK_MSG_ID_CELLULAR_STATUS_MIN_LEN, MAVLINK_MSG_ID_CELLULAR_STATUS_LEN, MAVLINK_MSG_ID_CELLULAR_STATUS_CRC);
  227. #else
  228. mavlink_cellular_status_t *packet = (mavlink_cellular_status_t *)msgbuf;
  229. packet->mcc = mcc;
  230. packet->mnc = mnc;
  231. packet->lac = lac;
  232. packet->status = status;
  233. packet->failure_reason = failure_reason;
  234. packet->type = type;
  235. packet->quality = quality;
  236. _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_CELLULAR_STATUS, (const char *)packet, MAVLINK_MSG_ID_CELLULAR_STATUS_MIN_LEN, MAVLINK_MSG_ID_CELLULAR_STATUS_LEN, MAVLINK_MSG_ID_CELLULAR_STATUS_CRC);
  237. #endif
  238. }
  239. #endif
  240. #endif
  241. // MESSAGE CELLULAR_STATUS UNPACKING
  242. /**
  243. * @brief Get field status from cellular_status message
  244. *
  245. * @return Cellular modem status
  246. */
  247. static inline uint8_t mavlink_msg_cellular_status_get_status(const mavlink_message_t* msg)
  248. {
  249. return _MAV_RETURN_uint8_t(msg, 6);
  250. }
  251. /**
  252. * @brief Get field failure_reason from cellular_status message
  253. *
  254. * @return Failure reason when status in in CELLULAR_STATUS_FLAG_FAILED
  255. */
  256. static inline uint8_t mavlink_msg_cellular_status_get_failure_reason(const mavlink_message_t* msg)
  257. {
  258. return _MAV_RETURN_uint8_t(msg, 7);
  259. }
  260. /**
  261. * @brief Get field type from cellular_status message
  262. *
  263. * @return Cellular network radio type: gsm, cdma, lte...
  264. */
  265. static inline uint8_t mavlink_msg_cellular_status_get_type(const mavlink_message_t* msg)
  266. {
  267. return _MAV_RETURN_uint8_t(msg, 8);
  268. }
  269. /**
  270. * @brief Get field quality from cellular_status message
  271. *
  272. * @return Signal quality in percent. If unknown, set to UINT8_MAX
  273. */
  274. static inline uint8_t mavlink_msg_cellular_status_get_quality(const mavlink_message_t* msg)
  275. {
  276. return _MAV_RETURN_uint8_t(msg, 9);
  277. }
  278. /**
  279. * @brief Get field mcc from cellular_status message
  280. *
  281. * @return Mobile country code. If unknown, set to UINT16_MAX
  282. */
  283. static inline uint16_t mavlink_msg_cellular_status_get_mcc(const mavlink_message_t* msg)
  284. {
  285. return _MAV_RETURN_uint16_t(msg, 0);
  286. }
  287. /**
  288. * @brief Get field mnc from cellular_status message
  289. *
  290. * @return Mobile network code. If unknown, set to UINT16_MAX
  291. */
  292. static inline uint16_t mavlink_msg_cellular_status_get_mnc(const mavlink_message_t* msg)
  293. {
  294. return _MAV_RETURN_uint16_t(msg, 2);
  295. }
  296. /**
  297. * @brief Get field lac from cellular_status message
  298. *
  299. * @return Location area code. If unknown, set to 0
  300. */
  301. static inline uint16_t mavlink_msg_cellular_status_get_lac(const mavlink_message_t* msg)
  302. {
  303. return _MAV_RETURN_uint16_t(msg, 4);
  304. }
  305. /**
  306. * @brief Decode a cellular_status message into a struct
  307. *
  308. * @param msg The message to decode
  309. * @param cellular_status C-struct to decode the message contents into
  310. */
  311. static inline void mavlink_msg_cellular_status_decode(const mavlink_message_t* msg, mavlink_cellular_status_t* cellular_status)
  312. {
  313. #if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS
  314. cellular_status->mcc = mavlink_msg_cellular_status_get_mcc(msg);
  315. cellular_status->mnc = mavlink_msg_cellular_status_get_mnc(msg);
  316. cellular_status->lac = mavlink_msg_cellular_status_get_lac(msg);
  317. cellular_status->status = mavlink_msg_cellular_status_get_status(msg);
  318. cellular_status->failure_reason = mavlink_msg_cellular_status_get_failure_reason(msg);
  319. cellular_status->type = mavlink_msg_cellular_status_get_type(msg);
  320. cellular_status->quality = mavlink_msg_cellular_status_get_quality(msg);
  321. #else
  322. uint8_t len = msg->len < MAVLINK_MSG_ID_CELLULAR_STATUS_LEN? msg->len : MAVLINK_MSG_ID_CELLULAR_STATUS_LEN;
  323. memset(cellular_status, 0, MAVLINK_MSG_ID_CELLULAR_STATUS_LEN);
  324. memcpy(cellular_status, _MAV_PAYLOAD(msg), len);
  325. #endif
  326. }