mavlink_msg_gps_status.h 10.8 KB
Newer Older
James Goppert's avatar
James Goppert committed
1 2 3
// MESSAGE GPS_STATUS PACKING

#define MAVLINK_MSG_ID_GPS_STATUS 27
lm's avatar
lm committed
4 5
#define MAVLINK_MSG_ID_GPS_STATUS_LEN 101
#define MAVLINK_MSG_27_LEN 101
James Goppert's avatar
James Goppert committed
6 7 8 9

typedef struct __mavlink_gps_status_t 
{
	uint8_t satellites_visible; ///< Number of satellites visible
lm's avatar
lm committed
10 11 12 13 14
	uint8_t satellite_prn[20]; ///< Global satellite ID
	uint8_t satellite_used[20]; ///< 0: Satellite not used, 1: used for localization
	uint8_t satellite_elevation[20]; ///< Elevation (0: right on top of receiver, 90: on the horizon) of satellite
	uint8_t satellite_azimuth[20]; ///< Direction of satellite, 0: 0 deg, 255: 360 deg.
	uint8_t satellite_snr[20]; ///< Signal to noise ratio of satellite
James Goppert's avatar
James Goppert committed
15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36

} mavlink_gps_status_t;
#define MAVLINK_MSG_GPS_STATUS_FIELD_SATELLITE_PRN_LEN 20
#define MAVLINK_MSG_GPS_STATUS_FIELD_SATELLITE_USED_LEN 20
#define MAVLINK_MSG_GPS_STATUS_FIELD_SATELLITE_ELEVATION_LEN 20
#define MAVLINK_MSG_GPS_STATUS_FIELD_SATELLITE_AZIMUTH_LEN 20
#define MAVLINK_MSG_GPS_STATUS_FIELD_SATELLITE_SNR_LEN 20

/**
 * @brief Pack a gps_status message
 * @param system_id ID of this system
 * @param component_id ID of this component (e.g. 200 for IMU)
 * @param msg The MAVLink message to compress the data into
 *
 * @param satellites_visible Number of satellites visible
 * @param satellite_prn Global satellite ID
 * @param satellite_used 0: Satellite not used, 1: used for localization
 * @param satellite_elevation Elevation (0: right on top of receiver, 90: on the horizon) of satellite
 * @param satellite_azimuth Direction of satellite, 0: 0 deg, 255: 360 deg.
 * @param satellite_snr Signal to noise ratio of satellite
 * @return length of the message in bytes (excluding serial stream start sign)
 */
lm's avatar
lm committed
37
static inline uint16_t mavlink_msg_gps_status_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, uint8_t satellites_visible, const uint8_t* satellite_prn, const uint8_t* satellite_used, const uint8_t* satellite_elevation, const uint8_t* satellite_azimuth, const uint8_t* satellite_snr)
James Goppert's avatar
James Goppert committed
38
{
lm's avatar
lm committed
39
	mavlink_gps_status_t *p = (mavlink_gps_status_t *)&msg->payload[0];
James Goppert's avatar
James Goppert committed
40 41
	msg->msgid = MAVLINK_MSG_ID_GPS_STATUS;

lm's avatar
lm committed
42 43 44 45 46 47
	p->satellites_visible = satellites_visible; // uint8_t:Number of satellites visible
	memcpy(p->satellite_prn, satellite_prn, sizeof(p->satellite_prn)); // uint8_t[20]:Global satellite ID
	memcpy(p->satellite_used, satellite_used, sizeof(p->satellite_used)); // uint8_t[20]:0: Satellite not used, 1: used for localization
	memcpy(p->satellite_elevation, satellite_elevation, sizeof(p->satellite_elevation)); // uint8_t[20]:Elevation (0: right on top of receiver, 90: on the horizon) of satellite
	memcpy(p->satellite_azimuth, satellite_azimuth, sizeof(p->satellite_azimuth)); // uint8_t[20]:Direction of satellite, 0: 0 deg, 255: 360 deg.
	memcpy(p->satellite_snr, satellite_snr, sizeof(p->satellite_snr)); // uint8_t[20]:Signal to noise ratio of satellite
James Goppert's avatar
James Goppert committed
48

lm's avatar
lm committed
49
	return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_GPS_STATUS_LEN);
