Slic3r::ESP3D Class Reference

#include </home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/Utils/ESP3D.hpp>

Inheritance diagram for Slic3r::ESP3D:

Collaboration diagram for Slic3r::ESP3D:

Public Types
typedef Http::ProgressFn	ProgressFn
typedef std::function< void(wxString)>	ErrorFn
typedef std::function< void(wxString, wxString)>	InfoFn

Public Member Functions
	ESP3D (DynamicPrintConfig *config)
	~ESP3D () override=default
const char *	get_name () const override
bool	test (wxString &curl_msg) const override
wxString	get_test_ok_msg () const override
wxString	get_test_failed_msg (wxString &msg) const override
bool	upload (PrintHostUpload upload_data, ProgressFn prorgess_fn, ErrorFn error_fn, InfoFn info_fn) const override
bool	has_auto_discovery () const override
bool	can_test () const override
PrintHostPostUploadActions	get_post_upload_actions () const override
std::string	get_host () const override
virtual bool	supports_multiple_printers () const
virtual std::string	get_sn () const
virtual bool	get_groups (wxArrayString &) const
virtual bool	get_printers (wxArrayString &) const
virtual bool	get_storage (wxArrayString &, wxArrayString &) const
virtual bool	is_cloud () const
virtual bool	is_logged_in () const
virtual void	log_out () const
virtual bool	get_login_url (wxString &auth_url) const

Static Public Member Functions
static PrintHost *	get_print_host (DynamicPrintConfig *config)
static std::string	get_print_host_webui (DynamicPrintConfig *config)
static int	get_err_code_from_body (const std::string &body)

Protected Member Functions
virtual wxString	format_error (const std::string &body, const std::string &error, unsigned status) const

Static Protected Member Functions
static wxString	timed_out_message ()

Private Member Functions
bool	start_print (wxString &msg, const std::string &filename) const
std::string	get_short_name (const std::string &filename) const
std::string	format_command (const std::string &path, const std::string &arg, const std::string &val) const

Private Attributes
std::string	m_host
std::string	m_console_port

Detailed Description

Member Typedef Documentation

ErrorFn

typedef std::function<void(wxString )> Slic3r::PrintHost::ErrorFn

inherited

InfoFn

typedef std::function<void(wxString , wxString )> Slic3r::PrintHost::InfoFn

inherited

ProgressFn

typedef Http::ProgressFn Slic3r::PrintHost::ProgressFn

inherited

Constructor & Destructor Documentation

ESP3D()

Slic3r::ESP3D::ESP3D ( DynamicPrintConfig * config )

explicit

: m_host(config->opt_string("print_host")), m_console_port("8888") {}

References m_console_port, and m_host.

~ESP3D()

Slic3r::ESP3D::~ESP3D ( )

overridedefault

Member Function Documentation

can_test()

bool Slic3r::ESP3D::can_test ( ) const

inlineoverridevirtual

Implements Slic3r::PrintHost.

{ return true; }

format_command()

std::string Slic3r::ESP3D::format_command ( const std::string & path, const std::string & arg, const std::string & val ) const

private

{
    return (boost::format("http://%1%%2%?%3%=%4%") % m_host % path % arg % val).str();
}

References m_host.

Referenced by start_print(), and test().

Here is the caller graph for this function:

format_error()

wxString Slic3r::PrintHost::format_error ( const std::string & body, const std::string & error, unsigned status ) const

protectedvirtualinherited

{
    if (status != 0) {
        const std::string reason = moonraker_error_reason(body);
        auto wxbody = wxString::FromUTF8(reason.empty() ? body : reason);
        return wxString::Format("HTTP %u: %s", status, wxbody);
    } else {
        if (error.find("curl:Timeout was reached") != std::string::npos) {
            return timed_out_message();
        }else if(error.find("curl:Couldn't resolve host name")!= std::string::npos){
            return _L("The Hostname/IP/URL could not be parsed, please check it and try again.");
        } else if (error.find("Connection was reset") != std::string::npos){
            return _L("File/data transfer interrupted. Please check the printer and network, then try it again.");
        }
        else {
            return wxString::FromUTF8(error.data());
        }
    }
}

References _L, and timed_out_message().

