Slic3r::BBLPrinterAgent Class Reference

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

Inheritance diagram for Slic3r::BBLPrinterAgent:

Collaboration diagram for Slic3r::BBLPrinterAgent:

Public Member Functions
	BBLPrinterAgent ()
	~BBLPrinterAgent () override
void	set_cloud_agent (std::shared_ptr< ICloudServiceAgent > cloud) override
int	send_message (std::string dev_id, std::string json_str, int qos, int flag) override
int	command_ams_refresh_rfid (std::string dev_id, int ams_id, int slot_id, int sequence_id, bool lan_mode) override
int	command_ams_calibrate (std::string dev_id, int ams_id, int sequence_id, bool lan_mode) override
int	command_ams_select_tray (std::string dev_id, std::string tray_id, int sequence_id, bool lan_mode) override
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) override
std::string	default_lan_username () const override
int	connect_printer (const PrinterConnectionParams &params) override
int	disconnect_printer () override
int	send_message_to_printer (std::string dev_id, std::string json_str, int qos, int flag) override
int	check_cert () override
void	install_device_cert (std::string dev_id, bool lan_only) override
bool	start_discovery (bool start, bool sending) override
int	ping_bind (std::string ping_code) override
int	bind_detect (std::string dev_ip, std::string sec_link, detectResult &detect) override
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) override
int	unbind (std::string dev_id) override
int	request_bind_ticket (std::string *ticket) override
int	get_hms_snapshot (std::string dev_id, std::string file_name, std::function< void(std::string, int)> callback) override
int	set_server_callback (OnServerErrFn fn) override
std::string	get_user_selected_machine () override
int	set_user_selected_machine (std::string dev_id) override
int	start_subscribe (std::string module) override
int	stop_subscribe (std::string module) override
int	add_subscribe (std::vector< std::string > dev_list) override
int	del_subscribe (std::vector< std::string > dev_list) override
AgentInfo	get_agent_info () override
int	start_print (PrintParams params, OnUpdateStatusFn update_fn, WasCancelledFn cancel_fn, OnWaitFn wait_fn) override
int	start_local_print_with_record (PrintParams params, OnUpdateStatusFn update_fn, WasCancelledFn cancel_fn, OnWaitFn wait_fn) override
int	start_send_gcode_to_sdcard (PrintParams params, OnUpdateStatusFn update_fn, WasCancelledFn cancel_fn, OnWaitFn wait_fn) override
int	start_local_print (PrintParams params, OnUpdateStatusFn update_fn, WasCancelledFn cancel_fn) override
int	start_sdcard_print (PrintParams params, OnUpdateStatusFn update_fn, WasCancelledFn cancel_fn) override
int	set_on_ssdp_msg_fn (OnMsgArrivedFn fn) override
int	set_on_printer_connected_fn (OnPrinterConnectedFn fn) override
int	set_on_subscribe_failure_fn (GetSubscribeFailureFn fn) override
int	set_on_message_fn (OnMessageFn fn) override
int	set_on_user_message_fn (OnMessageFn fn) override
int	set_on_local_connect_fn (OnLocalConnectedFn fn) override
int	set_on_local_message_fn (OnMessageFn fn) override
int	set_queue_on_main_fn (QueueOnMainFn fn) override
FilamentSyncMode	get_filament_sync_mode () const override
std::string	to_orca_filament_id (const std::string &printer_filament_id) const override
std::string	from_orca_filament_id (const std::string &orca_filament_id) const override
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 CameraStreamMode	get_camera_stream_mode () const
virtual bool	fetch_filament_info (std::string dev_id, FilamentSyncMode sync_mode=FilamentSyncMode::pull)
virtual std::string	get_camera_url () const

Static Public Member Functions
static AgentInfo	get_agent_info_static ()
static std::string	bambu_filament_id (const std::string &orca_filament_id)
static std::string	to_orca_payload (std::string json_text)
static std::string	from_orca_payload (std::string json_text)

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

Detailed Description

BBLPrinterAgent - BBL DLL wrapper implementation of IPrinterAgent.

Delegates all printer operations to the proprietary BBL network DLL through function pointers obtained from BBLNetworkPlugin singleton.

