Slic3r::IPrinterAgent Class Reference

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

Inheritance diagram for Slic3r::IPrinterAgent:

Public Member Functions
virtual	~IPrinterAgent ()=default
virtual void	set_cloud_agent (std::shared_ptr< ICloudServiceAgent > cloud)=0
virtual int	send_message (std::string dev_id, std::string json_str, int qos, int flag)=0
virtual int	command_ams_refresh_rfid (std::string, int, int, int, bool)
virtual int	command_ams_calibrate (std::string, int, int, bool)
virtual int	command_ams_select_tray (std::string, std::string, int, bool)
virtual int	command_start_camera (std::string)
virtual int	command_xyz_abs (std::string dev_id, int sequence_id, bool lan_mode)
virtual int	command_auto_leveling (std::string dev_id, int sequence_id, bool lan_mode)
virtual int	command_go_home (std::string dev_id, bool is_printing, bool supports_mqtt_homing, int sequence_id, bool lan_mode)
virtual int	command_set_bed (std::string dev_id, int temp, bool supports_mqtt_bed_ctrl, int sequence_id, bool lan_mode)
virtual int	command_set_nozzle (std::string dev_id, int temp, int sequence_id, bool lan_mode)
virtual int	command_axis_control (std::string dev_id, std::string axis, double unit, double input_val, int speed, bool is_core_xy, bool supports_mqtt_axis_control, int sequence_id, bool lan_mode)
virtual std::string	default_lan_username () const
virtual int	connect_printer (const PrinterConnectionParams &params)=0
virtual int	disconnect_printer ()=0
virtual int	send_message_to_printer (std::string dev_id, std::string json_str, int qos, int flag)=0
virtual int	check_cert ()
virtual void	install_device_cert (std::string dev_id, bool lan_only)
virtual bool	start_discovery (bool start, bool sending)=0
virtual int	ping_bind (std::string ping_code)
virtual int	bind_detect (std::string dev_ip, std::string sec_link, detectResult &detect)=0
virtual int	bind (std::string dev_ip, std::string dev_id, std::string dev_model, std::string sec_link, std::string timezone, bool improved, OnUpdateStatusFn update_fn)
virtual int	unbind (std::string dev_id)
virtual int	request_bind_ticket (std::string *ticket)
virtual int	get_hms_snapshot (std::string dev_id, std::string file_name, std::function< void(std::string, int)> callback)
virtual int	set_server_callback (OnServerErrFn fn)=0
virtual std::string	get_user_selected_machine ()=0
virtual int	set_user_selected_machine (std::string dev_id)=0
virtual int	start_subscribe (std::string module)
virtual int	stop_subscribe (std::string module)
virtual int	add_subscribe (std::vector< std::string > dev_list)
virtual int	del_subscribe (std::vector< std::string > dev_list)
virtual int	start_print (PrintParams params, OnUpdateStatusFn update_fn, WasCancelledFn cancel_fn, OnWaitFn wait_fn)=0
virtual int	start_local_print_with_record (PrintParams params, OnUpdateStatusFn update_fn, WasCancelledFn cancel_fn, OnWaitFn wait_fn)=0
virtual int	start_send_gcode_to_sdcard (PrintParams params, OnUpdateStatusFn update_fn, WasCancelledFn cancel_fn, OnWaitFn wait_fn)=0
virtual int	start_local_print (PrintParams params, OnUpdateStatusFn update_fn, WasCancelledFn cancel_fn)=0
virtual int	start_sdcard_print (PrintParams params, OnUpdateStatusFn update_fn, WasCancelledFn cancel_fn)=0
virtual int	set_on_ssdp_msg_fn (OnMsgArrivedFn fn)=0
virtual int	set_on_printer_connected_fn (OnPrinterConnectedFn fn)=0
virtual int	set_on_subscribe_failure_fn (GetSubscribeFailureFn fn)=0
virtual int	set_on_message_fn (OnMessageFn fn)=0
virtual int	set_on_user_message_fn (OnMessageFn fn)=0
virtual int	set_on_local_connect_fn (OnLocalConnectedFn fn)=0
virtual int	set_on_local_message_fn (OnMessageFn fn)=0
virtual int	set_queue_on_main_fn (QueueOnMainFn fn)=0
virtual AgentInfo	get_agent_info ()=0
virtual FilamentSyncMode	get_filament_sync_mode () const
virtual CameraStreamMode	get_camera_stream_mode () const
virtual bool	fetch_filament_info (std::string dev_id, FilamentSyncMode sync_mode=FilamentSyncMode::pull)
virtual std::string	to_orca_filament_id (const std::string &printer_filament_id) const
virtual std::string	from_orca_filament_id (const std::string &orca_filament_id) const
virtual std::string	get_camera_url () const