Referenced by Slic3r::Duet::connect(), Slic3r::UltiMaker::connect(), Slic3r::SimplyPrint::do_chunk_upload(), Slic3r::SimplyPrint::do_temp_upload(), Slic3r::ElegooLink::elegoo_cc2_test(), Slic3r::ElegooLink::elegoo_test(), Slic3r::PrusaLink::post_inner(), Slic3r::PrusaLink::put_inner(), Slic3r::Flashforge::request_local_api_json(), Slic3r::Duet::start_print(), Slic3r::Moonraker::start_print(), Slic3r::UltiMaker::start_print(), Slic3r::AstroBox::test(), Slic3r::CrealityPrint::test(), Slic3r::ESP3D::test(), Slic3r::FlashAir::test(), Slic3r::Moonraker::test(), Slic3r::Obico::test(), Slic3r::OctoPrint::test(), Slic3r::PrusaLink::test(), Slic3r::Repetier::test(), Slic3r::UltiMaker::test(), Slic3r::PrusaLink::test_with_method_check(), Slic3r::AstroBox::upload(), Slic3r::C3DPrinterOS::upload(), Slic3r::CrealityPrint::upload(), Slic3r::Duet::upload(), Slic3r::ESP3D::upload(), Slic3r::FlashAir::upload(), Slic3r::MKS::upload(), Slic3r::Moonraker::upload(), Slic3r::Obico::upload(), Slic3r::Repetier::upload(), Slic3r::UltiMaker::upload(), Slic3r::OctoPrint::upload_inner_with_host(), Slic3r::Flashforge::upload_local_api(), Slic3r::ElegooLink::uploadPart(), and Slic3r::ElegooLink::uploadPartCC2().

Here is the call graph for this function:

Here is the caller graph for this function:

get_err_code_from_body()

int Slic3r::PrintHost::get_err_code_from_body ( const std::string & body )

staticinherited

{
    boost::property_tree::ptree root;
    std::istringstream iss(body);
    try {
        boost::property_tree::read_json(iss, root);
    } catch (const std::exception &ex) {
        BOOST_LOG_TRIVIAL(error) << "PrintHost: response is not valid JSON: " << ex.what();
        return -1;
    }
 
    return root.get<int>("err", 0);
}

Referenced by Slic3r::Duet::connect(), Slic3r::UltiMaker::connect(), Slic3r::Duet::upload(), Slic3r::MKS::upload(), and Slic3r::UltiMaker::upload().

Here is the caller graph for this function:

get_groups()

virtual bool Slic3r::PrintHost::get_groups ( wxArrayString & ) const

inlinevirtualinherited

Reimplemented in Slic3r::Repetier.

{ return false; }

get_host()

std::string Slic3r::ESP3D::get_host ( ) const

inlineoverridevirtual

Implements Slic3r::PrintHost.

{ return m_host; }

References m_host.

get_login_url()

virtual bool Slic3r::PrintHost::get_login_url ( wxString & auth_url ) const

inlinevirtualinherited

Reimplemented in Slic3r::Obico.

{ return false; }

Referenced by Slic3r::GUI::PrinterCloudAuthDialog::PrinterCloudAuthDialog().

Here is the caller graph for this function:

get_name()

const char * Slic3r::ESP3D::get_name ( ) const

overridevirtual

Implements Slic3r::PrintHost.

{ return "ESP3D"; }

get_post_upload_actions()

PrintHostPostUploadActions Slic3r::ESP3D::get_post_upload_actions ( ) const

inlineoverridevirtual

Implements Slic3r::PrintHost.

{ return PrintHostPostUploadAction::StartPrint; }

References Slic3r::StartPrint.

get_print_host()

PrintHost * Slic3r::PrintHost::get_print_host ( DynamicPrintConfig * config )

staticinherited