Constructor & Destructor Documentation

BBLPrinterAgent()

Slic3r::BBLPrinterAgent::BBLPrinterAgent ( )

default

~BBLPrinterAgent()

Slic3r::BBLPrinterAgent::~BBLPrinterAgent ( )

overridedefault

Member Function Documentation

add_subscribe()

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

overridevirtual

Subscribe to push streams for specific device identifiers.

Reimplemented from Slic3r::IPrinterAgent.

{
    auto& plugin = BBLNetworkPlugin::instance();
    auto agent = plugin.get_agent();
    auto func = plugin.get_add_subscribe();
    if (func && agent) {
        return func(agent, dev_list);
    }
    return -1;
}

References Slic3r::BBLNetworkPlugin::instance().

Here is the call graph for this function:

bambu_filament_id()

std::string Slic3r::BBLPrinterAgent::bambu_filament_id ( const std::string & orca_filament_id )

static

{
    const auto& map = bambu_filament_id_map().to_bambu;
    auto it = map.find(orca_filament_id);
    return it != map.end() ? it->second : orca_filament_id;
}

References Slic3r::anonymous_namespace{BBLPrinterAgent.cpp}::BambuFilamentIdMap::to_bambu.

Referenced by from_orca_filament_id(), and Slic3r::FilamentColorCodeQuery::GetFilaInfoMap().

Here is the caller graph for this function:

bind()

int Slic3r::BBLPrinterAgent::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 )

overridevirtual

Execute the multi-stage printer binding workflow.

Reimplemented from Slic3r::IPrinterAgent.

{
    auto& plugin = BBLNetworkPlugin::instance();
    auto agent = plugin.get_agent();
    auto func = plugin.get_bind();
    if (func && agent) {
        // dev_model was added in 02.08.01. Passing it to a plug-in that takes the 7-argument
        // form shifts every following argument, so the older generations get the older call.
        switch (plugin.network_abi()) {
        case NetworkAbi::Legacy:
        case NetworkAbi::V0203: {
            auto older_func = as_abi<func_bind_pre0208>(func);
            return older_func(agent, dev_ip, dev_id, sec_link, timezone, improved, update_fn);
        }
        case NetworkAbi::Current:
            return func(agent, dev_ip, dev_id, dev_model, sec_link, timezone, improved, update_fn);
        default:
            return -1;
        }
    }
    return -1;
}

References Slic3r::Current, Slic3r::BBLNetworkPlugin::instance(), Slic3r::Legacy, and Slic3r::V0203.

Here is the call graph for this function:

bind_detect()

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

overridevirtual

Perform binding detection/handshake on a LAN printer.

Implements Slic3r::IPrinterAgent.

{
    auto& plugin = BBLNetworkPlugin::instance();
    auto agent = plugin.get_agent();
    auto func = plugin.get_bind_detect();
    if (func && agent) {
        return func(agent, dev_ip, sec_link, detect);
    }
    return -1;
}

References Slic3r::BBLNetworkPlugin::instance().

Here is the call graph for this function:

check_cert()

int Slic3r::BBLPrinterAgent::check_cert ( )

overridevirtual

Validate current user certificates for the printer.

Reimplemented from Slic3r::IPrinterAgent.

{
    auto& plugin = BBLNetworkPlugin::instance();
    auto agent = plugin.get_agent();
    auto func = plugin.get_check_cert();
    if (func && agent) {
        return func(agent);
    }
    return -1;
}

References Slic3r::BBLNetworkPlugin::instance().

Here is the call graph for this function:

command_ams_calibrate()

int Slic3r::BBLPrinterAgent::command_ams_calibrate ( std::string dev_id, int ams_id, int sequence_id, bool lan_mode )

overridevirtual

Reimplemented from Slic3r::IPrinterAgent.

{
    const std::string gcode = (boost::format("M620 C%1% \n") % ams_id).str();
    nlohmann::json j;
    j["print"]["command"] = "gcode_line";
    j["print"]["param"] = gcode;
    j["print"]["sequence_id"] = std::to_string(sequence_id);
    return publish(dev_id, j, lan_mode);
}

