Prusa-Firmware-MMU/tests/unit/logic/homing/test_homing.cpp

300 lines
9.9 KiB
C++

#include "catch2/catch_test_macros.hpp"
#include "catch2/matchers/catch_matchers_vector.hpp"
#include "../../../../src/modules/buttons.h"
#include "../../../../src/modules/finda.h"
#include "../../../../src/modules/fsensor.h"
#include "../../../../src/modules/globals.h"
#include "../../../../src/modules/idler.h"
#include "../../../../src/modules/leds.h"
#include "../../../../src/modules/motion.h"
#include "../../../../src/modules/permanent_storage.h"
#include "../../../../src/modules/selector.h"
#include "../../../../src/logic/home.h"
#include "../../../../src/logic/load_filament.h"
#include "../../../../src/logic/unload_filament.h"
#include "../../../../src/logic/no_command.h"
#include "../../modules/stubs/stub_adc.h"
#include "../stubs/homing.h"
#include "../stubs/main_loop_stub.h"
#include "../stubs/stub_motion.h"
using Catch::Matchers::Equals;
#include "../helpers/helpers.ipp"
bool SuccessfulHome(uint8_t slot) {
// prepare startup conditions
ForceReinitAllAutomata();
// change the startup to what we need here
REQUIRE(EnsureActiveSlotIndex(slot, mg::FilamentLoadState::AtPulley));
// set FINDA OFF + debounce
SetFINDAStateAndDebounce(false);
logic::Home h;
REQUIRE(VerifyState(h, mg::FilamentLoadState::AtPulley, mi::Idler::IdleSlotIndex(), slot, false, false, ml::off, ml::off, ErrorCode::OK, ProgressCode::OK));
h.Reset(0);
REQUIRE(VerifyState(h, mg::FilamentLoadState::AtPulley, mi::Idler::IdleSlotIndex(), slot, false, false, ml::off, ml::off, ErrorCode::RUNNING, ProgressCode::Homing));
REQUIRE_FALSE(mi::idler.HomingValid());
REQUIRE_FALSE(ms::selector.HomingValid());
// Idler homes first
SimulateIdlerHoming(h);
REQUIRE_FALSE(mi::idler.HomingValid());
REQUIRE_FALSE(ms::selector.HomingValid());
REQUIRE(h.TopLevelState() == ProgressCode::Homing);
// Homing becomes valid
SimulateIdlerWaitForHomingValid(h);
REQUIRE(mi::idler.HomingValid());
REQUIRE_FALSE(ms::selector.HomingValid());
REQUIRE(h.TopLevelState() == ProgressCode::Homing);
// Idler returns to the parked position, and it's state is now 'Ready'
// This will now allow the Selector to home
SimulateIdlerMoveToParkingPosition(h);
REQUIRE(mi::idler.HomingValid());
REQUIRE(mi::idler.State() == mm::MovableBase::Ready);
REQUIRE_FALSE(ms::selector.HomingValid());
REQUIRE(h.TopLevelState() == ProgressCode::Homing);
// Selector starts homing
SimulateSelectorHoming(h);
REQUIRE(mi::idler.HomingValid());
REQUIRE(mi::idler.State() == mm::MovableBase::Ready);
REQUIRE_FALSE(ms::selector.HomingValid());
REQUIRE(h.TopLevelState() == ProgressCode::Homing);
// Homing becomes valid
SimulateSelectorWaitForHomingValid(h);
REQUIRE(mi::idler.HomingValid());
REQUIRE(mi::idler.State() == mm::MovableBase::Ready);
REQUIRE(ms::selector.HomingValid());
REQUIRE(h.TopLevelState() == ProgressCode::Homing);
// If there is a planned move, the selector moves to the parked position
// Once at the parked position, it's state becomes 'Ready'
SimulateSelectorWaitForReadyState(h);
REQUIRE(mi::idler.HomingValid());
REQUIRE(mi::idler.State() == mm::MovableBase::Ready);
REQUIRE(ms::selector.HomingValid());
REQUIRE(ms::selector.State() == mm::MovableBase::Ready);
// 'Homing' should change to 'OK'
REQUIRE(VerifyState(h, mg::FilamentLoadState::AtPulley, mi::Idler::IdleSlotIndex(), slot, false, false, ml::off, ml::off, ErrorCode::OK, ProgressCode::OK));
REQUIRE(mi::idler.HomingValid());
REQUIRE(ms::selector.HomingValid());
return true;
}
TEST_CASE("homing::successful_run", "[homing]") {
for (uint8_t slot = 0; slot < config::toolCount; ++slot) {
REQUIRE(SuccessfulHome(slot));
}
}
bool SelectorFailedRetry() {
// prepare startup conditions
ForceReinitAllAutomata();
// change the startup to what we need here
REQUIRE(EnsureActiveSlotIndex(0, mg::FilamentLoadState::AtPulley));
// set FINDA OFF + debounce
SetFINDAStateAndDebounce(false);
logic::Home h;
REQUIRE(VerifyState(h, mg::FilamentLoadState::AtPulley, mi::Idler::IdleSlotIndex(), 0, false, false, ml::off, ml::off, ErrorCode::OK, ProgressCode::OK));
h.Reset(0);
REQUIRE(VerifyState(h, mg::FilamentLoadState::AtPulley, mi::Idler::IdleSlotIndex(), 0, false, false, ml::off, ml::off, ErrorCode::RUNNING, ProgressCode::Homing));
REQUIRE(SimulateFailedHomeFirstTime(h));
for (uint8_t i = 0; i < 5; ++i) {
REQUIRE(SimulateFailedHomeSelectorRepeated(h));
}
SimulateSelectorHoming(h);
SimulateSelectorWaitForHomingValid(h);
REQUIRE(ms::selector.HomingValid());
// Wait for the selector to return to the parked position
SimulateSelectorWaitForReadyState(h);
REQUIRE(VerifyState(h, mg::FilamentLoadState::AtPulley, mi::Idler::IdleSlotIndex(), 0, false, false, ml::off, ml::off, ErrorCode::OK, ProgressCode::OK));
REQUIRE(mi::idler.HomingValid());
REQUIRE(ms::selector.HomingValid());
return true;
}
TEST_CASE("homing::selector_failed_retry", "[homing]") {
REQUIRE(SelectorFailedRetry());
}
bool RefusedMove(uint8_t slot) {
// prepare startup conditions
ForceReinitAllAutomata();
// change the startup to what we need here
HomeIdlerAndSelector();
SetFINDAStateAndDebounce(true);
mg::globals.SetFilamentLoaded(slot, mg::FilamentLoadState::InSelector);
// move selector to the right spot - should not be possible
REQUIRE(ms::selector.MoveToSlot(slot) == ms::Selector::OperationResult::Refused);
return true;
}
bool RefusedHome(uint8_t slot) {
// prepare startup conditions
ForceReinitAllAutomata();
// change the startup to what we need here
HomeIdlerAndSelector();
SetFINDAStateAndDebounce(true);
mg::globals.SetFilamentLoaded(slot, mg::FilamentLoadState::InSelector);
ms::selector.InvalidateHoming();
// selector should not start homing, because something is in the FINDA
for (uint8_t i = 0; i < 100; ++i) {
main_loop();
REQUIRE_FALSE(ms::selector.HomingValid());
REQUIRE(ms::selector.State() == ms::Selector::Ready);
}
// unpress FINDA
SetFINDAStateAndDebounce(false);
mg::globals.SetFilamentLoaded(slot, mg::FilamentLoadState::AtPulley);
// selector should start the homing sequence
main_loop(); // plans the homing move
// since the Idler is ok, the Selector should start homing immediately
main_loop();
REQUIRE(ms::selector.State() == ms::Selector::HomeForward);
return true;
}
TEST_CASE("homing::refused_move", "[homing]") {
for (uint8_t slot = 0; slot < config::toolCount; ++slot) {
REQUIRE(RefusedMove(slot));
}
}
TEST_CASE("homing::refused_home", "[homing]") {
for (uint8_t slot = 0; slot < config::toolCount; ++slot) {
REQUIRE(RefusedHome(slot));
}
}
bool OnHold(uint8_t slot) {
// prepare startup conditions
ForceReinitAllAutomata();
// change the startup to what we need here
HomeIdlerAndSelector();
SetFINDAStateAndDebounce(true);
mg::globals.SetFilamentLoaded(slot, mg::FilamentLoadState::InSelector);
// now put movables on hold
logic::CommandBase::HoldIdlerSelector();
REQUIRE(mi::idler.IsOnHold());
REQUIRE(ms::selector.IsOnHold());
// both movables should ignore all attempts to perform moves
REQUIRE(mi::idler.PlanHome() == mi::Idler::OperationResult::Refused);
REQUIRE(mi::idler.IsOnHold());
REQUIRE(mi::idler.Disengaged());
REQUIRE(ms::selector.PlanHome() == ms::Selector::OperationResult::Refused);
REQUIRE(ms::selector.IsOnHold());
REQUIRE(mi::idler.Disengage() == mi::Idler::OperationResult::Refused);
REQUIRE(mi::idler.IsOnHold());
REQUIRE(mi::idler.Engage(slot) == mi::Idler::OperationResult::Refused);
REQUIRE(mi::idler.IsOnHold());
REQUIRE(mi::idler.Disengaged());
REQUIRE(ms::selector.MoveToSlot((slot + 1) % config::toolCount) == ms::Selector::OperationResult::Refused);
REQUIRE(ms::selector.IsOnHold());
return true;
}
TEST_CASE("homing::on-hold", "[homing]") {
for (uint8_t slot = 0; slot < config::toolCount; ++slot) {
REQUIRE(OnHold(slot));
}
}
void AdaptiveIdlerHoming() {
// prepare startup conditions
ForceReinitAllAutomata();
mi::idler.InvalidateHoming();
// idler should plan the homing move, position of the Idler should be 0
main_loop();
CHECK(mm::motion.CurPosition<mm::Idler>().v == mm::unitToSteps<mm::I_pos_t>(config::IdlerOffsetFromHome) + 1); // magic constant just to tune the motor steps
CHECK(mi::idler.axisStart == config::IdlerOffsetFromHome.v + 2);
CHECK(mm::axes[mm::Idler].sg_thrs == 63);
// do exact number of steps before triggering SG
uint32_t idlerSteps = mm::unitToSteps<mm::I_pos_t>(config::idlerLimits.lenght);
uint32_t sgChange = mm::unitToAxisUnit<mm::I_pos_t>(config::idlerLimits.lenght - 15.0_deg).v;
for (uint32_t i = 0; i < sgChange; ++i) {
main_loop();
}
CHECK(mm::axes[mm::Idler].sg_thrs <= config::idler.sg_thrs);
// finish the forward homing move to the correct distance
for (uint32_t i = sgChange; i < idlerSteps; ++i) {
main_loop();
}
mm::TriggerStallGuard(mm::Idler);
main_loop();
mm::motion.StallGuardReset(mm::Idler);
// now do a correct amount of steps of each axis towards the other end
uint32_t maxSteps = idlerSteps + 1;
for (uint32_t i = 0; i < maxSteps; ++i) {
main_loop();
if (i == idlerSteps) {
mm::TriggerStallGuard(mm::Idler);
} else {
mm::motion.StallGuardReset(mm::Idler);
}
}
// now the Idler shall perform a move into their parking positions
while (mi::idler.State() != mm::MovableBase::Ready) {
main_loop();
}
}
// currently disabled, adaptive stallguard threshold turned out to be highly unreliable when homing the Idler
// but the code will be kept around for some time as a proof of concept
TEST_CASE("homing::adaptive", "[homing][.]") {
AdaptiveIdlerHoming();
}