Private Member Functions
int	publish_command_json (std::string dev_id, const nlohmann::json &j, bool lan_mode)

Detailed Description

IPrinterAgent - Interface for printer operations.

This interface encapsulates all printer-related functionality:

• Direct printer communication (LAN and cloud relay)
• Certificate management
• Device discovery (SSDP)
• Printer binding/unbinding
• Print job operations

Implementations:

• OrcaPrinterAgent: Stub implementation (printer ops not yet supported)
• PrinterAgentPluginCapability: Python printer-agent plugin capability that implements IPrinterAgent directly and is handed out as the live agent
• BBLPrinterAgent: Wrapper around Bambu Lab's proprietary DLL

Token Access: Printer agents receive an ICloudServiceAgent instance via set_cloud_agent() to access tokens for cloud-relay operations.

Constructor & Destructor Documentation

~IPrinterAgent()

virtual Slic3r::IPrinterAgent::~IPrinterAgent ( )

virtualdefault

Member Function Documentation

add_subscribe()

virtual int Slic3r::IPrinterAgent::add_subscribe ( std::vector< std::string > dev_list )

inlinevirtual

Subscribe to push streams for specific device identifiers.

Reimplemented in Slic3r::BBLPrinterAgent.

{ (void) dev_list; return BAMBU_NETWORK_SUCCESS; }

References BAMBU_NETWORK_SUCCESS.

bind()

virtual int Slic3r::IPrinterAgent::bind ( std::string dev_ip, std::string dev_id, std::string dev_model, std::string sec_link, std::string timezone, bool improved, OnUpdateStatusFn update_fn )

inlinevirtual

Execute the multi-stage printer binding workflow.

Reimplemented in Slic3r::BBLPrinterAgent, and Slic3r::PyPrinterAgentPluginCapabilityTrampoline.

    {
        (void) dev_ip;
        (void) dev_id;
        (void) dev_model;
        (void) sec_link;
        (void) timezone;
        (void) improved;
        (void) update_fn;
        return BAMBU_NETWORK_SUCCESS;
    }

References BAMBU_NETWORK_SUCCESS.

Referenced by Slic3r::PrinterAgentPluginCapability::RegisterBindings().

Here is the caller graph for this function:

bind_detect()

virtual int Slic3r::IPrinterAgent::bind_detect ( std::string dev_ip, std::string sec_link, detectResult & detect )

pure virtual

Perform binding detection/handshake on a LAN printer.

Implemented in Slic3r::BBLPrinterAgent, Slic3r::MoonrakerPrinterAgent, Slic3r::OrcaPrinterAgent, Slic3r::PrinterAgentPluginCapability, and Slic3r::PyPrinterAgentPluginCapabilityTrampoline.

check_cert()

virtual int Slic3r::IPrinterAgent::check_cert ( )

inlinevirtual

Validate current user certificates for the printer.

Reimplemented in Slic3r::BBLPrinterAgent, and Slic3r::PyPrinterAgentPluginCapabilityTrampoline.

{ return BAMBU_NETWORK_SUCCESS; }

References BAMBU_NETWORK_SUCCESS.

Referenced by Slic3r::PrinterAgentPluginCapability::RegisterBindings().

Here is the caller graph for this function:

command_ams_calibrate()

virtual int Slic3r::IPrinterAgent::command_ams_calibrate ( std::string , int , int , bool  )

inlinevirtual

Reimplemented in Slic3r::BBLPrinterAgent, and Slic3r::PyPrinterAgentPluginCapabilityTrampoline.

    { return ORCA_NETWORK_ERR_CMD_NOT_SUPPORTED; }

References ORCA_NETWORK_ERR_CMD_NOT_SUPPORTED.

Referenced by Slic3r::PrinterAgentPluginCapability::RegisterBindings().

Here is the caller graph for this function:

command_ams_refresh_rfid()

virtual int Slic3r::IPrinterAgent::command_ams_refresh_rfid ( std::string , int , int , int , bool  )

inlinevirtual

Reimplemented in Slic3r::BBLPrinterAgent, and Slic3r::PyPrinterAgentPluginCapabilityTrampoline.

    { return ORCA_NETWORK_ERR_CMD_NOT_SUPPORTED; }