References publish().

Here is the call graph for this function:

command_ams_refresh_rfid()

int Slic3r::BBLPrinterAgent::command_ams_refresh_rfid ( std::string dev_id, int ams_id, int slot_id, int sequence_id, bool lan_mode )

overridevirtual

Reimplemented from Slic3r::IPrinterAgent.

{
    nlohmann::json j;
    if (ams_id == -1) {
        const std::string gcode   = (boost::format("M620 R%1% \n") % slot_id).str();
        j["print"]["command"]     = "gcode_line";
        j["print"]["param"]       = gcode;
        j["print"]["sequence_id"] = std::to_string(sequence_id);
        return publish(dev_id, j, lan_mode);
    }
 
    j["print"]["command"]     = "ams_get_rfid";
    j["print"]["sequence_id"] = std::to_string(MachineObject::m_sequence_id++);
    j["print"]["ams_id"]      = ams_id;
    j["print"]["slot_id"]     = slot_id;
    return publish(dev_id, j, lan_mode);
}

References Slic3r::MachineObject::m_sequence_id, and publish().

Here is the call graph for this function:

command_ams_select_tray()

int Slic3r::BBLPrinterAgent::command_ams_select_tray ( std::string dev_id, std::string tray_id, int sequence_id, bool lan_mode )

overridevirtual

Reimplemented from Slic3r::IPrinterAgent.

{
    const std::string gcode = (boost::format("M620 P%1% \n") % tray_id).str();
    nlohmann::json j;
    j["print"]["command"] = "gcode_line";
    j["print"]["param"] = gcode;
    j["print"]["sequence_id"] = std::to_string(sequence_id);
    return publish(dev_id, j, lan_mode);
}

References publish().

Here is the call graph for this function:

command_auto_leveling()

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

inlinevirtualinherited

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

int Slic3r::BBLPrinterAgent::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 )

overridevirtual

Reimplemented from Slic3r::IPrinterAgent.

{
    nlohmann::json j;
    j["print"]["sequence_id"] = std::to_string(sequence_id);
 
    if (supports_mqtt_axis_control) {
        int dir = input_val > 0 ? 1 : -1;
        // i3-arch printers move the bed for Y/Z, so the on-screen direction is
        // reversed -- same negation the g-code fallback below applies.
        if (!is_core_xy && (axis == "Y" || axis == "Z"))
            dir = -dir;
 
        j["print"]["command"] = "xyz_ctrl";
        j["print"]["axis"] = axis;
        j["print"]["dir"] = dir;
        j["print"]["mode"] = (std::abs(input_val) >= 10) ? 1 : 0;
        return publish(dev_id, j, lan_mode);
    }
 
    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("M211 S \nM211 X1 Y1 Z1\nM1002 push_ref_mode\nG91 \nG1 %1%%2% F%3%\nM1002 pop_ref_mode\nM211 R\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;
    }
 
    j["print"]["command"] = "gcode_line";
    j["print"]["param"] = gcode;
    return publish(dev_id, j, lan_mode);
}

References publish().

Here is the call 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 )

inlinevirtualinherited

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 )

inlinevirtualinherited

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 )

inlinevirtualinherited

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 )

inlinevirtualinherited

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 )

inlinevirtualinherited

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

int Slic3r::BBLPrinterAgent::connect_printer ( const PrinterConnectionParams & params )

overridevirtual

Establish a direct LAN connection to a printer.

Implements Slic3r::IPrinterAgent.

{
    auto& plugin = BBLNetworkPlugin::instance();
    auto agent = plugin.get_agent();
    auto func = plugin.get_connect_printer();
#if !BBL_RELEASE_TO_PUBLIC
    const bool use_ssl_for_mqtt = GUI::wxGetApp().app_config &&
                                  GUI::wxGetApp().app_config->get_bool("enable_ssl_for_mqtt");
#else
    bool use_ssl_for_mqtt = true;
    if (auto* dev_manager = GUI::wxGetApp().getDeviceManager()) {
        if (auto* machine = dev_manager->get_my_machine(params.dev_id))
            use_ssl_for_mqtt = machine->local_use_ssl;
    }
#endif
    if (func && agent) {
        return func(agent, params.dev_id, params.host, params.username, params.password, use_ssl_for_mqtt);
    }
    return -1;
}

