Mirror
/
ardupilot
mirror of https://github.com/ArduPilot/ardupilot
5
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

AP_GPS:add note to old param names to avoid confusion

This commit is contained in:
Henry Wurzburg 2024-08-26 13:29:46 +02:00 committed by Peter Barker
parent c3d89ed9d1
commit 1631e85fe8
2 changed files with 24 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
libraries/AP_GPS/AP_GPS.cpp
View File

@ -1998,31 +1998,31 @@ bool AP_GPS::gps_yaw_deg(uint8_t instance, float &yaw_deg, float &accuracy_deg,
// @Param: _TYPE // @Param: _TYPE
// @DisplayName: 1st GPS type // @DisplayName: 1st GPS type
// @Description: GPS type of 1st GPS // @Description: GPS type of 1st GPS.Renamed in 4.6 and later to GPS1_TYPE
// @Values: 0:None,1:AUTO,2:uBlox,5:NMEA,6:SiRF,7:HIL,8:SwiftNav,9:DroneCAN,10:SBF,11:GSOF,13:ERB,14:MAV,15:NOVA,16:HemisphereNMEA,17:uBlox-MovingBaseline-Base,18:uBlox-MovingBaseline-Rover,19:MSP,20:AllyStar,21:ExternalAHRS,22:DroneCAN-MovingBaseline-Base,23:DroneCAN-MovingBaseline-Rover,24:UnicoreNMEA,25:UnicoreMovingBaselineNMEA,26:SBF-DualAntenna // @Values: 0:None,1:AUTO,2:uBlox,5:NMEA,6:SiRF,7:HIL,8:SwiftNav,9:DroneCAN,10:SBF,11:GSOF,13:ERB,14:MAV,15:NOVA,16:HemisphereNMEA,17:uBlox-MovingBaseline-Base,18:uBlox-MovingBaseline-Rover,19:MSP,20:AllyStar,21:ExternalAHRS,22:DroneCAN-MovingBaseline-Base,23:DroneCAN-MovingBaseline-Rover,24:UnicoreNMEA,25:UnicoreMovingBaselineNMEA,26:SBF-DualAntenna
// @RebootRequired: True // @RebootRequired: True
// @User: Advanced // @User: Advanced
// @Param: _TYPE2 // @Param: _TYPE2
// @CopyFieldsFrom: GPS_TYPE // @CopyFieldsFrom: GPS_TYPE
// @DisplayName: 2nd GPS type // @DisplayName: 2nd GPS type.Renamed in 4.6 to GPS2_TYPE
// @Description: GPS type of 2nd GPS // @Description: GPS type of 2nd GPS
// @Param: _GNSS_MODE // @Param: _GNSS_MODE
// @DisplayName: GNSS system configuration // @DisplayName: GNSS system configuration
// @Description: Bitmask for what GNSS system to use on the first GPS (all unchecked or zero to leave GPS as configured) // @Description: Bitmask for what GNSS system to use on the first GPS (all unchecked or zero to leave GPS as configured).Renamed in 4.6 and later to GPS1_GNSS_MODE.
// @Bitmask: 0:GPS,1:SBAS,2:Galileo,3:Beidou,4:IMES,5:QZSS,6:GLONASS // @Bitmask: 0:GPS,1:SBAS,2:Galileo,3:Beidou,4:IMES,5:QZSS,6:GLONASS
// @User: Advanced // @User: Advanced
// @Param: _GNSS_MODE2 // @Param: _GNSS_MODE2
// @DisplayName: GNSS system configuration // @DisplayName: GNSS system configuration.
// @Description: Bitmask for what GNSS system to use on the second GPS (all unchecked or zero to leave GPS as configured) // @Description: Bitmask for what GNSS system to use on the second GPS (all unchecked or zero to leave GPS as configured). Renamed in 4.6 and later to GPS2_GNSS_MODE
// @Bitmask: 0:GPS,1:SBAS,2:Galileo,3:Beidou,4:IMES,5:QZSS,6:GLONASS // @Bitmask: 0:GPS,1:SBAS,2:Galileo,3:Beidou,4:IMES,5:QZSS,6:GLONASS
// @User: Advanced // @User: Advanced
// @Param: _RATE_MS // @Param: _RATE_MS
// @DisplayName: GPS update rate in milliseconds // @DisplayName: GPS update rate in milliseconds. Renamed in 4.6 to GPS1_RAATE_MS
// @Description: Controls how often the GPS should provide a position update. Lowering below 5Hz(default) is not allowed. Raising the rate above 5Hz usually provides little benefit and for some GPS (eg Ublox M9N) can severely impact performance. // @Description: Controls how often the GPS should provide a position update. Lowering below 5Hz(default) is not allowed. Raising the rate above 5Hz usually provides little benefit and for some GPS (eg Ublox M9N) can severely impact performance.Renamed in 4.6 and later to GPS1_RATE_MS
// @Units: ms // @Units: ms
// @Values: 100:10Hz,125:8Hz,200:5Hz // @Values: 100:10Hz,125:8Hz,200:5Hz
// @Range: 50 200 // @Range: 50 200
@ -2030,7 +2030,7 @@ bool AP_GPS::gps_yaw_deg(uint8_t instance, float &yaw_deg, float &accuracy_deg,
// @Param: _RATE_MS2 // @Param: _RATE_MS2
// @DisplayName: GPS 2 update rate in milliseconds // @DisplayName: GPS 2 update rate in milliseconds
// @Description: Controls how often the GPS should provide a position update. Lowering below 5Hz(default) is not allowed. Raising the rate above 5Hz usually provides little benefit and for some GPS (eg Ublox M9N) can severely impact performance. // @Description: Controls how often the GPS should provide a position update. Lowering below 5Hz(default) is not allowed. Raising the rate above 5Hz usually provides little benefit and for some GPS (eg Ublox M9N) can severely impact performance.Renamed in 4.6 and later to GPS2_RATE_MS
// @Units: ms // @Units: ms
// @Values: 100:10Hz,125:8Hz,200:5Hz // @Values: 100:10Hz,125:8Hz,200:5Hz
// @Range: 50 200 // @Range: 50 200
@ -2038,7 +2038,7 @@ bool AP_GPS::gps_yaw_deg(uint8_t instance, float &yaw_deg, float &accuracy_deg,
// @Param: _POS1_X // @Param: _POS1_X
// @DisplayName: Antenna X position offset // @DisplayName: Antenna X position offset
// @Description: X position of the first GPS antenna in body frame. Positive X is forward of the origin. Use antenna phase centroid location if provided by the manufacturer. // @Description: X position of the first GPS antenna in body frame. Positive X is forward of the origin. Use antenna phase centroid location if provided by the manufacturer.Renamed in 4.6 and later to GPS1_POS_X.
// @Units: m // @Units: m
// @Range: -5 5 // @Range: -5 5
// @Increment: 0.01 // @Increment: 0.01
@ -2046,7 +2046,7 @@ bool AP_GPS::gps_yaw_deg(uint8_t instance, float &yaw_deg, float &accuracy_deg,
// @Param: _POS1_Y // @Param: _POS1_Y
// @DisplayName: Antenna Y position offset // @DisplayName: Antenna Y position offset
// @Description: Y position of the first GPS antenna in body frame. Positive Y is to the right of the origin. Use antenna phase centroid location if provided by the manufacturer. // @Description: Y position of the first GPS antenna in body frame. Positive Y is to the right of the origin. Use antenna phase centroid location if provided by the manufacturer.Renamed in 4.6 and later to GPS1_POS_Y.
// @Units: m // @Units: m
// @Range: -5 5 // @Range: -5 5
// @Increment: 0.01 // @Increment: 0.01
@ -2054,7 +2054,7 @@ bool AP_GPS::gps_yaw_deg(uint8_t instance, float &yaw_deg, float &accuracy_deg,
// @Param: _POS1_Z // @Param: _POS1_Z
// @DisplayName: Antenna Z position offset // @DisplayName: Antenna Z position offset
// @Description: Z position of the first GPS antenna in body frame. Positive Z is down from the origin. Use antenna phase centroid location if provided by the manufacturer. // @Description: Z position of the first GPS antenna in body frame. Positive Z is down from the origin. Use antenna phase centroid location if provided by the manufacturer.Renamed in 4.6 and later to GPS1_POS_Z.
// @Units: m // @Units: m
// @Range: -5 5 // @Range: -5 5
// @Increment: 0.01 // @Increment: 0.01
@ -2062,7 +2062,7 @@ bool AP_GPS::gps_yaw_deg(uint8_t instance, float &yaw_deg, float &accuracy_deg,
// @Param: _POS2_X // @Param: _POS2_X
// @DisplayName: Antenna X position offset // @DisplayName: Antenna X position offset
// @Description: X position of the second GPS antenna in body frame. Positive X is forward of the origin. Use antenna phase centroid location if provided by the manufacturer. // @Description: X position of the second GPS antenna in body frame. Positive X is forward of the origin. Use antenna phase centroid location if provided by the manufacturer.Renamed in 4.6 and later to GPS2_POS_X.
// @Units: m // @Units: m
// @Range: -5 5 // @Range: -5 5
// @Increment: 0.01 // @Increment: 0.01
@ -2070,7 +2070,7 @@ bool AP_GPS::gps_yaw_deg(uint8_t instance, float &yaw_deg, float &accuracy_deg,
// @Param: _POS2_Y // @Param: _POS2_Y
// @DisplayName: Antenna Y position offset // @DisplayName: Antenna Y position offset
// @Description: Y position of the second GPS antenna in body frame. Positive Y is to the right of the origin. Use antenna phase centroid location if provided by the manufacturer. // @Description: Y position of the second GPS antenna in body frame. Positive Y is to the right of the origin. Use antenna phase centroid location if provided by the manufacturer.Renamed in 4.6 and later to GPS2_POS_Y.
// @Units: m // @Units: m
// @Range: -5 5 // @Range: -5 5
// @Increment: 0.01 // @Increment: 0.01
@ -2078,7 +2078,7 @@ bool AP_GPS::gps_yaw_deg(uint8_t instance, float &yaw_deg, float &accuracy_deg,
// @Param: _POS2_Z // @Param: _POS2_Z
// @DisplayName: Antenna Z position offset // @DisplayName: Antenna Z position offset
// @Description: Z position of the second GPS antenna in body frame. Positive Z is down from the origin. Use antenna phase centroid location if provided by the manufacturer. // @Description: Z position of the second GPS antenna in body frame. Positive Z is down from the origin. Use antenna phase centroid location if provided by the manufacturer.Renamed in 4.6 and later to GPS2_POS_Z.
// @Units: m // @Units: m
// @Range: -5 5 // @Range: -5 5
// @Increment: 0.01 // @Increment: 0.01
@ -2086,7 +2086,7 @@ bool AP_GPS::gps_yaw_deg(uint8_t instance, float &yaw_deg, float &accuracy_deg,
// @Param: _DELAY_MS // @Param: _DELAY_MS
// @DisplayName: GPS delay in milliseconds // @DisplayName: GPS delay in milliseconds
// @Description: Controls the amount of GPS measurement delay that the autopilot compensates for. Set to zero to use the default delay for the detected GPS type. // @Description: Controls the amount of GPS measurement delay that the autopilot compensates for. Set to zero to use the default delay for the detected GPS type.Renamed in 4.6 and later to GPS1_DELAY_MS.
// @Units: ms // @Units: ms
// @Range: 0 250 // @Range: 0 250
// @User: Advanced // @User: Advanced
@ -2094,7 +2094,7 @@ bool AP_GPS::gps_yaw_deg(uint8_t instance, float &yaw_deg, float &accuracy_deg,
// @Param: _DELAY_MS2 // @Param: _DELAY_MS2
// @DisplayName: GPS 2 delay in milliseconds // @DisplayName: GPS 2 delay in milliseconds
// @Description: Controls the amount of GPS measurement delay that the autopilot compensates for. Set to zero to use the default delay for the detected GPS type. // @Description: Controls the amount of GPS measurement delay that the autopilot compensates for. Set to zero to use the default delay for the detected GPS type.Renamed in 4.6 and later to GPS2_DELAY_MS.
// @Units: ms // @Units: ms
// @Range: 0 250 // @Range: 0 250
// @User: Advanced // @User: Advanced
@ -2102,7 +2102,7 @@ bool AP_GPS::gps_yaw_deg(uint8_t instance, float &yaw_deg, float &accuracy_deg,
// @Param: _COM_PORT // @Param: _COM_PORT
// @DisplayName: GPS physical COM port // @DisplayName: GPS physical COM port
// @Description: The physical COM port on the connected device, currently only applies to SBF and GSOF GPS // @Description: The physical COM port on the connected device, currently only applies to SBF and GSOF GPS,Renamed in 4.6 and later to GPS1_COM_PORT.
// @Range: 0 10 // @Range: 0 10
// @Increment: 1 // @Increment: 1
// @User: Advanced // @User: Advanced
@ -2111,7 +2111,7 @@ bool AP_GPS::gps_yaw_deg(uint8_t instance, float &yaw_deg, float &accuracy_deg,
// @Param: _COM_PORT2 // @Param: _COM_PORT2
// @DisplayName: GPS physical COM port // @DisplayName: GPS physical COM port
// @Description: The physical COM port on the connected device, currently only applies to SBF and GSOF GPS // @Description: The physical COM port on the connected device, currently only applies to SBF and GSOF GPS.Renamed in 4.6 and later to GPS1_COM_PORT.
// @Range: 0 10 // @Range: 0 10
// @Increment: 1 // @Increment: 1
// @User: Advanced // @User: Advanced
@ -2125,13 +2125,13 @@ bool AP_GPS::gps_yaw_deg(uint8_t instance, float &yaw_deg, float &accuracy_deg,
// @Param: _CAN_NODEID1 // @Param: _CAN_NODEID1
// @DisplayName: GPS Node ID 1 // @DisplayName: GPS Node ID 1
// @Description: GPS Node id for first-discovered GPS. // @Description: GPS Node id for first-discovered GPS.Renamed in 4.6 and later to GPS1_CAN_NODEID.
// @ReadOnly: True // @ReadOnly: True
// @User: Advanced // @User: Advanced
// @Param: _CAN_NODEID2 // @Param: _CAN_NODEID2
// @DisplayName: GPS Node ID 2 // @DisplayName: GPS Node ID 2
// @Description: GPS Node id for second-discovered GPS. // @Description: GPS Node id for second-discovered GPS.Renamed in 4.6 and later to GPS2_CAN_NODEID.
// @ReadOnly: True // @ReadOnly: True
// @User: Advanced // @User: Advanced

8
libraries/AP_GPS/MovingBase.cpp
View File

@ -3,7 +3,7 @@
const AP_Param::GroupInfo MovingBase::var_info[] = { const AP_Param::GroupInfo MovingBase::var_info[] = {
// @Param: TYPE // @Param: TYPE
// @DisplayName: Moving base type // @DisplayName: Moving base type
// @Description: Controls the type of moving base used if using moving base. // @Description: Controls the type of moving base used if using moving base.This is renamed in 4.6 and later to GPSx_MB_TYPE.
// @Values: 0:Relative to alternate GPS instance,1:RelativeToCustomBase // @Values: 0:Relative to alternate GPS instance,1:RelativeToCustomBase
// @User: Advanced // @User: Advanced
// @RebootRequired: True // @RebootRequired: True
@ -11,7 +11,7 @@ const AP_Param::GroupInfo MovingBase::var_info[] = {
// @Param: OFS_X // @Param: OFS_X
// @DisplayName: Base antenna X position offset // @DisplayName: Base antenna X position offset
// @Description: X position of the base (primary) GPS antenna in body frame from the position of the 2nd antenna. Positive X is forward of the 2nd antenna. Use antenna phase centroid location if provided by the manufacturer. // @Description: X position of the base (primary) GPS antenna in body frame from the position of the 2nd antenna. Positive X is forward of the 2nd antenna. Use antenna phase centroid location if provided by the manufacturer.This is renamed in 4.6 and later to GPSx_MB_OFS_X.
// @Units: m // @Units: m
// @Range: -5 5 // @Range: -5 5
// @Increment: 0.01 // @Increment: 0.01
@ -19,7 +19,7 @@ const AP_Param::GroupInfo MovingBase::var_info[] = {
// @Param: OFS_Y // @Param: OFS_Y
// @DisplayName: Base antenna Y position offset // @DisplayName: Base antenna Y position offset
// @Description: Y position of the base (primary) GPS antenna in body frame from the position of the 2nd antenna. Positive Y is to the right of the 2nd antenna. Use antenna phase centroid location if provided by the manufacturer. // @Description: Y position of the base (primary) GPS antenna in body frame from the position of the 2nd antenna. Positive Y is to the right of the 2nd antenna. Use antenna phase centroid location if provided by the manufacturer.This is renamed in 4.6 and later to GPSx_MB_OFS_Y.
// @Units: m // @Units: m
// @Range: -5 5 // @Range: -5 5
// @Increment: 0.01 // @Increment: 0.01
@ -27,7 +27,7 @@ const AP_Param::GroupInfo MovingBase::var_info[] = {
// @Param: OFS_Z // @Param: OFS_Z
// @DisplayName: Base antenna Z position offset // @DisplayName: Base antenna Z position offset
// @Description: Z position of the base (primary) GPS antenna in body frame from the position of the 2nd antenna. Positive Z is down from the 2nd antenna. Use antenna phase centroid location if provided by the manufacturer. // @Description: Z position of the base (primary) GPS antenna in body frame from the position of the 2nd antenna. Positive Z is down from the 2nd antenna. Use antenna phase centroid location if provided by the manufacturer.This is renamed in 4.6 and later to GPSx_MB_OFS_Z.
// @Units: m // @Units: m
// @Range: -5 5 // @Range: -5 5
// @Increment: 0.01 // @Increment: 0.01