References ORCA_NETWORK_ERR_CMD_NOT_SUPPORTED.

Referenced by Slic3r::PrinterAgentPluginCapability::RegisterBindings().

Here is the caller graph for this function:

command_ams_select_tray()

virtual int Slic3r::IPrinterAgent::command_ams_select_tray ( std::string , std::string , int , bool  )

inlinevirtual

Reimplemented in Slic3r::BBLPrinterAgent, and Slic3r::PyPrinterAgentPluginCapabilityTrampoline.

    { return ORCA_NETWORK_ERR_CMD_NOT_SUPPORTED; }

References ORCA_NETWORK_ERR_CMD_NOT_SUPPORTED.

Referenced by Slic3r::PrinterAgentPluginCapability::RegisterBindings().

Here is the caller graph for this function:

command_auto_leveling()

virtual int Slic3r::IPrinterAgent::command_auto_leveling ( std::string dev_id, int sequence_id, bool lan_mode )

inlinevirtual

Reimplemented in Slic3r::PyPrinterAgentPluginCapabilityTrampoline.

    {
        nlohmann::json j;
        j["print"]["command"]     = "gcode_line";
        j["print"]["param"]       = "G29 \n";
        j["print"]["sequence_id"] = std::to_string(sequence_id);
        return publish_command_json(dev_id, j, lan_mode);
    }

References publish_command_json().

Referenced by Slic3r::PrinterAgentPluginCapability::RegisterBindings().

Here is the call graph for this function:

Here is the caller graph for this function:

command_axis_control()

virtual int Slic3r::IPrinterAgent::command_axis_control ( std::string dev_id, std::string axis, double unit, double input_val, int speed, bool is_core_xy, bool supports_mqtt_axis_control, int sequence_id, bool lan_mode )

inlinevirtual

Reimplemented in Slic3r::BBLPrinterAgent, and Slic3r::PyPrinterAgentPluginCapabilityTrampoline.

    {
        (void) supports_mqtt_axis_control;
 
        double value = input_val;
        if (!is_core_xy && (axis == "Y" || axis == "Z"))
            value = -input_val;
 
        std::string value_str = (boost::format("%.1f") % (value * unit)).str();
        std::string gcode;
        if (axis == "X" || axis == "Y" || axis == "Z") {
            gcode = (boost::format("G91 \nG1 %1%%2% F%3%\nG90 \n") % axis % value_str % speed).str();
        } else if (axis == "E") {
            gcode = (boost::format("M83 \nG0 %1%%2% F%3%\n") % axis % value_str % speed).str();
        } else {
            return -1;
        }
 
        nlohmann::json j;
        j["print"]["command"]     = "gcode_line";
        j["print"]["param"]       = gcode;
        j["print"]["sequence_id"] = std::to_string(sequence_id);
        return publish_command_json(dev_id, j, lan_mode);
    }

References publish_command_json().

Referenced by Slic3r::PrinterAgentPluginCapability::RegisterBindings().

Here is the call graph for this function:

Here is the caller graph for this function:

command_go_home()

virtual int Slic3r::IPrinterAgent::command_go_home ( std::string dev_id, bool is_printing, bool supports_mqtt_homing, int sequence_id, bool lan_mode )

inlinevirtual

Reimplemented in Slic3r::PyPrinterAgentPluginCapabilityTrampoline.

    {
        nlohmann::json j;
        j["print"]["sequence_id"] = std::to_string(sequence_id);
        if (supports_mqtt_homing) {
            j["print"]["command"] = "back_to_center";
        } else {
            j["print"]["command"] = "gcode_line";
            j["print"]["param"]   = is_printing ? "G28 X\n" : "G28 \n";
        }
        return publish_command_json(dev_id, j, lan_mode);
    }

References publish_command_json().

Referenced by Slic3r::PrinterAgentPluginCapability::RegisterBindings().

Here is the call graph for this function:

Here is the caller graph for this function:

command_set_bed()

virtual int Slic3r::IPrinterAgent::command_set_bed ( std::string dev_id, int temp, bool supports_mqtt_bed_ctrl, int sequence_id, bool lan_mode )

inlinevirtual

Reimplemented in Slic3r::PyPrinterAgentPluginCapabilityTrampoline.

    {
        nlohmann::json j;
        j["print"]["sequence_id"] = std::to_string(sequence_id);
        if (supports_mqtt_bed_ctrl) {
            j["print"]["command"] = "set_bed_temp";
            j["print"]["temp"]    = temp;
        } else {
            j["print"]["command"] = "gcode_line";
            j["print"]["param"]   = (boost::format("M140 S%1%\n") % temp).str();
        }
        return publish_command_json(dev_id, j, lan_mode);
    }