References Slic3r::PrinterConnectionParams::dev_id, Slic3r::PrinterConnectionParams::host, Slic3r::BBLNetworkPlugin::instance(), Slic3r::PrinterConnectionParams::password, and Slic3r::PrinterConnectionParams::username.

Here is the call graph for this function:

default_lan_username()

std::string Slic3r::BBLPrinterAgent::default_lan_username ( ) const

inlineoverridevirtual

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 from Slic3r::IPrinterAgent.

{ return "bblp"; }

del_subscribe()

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

overridevirtual

Remove device-level subscriptions.

Reimplemented from Slic3r::IPrinterAgent.

{
    auto& plugin = BBLNetworkPlugin::instance();
    auto agent = plugin.get_agent();
    auto func = plugin.get_del_subscribe();
    if (func && agent) {
        return func(agent, dev_list);
    }
    return -1;
}

References Slic3r::BBLNetworkPlugin::instance().

Here is the call graph for this function:

disconnect_printer()

int Slic3r::BBLPrinterAgent::disconnect_printer ( )

overridevirtual

Tear down the active LAN printer connection.

Implements Slic3r::IPrinterAgent.

{
    auto& plugin = BBLNetworkPlugin::instance();
    auto agent = plugin.get_agent();
    auto func = plugin.get_disconnect_printer();
    if (func && agent) {
        return func(agent);
    }
    return -1;
}

References Slic3r::BBLNetworkPlugin::instance().

Here is the call graph for this function:

fetch_filament_info()

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

inlinevirtualinherited

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

std::string Slic3r::BBLPrinterAgent::from_orca_filament_id ( const std::string & orca_filament_id ) const

overridevirtual

Reimplemented from Slic3r::IPrinterAgent.

{
    return bambu_filament_id(orca_filament_id);
}

References bambu_filament_id().

Referenced by Slic3r::CLI::run().

Here is the call graph for this function:

Here is the caller graph for this function:

from_orca_payload()

std::string Slic3r::BBLPrinterAgent::from_orca_payload ( std::string json_text )

static

{
    return rewrite_filament_ids(std::move(json_text), bambu_filament_id_map().to_bambu);
}

Referenced by Slic3r::anonymous_namespace{BBLPrinterAgent.cpp}::dispatch_start(), send_message(), and send_message_to_printer().

Here is the caller graph for this function:

get_agent_info()

AgentInfo Slic3r::BBLPrinterAgent::get_agent_info ( )

inlineoverridevirtual

Get agent information.

Implements Slic3r::IPrinterAgent.

{ return get_agent_info_static(); }

References get_agent_info_static().

Here is the call graph for this function:

get_agent_info_static()

AgentInfo Slic3r::BBLPrinterAgent::get_agent_info_static ( )

static

Get agent information.

Returns

AgentInfo struct containing agent identification and descriptive information

{
    return AgentInfo{BBL_PRINTER_AGENT_ID, "Bambu Lab", "", "Bambu Lab printer agent"};
}

References Slic3r::BBL_PRINTER_AGENT_ID.

Referenced by get_agent_info(), and Slic3r::NetworkAgentFactory::register_all_agents().

Here is the caller graph for this function:

get_camera_stream_mode()

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

inlinevirtualinherited

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

inlinevirtualinherited

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

FilamentSyncMode Slic3r::BBLPrinterAgent::get_filament_sync_mode ( ) const

overridevirtual

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 from Slic3r::IPrinterAgent.

{
    // BBL uses MQTT subscription for real-time filament updates
    return FilamentSyncMode::subscription;
}

References Slic3r::subscription.

get_hms_snapshot()

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

overridevirtual

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 from Slic3r::IPrinterAgent.

{
    auto& plugin = BBLNetworkPlugin::instance();
    auto agent = plugin.get_agent();
    auto func = plugin.get_get_hms_snapshot();
    // dev_id/file_name are passed as lvalues to bind the plugin's std::string& params.
    // A null func (older plugin without this symbol) falls through to -1 so callers degrade gracefully.
    if (func && agent) {
        return func(agent, dev_id, file_name, callback);
    }
    return -1;
}