James Goppert's avatar
James Goppert committed
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65
}

/**
 * @brief Pack a gps_status message
 * @param system_id ID of this system
 * @param component_id ID of this component (e.g. 200 for IMU)
 * @param chan The MAVLink channel this message was sent over
 * @param msg The MAVLink message to compress the data into
 * @param satellites_visible Number of satellites visible
 * @param satellite_prn Global satellite ID
 * @param satellite_used 0: Satellite not used, 1: used for localization
 * @param satellite_elevation Elevation (0: right on top of receiver, 90: on the horizon) of satellite
 * @param satellite_azimuth Direction of satellite, 0: 0 deg, 255: 360 deg.
 * @param satellite_snr Signal to noise ratio of satellite
 * @return length of the message in bytes (excluding serial stream start sign)
 */
lm's avatar
lm committed
66
static inline uint16_t mavlink_msg_gps_status_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan, mavlink_message_t* msg, uint8_t satellites_visible, const uint8_t* satellite_prn, const uint8_t* satellite_used, const uint8_t* satellite_elevation, const uint8_t* satellite_azimuth, const uint8_t* satellite_snr)
James Goppert's avatar
James Goppert committed
67
{
lm's avatar
lm committed
68
	mavlink_gps_status_t *p = (mavlink_gps_status_t *)&msg->payload[0];
James Goppert's avatar
James Goppert committed
69 70
	msg->msgid = MAVLINK_MSG_ID_GPS_STATUS;

lm's avatar
lm committed
71 72 73 74 75 76
	p->satellites_visible = satellites_visible; // uint8_t:Number of satellites visible
	memcpy(p->satellite_prn, satellite_prn, sizeof(p->satellite_prn)); // uint8_t[20]:Global satellite ID
	memcpy(p->satellite_used, satellite_used, sizeof(p->satellite_used)); // uint8_t[20]:0: Satellite not used, 1: used for localization
	memcpy(p->satellite_elevation, satellite_elevation, sizeof(p->satellite_elevation)); // uint8_t[20]:Elevation (0: right on top of receiver, 90: on the horizon) of satellite
	memcpy(p->satellite_azimuth, satellite_azimuth, sizeof(p->satellite_azimuth)); // uint8_t[20]:Direction of satellite, 0: 0 deg, 255: 360 deg.
	memcpy(p->satellite_snr, satellite_snr, sizeof(p->satellite_snr)); // uint8_t[20]:Signal to noise ratio of satellite
James Goppert's avatar
James Goppert committed
77

lm's avatar
lm committed
78
	return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_GPS_STATUS_LEN);
James Goppert's avatar
James Goppert committed
79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104
}

/**
 * @brief Encode a gps_status struct into a message
 *
 * @param system_id ID of this system
 * @param component_id ID of this component (e.g. 200 for IMU)
 * @param msg The MAVLink message to compress the data into
 * @param gps_status C-struct to read the message contents from
 */
static inline uint16_t mavlink_msg_gps_status_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_gps_status_t* gps_status)
{
	return mavlink_msg_gps_status_pack(system_id, component_id, msg, gps_status->satellites_visible, gps_status->satellite_prn, gps_status->satellite_used, gps_status->satellite_elevation, gps_status->satellite_azimuth, gps_status->satellite_snr);
}

/**
 * @brief Send a gps_status message
 * @param chan MAVLink channel to send the message
 *
 * @param satellites_visible Number of satellites visible
 * @param satellite_prn Global satellite ID
 * @param satellite_used 0: Satellite not used, 1: used for localization
 * @param satellite_elevation Elevation (0: right on top of receiver, 90: on the horizon) of satellite
 * @param satellite_azimuth Direction of satellite, 0: 0 deg, 255: 360 deg.
 * @param satellite_snr Signal to noise ratio of satellite
 */