References publish_command_json().

Referenced by Slic3r::PrinterAgentPluginCapability::RegisterBindings().

Here is the call graph for this function:

Here is the caller graph for this function:

command_set_nozzle()

virtual int Slic3r::IPrinterAgent::command_set_nozzle ( std::string dev_id, int temp, int sequence_id, bool lan_mode )

inlinevirtual

Reimplemented in Slic3r::PyPrinterAgentPluginCapabilityTrampoline.

    {
        nlohmann::json j;
        j["print"]["command"]     = "gcode_line";
        j["print"]["param"]       = (boost::format("M104 S%1%\n") % temp).str();
        j["print"]["sequence_id"] = std::to_string(sequence_id);
        return publish_command_json(dev_id, j, lan_mode);
    }

References publish_command_json().

Referenced by Slic3r::PrinterAgentPluginCapability::RegisterBindings().

Here is the call graph for this function:

Here is the caller graph for this function:

command_start_camera()

virtual int Slic3r::IPrinterAgent::command_start_camera ( std::string )

inlinevirtual

Reimplemented in Slic3r::PyPrinterAgentPluginCapabilityTrampoline.

    { return ORCA_NETWORK_ERR_CMD_NOT_SUPPORTED; }

References ORCA_NETWORK_ERR_CMD_NOT_SUPPORTED.

Referenced by Slic3r::PrinterAgentPluginCapability::RegisterBindings().

Here is the caller graph for this function:

command_xyz_abs()

virtual int Slic3r::IPrinterAgent::command_xyz_abs ( std::string dev_id, int sequence_id, bool lan_mode )

inlinevirtual

Reimplemented in Slic3r::PyPrinterAgentPluginCapabilityTrampoline.

    {
        nlohmann::json j;
        j["print"]["command"]     = "gcode_line";
        j["print"]["param"]       = "G90 \n";
        j["print"]["sequence_id"] = std::to_string(sequence_id);
        return publish_command_json(dev_id, j, lan_mode);
    }

References publish_command_json().

Referenced by Slic3r::PrinterAgentPluginCapability::RegisterBindings().

Here is the call graph for this function:

Here is the caller graph for this function:

connect_printer()

virtual int Slic3r::IPrinterAgent::connect_printer ( const PrinterConnectionParams & params )

pure virtual

Establish a direct LAN connection to a printer.

Implemented in Slic3r::BBLPrinterAgent, Slic3r::MoonrakerPrinterAgent, Slic3r::OrcaPrinterAgent, Slic3r::PrinterAgentPluginCapability, and Slic3r::PyPrinterAgentPluginCapabilityTrampoline.

default_lan_username()

virtual std::string Slic3r::IPrinterAgent::default_lan_username ( ) const

inlinevirtual

Default LAN account username for this agent's protocol, if it has a fixed one. Returns an empty string if the agent has no fixed default (e.g. caller must supply one).

Reimplemented in Slic3r::BBLPrinterAgent.

{ return {}; }

del_subscribe()

virtual int Slic3r::IPrinterAgent::del_subscribe ( std::vector< std::string > dev_list )

inlinevirtual

Remove device-level subscriptions.

Reimplemented in Slic3r::BBLPrinterAgent.

{ (void) dev_list; return BAMBU_NETWORK_SUCCESS; }

References BAMBU_NETWORK_SUCCESS.

disconnect_printer()

virtual int Slic3r::IPrinterAgent::disconnect_printer ( )

pure virtual

Tear down the active LAN printer connection.

Implemented in Slic3r::BBLPrinterAgent, Slic3r::MoonrakerPrinterAgent, Slic3r::OrcaPrinterAgent, and Slic3r::PyPrinterAgentPluginCapabilityTrampoline.

Referenced by Slic3r::PrinterAgentPluginCapability::RegisterBindings().

Here is the caller graph for this function:

fetch_filament_info()

virtual bool Slic3r::IPrinterAgent::fetch_filament_info ( std::string dev_id, FilamentSyncMode sync_mode = FilamentSyncMode::pull )

inlinevirtual

Refresh filament info from the printer synchronously. Should only be called when get_filament_sync_mode() returns FilamentSyncMode::pull. Populates the MachineObject's DevFilaSystem with fetched filament data.