References Slic3r::BBLNetworkPlugin::instance().

Here is the call graph for this function:

get_user_selected_machine()

std::string Slic3r::BBLPrinterAgent::get_user_selected_machine ( )

overridevirtual

Return the currently selected printer ID.

Implements Slic3r::IPrinterAgent.

{
    auto& plugin = BBLNetworkPlugin::instance();
    auto agent = plugin.get_agent();
    auto func = plugin.get_get_user_selected_machine();
    if (func && agent) {
        return func(agent);
    }
    return "";
}

References Slic3r::BBLNetworkPlugin::instance().

Here is the call graph for this function:

install_device_cert()

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

overridevirtual

Install or refresh device certificate for LAN TLS.

Reimplemented from Slic3r::IPrinterAgent.

{
    auto& plugin = BBLNetworkPlugin::instance();
    auto agent = plugin.get_agent();
    auto func = plugin.get_install_device_cert();
    if (func && agent) {
        func(agent, dev_id, lan_only);
    }
}

References Slic3r::BBLNetworkPlugin::instance().

Here is the call graph for this function:

ping_bind()

int Slic3r::BBLPrinterAgent::ping_bind ( std::string ping_code )

overridevirtual

Ping the binding endpoint to check printer readiness.

Reimplemented from Slic3r::IPrinterAgent.

{
    auto& plugin = BBLNetworkPlugin::instance();
    auto agent = plugin.get_agent();
    auto func = plugin.get_ping_bind();
    if (func && agent) {
        return func(agent, ping_code);
    }
    return -1;
}

References Slic3r::BBLNetworkPlugin::instance().

Here is the call graph for this function:

publish()

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

private

{
    const int rtn = lan_mode ? send_message_to_printer(dev_id, j.dump(), 0, 0) : send_message(dev_id, j.dump(), 0, 0);
    if (rtn == 0)
        BOOST_LOG_TRIVIAL(info) << "publish_json: " << j.dump() << " code: " << rtn;
    else
        BOOST_LOG_TRIVIAL(error) << "publish_json: " << j.dump() << " code: " << rtn;
    return rtn;
}

References send_message(), and send_message_to_printer().

Referenced by command_ams_calibrate(), command_ams_refresh_rfid(), command_ams_select_tray(), and command_axis_control().

Here is the call graph for this function:

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 )

inlineprivateinherited

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

int Slic3r::BBLPrinterAgent::request_bind_ticket ( std::string * ticket )

overridevirtual

Request a one-time bind ticket from the server.

Reimplemented from Slic3r::IPrinterAgent.

{
    auto& plugin = BBLNetworkPlugin::instance();
    auto agent = plugin.get_agent();
    auto func = plugin.get_request_bind_ticket();
    if (func && agent) {
        return func(agent, ticket);
    }
    return -1;
}

References Slic3r::BBLNetworkPlugin::instance().

Here is the call graph for this function:

send_message()

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

overridevirtual

Publish a JSON command to a printer through cloud relay.

Implements Slic3r::IPrinterAgent.

{
    json_str = from_orca_payload(std::move(json_str));
    auto& plugin = BBLNetworkPlugin::instance();
    auto agent = plugin.get_agent();
    auto func = plugin.get_send_message();
    if (func && agent) {
        // Only the legacy plug-in lacks `flag`; 02.03.00 already takes it, and routing that
        // series through the legacy form would silently drop MessageFlag sign/encrypt.
        switch (plugin.network_abi()) {
        case NetworkAbi::Legacy: {
            auto legacy_func = as_abi<func_send_message_legacy>(func);
            return legacy_func(agent, std::move(dev_id), std::move(json_str), qos);
        }
        case NetworkAbi::V0203:
        case NetworkAbi::Current:
            return func(agent, std::move(dev_id), std::move(json_str), qos, flag);
        default:
            return -1;
        }
    }
    return -1;
}

References Slic3r::Current, from_orca_payload(), Slic3r::BBLNetworkPlugin::instance(), Slic3r::Legacy, and Slic3r::V0203.

