mirror of
https://github.com/ArduPilot/ardupilot.git
synced 2026-10-06 19:00:27 +08:00
Andrew Tridgell
02948c05b4
The GSOF position-time record encodes GPS week as a 16-bit big-endian value. Reading 32 bits folded the following satellite-count and flag bytes into the reported week. Guard optional logging so a packet-level regression test can exercise the parser without a logger singleton.
424 lines
14 KiB
C++
424 lines
14 KiB
C++
#define AP_MATH_ALLOW_DOUBLE_FUNCTIONS 1
|
|
|
|
#include "AP_GSOF_config.h"
|
|
|
|
#if AP_GSOF_ENABLED
|
|
|
|
#include <AP_Logger/AP_Logger.h>
|
|
#include <AP_HAL/utility/sparse-endian.h>
|
|
#include <GCS_MAVLink/GCS.h>
|
|
#include <AP_GSOF/AP_GSOF.h>
|
|
|
|
#define gsof_DEBUGGING 0
|
|
#if gsof_DEBUGGING
|
|
extern const AP_HAL::HAL& hal;
|
|
# define Debug(fmt, args ...) \
|
|
do { \
|
|
hal.console->printf("%s:%d: " fmt "\n", \
|
|
__FUNCTION__, __LINE__, \
|
|
## args); \
|
|
hal.scheduler->delay(1); \
|
|
} while(0)
|
|
#else
|
|
# define Debug(fmt, args ...)
|
|
#endif
|
|
|
|
int
|
|
AP_GSOF::parse(const uint8_t temp, MsgTypes& parsed_msgs)
|
|
{
|
|
// https://receiverhelp.trimble.com/oem-gnss/index.html#API_DataCollectorFormatPacketStructure.html
|
|
switch (msg.state) {
|
|
default:
|
|
case Msg_Parser::State::STARTTX:
|
|
if (temp == STX) {
|
|
msg.state = Msg_Parser::State::STATUS;
|
|
msg.read = 0;
|
|
msg.checksumcalc = 0;
|
|
}
|
|
break;
|
|
case Msg_Parser::State::STATUS:
|
|
msg.status = temp;
|
|
msg.state = Msg_Parser::State::PACKETTYPE;
|
|
msg.checksumcalc += temp;
|
|
break;
|
|
case Msg_Parser::State::PACKETTYPE:
|
|
msg.packettype = temp;
|
|
msg.state = Msg_Parser::State::LENGTH;
|
|
msg.checksumcalc += temp;
|
|
break;
|
|
case Msg_Parser::State::LENGTH:
|
|
msg.length = temp;
|
|
msg.state = Msg_Parser::State::DATA;
|
|
msg.checksumcalc += temp;
|
|
break;
|
|
case Msg_Parser::State::DATA:
|
|
msg.data[msg.read] = temp;
|
|
msg.read++;
|
|
msg.checksumcalc += temp;
|
|
if (msg.read >= msg.length) {
|
|
msg.state = Msg_Parser::State::CHECKSUM;
|
|
}
|
|
break;
|
|
case Msg_Parser::State::CHECKSUM:
|
|
msg.checksum = temp;
|
|
msg.state = Msg_Parser::State::ENDTX;
|
|
if (msg.checksum == msg.checksumcalc) {
|
|
if (!process_message(parsed_msgs)) {
|
|
return NO_GSOF_DATA;
|
|
}
|
|
return PARSED_GSOF_DATA;
|
|
}
|
|
break;
|
|
case Msg_Parser::State::ENDTX:
|
|
msg.endtx = temp;
|
|
msg.state = Msg_Parser::State::STARTTX;
|
|
break;
|
|
}
|
|
|
|
return NO_GSOF_DATA;
|
|
}
|
|
|
|
bool
|
|
AP_GSOF::process_message(MsgTypes& parsed_msgs)
|
|
{
|
|
if (msg.packettype == 0x40) { // GSOF
|
|
// https://receiverhelp.trimble.com/oem-gnss/index.html#GSOFmessages_TIME.html?TocPath=Output%2520Messages%257CGSOF%2520Messages%257C_____25
|
|
|
|
for (uint32_t a = 3; a < msg.length; a++) {
|
|
const uint8_t output_type = msg.data[a];
|
|
|
|
if (output_type >= parsed_msgs.size()) {
|
|
#if CONFIG_HAL_BOARD == HAL_BOARD_SITL
|
|
AP_HAL::panic("Invalid output type.");
|
|
#else
|
|
return false;
|
|
#endif
|
|
}
|
|
|
|
parsed_msgs.set(output_type);
|
|
a++;
|
|
const uint8_t output_length = msg.data[a];
|
|
a++;
|
|
// TODO handle corruption on output_length causing buffer overrun?
|
|
|
|
switch (output_type) {
|
|
case POS_TIME:
|
|
parse_pos_time(a);
|
|
break;
|
|
case POS:
|
|
parse_pos(a);
|
|
break;
|
|
case VEL:
|
|
parse_vel(a);
|
|
break;
|
|
case DOP:
|
|
parse_dop(a);
|
|
break;
|
|
case POS_SIGMA:
|
|
parse_pos_sigma(a);
|
|
break;
|
|
case INS_FULL_NAV:
|
|
parse_ins_full_nav(a);
|
|
break;
|
|
case INS_RMS:
|
|
parse_ins_rms(a);
|
|
break;
|
|
case LLH_MSL:
|
|
parse_llh_msl(a);
|
|
break;
|
|
default:
|
|
// TODO log warning unparsed packet.
|
|
break;
|
|
}
|
|
|
|
a += output_length - 1u;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
// No GSOF packets.
|
|
return false;
|
|
}
|
|
|
|
void AP_GSOF::parse_pos_time(uint32_t a)
|
|
{
|
|
// https://receiverhelp.trimble.com/oem-gnss/gsof-messages-time.html
|
|
pos_time.time_week_ms = be32toh_ptr(msg.data + a);
|
|
pos_time.time_week = be16toh_ptr(msg.data + a + 4);
|
|
pos_time.num_sats = msg.data[a + 6];
|
|
pos_time.pos_flags1 = msg.data[a + 7];
|
|
pos_time.pos_flags2 = msg.data[a + 8];
|
|
#if HAL_LOGGING_ENABLED
|
|
log_pos_time();
|
|
#endif // HAL_LOGGING_ENABLED
|
|
}
|
|
|
|
void AP_GSOF::parse_pos(uint32_t a)
|
|
{
|
|
// https://receiverhelp.trimble.com/oem-gnss/gsof-messages-llh.html
|
|
position.latitude_rad = be64todouble_ptr(msg.data, a);
|
|
position.longitude_rad = be64todouble_ptr(msg.data, a + 8);
|
|
// Altitude is "Height from WGS-84 datum" -> Likely ellipsoid
|
|
position.altitude = be64todouble_ptr(msg.data, a + 16);
|
|
}
|
|
|
|
void AP_GSOF::parse_vel(uint32_t a)
|
|
{
|
|
// https://receiverhelp.trimble.com/oem-gnss/gsof-messages-velocity.html
|
|
|
|
vel.velocity_flags = msg.data[a];
|
|
constexpr uint8_t BIT_VELOCITY_VALID = 0;
|
|
if (BIT_IS_SET(vel.velocity_flags, BIT_VELOCITY_VALID)) {
|
|
vel.horizontal_velocity = be32tofloat_ptr(msg.data, a + 1);
|
|
vel.vertical_velocity = be32tofloat_ptr(msg.data, a + 9);
|
|
}
|
|
|
|
constexpr uint8_t BIT_HEADING_VALID = 2;
|
|
if (BIT_IS_SET(vel.velocity_flags, BIT_HEADING_VALID)) {
|
|
vel.heading = be32tofloat_ptr(msg.data, a + 5);
|
|
}
|
|
}
|
|
|
|
void AP_GSOF::parse_dop(uint32_t a)
|
|
{
|
|
// https://receiverhelp.trimble.com/oem-gnss/gsof-messages-pdop.html
|
|
// Skip pdop.
|
|
dop.hdop = be32tofloat_ptr(msg.data, a + 4);
|
|
}
|
|
|
|
void AP_GSOF::parse_pos_sigma(uint32_t a)
|
|
{
|
|
// https://receiverhelp.trimble.com/oem-gnss/gsof-messages-sigma.html
|
|
// Skip pos_rms
|
|
pos_sigma.sigma_east = be32tofloat_ptr(msg.data, a + 4);
|
|
pos_sigma.sigma_north = be32tofloat_ptr(msg.data, a + 8);
|
|
pos_sigma.sigma_up = be32tofloat_ptr(msg.data, a + 16);
|
|
}
|
|
|
|
void AP_GSOF::parse_ins_full_nav(uint32_t a)
|
|
{
|
|
// https://receiverhelp.trimble.com/oem-gnss/gsof-messages-ins-full-nav.html
|
|
ins_full_nav.gps_week = be16toh_ptr(msg.data + a);
|
|
ins_full_nav.gps_time_ms = be32toh_ptr(msg.data + a + 2);
|
|
ins_full_nav.imu_alignment_status = ImuAlignmentStatus(msg.data[a + 6]);
|
|
ins_full_nav.gnss_status = GnssStatus(msg.data[a + 7]);
|
|
ins_full_nav.latitude = be64todouble_ptr(msg.data, a + 8);
|
|
ins_full_nav.longitude = be64todouble_ptr(msg.data, a + 16);
|
|
ins_full_nav.altitude = be64todouble_ptr(msg.data, a + 24);
|
|
ins_full_nav.vel_n = be32tofloat_ptr(msg.data, a + 32);
|
|
ins_full_nav.vel_e = be32tofloat_ptr(msg.data, a + 36);
|
|
ins_full_nav.vel_d = be32tofloat_ptr(msg.data, a + 40);
|
|
ins_full_nav.speed = be32tofloat_ptr(msg.data, a + 44);
|
|
ins_full_nav.roll_deg = be64todouble_ptr(msg.data, a + 48);
|
|
ins_full_nav.pitch_deg = be64todouble_ptr(msg.data, a + 56);
|
|
ins_full_nav.heading_deg = be64todouble_ptr(msg.data, a + 64);
|
|
ins_full_nav.track_angle_deg = be64todouble_ptr(msg.data, a + 72);
|
|
ins_full_nav.ang_rate_x = be32tofloat_ptr(msg.data, a + 80);
|
|
ins_full_nav.ang_rate_y = be32tofloat_ptr(msg.data, a + 84);
|
|
ins_full_nav.ang_rate_z = be32tofloat_ptr(msg.data, a + 88);
|
|
ins_full_nav.acc_x = be32tofloat_ptr(msg.data, a + 92);
|
|
ins_full_nav.acc_y = be32tofloat_ptr(msg.data, a + 96);
|
|
ins_full_nav.acc_z = be32tofloat_ptr(msg.data, a + 100);
|
|
|
|
#if HAL_LOGGING_ENABLED
|
|
log_ins_full_nav();
|
|
#endif // HAL_LOGGING_ENABLED
|
|
}
|
|
|
|
void AP_GSOF::parse_ins_rms(uint32_t a)
|
|
{
|
|
// https://receiverhelp.trimble.com/oem-gnss/gsof-messages-ins-rms.html
|
|
ins_rms.gps_week = be16toh_ptr(msg.data + a);
|
|
ins_rms.gps_time_ms = be32toh_ptr(msg.data + a + 2);
|
|
ins_rms.imu_alignment_status = ImuAlignmentStatus(msg.data[a + 6]);
|
|
ins_rms.gnss_status = GnssStatus(msg.data[a + 7]);
|
|
ins_rms.pos_rms_n = be32tofloat_ptr(msg.data, a + 8);
|
|
ins_rms.pos_rms_e = be32tofloat_ptr(msg.data, a + 12);
|
|
ins_rms.pos_rms_d = be32tofloat_ptr(msg.data, a + 16);
|
|
ins_rms.vel_rms_n = be32tofloat_ptr(msg.data, a + 20);
|
|
ins_rms.vel_rms_e = be32tofloat_ptr(msg.data, a + 24);
|
|
ins_rms.vel_rms_d = be32tofloat_ptr(msg.data, a + 28);
|
|
ins_rms.roll_rms_deg = be32tofloat_ptr(msg.data, a + 32);
|
|
ins_rms.pitch_rms_deg = be32tofloat_ptr(msg.data, a + 36);
|
|
ins_rms.yaw_rms_deg = be32tofloat_ptr(msg.data, a + 40);
|
|
|
|
#if HAL_LOGGING_ENABLED
|
|
log_ins_rms();
|
|
#endif // HAL_LOGGING_ENABLED
|
|
}
|
|
|
|
void AP_GSOF::parse_llh_msl(uint32_t a)
|
|
{
|
|
// https://receiverhelp.trimble.com/oem-gnss/gsof-messages-llmsl.html
|
|
llh_msl.latitude = RAD_TO_DEG_DOUBLE * be64todouble_ptr(msg.data, a);
|
|
llh_msl.longitude = RAD_TO_DEG_DOUBLE * be64todouble_ptr(msg.data, a + 8);
|
|
llh_msl.altitude_msl = be64todouble_ptr(msg.data, a + 16);
|
|
// Assume the model is EGM96 in ArduPilot, but log for BIN analysis.
|
|
memcpy(llh_msl.model, msg.data + a + 24, sizeof(llh_msl.model));
|
|
llh_msl.model[sizeof(llh_msl.model) - 1] = '\0'; // ensure null-termination
|
|
|
|
#if HAL_LOGGING_ENABLED
|
|
log_llh_msl();
|
|
#endif // HAL_LOGGING_ENABLED
|
|
}
|
|
|
|
#if HAL_LOGGING_ENABLED
|
|
void AP_GSOF::log_pos_time() const
|
|
{
|
|
|
|
// @LoggerMessage: GSPT
|
|
// @Description: GSOF1 GPS Position Time Metadata
|
|
// @Field: TimeUS: GPS Time since system startup [us]
|
|
// @Field: TOWms: GPS Time of week [ms]
|
|
// @Field: Week: GPS week number
|
|
// @Field: Sats: Number of satellites
|
|
// @Field: Flags1: Positioning flags byte 1
|
|
// @Field: Flags2: Positioning flags byte 2
|
|
// @Field: InitNum: Initialization count
|
|
AP::logger().WriteStreaming(
|
|
"GSPT",
|
|
"TimeUS,TOWms,Week,Sats,Flags1,Flags2,InitNum",
|
|
"s" "s" "-" "S" "-" "-" "-",
|
|
"F" "C" "0" "0" "0" "0" "0",
|
|
"Q" "I" "H" "B" "B" "B" "B",
|
|
AP_HAL::micros64(),
|
|
pos_time.time_week_ms,
|
|
pos_time.time_week,
|
|
pos_time.num_sats,
|
|
pos_time.pos_flags1,
|
|
pos_time.pos_flags2,
|
|
pos_time.initialized_number
|
|
);
|
|
}
|
|
|
|
void AP_GSOF::log_ins_full_nav() const
|
|
{
|
|
// @LoggerMessage: GSN1
|
|
// @Description: GSOF49 Full INS Navigation Solution 1
|
|
// @Field: TimeUS: Time since system startup [us]
|
|
// @Field: GpsWk: GPS week number since Jan 1980
|
|
// @Field: GpsTs: GPS time of week [ms]
|
|
// @Field: ImuStat: IMU alignment status (enum)
|
|
// @Field: GStat: GNSS status (enum)
|
|
// @Field: Lat: Latitude [degrees]
|
|
// @Field: Lng: Longitude [degrees]
|
|
// @Field: Alt: Altitude in ITRF 2020 [meters]
|
|
// @Field: VN: Velocity North [m/s]
|
|
// @Field: VE: Velocity East [m/s]
|
|
// @Field: VD: Velocity Down [m/s]
|
|
// @Field: Spd: 3D Speed [m/s]
|
|
AP::logger().WriteStreaming(
|
|
"GSN1",
|
|
"TimeUS,GpsWk,GpsTs,ImuStat,GStat,Lat,Lng,Alt,VN," "VE," "VD," "Spd",
|
|
"s" "-" "s" "-" "-" "D" "U" "m" "n" "n" "n" "n",
|
|
"F" "0" "C" "0" "0" "0" "0" "0" "0" "0" "0" "0",
|
|
"Q" "H" "I" "B" "B" "d" "d" "d" "f" "f" "f" "f",
|
|
AP_HAL::micros64(),
|
|
ins_full_nav.gps_week,
|
|
ins_full_nav.gps_time_ms,
|
|
static_cast<uint8_t>(ins_full_nav.imu_alignment_status),
|
|
static_cast<uint8_t>(ins_full_nav.gnss_status),
|
|
ins_full_nav.latitude,
|
|
ins_full_nav.longitude,
|
|
ins_full_nav.altitude,
|
|
ins_full_nav.vel_n,
|
|
ins_full_nav.vel_e,
|
|
ins_full_nav.vel_d,
|
|
ins_full_nav.speed
|
|
);
|
|
|
|
// @LoggerMessage: GSN2
|
|
// @Description: GSOF49 Full INS Navigation Solution 2
|
|
// @Field: TimeUS: Time since system startup [us]
|
|
// @Field: Roll: Roll [degrees]
|
|
// @Field: Pitch: Pitch [degrees]
|
|
// @Field: Heading: Heading [degrees]
|
|
// @Field: Track: Track angle [degrees]
|
|
// @Field: RateX: Angular rate X [deg/s]
|
|
// @Field: RateY: Angular rate Y [deg/s]
|
|
// @Field: RateZ: Angular rate Z [m/s]
|
|
// @Field: AccX: Acceleration X [m/s^2]
|
|
// @Field: AccY: Acceleration Y [m/s^2]
|
|
// @Field: AccZ: Acceleration Z [m/s^2]
|
|
AP::logger().WriteStreaming(
|
|
"GSN2",
|
|
"TimeUS,Roll,Pitch,Heading,Track,RateX,RateY,RateZ,AccX,AccY,AccZ",
|
|
"s" "d" "d" "h" "d" "k" "k" "E" "o" "o" "o",
|
|
"F" "0" "0" "0" "0" "0" "0" "0" "0" "0" "0",
|
|
"Q" "d" "d" "d" "d" "f" "f" "f" "f" "f" "f",
|
|
AP_HAL::micros64(),
|
|
ins_full_nav.roll_deg,
|
|
ins_full_nav.pitch_deg,
|
|
ins_full_nav.heading_deg,
|
|
ins_full_nav.track_angle_deg,
|
|
ins_full_nav.ang_rate_x,
|
|
ins_full_nav.ang_rate_y,
|
|
ins_full_nav.ang_rate_z,
|
|
ins_full_nav.acc_x,
|
|
ins_full_nav.acc_y,
|
|
ins_full_nav.acc_z
|
|
);
|
|
}
|
|
|
|
void AP_GSOF::log_ins_rms() const
|
|
{
|
|
// @LoggerMessage: GSR1
|
|
// @Description: GSOF50 INS Solution RMS Values 1
|
|
// @Field: TUS: Time since system startup [us]
|
|
// @Field: GpsTMs: GPS time of week [ms]
|
|
// @Field: PUN: North Position uncertainty RMS [m]
|
|
// @Field: PUE: East Position uncertainty RMS [m]
|
|
// @Field: PUD: Down Position uncertainty RMS [m]
|
|
// @Field: VUN: North Velocity uncertainty RMS [m/s]
|
|
// @Field: VUE: East Velocity uncertainty RMS [m/s]
|
|
// @Field: VUD: Down Velocity uncertainty RMS [m/s]
|
|
// @Field: RollU: Roll RMS uncertainty [deg]
|
|
// @Field: PitchU: Pitch RMS uncertainty[deg]
|
|
// @Field: YawU: Yaw RMS uncertainty[deg]
|
|
AP::logger().WriteStreaming(
|
|
"GSR1",
|
|
"TUS,GpsTMs,PUN,PUE,PUD,VUN,VUE,VUD,RollU,PitchU,YawU",
|
|
"s" "s" "m" "m" "m" "n" "n" "n" "d" "d" "d",
|
|
"F" "C" "0" "0" "0" "0" "0" "0" "0" "0" "0",
|
|
"Q" "I" "f" "f" "f" "f" "f" "f" "f" "f" "f",
|
|
AP_HAL::micros64(),
|
|
ins_rms.gps_time_ms,
|
|
ins_rms.pos_rms_n,
|
|
ins_rms.pos_rms_e,
|
|
ins_rms.pos_rms_d,
|
|
ins_rms.vel_rms_n,
|
|
ins_rms.vel_rms_e,
|
|
ins_rms.vel_rms_d,
|
|
ins_rms.roll_rms_deg,
|
|
ins_rms.pitch_rms_deg,
|
|
ins_rms.yaw_rms_deg
|
|
);
|
|
|
|
}
|
|
void AP_GSOF::log_llh_msl() const
|
|
{
|
|
// @LoggerMessage: GSLH
|
|
// @Description: GSOF70 LLH with MSL Altitude
|
|
// @Field: TimeUS: Time since system startup [µs]
|
|
// @Field: Lat: Latitude [deg]
|
|
// @Field: Lng: Longitude [deg]
|
|
// @Field: AltMSL: Altitude above mean sea level [m]
|
|
// @Field: Model: Geoid model used (null-terminated string)
|
|
AP::logger().WriteStreaming(
|
|
"GSLH",
|
|
"TimeUS,Lat,Lng,AltMSL,Model",
|
|
"s" "D" "U" "m" "-",
|
|
"F" "0" "0" "0" "-",
|
|
"Q" "d" "d" "d" "Z",
|
|
AP_HAL::micros64(),
|
|
llh_msl.latitude,
|
|
llh_msl.longitude,
|
|
llh_msl.altitude_msl,
|
|
llh_msl.model
|
|
);
|
|
}
|
|
#endif // HAL_LOGGING_ENABLED
|
|
|
|
#endif // AP_GSOF_ENABLED
|