Reimplemented in Slic3r::CrealityPrintAgent, Slic3r::MoonrakerPrinterAgent, Slic3r::PyPrinterAgentPluginCapabilityTrampoline, Slic3r::QidiPrinterAgent, and Slic3r::SnapmakerPrinterAgent.

{ return false; }

References Slic3r::pull.

Referenced by Slic3r::PrinterAgentPluginCapability::RegisterBindings().

Here is the caller graph for this function:

from_orca_filament_id()

virtual std::string Slic3r::IPrinterAgent::from_orca_filament_id ( const std::string & orca_filament_id ) const

inlinevirtual

Reimplemented in Slic3r::BBLPrinterAgent.

{ return orca_filament_id; }

get_agent_info()

virtual AgentInfo Slic3r::IPrinterAgent::get_agent_info ( )

pure virtual

Get agent information.

Implemented in Slic3r::BBLPrinterAgent, Slic3r::CrealityPrintAgent, Slic3r::MoonrakerPrinterAgent, Slic3r::OrcaPrinterAgent, Slic3r::PrinterAgentPluginCapability, Slic3r::PyPrinterAgentPluginCapabilityTrampoline, Slic3r::QidiPrinterAgent, and Slic3r::SnapmakerPrinterAgent.

get_camera_stream_mode()

virtual CameraStreamMode Slic3r::IPrinterAgent::get_camera_stream_mode ( ) const

inlinevirtual

Get the camera stream mode for this agent. This value can be deterministic and derived at runtime if the printer supports multiple camera stream modes. E.g. LAN => HTTP/HTTPS/RTSP, Cloud => WebRTC.

Returns

CameraStreamMode indicating how the camera stream is obtained or used:

Reimplemented in Slic3r::PyPrinterAgentPluginCapabilityTrampoline.

{ return CameraStreamMode::none; }

References Slic3r::none.

Referenced by Slic3r::PrinterAgentPluginCapability::RegisterBindings().

Here is the caller graph for this function:

get_camera_url()

virtual std::string Slic3r::IPrinterAgent::get_camera_url ( ) const

inlinevirtual

Get the current camera stream URL for this agent's active machine. Only meaningful when get_camera_stream_mode() returns an HTTP, HTTPS, or RTSP mode.

Reimplemented in Slic3r::PyPrinterAgentPluginCapabilityTrampoline.

{ return {}; }

Referenced by Slic3r::PrinterAgentPluginCapability::RegisterBindings().

Here is the caller graph for this function:

get_filament_sync_mode()

virtual FilamentSyncMode Slic3r::IPrinterAgent::get_filament_sync_mode ( ) const

inlinevirtual

Get the filament synchronization mode for this agent.

Returns

FilamentSyncMode indicating how filament data is obtained:

• subscription: Real-time push updates via MQTT (no fetch needed)
• pull: On-demand fetch via REST API (call fetch_filament_info())
• none: Filament synchronization not supported

Reimplemented in Slic3r::BBLPrinterAgent, Slic3r::MoonrakerPrinterAgent, and Slic3r::PyPrinterAgentPluginCapabilityTrampoline.

{ return FilamentSyncMode::none; }

References Slic3r::none.

Referenced by Slic3r::PrinterAgentPluginCapability::RegisterBindings().

Here is the caller graph for this function:

get_hms_snapshot()

virtual int Slic3r::IPrinterAgent::get_hms_snapshot ( std::string dev_id, std::string file_name, std::function< void(std::string, int)> callback )

inlinevirtual

Fetch the cloud snapshot image captured at a print failure. Returns 0 if the request was dispatched; the image body arrives via callback(body, http_status).

Reimplemented in Slic3r::BBLPrinterAgent, and Slic3r::PyPrinterAgentPluginCapabilityTrampoline.

    {
        (void) dev_id;
        (void) file_name;
        (void) callback;
        return -1;
    }

get_user_selected_machine()

virtual std::string Slic3r::IPrinterAgent::get_user_selected_machine ( )

pure virtual

Return the currently selected printer ID.

Implemented in Slic3r::BBLPrinterAgent, Slic3r::MoonrakerPrinterAgent, Slic3r::OrcaPrinterAgent, Slic3r::PrinterAgentPluginCapability, and Slic3r::PyPrinterAgentPluginCapabilityTrampoline.

install_device_cert()

virtual void Slic3r::IPrinterAgent::install_device_cert ( std::string dev_id, bool lan_only )

inlinevirtual