Referenced by publish().

Here is the call graph for this function:

Here is the caller graph for this function:

send_message_to_printer()

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

overridevirtual

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

Implements Slic3r::IPrinterAgent.

{
    json_str = from_orca_payload(std::move(json_str));
    auto& plugin = BBLNetworkPlugin::instance();
    auto agent = plugin.get_agent();
    auto func = plugin.get_send_message_to_printer();
    if (func && agent) {
        switch (plugin.network_abi()) {
        case NetworkAbi::Legacy: {
            auto legacy_func = as_abi<func_send_message_to_printer_legacy>(func);
            return legacy_func(agent, std::move(dev_id), std::move(json_str), qos);
        }
        case NetworkAbi::V0203:
        case NetworkAbi::Current:
            return func(agent, std::move(dev_id), std::move(json_str), qos, flag);
        default:
            return -1;
        }
    }
    return -1;
}

References Slic3r::Current, from_orca_payload(), Slic3r::BBLNetworkPlugin::instance(), Slic3r::Legacy, and Slic3r::V0203.

Referenced by publish().

Here is the call graph for this function:

Here is the caller graph for this function:

set_cloud_agent()

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

overridevirtual

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

Implements Slic3r::IPrinterAgent.

{
    (void) cloud;
    // BBL DLL manages tokens internally, so this is just for interface compliance
}

set_on_local_connect_fn()

int Slic3r::BBLPrinterAgent::set_on_local_connect_fn ( OnLocalConnectedFn fn )

overridevirtual

Register LAN connection status callback.

Implements Slic3r::IPrinterAgent.

{
    auto& plugin = BBLNetworkPlugin::instance();
    auto agent = plugin.get_agent();
    auto func = plugin.get_set_on_local_connect_fn();
    if (func && agent) {
        return func(agent, fn);
    }
    return -1;
}

References Slic3r::BBLNetworkPlugin::instance().

Here is the call graph for this function:

set_on_local_message_fn()

int Slic3r::BBLPrinterAgent::set_on_local_message_fn ( OnMessageFn fn )

overridevirtual

Register LAN message callback.

Implements Slic3r::IPrinterAgent.

{
    auto& plugin = BBLNetworkPlugin::instance();
    auto agent = plugin.get_agent();
    auto func = plugin.get_set_on_local_message_fn();
    if (func && agent) {
        return func(agent, to_orca_messages(std::move(fn)));
    }
    return -1;
}

References Slic3r::BBLNetworkPlugin::instance().

Here is the call graph for this function:

set_on_message_fn()

int Slic3r::BBLPrinterAgent::set_on_message_fn ( OnMessageFn fn )

overridevirtual

Register cloud device message callback.

Implements Slic3r::IPrinterAgent.

{
    auto& plugin = BBLNetworkPlugin::instance();
    auto agent = plugin.get_agent();
    auto func = plugin.get_set_on_message_fn();
    if (func && agent) {
        return func(agent, to_orca_messages(std::move(fn)));
    }
    return -1;
}

References Slic3r::BBLNetworkPlugin::instance().

Here is the call graph for this function:

set_on_printer_connected_fn()

int Slic3r::BBLPrinterAgent::set_on_printer_connected_fn ( OnPrinterConnectedFn fn )

overridevirtual

Register printer MQTT connection callback.

Implements Slic3r::IPrinterAgent.

{
    auto& plugin = BBLNetworkPlugin::instance();
    auto agent = plugin.get_agent();
    auto func = plugin.get_set_on_printer_connected_fn();
    if (func && agent) {
        return func(agent, fn);
    }
    return -1;
}

References Slic3r::BBLNetworkPlugin::instance().

Here is the call graph for this function:

set_on_ssdp_msg_fn()

int Slic3r::BBLPrinterAgent::set_on_ssdp_msg_fn ( OnMsgArrivedFn fn )

overridevirtual

Register SSDP discovery callback.

Implements Slic3r::IPrinterAgent.

{
    auto& plugin = BBLNetworkPlugin::instance();
    auto agent = plugin.get_agent();
    auto func = plugin.get_set_on_ssdp_msg_fn();
    if (func && agent) {
        return func(agent, fn);
    }
    return -1;
}

