-
Notifications
You must be signed in to change notification settings - Fork 15.7k
feat(fw_performance_model): scale vehicle weight by remaining fuel #27901
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
mahima-yoga
wants to merge
4
commits into
main
Choose a base branch
from
pr-fuel-level-tecs-scale
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
236e6c3
feat(fw_performance_model): scale vehicle weight by remaining fuel
mahima-yoga 1063b60
fix: don't set max climb/sink rates based on fuel fraction
mahima-yoga 1c24ac5
chore: shorten param description
mahima-yoga c49a08d
chore: move _fuel_fraction_remaining constraint
mahima-yoga File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,181 @@ | ||
| /**************************************************************************** | ||
| * | ||
| * Copyright (c) 2026 PX4 Development Team. All rights reserved. | ||
| * | ||
| * Redistribution and use in source and binary forms, with or without | ||
| * modification, are permitted provided that the following conditions | ||
| * are met: | ||
| * | ||
| * 1. Redistributions of source code must retain the above copyright | ||
| * notice, this list of conditions and the following disclaimer. | ||
| * 2. Redistributions in binary form must reproduce the above copyright | ||
| * notice, this list of conditions and the following disclaimer in | ||
| * the documentation and/or other materials provided with the | ||
| * distribution. | ||
| * 3. Neither the name PX4 nor the names of its contributors may be | ||
| * used to endorse or promote products derived from this software | ||
| * without specific prior written permission. | ||
| * | ||
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | ||
| * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | ||
| * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS | ||
| * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE | ||
| * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, | ||
| * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, | ||
| * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS | ||
| * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED | ||
| * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | ||
| * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN | ||
| * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE | ||
| * POSSIBILITY OF SUCH DAMAGE. | ||
| * | ||
| ****************************************************************************/ | ||
|
|
||
| #include <gtest/gtest.h> | ||
| #include "PerformanceModel.hpp" | ||
|
|
||
| // to run: make tests TESTFILTER=PerformanceModel | ||
|
|
||
| class PerformanceModelTest : public ::testing::Test | ||
| { | ||
| public: | ||
| void SetUp() override | ||
| { | ||
| param_control_autosave(false); | ||
| param_reset_all(); | ||
| } | ||
|
|
||
| void setWeightParams(float base, float gross, float fuel) | ||
| { | ||
| param_set(param_handle(px4::params::WEIGHT_BASE), &base); | ||
| param_set(param_handle(px4::params::WEIGHT_GROSS), &gross); | ||
| param_set(param_handle(px4::params::WEIGHT_FUEL), &fuel); | ||
| _model.updateParameters(); | ||
| } | ||
|
|
||
| PerformanceModel _model; | ||
| }; | ||
|
|
||
| TEST_F(PerformanceModelTest, weightRatioDefaultsToOne) | ||
| { | ||
| // GIVEN: default parameters (weight compensation disabled) | ||
| // THEN: the weight ratio is 1 | ||
| EXPECT_FLOAT_EQ(_model.getWeightRatio(), 1.0f); | ||
| } | ||
|
|
||
| TEST_F(PerformanceModelTest, weightRatioWithoutFuelCompensation) | ||
| { | ||
| // GIVEN: base and gross weight set, fuel compensation disabled | ||
| setWeightParams(10.0f, 12.0f, -1.0f); | ||
|
|
||
| // THEN: the weight ratio is gross/base, independent of any fuel fraction | ||
| EXPECT_FLOAT_EQ(_model.getWeightRatio(), 1.2f); | ||
|
|
||
| _model.setFuelFractionRemaining(0.5f); | ||
| EXPECT_FLOAT_EQ(_model.getWeightRatio(), 1.2f); | ||
| } | ||
|
|
||
| TEST_F(PerformanceModelTest, weightRatioScalesWithFuelFraction) | ||
| { | ||
| // GIVEN: base and gross weight set, 4kg full fuel load | ||
| setWeightParams(10.0f, 12.0f, 4.0f); | ||
|
|
||
| // THEN: with unknown fuel fraction the full-tank gross weight is assumed | ||
| EXPECT_FLOAT_EQ(_model.getWeightRatio(), 1.2f); | ||
|
|
||
| // AND: the weight ratio scales linearly with the burned fuel mass | ||
| _model.setFuelFractionRemaining(1.0f); | ||
| EXPECT_FLOAT_EQ(_model.getWeightRatio(), 1.2f); | ||
|
|
||
| _model.setFuelFractionRemaining(0.5f); | ||
| EXPECT_FLOAT_EQ(_model.getWeightRatio(), 1.0f); | ||
|
|
||
| _model.setFuelFractionRemaining(0.0f); | ||
| EXPECT_FLOAT_EQ(_model.getWeightRatio(), 0.8f); | ||
| } | ||
|
|
||
| TEST_F(PerformanceModelTest, fuelFractionKeptOnNonFiniteInput) | ||
| { | ||
| // GIVEN: base and gross weight set, 4kg full fuel load, and a known fuel fraction | ||
| setWeightParams(10.0f, 12.0f, 4.0f); | ||
| _model.setFuelFractionRemaining(0.5f); | ||
| EXPECT_FLOAT_EQ(_model.getWeightRatio(), 1.0f); | ||
|
|
||
| // WHEN: the fuel fraction input becomes non-finite (e.g. sensor failure) | ||
| _model.setFuelFractionRemaining(NAN); | ||
|
|
||
| // THEN: the last known fuel fraction is kept | ||
| EXPECT_FLOAT_EQ(_model.getWeightRatio(), 1.0f); | ||
| } | ||
|
|
||
| TEST_F(PerformanceModelTest, fuelFractionIsConstrained) | ||
| { | ||
| // GIVEN: base and gross weight set, 4kg full fuel load | ||
| setWeightParams(10.0f, 12.0f, 4.0f); | ||
|
|
||
| // THEN: out-of-range fuel fractions are constrained to [0, 1] | ||
| _model.setFuelFractionRemaining(-0.5f); | ||
| EXPECT_FLOAT_EQ(_model.getWeightRatio(), 0.8f); | ||
|
|
||
| _model.setFuelFractionRemaining(1.5f); | ||
| EXPECT_FLOAT_EQ(_model.getWeightRatio(), 1.2f); | ||
| } | ||
|
|
||
| TEST_F(PerformanceModelTest, weightRatioIsConstrained) | ||
| { | ||
| // GIVEN: a fuel weight larger than the gross weight (misconfiguration) | ||
| setWeightParams(10.0f, 12.0f, 12.0f); | ||
|
|
||
| // THEN: the weight ratio is constrained to its lower bound | ||
| _model.setFuelFractionRemaining(0.0f); | ||
| EXPECT_FLOAT_EQ(_model.getWeightRatio(), 0.5f); | ||
| } | ||
|
|
||
| TEST_F(PerformanceModelTest, fuelFractionFromTankStatusFallbackChain) | ||
| { | ||
| // GIVEN: a fuel tank status with no measurements | ||
| fuel_tank_status_s status{}; | ||
| status.maximum_fuel_capacity = NAN; | ||
| status.remaining_fuel = NAN; | ||
| status.consumed_fuel = NAN; | ||
| status.percent_remaining = UINT8_MAX; | ||
|
|
||
| // THEN: no fuel fraction is available | ||
| EXPECT_TRUE(std::isnan(PerformanceModel::getFuelFractionRemaining(status))); | ||
|
|
||
| // AND: the consumed fuel is the last fallback, assuming a full tank at boot | ||
| status.maximum_fuel_capacity = 2000.f; | ||
| status.consumed_fuel = 500.f; | ||
| EXPECT_FLOAT_EQ(PerformanceModel::getFuelFractionRemaining(status), 0.75f); | ||
|
|
||
| // AND: a valid remaining percentage takes precedence over the consumed fuel | ||
| status.percent_remaining = 40; | ||
| EXPECT_FLOAT_EQ(PerformanceModel::getFuelFractionRemaining(status), 0.4f); | ||
|
|
||
| // AND: the measured remaining fuel takes precedence over everything else | ||
| status.remaining_fuel = 1000.f; | ||
| EXPECT_FLOAT_EQ(PerformanceModel::getFuelFractionRemaining(status), 0.5f); | ||
| } | ||
|
|
||
| TEST_F(PerformanceModelTest, fuelFractionFromTankStatusIsConstrained) | ||
| { | ||
| // GIVEN: a remaining fuel measurement exceeding the maximum capacity | ||
| fuel_tank_status_s status{}; | ||
| status.maximum_fuel_capacity = 2000.f; | ||
| status.remaining_fuel = 3000.f; | ||
| status.consumed_fuel = NAN; | ||
| status.percent_remaining = UINT8_MAX; | ||
|
|
||
| // THEN: the fuel fraction is constrained to 1 | ||
| EXPECT_FLOAT_EQ(PerformanceModel::getFuelFractionRemaining(status), 1.0f); | ||
|
|
||
| // AND: more consumed fuel than the maximum capacity results in a fraction of 0 | ||
| status.remaining_fuel = NAN; | ||
| status.consumed_fuel = 3000.f; | ||
| EXPECT_FLOAT_EQ(PerformanceModel::getFuelFractionRemaining(status), 0.0f); | ||
|
|
||
| // AND: a remaining fuel measurement without a valid maximum capacity is unusable | ||
| status.maximum_fuel_capacity = 0.f; | ||
| status.remaining_fuel = 1000.f; | ||
| EXPECT_TRUE(std::isnan(PerformanceModel::getFuelFractionRemaining(status))); | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.