Install or refresh device certificate for LAN TLS.

Reimplemented in Slic3r::BBLPrinterAgent, and Slic3r::PyPrinterAgentPluginCapabilityTrampoline.

    {
        (void) dev_id;
        (void) lan_only;
    }

Referenced by Slic3r::PrinterAgentPluginCapability::RegisterBindings().

Here is the caller graph for this function:

ping_bind()

virtual int Slic3r::IPrinterAgent::ping_bind ( std::string ping_code )

inlinevirtual

Ping the binding endpoint to check printer readiness.

Reimplemented in Slic3r::BBLPrinterAgent, and Slic3r::PyPrinterAgentPluginCapabilityTrampoline.

    {
        (void) ping_code;
        return BAMBU_NETWORK_SUCCESS;
    }

References BAMBU_NETWORK_SUCCESS.

Referenced by Slic3r::PrinterAgentPluginCapability::RegisterBindings().

Here is the caller graph for this function:

publish_command_json()

int Slic3r::IPrinterAgent::publish_command_json ( std::string dev_id, const nlohmann::json & j, bool lan_mode )

inlineprivate

    {
        return lan_mode ? send_message_to_printer(dev_id, j.dump(), 0, 0)
                         : send_message(dev_id, j.dump(), 0, 0);
    }

References send_message(), and send_message_to_printer().

Referenced by command_auto_leveling(), command_axis_control(), command_go_home(), command_set_bed(), command_set_nozzle(), and command_xyz_abs().

Here is the call graph for this function:

Here is the caller graph for this function:

request_bind_ticket()

virtual int Slic3r::IPrinterAgent::request_bind_ticket ( std::string * ticket )

inlinevirtual

Request a one-time bind ticket from the server.

Reimplemented in Slic3r::BBLPrinterAgent, and Slic3r::PyPrinterAgentPluginCapabilityTrampoline.

    {
        if (ticket)
            *ticket = {};
        return BAMBU_NETWORK_SUCCESS;
    }

References BAMBU_NETWORK_SUCCESS.

send_message()

virtual int Slic3r::IPrinterAgent::send_message ( std::string dev_id, std::string json_str, int qos, int flag )

pure virtual

Publish a JSON command to a printer through cloud relay.

Implemented in Slic3r::BBLPrinterAgent, Slic3r::MoonrakerPrinterAgent, Slic3r::OrcaPrinterAgent, Slic3r::PrinterAgentPluginCapability, and Slic3r::PyPrinterAgentPluginCapabilityTrampoline.

Referenced by publish_command_json().

Here is the caller graph for this function:

send_message_to_printer()

virtual int Slic3r::IPrinterAgent::send_message_to_printer ( std::string dev_id, std::string json_str, int qos, int flag )

pure virtual

Send a JSON command to a LAN printer (bypassing cloud).

Implemented in Slic3r::BBLPrinterAgent, Slic3r::MoonrakerPrinterAgent, Slic3r::OrcaPrinterAgent, Slic3r::PrinterAgentPluginCapability, and Slic3r::PyPrinterAgentPluginCapabilityTrampoline.

Referenced by publish_command_json().

Here is the caller graph for this function:

set_cloud_agent()

virtual void Slic3r::IPrinterAgent::set_cloud_agent ( std::shared_ptr< ICloudServiceAgent > cloud )

pure virtual

Set the cloud agent used for token access. Must be called before any cloud-relay operations.

Implemented in Slic3r::BBLPrinterAgent, Slic3r::MoonrakerPrinterAgent, Slic3r::OrcaPrinterAgent, and Slic3r::PrinterAgentPluginCapability.

set_on_local_connect_fn()

virtual int Slic3r::IPrinterAgent::set_on_local_connect_fn ( OnLocalConnectedFn fn )

pure virtual

Register LAN connection status callback.

Implemented in Slic3r::BBLPrinterAgent, Slic3r::MoonrakerPrinterAgent, Slic3r::OrcaPrinterAgent, Slic3r::PrinterAgentPluginCapability, and Slic3r::PyPrinterAgentPluginCapabilityTrampoline.

set_on_local_message_fn()

virtual int Slic3r::IPrinterAgent::set_on_local_message_fn ( OnMessageFn fn )

pure virtual

Register LAN message callback.

Implemented in Slic3r::BBLPrinterAgent, Slic3r::MoonrakerPrinterAgent, Slic3r::OrcaPrinterAgent, Slic3r::PrinterAgentPluginCapability, and Slic3r::PyPrinterAgentPluginCapabilityTrampoline.