{
    PrinterTechnology tech = ptFFF;
 
    {
        const auto opt = config->option<ConfigOptionEnum<PrinterTechnology>>("printer_technology");
        if (opt != nullptr) {
            tech = opt->value;
        }
    }
 
    if (tech == ptFFF) {
        const auto opt = config->option<ConfigOptionEnum<PrintHostType>>("host_type");
        const auto host_type = opt != nullptr ? opt->value : htOctoPrint;
 
        switch (host_type) {
            case htOctoPrint: return new OctoPrint(config);
            case htDuet:      return new Duet(config);
            case htUltiMaker: return new UltiMaker(config);
            case htFlashAir:  return new FlashAir(config);
            case htAstroBox:  return new AstroBox(config);
            case htRepetier:  return new Repetier(config);
            case htPrusaLink: return new PrusaLink(config);
            case htPrusaConnect: return new PrusaConnect(config);
            case htMKS:       return new MKS(config);
            case htESP3D:       return new ESP3D(config);
            case htCrealityPrint:    return new CrealityPrint(config);
            case htObico:     return new Obico(config);
            case htFlashforge: return new Flashforge(config);
            case htSimplyPrint: return new SimplyPrint(config);
            case htElegooLink: return new ElegooLink(config);
            case ht3DPrinterOS: return new C3DPrinterOS(config);
            case htMoonraker: return new Moonraker(config);
            default:          return nullptr;
        }
    } else {
        return new SL1Host(config);
    }
}

References Slic3r::ht3DPrinterOS, Slic3r::htAstroBox, Slic3r::htCrealityPrint, Slic3r::htDuet, Slic3r::htElegooLink, Slic3r::htESP3D, Slic3r::htFlashAir, Slic3r::htFlashforge, Slic3r::htMKS, Slic3r::htMoonraker, Slic3r::htObico, Slic3r::htOctoPrint, Slic3r::htPrusaConnect, Slic3r::htPrusaLink, Slic3r::htRepetier, Slic3r::htSimplyPrint, Slic3r::htUltiMaker, Slic3r::ConfigBase::option(), and Slic3r::ptFFF.

Referenced by Slic3r::GUI::PhysicalPrinterDialog::build_printhost_settings(), Slic3r::GUI::anonymous_namespace{PrinterWebViewHandler.cpp}::ElegooPrinterWebViewHandler::handle_get_sn_request(), Slic3r::GUI::anonymous_namespace{PrinterWebViewHandler.cpp}::ElegooPrinterWebViewHandler::handle_upload_request(), Slic3r::GUI::PhysicalPrinterDialog::update_printers(), and Slic3r::GUI::PhysicalPrinterDialog::update_printhost_buttons().

Here is the call graph for this function:

Here is the caller graph for this function:

get_print_host_webui()

std::string Slic3r::PrintHost::get_print_host_webui ( DynamicPrintConfig * config )

staticinherited

{
    if (config == nullptr)
        return {};
 
    std::string webui_url;
    const auto* host_type_opt = config->option<ConfigOptionEnum<PrintHostType>>("host_type");
    const auto  host_type     = host_type_opt != nullptr ? host_type_opt->value : htOctoPrint;
 
    switch (host_type) {
    case htElegooLink: {
        webui_url = ElegooLink::get_print_host_webui(config);
        break;
    }
    default: break;
    }
 
    if (webui_url.empty()) {
        webui_url = config->opt_string("print_host_webui");
        if (webui_url.empty())
            webui_url = config->opt_string("print_host");
        if (webui_url.empty())
            return webui_url;
    }
 
    const bool has_http_scheme = boost::algorithm::istarts_with(webui_url, "http");
    const bool has_file_scheme = boost::algorithm::istarts_with(webui_url, "file:");
 
    if (!has_http_scheme && !has_file_scheme)
        webui_url = "http://" + webui_url;
 
    return webui_url;
}

References Slic3r::ElegooLink::get_print_host_webui(), Slic3r::htElegooLink, Slic3r::htOctoPrint, Slic3r::DynamicConfig::opt_string(), Slic3r::ConfigBase::option(), and Slic3r::ConfigOptionSingle< T >::value.

Referenced by Slic3r::GUI::MainFrame::load_printer_url(), Slic3r::GUI::Plater::priv::on_tab_selection_changing(), and Slic3r::GUI::Sidebar::update_all_preset_comboboxes().

Here is the call graph for this function:

Here is the caller graph for this function:

get_printers()

virtual bool Slic3r::PrintHost::get_printers ( wxArrayString & ) const

inlinevirtualinherited