lm's avatar
lm committed
105 106


107
#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS
lm's avatar
lm committed
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
static inline void mavlink_msg_gps_status_send(mavlink_channel_t chan, uint8_t satellites_visible, const uint8_t* satellite_prn, const uint8_t* satellite_used, const uint8_t* satellite_elevation, const uint8_t* satellite_azimuth, const uint8_t* satellite_snr)
{
	mavlink_header_t hdr;
	mavlink_gps_status_t payload;
	uint16_t checksum;
	mavlink_gps_status_t *p = &payload;

	p->satellites_visible = satellites_visible; // uint8_t:Number of satellites visible
	memcpy(p->satellite_prn, satellite_prn, sizeof(p->satellite_prn)); // uint8_t[20]:Global satellite ID
	memcpy(p->satellite_used, satellite_used, sizeof(p->satellite_used)); // uint8_t[20]:0: Satellite not used, 1: used for localization
	memcpy(p->satellite_elevation, satellite_elevation, sizeof(p->satellite_elevation)); // uint8_t[20]:Elevation (0: right on top of receiver, 90: on the horizon) of satellite
	memcpy(p->satellite_azimuth, satellite_azimuth, sizeof(p->satellite_azimuth)); // uint8_t[20]:Direction of satellite, 0: 0 deg, 255: 360 deg.
	memcpy(p->satellite_snr, satellite_snr, sizeof(p->satellite_snr)); // uint8_t[20]:Signal to noise ratio of satellite

	hdr.STX = MAVLINK_STX;
	hdr.len = MAVLINK_MSG_ID_GPS_STATUS_LEN;
	hdr.msgid = MAVLINK_MSG_ID_GPS_STATUS;
	hdr.sysid = mavlink_system.sysid;
	hdr.compid = mavlink_system.compid;
	hdr.seq = mavlink_get_channel_status(chan)->current_tx_seq;
	mavlink_get_channel_status(chan)->current_tx_seq = hdr.seq + 1;
	mavlink_send_mem(chan, (uint8_t *)&hdr.STX, MAVLINK_NUM_HEADER_BYTES );

	crc_init(&checksum);
	checksum = crc_calculate_mem((uint8_t *)&hdr.len, &checksum, MAVLINK_CORE_HEADER_LEN);
	checksum = crc_calculate_mem((uint8_t *)&payload, &checksum, hdr.len );
	hdr.ck_a = (uint8_t)(checksum & 0xFF); ///< Low byte
	hdr.ck_b = (uint8_t)(checksum >> 8); ///< High byte

	mavlink_send_mem(chan, (uint8_t *)&payload, hdr.len);
	mavlink_send_mem(chan, (uint8_t *)&hdr.ck_a, MAVLINK_NUM_CHECKSUM_BYTES);
James Goppert's avatar
James Goppert committed
139 140 141 142 143 144 145 146 147 148 149 150
}

#endif
// MESSAGE GPS_STATUS UNPACKING

/**
 * @brief Get field satellites_visible from gps_status message
 *
 * @return Number of satellites visible
 */
static inline uint8_t mavlink_msg_gps_status_get_satellites_visible(const mavlink_message_t* msg)
{
lm's avatar
lm committed
151 152
	mavlink_gps_status_t *p = (mavlink_gps_status_t *)&msg->payload[0];
	return (uint8_t)(p->satellites_visible);
James Goppert's avatar
James Goppert committed
153 154 155 156 157 158 159
}

/**
 * @brief Get field satellite_prn from gps_status message
 *
 * @return Global satellite ID
 */
lm's avatar
lm committed
160
static inline uint16_t mavlink_msg_gps_status_get_satellite_prn(const mavlink_message_t* msg, uint8_t* satellite_prn)
James Goppert's avatar
James Goppert committed
161
{
lm's avatar
lm committed
162
	mavlink_gps_status_t *p = (mavlink_gps_status_t *)&msg->payload[0];
James Goppert's avatar
James Goppert committed
163

lm's avatar
lm committed
164 165
	memcpy(satellite_prn, p->satellite_prn, sizeof(p->satellite_prn));
	return sizeof(p->satellite_prn);
James Goppert's avatar
James Goppert committed
166 167 168 169 170 171 172
}