References Slic3r::BBLNetworkPlugin::instance().

Here is the call graph for this function:

set_on_subscribe_failure_fn()

int Slic3r::BBLPrinterAgent::set_on_subscribe_failure_fn ( GetSubscribeFailureFn fn )

overridevirtual

Register subscription failure callback.

Implements Slic3r::IPrinterAgent.

{
    auto& plugin = BBLNetworkPlugin::instance();
    auto agent = plugin.get_agent();
    auto func = plugin.get_set_on_subscribe_failure_fn();
    if (func && agent) {
        return func(agent, fn);
    }
    return -1;
}

References Slic3r::BBLNetworkPlugin::instance().

Here is the call graph for this function:

set_on_user_message_fn()

int Slic3r::BBLPrinterAgent::set_on_user_message_fn ( OnMessageFn fn )

overridevirtual

Register user-scoped message callback.

Implements Slic3r::IPrinterAgent.

{
    auto& plugin = BBLNetworkPlugin::instance();
    auto agent = plugin.get_agent();
    auto func = plugin.get_set_on_user_message_fn();
    if (func && agent) {
        return func(agent, fn);
    }
    return -1;
}

References Slic3r::BBLNetworkPlugin::instance().

Here is the call graph for this function:

set_queue_on_main_fn()

int Slic3r::BBLPrinterAgent::set_queue_on_main_fn ( QueueOnMainFn fn )

overridevirtual

Provide main thread queue callback.

Implements Slic3r::IPrinterAgent.

{
    auto& plugin = BBLNetworkPlugin::instance();
    auto agent = plugin.get_agent();
    auto func = plugin.get_set_queue_on_main_fn();
    if (func && agent) {
        return func(agent, fn);
    }
    return -1;
}

References Slic3r::BBLNetworkPlugin::instance().

Here is the call graph for this function:

set_server_callback()

int Slic3r::BBLPrinterAgent::set_server_callback ( OnServerErrFn fn )

overridevirtual

Register callback for fatal HTTP errors.

Implements Slic3r::IPrinterAgent.

{
    auto& plugin = BBLNetworkPlugin::instance();
    auto agent = plugin.get_agent();
    auto func = plugin.get_set_server_callback();
    if (func && agent) {
        return func(agent, fn);
    }
    return -1;
}

References Slic3r::BBLNetworkPlugin::instance().

Here is the call graph for this function:

set_user_selected_machine()

int Slic3r::BBLPrinterAgent::set_user_selected_machine ( std::string dev_id )

overridevirtual

Update the selected cloud machine preference.

Implements Slic3r::IPrinterAgent.

{
    auto& plugin = BBLNetworkPlugin::instance();
    auto agent = plugin.get_agent();
    auto func = plugin.get_set_user_selected_machine();
    if (func && agent) {
        return func(agent, dev_id);
    }
    return -1;
}

References Slic3r::BBLNetworkPlugin::instance().

Here is the call graph for this function:

start_discovery()

bool Slic3r::BBLPrinterAgent::start_discovery ( bool start, bool sending )

overridevirtual

Start or stop SSDP discovery.

Implements Slic3r::IPrinterAgent.

{
    auto& plugin = BBLNetworkPlugin::instance();
    auto agent = plugin.get_agent();
    auto func = plugin.get_start_discovery();
    if (func && agent) {
        return func(agent, start, sending);
    }
    return false;
}

References Slic3r::BBLNetworkPlugin::instance().

Here is the call graph for this function:

start_local_print()

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

overridevirtual

Start a LAN-only print.

Implements Slic3r::IPrinterAgent.

{
    return dispatch_start<func_start_local_print_legacy, func_start_local_print_0203>(
        BBLNetworkPlugin::instance().get_start_local_print(), params, update_fn, cancel_fn);
}

References Slic3r::BBLNetworkPlugin::instance().

Here is the call graph for this function:

start_local_print_with_record()

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

overridevirtual

Start a local print with cloud record.

Implements Slic3r::IPrinterAgent.

