Prusa-Firmware-MMU/src/logic/eject_filament.h

55 lines
2.1 KiB
C++

/// @file eject_filament.h
#pragma once
#include <stdint.h>
#include "command_base.h"
#include "unload_filament.h"
#include "../modules/axisunit.h"
namespace logic {
// These cannot be class memebers without definition until c++17
static constexpr modules::motion::P_pos_t ejectLength = 50.0_P_mm; //@@TODO
static constexpr modules::motion::P_speed_t ejectSpeed = 1000.0_P_mm_s; //@@TODO
/// @brief A high-level command state machine - handles the complex logic of ejecting filament
///
/// The eject operation consists of:
/// - Move selector sideways and push filament forward a little bit, so that the user can catch it
/// - Unpark idler at the end so that the user can pull filament out.
/// - If there is still some filament detected by PINDA unload it first.
/// - If we want to eject fil 0-2, move selector to position 4 (right).
/// - If we want to eject fil 3-4, move selector to position 0 (left)
/// - emit a message to the user: Filament ejected, press Continue to confirm removal and finish (or something like that)
/// Optionally, we can also move the selector to its service position in the future.
///
/// Technically, the hardest part is the UI - emitting a message. But, we have the MMU error screens.
/// The Eject message is not an error, but we'll leverage existing infrastructure of error screens + user input to model a nice UI dialog.
class EjectFilament : public CommandBase {
public:
inline EjectFilament()
: CommandBase() {}
/// Restart the automaton
/// @param param index of filament slot to eject
bool Reset(uint8_t param) override;
/// @returns true if the state machine finished its job, false otherwise
bool StepInner() override;
ProgressCode State() const override;
ErrorCode Error() const override;
#ifndef UNITTEST
private:
#endif
UnloadFilament unl; ///< a high-level command/operation may be used as a building block of other operations as well
uint8_t slot;
void MoveSelectorAside();
};
/// The one and only instance of EjectFilament state machine in the FW
extern EjectFilament ejectFilament;
} // namespace logic