Reimplemented in Slic3r::Obico, and Slic3r::Repetier.

{ return false; }

get_short_name()

std::string Slic3r::ESP3D::get_short_name ( const std::string & filename ) const

private

{
    std::string             shortname = "";
    boost::filesystem::path p(filename);
    std::string             stem      = p.stem().string();
    std::string             extension = p.extension().string();
    if (!extension.empty() && extension[0] == '.') {
        extension = extension.substr(1);
    }
    stem      = stem.substr(0, 8);
    extension = extension.substr(0, 3);
    if (!extension.empty()) {
        shortname = stem + "." + extension;
    } else {
        shortname = stem;
    }
    return shortname;
}

Referenced by upload().

Here is the caller graph for this function:

get_sn()

virtual std::string Slic3r::PrintHost::get_sn ( ) const

inlinevirtualinherited

Get the serial number for connecting to the printer. For Elegoo CC2, the device details connection to the printer requires the serial number. Other print hosts do not need to implement this interface, and it returns an empty string by default.

Reimplemented in Slic3r::ElegooLink.

{ return ""; }

get_storage()

virtual bool Slic3r::PrintHost::get_storage ( wxArrayString & , wxArrayString &  ) const

inlinevirtualinherited

Reimplemented in Slic3r::Moonraker, Slic3r::PrusaConnect, and Slic3r::PrusaLink.

{ return false; }

get_test_failed_msg()

wxString Slic3r::ESP3D::get_test_failed_msg ( wxString & msg ) const

overridevirtual

Implements Slic3r::PrintHost.

{
    return GUI::from_u8((boost::format("%s: %s") % _utf8(L("Could not connect to ESP3D")) % std::string(msg.ToUTF8())).str());
}

References _utf8, Slic3r::GUI::from_u8(), and L.

Here is the call graph for this function:

get_test_ok_msg()

wxString Slic3r::ESP3D::get_test_ok_msg ( ) const

overridevirtual

Implements Slic3r::PrintHost.

{ return _(L("Connection to ESP3D is working correctly.")); }

References _, and L.

Referenced by test().

Here is the caller graph for this function:

has_auto_discovery()

bool Slic3r::ESP3D::has_auto_discovery ( ) const

inlineoverridevirtual

Implements Slic3r::PrintHost.

{ return false; }

is_cloud()

virtual bool Slic3r::PrintHost::is_cloud ( ) const

inlinevirtualinherited

Reimplemented in Slic3r::C3DPrinterOS, Slic3r::Obico, and Slic3r::SimplyPrint.

{ return false; }

is_logged_in()

virtual bool Slic3r::PrintHost::is_logged_in ( ) const

inlinevirtualinherited

Reimplemented in Slic3r::C3DPrinterOS, and Slic3r::SimplyPrint.

{ return false; }

log_out()

virtual void Slic3r::PrintHost::log_out ( ) const

inlinevirtualinherited

Reimplemented in Slic3r::C3DPrinterOS, and Slic3r::SimplyPrint.

{}

start_print()

bool Slic3r::ESP3D::start_print ( wxString & msg, const std::string & filename ) const

private

{
    // For some reason printer firmware does not want to respond on gcode commands immediately after file upload.
    // So we just introduce artificial delay to workaround it.
    // ESP3D also locks the serial during SD transfer, this is safer
    std::this_thread::sleep_for(std::chrono::milliseconds(1500));
 
    bool ret         = false;
    auto select_file = (boost::format("%1% %2%") % "M23" % filename).str();
    auto select      = format_command("/command", "plain", Http::url_encode(select_file));
    auto http_sel    = Http::get(select);
    http_sel
        .on_complete([&](std::string body, unsigned status) { 
            ret = true;
        })
        .on_error([&](std::string body, std::string error, unsigned status) {
            // error sending M23
            ret = false;
            msg = (wxString::FromUTF8(error));
        })
        .perform_sync();
 
    if (!ret)
        return ret;
 
    auto start      = format_command("/command", "plain", "M24");
    auto http_start = Http::get(start);
    http_start
        .on_complete([&](std::string body, unsigned status) {
            // print kicked off succesfully
            ret = true;
        })
        .on_error([&](std::string body, std::string error, unsigned status) {
            // error sending M24
            ret = false;
            msg = (wxString::FromUTF8(error));
        })
        .perform_sync();
 
    return ret;
}

