Slic3r::PrintHost Class Reference

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

Inheritance diagram for Slic3r::PrintHost:

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

Public Member Functions
virtual	~PrintHost ()
virtual const char *	get_name () const =0
virtual bool	test (wxString &curl_msg) const =0
virtual wxString	get_test_ok_msg () const =0
virtual wxString	get_test_failed_msg (wxString &msg) const =0
virtual bool	upload (PrintHostUpload upload_data, ProgressFn prorgess_fn, ErrorFn error_fn, InfoFn info_fn) const =0
virtual bool	has_auto_discovery () const =0
virtual bool	can_test () const =0
virtual PrintHostPostUploadActions	get_post_upload_actions () const =0
virtual bool	supports_multiple_printers () const
virtual std::string	get_host () const =0
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 ()

Detailed Description

Member Typedef Documentation

ErrorFn

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

InfoFn

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

ProgressFn

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

Constructor & Destructor Documentation

~PrintHost()

Slic3r::PrintHost::~PrintHost ( )

virtual

{}

Member Function Documentation

can_test()

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

pure virtual

Implemented in Slic3r::AstroBox, Slic3r::C3DPrinterOS, Slic3r::CrealityPrint, Slic3r::Duet, Slic3r::ElegooLink, Slic3r::ESP3D, Slic3r::FlashAir, Slic3r::Flashforge, Slic3r::MKS, Slic3r::Moonraker, Slic3r::Obico, Slic3r::OctoPrint, Slic3r::Repetier, Slic3r::SimplyPrint, and Slic3r::UltiMaker.

format_error()

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

protectedvirtual

{
    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 )

static

{
    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

inlinevirtual

Reimplemented in Slic3r::Repetier.

{ return false; }

get_host()

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

pure virtual

Implemented in Slic3r::AstroBox, Slic3r::C3DPrinterOS, Slic3r::CrealityPrint, Slic3r::Duet, Slic3r::ESP3D, Slic3r::FlashAir, Slic3r::Flashforge, Slic3r::MKS, Slic3r::Moonraker, Slic3r::Obico, Slic3r::OctoPrint, Slic3r::Repetier, Slic3r::SimplyPrint, and Slic3r::UltiMaker.

get_login_url()

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

inlinevirtual

Reimplemented in Slic3r::Obico.

{ return false; }

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

Here is the caller graph for this function:

get_name()

virtual const char * Slic3r::PrintHost::get_name ( ) const

pure virtual

Implemented in Slic3r::AstroBox, Slic3r::C3DPrinterOS, Slic3r::CrealityPrint, Slic3r::Duet, Slic3r::ElegooLink, Slic3r::ESP3D, Slic3r::FlashAir, Slic3r::Flashforge, Slic3r::MKS, Slic3r::Moonraker, Slic3r::Obico, Slic3r::OctoPrint, Slic3r::PrusaConnect, Slic3r::PrusaLink, Slic3r::Repetier, Slic3r::SimplyPrint, Slic3r::SL1Host, and Slic3r::UltiMaker.

get_post_upload_actions()

virtual PrintHostPostUploadActions Slic3r::PrintHost::get_post_upload_actions ( ) const

pure virtual

Implemented in Slic3r::AstroBox, Slic3r::C3DPrinterOS, Slic3r::CrealityPrint, Slic3r::Duet, Slic3r::ElegooLink, Slic3r::ESP3D, Slic3r::FlashAir, Slic3r::Flashforge, Slic3r::MKS, Slic3r::Moonraker, Slic3r::Obico, Slic3r::OctoPrint, Slic3r::PrusaConnect, Slic3r::PrusaLink, Slic3r::Repetier, Slic3r::SimplyPrint, Slic3r::SL1Host, and Slic3r::UltiMaker.

get_print_host()

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

static

{
    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 )

static

{
    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

inlinevirtual

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

{ return false; }

get_sn()

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

inlinevirtual

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

inlinevirtual

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

{ return false; }

get_test_failed_msg()

virtual wxString Slic3r::PrintHost::get_test_failed_msg ( wxString & msg ) const

pure virtual

Implemented in Slic3r::AstroBox, Slic3r::C3DPrinterOS, Slic3r::CrealityPrint, Slic3r::Duet, Slic3r::ElegooLink, Slic3r::ESP3D, Slic3r::FlashAir, Slic3r::Flashforge, Slic3r::MKS, Slic3r::Moonraker, Slic3r::Obico, Slic3r::OctoPrint, Slic3r::PrusaConnect, Slic3r::PrusaLink, Slic3r::Repetier, Slic3r::SimplyPrint, Slic3r::SL1Host, and Slic3r::UltiMaker.

get_test_ok_msg()

virtual wxString Slic3r::PrintHost::get_test_ok_msg ( ) const

pure virtual

Implemented in Slic3r::AstroBox, Slic3r::C3DPrinterOS, Slic3r::CrealityPrint, Slic3r::Duet, Slic3r::ElegooLink, Slic3r::ESP3D, Slic3r::FlashAir, Slic3r::Flashforge, Slic3r::MKS, Slic3r::Moonraker, Slic3r::Obico, Slic3r::OctoPrint, Slic3r::PrusaConnect, Slic3r::PrusaLink, Slic3r::Repetier, Slic3r::SimplyPrint, Slic3r::SL1Host, and Slic3r::UltiMaker.

has_auto_discovery()

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

pure virtual

Implemented in Slic3r::AstroBox, Slic3r::C3DPrinterOS, Slic3r::CrealityPrint, Slic3r::Duet, Slic3r::ElegooLink, Slic3r::ESP3D, Slic3r::FlashAir, Slic3r::Flashforge, Slic3r::MKS, Slic3r::Moonraker, Slic3r::Obico, Slic3r::OctoPrint, Slic3r::Repetier, Slic3r::SimplyPrint, and Slic3r::UltiMaker.

is_cloud()

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

inlinevirtual

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

{ return false; }

is_logged_in()

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

inlinevirtual

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

{ return false; }

log_out()

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

inlinevirtual

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

{}

supports_multiple_printers()

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

inlinevirtual

Reimplemented in Slic3r::Repetier.

{ return false; }

test()

virtual bool Slic3r::PrintHost::test ( wxString & curl_msg ) const

pure virtual

Implemented in Slic3r::AstroBox, Slic3r::C3DPrinterOS, Slic3r::CrealityPrint, Slic3r::Duet, Slic3r::ElegooLink, Slic3r::ESP3D, Slic3r::FlashAir, Slic3r::Flashforge, Slic3r::MKS, Slic3r::Moonraker, Slic3r::Obico, Slic3r::OctoPrint, Slic3r::PrusaLink, Slic3r::Repetier, Slic3r::SimplyPrint, and Slic3r::UltiMaker.

timed_out_message()

wxString Slic3r::PrintHost::timed_out_message ( )

staticprotected

{
    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()

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

pure virtual

Implemented in Slic3r::AstroBox, Slic3r::C3DPrinterOS, Slic3r::CrealityPrint, Slic3r::Duet, Slic3r::ESP3D, Slic3r::FlashAir, Slic3r::Flashforge, Slic3r::MKS, Slic3r::Moonraker, Slic3r::Obico, Slic3r::OctoPrint, Slic3r::Repetier, Slic3r::SimplyPrint, and Slic3r::UltiMaker.

---

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

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