set_on_message_fn()

virtual int Slic3r::IPrinterAgent::set_on_message_fn ( OnMessageFn fn )

pure virtual

Register cloud device message callback.

Implemented in Slic3r::BBLPrinterAgent, Slic3r::MoonrakerPrinterAgent, Slic3r::OrcaPrinterAgent, Slic3r::PrinterAgentPluginCapability, and Slic3r::PyPrinterAgentPluginCapabilityTrampoline.

set_on_printer_connected_fn()

virtual int Slic3r::IPrinterAgent::set_on_printer_connected_fn ( OnPrinterConnectedFn fn )

pure virtual

Register printer MQTT connection callback.

Implemented in Slic3r::BBLPrinterAgent, Slic3r::MoonrakerPrinterAgent, Slic3r::OrcaPrinterAgent, Slic3r::PrinterAgentPluginCapability, and Slic3r::PyPrinterAgentPluginCapabilityTrampoline.

set_on_ssdp_msg_fn()

virtual int Slic3r::IPrinterAgent::set_on_ssdp_msg_fn ( OnMsgArrivedFn fn )

pure virtual

Register SSDP discovery callback.

Implemented in Slic3r::BBLPrinterAgent, Slic3r::MoonrakerPrinterAgent, Slic3r::OrcaPrinterAgent, Slic3r::PrinterAgentPluginCapability, and Slic3r::PyPrinterAgentPluginCapabilityTrampoline.

set_on_subscribe_failure_fn()

virtual int Slic3r::IPrinterAgent::set_on_subscribe_failure_fn ( GetSubscribeFailureFn fn )

pure virtual

Register subscription failure callback.

Implemented in Slic3r::BBLPrinterAgent, Slic3r::MoonrakerPrinterAgent, Slic3r::OrcaPrinterAgent, Slic3r::PrinterAgentPluginCapability, and Slic3r::PyPrinterAgentPluginCapabilityTrampoline.

set_on_user_message_fn()

virtual int Slic3r::IPrinterAgent::set_on_user_message_fn ( OnMessageFn fn )

pure virtual

Register user-scoped message callback.

Implemented in Slic3r::BBLPrinterAgent, Slic3r::MoonrakerPrinterAgent, Slic3r::OrcaPrinterAgent, Slic3r::PrinterAgentPluginCapability, and Slic3r::PyPrinterAgentPluginCapabilityTrampoline.

set_queue_on_main_fn()

virtual int Slic3r::IPrinterAgent::set_queue_on_main_fn ( QueueOnMainFn fn )

pure virtual

Provide main thread queue callback.

Implemented in Slic3r::BBLPrinterAgent, Slic3r::MoonrakerPrinterAgent, Slic3r::OrcaPrinterAgent, Slic3r::PrinterAgentPluginCapability, and Slic3r::PyPrinterAgentPluginCapabilityTrampoline.

set_server_callback()

virtual int Slic3r::IPrinterAgent::set_server_callback ( OnServerErrFn fn )

pure virtual

Register callback for fatal HTTP errors.

Implemented in Slic3r::BBLPrinterAgent, Slic3r::MoonrakerPrinterAgent, Slic3r::OrcaPrinterAgent, Slic3r::PrinterAgentPluginCapability, and Slic3r::PyPrinterAgentPluginCapabilityTrampoline.

set_user_selected_machine()

virtual int Slic3r::IPrinterAgent::set_user_selected_machine ( std::string dev_id )

pure virtual

Update the selected cloud machine preference.

Implemented in Slic3r::BBLPrinterAgent, Slic3r::MoonrakerPrinterAgent, Slic3r::OrcaPrinterAgent, Slic3r::PrinterAgentPluginCapability, and Slic3r::PyPrinterAgentPluginCapabilityTrampoline.

start_discovery()

virtual bool Slic3r::IPrinterAgent::start_discovery ( bool start, bool sending )

pure virtual

Start or stop SSDP discovery.

Implemented in Slic3r::BBLPrinterAgent, Slic3r::MoonrakerPrinterAgent, Slic3r::OrcaPrinterAgent, Slic3r::PrinterAgentPluginCapability, and Slic3r::PyPrinterAgentPluginCapabilityTrampoline.

start_local_print()

virtual int Slic3r::IPrinterAgent::start_local_print ( PrintParams params, OnUpdateStatusFn update_fn, WasCancelledFn cancel_fn )

pure virtual