/**
 * @brief Get field satellite_used from gps_status message
 *
 * @return 0: Satellite not used, 1: used for localization
 */
lm's avatar
lm committed
173
static inline uint16_t mavlink_msg_gps_status_get_satellite_used(const mavlink_message_t* msg, uint8_t* satellite_used)
James Goppert's avatar
James Goppert committed
174
{
lm's avatar
lm committed
175
	mavlink_gps_status_t *p = (mavlink_gps_status_t *)&msg->payload[0];
James Goppert's avatar
James Goppert committed
176

lm's avatar
lm committed
177 178
	memcpy(satellite_used, p->satellite_used, sizeof(p->satellite_used));
	return sizeof(p->satellite_used);
James Goppert's avatar
James Goppert committed
179 180 181 182 183 184 185
}

/**
 * @brief Get field satellite_elevation from gps_status message
 *
 * @return Elevation (0: right on top of receiver, 90: on the horizon) of satellite
 */
lm's avatar
lm committed
186
static inline uint16_t mavlink_msg_gps_status_get_satellite_elevation(const mavlink_message_t* msg, uint8_t* satellite_elevation)
James Goppert's avatar
James Goppert committed
187
{
lm's avatar
lm committed
188
	mavlink_gps_status_t *p = (mavlink_gps_status_t *)&msg->payload[0];
James Goppert's avatar
James Goppert committed
189

lm's avatar
lm committed
190 191
	memcpy(satellite_elevation, p->satellite_elevation, sizeof(p->satellite_elevation));
	return sizeof(p->satellite_elevation);
James Goppert's avatar
James Goppert committed
192 193 194 195 196 197 198
}

/**
 * @brief Get field satellite_azimuth from gps_status message
 *
 * @return Direction of satellite, 0: 0 deg, 255: 360 deg.
 */
lm's avatar
lm committed
199
static inline uint16_t mavlink_msg_gps_status_get_satellite_azimuth(const mavlink_message_t* msg, uint8_t* satellite_azimuth)
James Goppert's avatar
James Goppert committed
200
{
lm's avatar
lm committed
201
	mavlink_gps_status_t *p = (mavlink_gps_status_t *)&msg->payload[0];
James Goppert's avatar
James Goppert committed
202

lm's avatar
lm committed
203 204
	memcpy(satellite_azimuth, p->satellite_azimuth, sizeof(p->satellite_azimuth));
	return sizeof(p->satellite_azimuth);
James Goppert's avatar
James Goppert committed
205 206 207 208 209 210 211
}

/**
 * @brief Get field satellite_snr from gps_status message
 *
 * @return Signal to noise ratio of satellite
 */
lm's avatar
lm committed
212
static inline uint16_t mavlink_msg_gps_status_get_satellite_snr(const mavlink_message_t* msg, uint8_t* satellite_snr)
James Goppert's avatar
James Goppert committed
213
{
lm's avatar
lm committed
214
	mavlink_gps_status_t *p = (mavlink_gps_status_t *)&msg->payload[0];
James Goppert's avatar
James Goppert committed
215

lm's avatar
lm committed
216 217
	memcpy(satellite_snr, p->satellite_snr, sizeof(p->satellite_snr));
	return sizeof(p->satellite_snr);
James Goppert's avatar
James Goppert committed
218 219 220 221 222 223 224 225 226 227
}

/**
 * @brief Decode a gps_status message into a struct
 *
 * @param msg The message to decode
 * @param gps_status C-struct to decode the message contents into
 */
static inline void mavlink_msg_gps_status_decode(const mavlink_message_t* msg, mavlink_gps_status_t* gps_status)
{
lm's avatar
lm committed
228
	memcpy( gps_status, msg->payload, sizeof(mavlink_gps_status_t));
James Goppert's avatar
James Goppert committed
229
}