References format_command(), Slic3r::Http::get(), and Slic3r::Http::url_encode().

Referenced by upload().

Here is the call graph for this function:

Here is the caller graph for this function:

supports_multiple_printers()

virtual bool Slic3r::PrintHost::supports_multiple_printers ( ) const

inlinevirtualinherited

Reimplemented in Slic3r::Repetier.

{ return false; }

test()

bool Slic3r::ESP3D::test ( wxString & curl_msg ) const

overridevirtual

Implements Slic3r::PrintHost.

{
    bool        ret      = false;
    std::string url_test = format_command("/command", "plain", "M105");
    auto        http     = Http::get(url_test);
    http.on_complete([&](std::string body, unsigned status) {
            // check  for OK
            ret = true;
            msg = get_test_ok_msg();
        })
        .on_error([&](std::string body, std::string error, unsigned status) {
            ret = false;
            msg = format_error(body , error, status);
        })
        .perform_sync();
    return ret;
}

References format_command(), Slic3r::PrintHost::format_error(), Slic3r::Http::get(), get_test_ok_msg(), and Slic3r::http.

Here is the call graph for this function:

timed_out_message()

wxString Slic3r::PrintHost::timed_out_message ( )

staticprotectedinherited

{
    return _L("Connection timed out. Please check if the printer and computer network are functioning properly, and confirm that they are on the same network.");
}

References _L.

Referenced by format_error(), and Slic3r::CrealityPrint::start_print().

Here is the caller graph for this function:

upload()

bool Slic3r::ESP3D::upload ( PrintHostUpload upload_data, ProgressFn prorgess_fn, ErrorFn error_fn, InfoFn info_fn ) const

overridevirtual

Implements Slic3r::PrintHost.

{
    std::string short_name = get_short_name(upload_data.upload_path.string());
    bool        res        = false;
 
    auto http = Http::post((boost::format("http://%1%/upload_serial") % m_host).str());
    http.header("Connection", "keep-alive")
        .form_add_file("file", upload_data.source_path, short_name)
        .on_complete([&](std::string body, unsigned status) {
            // check for OK
            if (upload_data.post_action == PrintHostPostUploadAction::StartPrint) {
                wxString errormsg;
                res = start_print(errormsg, short_name);
                if (!res) {
                    error_fn(std::move(errormsg));
                }
            }
        })
        .on_error([&](std::string body, std::string error, unsigned status) {
            BOOST_LOG_TRIVIAL(error) << boost::format("ESP3D: Error uploading file: %1%, HTTP %2%, body: `%3%`") % error % status % body;
            error_fn(format_error(body, error, status));
            res = false;
        })
        .on_progress([&](Http::Progress progress, bool& cancel) {
            // workaround:
            // progress bar disappears before .on_complete
            // ESP3D can be super slow, the user could close slicer before upload completes & M24 is sent because no progress bar
            // M24 can only be sent after .on_complete
            Http::Progress prog = std::move(progress);
            prog.ulnow -= 1;
            prorgess_fn(std::move(prog), cancel);
            if (cancel) {
                // Upload was canceled
                BOOST_LOG_TRIVIAL(info) << "ESP3D: Upload canceled";
                res = false;
            }
        })
        .perform_sync();
 
    return res;
}

References Slic3r::PrintHost::format_error(), get_short_name(), Slic3r::http, m_host, Slic3r::Http::post(), Slic3r::PrintHostUpload::post_action, Slic3r::PrintHostUpload::source_path, start_print(), Slic3r::StartPrint, Slic3r::Http::Progress::ulnow, and Slic3r::PrintHostUpload::upload_path.

Here is the call graph for this function:

Member Data Documentation

m_console_port

std::string Slic3r::ESP3D::m_console_port

private

Referenced by ESP3D().

m_host

std::string Slic3r::ESP3D::m_host

private

Referenced by ESP3D(), format_command(), get_host(), and upload().

---

The documentation for this class was generated from the following files:

• /home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/Utils/ESP3D.hpp
• /home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/Utils/ESP3D.cpp