Start a LAN-only print.

Implemented in Slic3r::BBLPrinterAgent, Slic3r::MoonrakerPrinterAgent, Slic3r::OrcaPrinterAgent, Slic3r::PrinterAgentPluginCapability, and Slic3r::PyPrinterAgentPluginCapabilityTrampoline.

start_local_print_with_record()

virtual int Slic3r::IPrinterAgent::start_local_print_with_record ( PrintParams params, OnUpdateStatusFn update_fn, WasCancelledFn cancel_fn, OnWaitFn wait_fn )

pure virtual

Start a local print with cloud record.

Implemented in Slic3r::BBLPrinterAgent, Slic3r::MoonrakerPrinterAgent, Slic3r::OrcaPrinterAgent, Slic3r::PrinterAgentPluginCapability, and Slic3r::PyPrinterAgentPluginCapabilityTrampoline.

start_print()

virtual int Slic3r::IPrinterAgent::start_print ( PrintParams params, OnUpdateStatusFn update_fn, WasCancelledFn cancel_fn, OnWaitFn wait_fn )

pure virtual

Start a fully managed cloud print.

Implemented in Slic3r::BBLPrinterAgent, Slic3r::MoonrakerPrinterAgent, Slic3r::OrcaPrinterAgent, Slic3r::PrinterAgentPluginCapability, and Slic3r::PyPrinterAgentPluginCapabilityTrampoline.

start_sdcard_print()

virtual int Slic3r::IPrinterAgent::start_sdcard_print ( PrintParams params, OnUpdateStatusFn update_fn, WasCancelledFn cancel_fn )

pure virtual

Start a print from printer's SD card.

Implemented in Slic3r::BBLPrinterAgent, Slic3r::MoonrakerPrinterAgent, Slic3r::OrcaPrinterAgent, Slic3r::PrinterAgentPluginCapability, and Slic3r::PyPrinterAgentPluginCapabilityTrampoline.

start_send_gcode_to_sdcard()

virtual int Slic3r::IPrinterAgent::start_send_gcode_to_sdcard ( PrintParams params, OnUpdateStatusFn update_fn, WasCancelledFn cancel_fn, OnWaitFn wait_fn )

pure virtual

Upload gcode to printer's SD card without starting.

Implemented in Slic3r::BBLPrinterAgent, Slic3r::MoonrakerPrinterAgent, Slic3r::OrcaPrinterAgent, Slic3r::PrinterAgentPluginCapability, and Slic3r::PyPrinterAgentPluginCapabilityTrampoline.

start_subscribe()

virtual int Slic3r::IPrinterAgent::start_subscribe ( std::string module )

inlinevirtual

Subscribe to a logical module (for example app- or tunnel-scoped streams).

Reimplemented in Slic3r::BBLPrinterAgent.

{ (void) module; return BAMBU_NETWORK_SUCCESS; }

References BAMBU_NETWORK_SUCCESS, and Slic3r::module().

Here is the call graph for this function:

stop_subscribe()

virtual int Slic3r::IPrinterAgent::stop_subscribe ( std::string module )

inlinevirtual

Stop listening to a formerly subscribed module.

Reimplemented in Slic3r::BBLPrinterAgent.

{ (void) module; return BAMBU_NETWORK_SUCCESS; }

References BAMBU_NETWORK_SUCCESS, and Slic3r::module().

Here is the call graph for this function:

to_orca_filament_id()

virtual std::string Slic3r::IPrinterAgent::to_orca_filament_id ( const std::string & printer_filament_id ) const

inlinevirtual

Translate one filament id across the printer boundary.

Orca content-addresses every system filament; a printer, its AMS and its vendor cloud know only that vendor's own catalog ids. An agent whose printers already speak Orca's ids leaves them alone, and so does an id with no mapping.

Reimplemented in Slic3r::BBLPrinterAgent.

{ return printer_filament_id; }

unbind()

virtual int Slic3r::IPrinterAgent::unbind ( std::string dev_id )

inlinevirtual

Remove the association between account and printer.

Reimplemented in Slic3r::BBLPrinterAgent, and Slic3r::PyPrinterAgentPluginCapabilityTrampoline.

    {
        (void) dev_id;
        return BAMBU_NETWORK_SUCCESS;
    }

References BAMBU_NETWORK_SUCCESS.

Referenced by Slic3r::PrinterAgentPluginCapability::RegisterBindings().

Here is the caller graph for this function:

---

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

• /home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/Utils/IPrinterAgent.hpp