{
    return dispatch_start<func_start_local_print_with_record_legacy, func_start_local_print_with_record_0203>(
        BBLNetworkPlugin::instance().get_start_local_print_with_record(), params, update_fn, cancel_fn, wait_fn);
}

References Slic3r::BBLNetworkPlugin::instance().

Here is the call graph for this function:

start_print()

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

overridevirtual

Start a fully managed cloud print.

Implements Slic3r::IPrinterAgent.

{
    return dispatch_start<func_start_print_legacy, func_start_print_0203>(
        BBLNetworkPlugin::instance().get_start_print(), params, update_fn, cancel_fn, wait_fn);
}

References Slic3r::BBLNetworkPlugin::instance().

Here is the call graph for this function:

start_sdcard_print()

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

overridevirtual

Start a print from printer's SD card.

Implements Slic3r::IPrinterAgent.

{
    return dispatch_start<func_start_sdcard_print_legacy, func_start_sdcard_print_0203>(
        BBLNetworkPlugin::instance().get_start_sdcard_print(), params, update_fn, cancel_fn);
}

References Slic3r::BBLNetworkPlugin::instance().

Here is the call graph for this function:

start_send_gcode_to_sdcard()

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

overridevirtual

Upload gcode to printer's SD card without starting.

Implements Slic3r::IPrinterAgent.

{
    return dispatch_start<func_start_send_gcode_to_sdcard_legacy, func_start_send_gcode_to_sdcard_0203>(
        BBLNetworkPlugin::instance().get_start_send_gcode_to_sdcard(), params, update_fn, cancel_fn, wait_fn);
}

References Slic3r::BBLNetworkPlugin::instance().

Here is the call graph for this function:

start_subscribe()

int Slic3r::BBLPrinterAgent::start_subscribe ( std::string module )

overridevirtual

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

Reimplemented from Slic3r::IPrinterAgent.

{
    auto& plugin = BBLNetworkPlugin::instance();
    auto agent = plugin.get_agent();
    auto func = plugin.get_start_subscribe();
    if (func && agent) {
        return func(agent, module);
    }
    return -1;
}

References Slic3r::BBLNetworkPlugin::instance(), and Slic3r::module().

Here is the call graph for this function:

stop_subscribe()

int Slic3r::BBLPrinterAgent::stop_subscribe ( std::string module )

overridevirtual

Stop listening to a formerly subscribed module.

Reimplemented from Slic3r::IPrinterAgent.

{
    auto& plugin = BBLNetworkPlugin::instance();
    auto agent = plugin.get_agent();
    auto func = plugin.get_stop_subscribe();
    if (func && agent) {
        return func(agent, module);
    }
    return -1;
}

References Slic3r::BBLNetworkPlugin::instance(), and Slic3r::module().

Here is the call graph for this function:

to_orca_filament_id()

std::string Slic3r::BBLPrinterAgent::to_orca_filament_id ( const std::string & printer_filament_id ) const

overridevirtual

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 from Slic3r::IPrinterAgent.

{
    const auto& map = bambu_filament_id_map().to_orca;
    auto it = map.find(printer_filament_id);
    return it != map.end() ? it->second : printer_filament_id;
}

References Slic3r::anonymous_namespace{BBLPrinterAgent.cpp}::BambuFilamentIdMap::to_orca.

to_orca_payload()

std::string Slic3r::BBLPrinterAgent::to_orca_payload ( std::string json_text )

static

{
    return rewrite_filament_ids(std::move(json_text), bambu_filament_id_map().to_orca);
}

Referenced by Slic3r::anonymous_namespace{BBLPrinterAgent.cpp}::to_orca_messages().

Here is the caller graph for this function:

unbind()

int Slic3r::BBLPrinterAgent::unbind ( std::string dev_id )

overridevirtual

Remove the association between account and printer.

Reimplemented from Slic3r::IPrinterAgent.

{
    auto& plugin = BBLNetworkPlugin::instance();
    auto agent = plugin.get_agent();
    auto func = plugin.get_unbind();
    if (func && agent) {
        return func(agent, dev_id);
    }
    return -1;
}

References Slic3r::BBLNetworkPlugin::instance().

Here is the call graph for this function:

---

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

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