Slic3r::PyPrinterAgentPluginCapabilityTrampoline Class Reference

#include </home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/plugin/pluginTypes/printerAgent/PrinterAgentPluginCapabilityTrampoline.hpp>

Inheritance diagram for Slic3r::PyPrinterAgentPluginCapabilityTrampoline:

Collaboration diagram for Slic3r::PyPrinterAgentPluginCapabilityTrampoline:

Classes
struct	ShutdownDisconnect

Public Member Functions
AgentInfo	get_agent_info () override
int	connect_printer (const PrinterConnectionParams &params) override
int	disconnect_printer () override
int	send_message (std::string dev_id, std::string json_str, int qos, int flag) override
int	send_message_to_printer (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_start_camera (std::string dev_id) override
int	command_xyz_abs (std::string dev_id, int sequence_id, bool lan_mode) override
int	command_auto_leveling (std::string dev_id, int sequence_id, bool lan_mode) override
int	command_go_home (std::string dev_id, bool is_printing, bool supports_mqtt_homing, int sequence_id, bool lan_mode) override
int	command_set_bed (std::string dev_id, int temp, bool supports_mqtt_bed_ctrl, int sequence_id, bool lan_mode) override
int	command_set_nozzle (std::string dev_id, int temp, 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
bool	start_discovery (bool start, bool sending) override
int	bind_detect (std::string dev_ip, std::string sec_link, detectResult &detect) override
std::string	get_user_selected_machine () override
int	set_user_selected_machine (std::string dev_id) 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
FilamentSyncMode	get_filament_sync_mode () const override
CameraStreamMode	get_camera_stream_mode () const override
std::string	get_camera_url () const override
bool	fetch_filament_info (std::string dev_id, FilamentSyncMode sync_mode) override
int	check_cert () override
void	install_device_cert (std::string dev_id, bool lan_only) override
int	ping_bind (std::string ping_code) 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	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_sdcard_print (PrintParams params, OnUpdateStatusFn update_fn, WasCancelledFn cancel_fn) 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
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
int	request_bind_ticket (std::string *ticket) override
std::string	get_name () const override
bool	has_config_ui () const override
std::string	get_config_ui () const override
nlohmann::json	get_default_config () const override
void	on_load () override
void	on_unload () override
void	on_cancelled () override
void	on_lifecycle_event (LifecycleEvent event, const LifecycleEventContext &ctx) override
PluginCapabilityType	get_type () const override
void	set_cloud_agent (std::shared_ptr< ICloudServiceAgent > cloud) final override
const std::string &	name () const
PluginCapabilityType	type () const
PluginCapabilityId	identity () const
void	set_resolved_identity (std::string name, PluginCapabilityType type)
bool	is_enabled () const
void	set_enabled (bool enabled)
bool	config_ui_available () const
void	set_config_ui_available (bool available)
void	set_audit_plugin_key (std::string key)
const std::string &	audit_plugin_key () const
void	increment () const
void	decrement () const
int	ref_count () const
virtual std::string	default_lan_username () const
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 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

Static Public Member Functions
static void	RegisterBindings (pybind11::module_ &module)

Private Member Functions
int	python_disconnect_printer ()
int	disconnect_printer_at_shutdown ()
void	log_failure (const char *operation, const char *error) const
int	publish_command_json (std::string dev_id, const nlohmann::json &j, bool lan_mode)

Static Private Member Functions
static void	run_shutdown_disconnect (PyPrinterAgentPluginCapabilityTrampoline *agent, ShutdownDisconnect &call)

Private Attributes
std::mutex	m_shutdown_disconnect_mutex
std::shared_ptr< ShutdownDisconnect >	m_shutdown_disconnect
std::string	m_name
PluginCapabilityType	m_type = PluginCapabilityType::Unknown
std::atomic< bool >	m_enabled {true}
bool	m_config_ui_available = false
std::string	m_audit_plugin_key
std::atomic< int >	m_refs {0}

Detailed Description

Member Function Documentation

add_subscribe()

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

inlinevirtualinherited

Subscribe to push streams for specific device identifiers.

Reimplemented in Slic3r::BBLPrinterAgent.

{ (void) dev_list; return BAMBU_NETWORK_SUCCESS; }

References BAMBU_NETWORK_SUCCESS.

audit_plugin_key()

const std::string & Slic3r::PluginCapabilityInterface::audit_plugin_key ( ) const

inlineinherited

{ return m_audit_plugin_key; }

References m_audit_plugin_key.

Referenced by Slic3r::PyPrinterAgentPluginCapabilityTrampoline::log_failure().

Here is the caller graph for this function:

bind()

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

inlineoverridevirtual

Execute the multi-stage printer binding workflow.

Reimplemented from Slic3r::IPrinterAgent.

    {
        ORCA_PY_AGENT_OVERRIDE(int, bind, dev_ip, dev_id, dev_model, sec_link, timezone, improved, update_fn);
    }

References bind(), and ORCA_PY_AGENT_OVERRIDE.

Referenced by bind().

Here is the call graph for this function:

Here is the caller graph for this function:

bind_detect()

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

inlineoverridevirtual

Perform binding detection/handshake on a LAN printer.

Implements Slic3r::PrinterAgentPluginCapability.

    {
        // Passed as a pointer: pybind11 copies a reference argument, so the plugin's writes would be lost.
        ORCA_PY_AGENT_OVERRIDE(int, bind_detect, dev_ip, sec_link, &detect);
    }

References bind_detect(), and ORCA_PY_AGENT_OVERRIDE.

Referenced by bind_detect().

Here is the call graph for this function:

Here is the caller graph for this function:

check_cert()

int Slic3r::PyPrinterAgentPluginCapabilityTrampoline::check_cert ( )

inlineoverridevirtual

Validate current user certificates for the printer.

Reimplemented from Slic3r::IPrinterAgent.

    {
        ORCA_PY_AGENT_OVERRIDE(int, check_cert);
    }

References check_cert(), and ORCA_PY_AGENT_OVERRIDE.

Referenced by check_cert().

Here is the call graph for this function:

Here is the caller graph for this function:

command_ams_calibrate()

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

inlineoverridevirtual

Reimplemented from Slic3r::IPrinterAgent.

    {
        ORCA_PY_AGENT_OVERRIDE_DEFAULT(int, command_ams_calibrate, dev_id, ams_id, sequence_id, lan_mode);
    }

References command_ams_calibrate(), and ORCA_PY_AGENT_OVERRIDE_DEFAULT.

Referenced by command_ams_calibrate().

Here is the call graph for this function:

Here is the caller graph for this function:

command_ams_refresh_rfid()

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

inlineoverridevirtual

Reimplemented from Slic3r::IPrinterAgent.

    {
        ORCA_PY_AGENT_OVERRIDE_DEFAULT(int, command_ams_refresh_rfid, dev_id, ams_id, slot_id, sequence_id, lan_mode);
    }

References command_ams_refresh_rfid(), and ORCA_PY_AGENT_OVERRIDE_DEFAULT.

Referenced by command_ams_refresh_rfid().

Here is the call graph for this function:

Here is the caller graph for this function:

command_ams_select_tray()

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

inlineoverridevirtual

Reimplemented from Slic3r::IPrinterAgent.

    {
        ORCA_PY_AGENT_OVERRIDE_DEFAULT(int, command_ams_select_tray, dev_id, tray_id, sequence_id, lan_mode);
    }

References command_ams_select_tray(), and ORCA_PY_AGENT_OVERRIDE_DEFAULT.

Referenced by command_ams_select_tray().

Here is the call graph for this function:

Here is the caller graph for this function:

command_auto_leveling()

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

inlineoverridevirtual

Reimplemented from Slic3r::IPrinterAgent.

    {
        ORCA_PY_AGENT_OVERRIDE_DEFAULT(int, command_auto_leveling, dev_id, sequence_id, lan_mode);
    }

References command_auto_leveling(), and ORCA_PY_AGENT_OVERRIDE_DEFAULT.

Referenced by command_auto_leveling().

Here is the call graph for this function:

Here is the caller graph for this function:

command_axis_control()

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

inlineoverridevirtual

Reimplemented from Slic3r::IPrinterAgent.

    {
        ORCA_PY_AGENT_OVERRIDE_DEFAULT(int, command_axis_control, dev_id, axis, unit, input_val, speed,
                                       is_core_xy, supports_mqtt_axis_control, sequence_id, lan_mode);
    }

References command_axis_control(), and ORCA_PY_AGENT_OVERRIDE_DEFAULT.

Referenced by command_axis_control().

Here is the call graph for this function:

Here is the caller graph for this function:

command_go_home()

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

inlineoverridevirtual

Reimplemented from Slic3r::IPrinterAgent.

    {
        ORCA_PY_AGENT_OVERRIDE_DEFAULT(int, command_go_home, dev_id, is_printing, supports_mqtt_homing, sequence_id, lan_mode);
    }

References command_go_home(), and ORCA_PY_AGENT_OVERRIDE_DEFAULT.

Referenced by command_go_home().

Here is the call graph for this function:

Here is the caller graph for this function:

command_set_bed()

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

inlineoverridevirtual

Reimplemented from Slic3r::IPrinterAgent.

    {
        ORCA_PY_AGENT_OVERRIDE_DEFAULT(int, command_set_bed, dev_id, temp, supports_mqtt_bed_ctrl, sequence_id, lan_mode);
    }

References command_set_bed(), and ORCA_PY_AGENT_OVERRIDE_DEFAULT.

Referenced by command_set_bed().

Here is the call graph for this function:

Here is the caller graph for this function:

command_set_nozzle()

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

inlineoverridevirtual

Reimplemented from Slic3r::IPrinterAgent.

    {
        ORCA_PY_AGENT_OVERRIDE_DEFAULT(int, command_set_nozzle, dev_id, temp, sequence_id, lan_mode);
    }

References command_set_nozzle(), and ORCA_PY_AGENT_OVERRIDE_DEFAULT.

Referenced by command_set_nozzle().

Here is the call graph for this function:

Here is the caller graph for this function:

command_start_camera()

int Slic3r::PyPrinterAgentPluginCapabilityTrampoline::command_start_camera ( std::string dev_id )

inlineoverridevirtual

Reimplemented from Slic3r::IPrinterAgent.

    {
        ORCA_PY_AGENT_OVERRIDE_DEFAULT(int, command_start_camera, dev_id);
    }

References command_start_camera(), and ORCA_PY_AGENT_OVERRIDE_DEFAULT.

Referenced by command_start_camera().

Here is the call graph for this function:

Here is the caller graph for this function:

command_xyz_abs()

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

inlineoverridevirtual

Reimplemented from Slic3r::IPrinterAgent.

    {
        ORCA_PY_AGENT_OVERRIDE_DEFAULT(int, command_xyz_abs, dev_id, sequence_id, lan_mode);
    }

References command_xyz_abs(), and ORCA_PY_AGENT_OVERRIDE_DEFAULT.

Referenced by command_xyz_abs().

Here is the call graph for this function:

Here is the caller graph for this function:

config_ui_available()

bool Slic3r::PluginCapabilityInterface::config_ui_available ( ) const

inlineinherited

{ return m_config_ui_available; }

References m_config_ui_available.

connect_printer()

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

inlineoverridevirtual

Establish a direct LAN connection to a printer.

Implements Slic3r::PrinterAgentPluginCapability.

    {
        ORCA_PY_AGENT_OVERRIDE(int, connect_printer, params);
    }

References connect_printer(), and ORCA_PY_AGENT_OVERRIDE.

Referenced by connect_printer().

Here is the call graph for this function:

Here is the caller graph for this function:

decrement()

void Slic3r::PluginCapabilityInterface::decrement ( ) const

inlineinherited

{ m_refs.fetch_sub(1, std::memory_order_acq_rel); }

References m_refs.

default_lan_username()

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

inlinevirtualinherited

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 )

inlinevirtualinherited

Remove device-level subscriptions.

Reimplemented in Slic3r::BBLPrinterAgent.

{ (void) dev_list; return BAMBU_NETWORK_SUCCESS; }

References BAMBU_NETWORK_SUCCESS.

disconnect_printer()

int Slic3r::PyPrinterAgentPluginCapabilityTrampoline::disconnect_printer ( )

inlineoverridevirtual

Tear down the active LAN printer connection.

Implements Slic3r::IPrinterAgent.

    {
        // While the app closes, the UI thread waits here; a plugin that never returns would keep it
        // open, so the call gets a deadline and is left running past it.
        if (!PluginManager::instance().is_shutting_down())
            return python_disconnect_printer();
        return disconnect_printer_at_shutdown();
    }

References disconnect_printer_at_shutdown(), Slic3r::PluginManager::instance(), and python_disconnect_printer().

Referenced by python_disconnect_printer().

Here is the call graph for this function:

Here is the caller graph for this function:

disconnect_printer_at_shutdown()

int Slic3r::PyPrinterAgentPluginCapabilityTrampoline::disconnect_printer_at_shutdown ( )

inlineprivate

    {
        std::shared_ptr<ShutdownDisconnect> call;
        bool                                start = false;
        {
            std::lock_guard<std::mutex> lock(m_shutdown_disconnect_mutex);
            if (!m_shutdown_disconnect) {
                m_shutdown_disconnect = std::make_shared<ShutdownDisconnect>();
                start                 = true;
            }
            call = m_shutdown_disconnect;
        }
        if (start) {
            try {
                std::thread([agent = this, call] { run_shutdown_disconnect(agent, *call); }).detach();
            } catch (const std::system_error&) {
                // No thread, so no deadline either: call the plugin directly as before.
                call->state.store(ShutdownDisconnect::Started);
                const int result = python_disconnect_printer();
                call->result.set_value(result);
                return result;
            }
        }
        if (call->done.wait_until(call->deadline) == std::future_status::ready)
            return call->done.get();
        int expected = ShutdownDisconnect::Pending;
        call->state.compare_exchange_strong(expected, ShutdownDisconnect::Abandoned);
        log_failure("disconnect_printer", "did not return within 3 s while the app is closing");
        return printer_agent_failure<int>();
    }

References Slic3r::PyPrinterAgentPluginCapabilityTrampoline::ShutdownDisconnect::Abandoned, log_failure(), m_shutdown_disconnect, m_shutdown_disconnect_mutex, Slic3r::PyPrinterAgentPluginCapabilityTrampoline::ShutdownDisconnect::Pending, Slic3r::printer_agent_failure(), python_disconnect_printer(), run_shutdown_disconnect(), and Slic3r::PyPrinterAgentPluginCapabilityTrampoline::ShutdownDisconnect::Started.

Referenced by disconnect_printer().

Here is the call graph for this function:

Here is the caller graph for this function:

fetch_filament_info()

bool Slic3r::PyPrinterAgentPluginCapabilityTrampoline::fetch_filament_info ( std::string dev_id, FilamentSyncMode sync_mode )

inlineoverridevirtual

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

    {
        ORCA_PY_AGENT_OVERRIDE_DEFAULT(bool, fetch_filament_info, dev_id, sync_mode);
    }

References fetch_filament_info(), and ORCA_PY_AGENT_OVERRIDE_DEFAULT.

Referenced by fetch_filament_info().

Here is the call graph for this function:

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

inlinevirtualinherited

Reimplemented in Slic3r::BBLPrinterAgent.

{ return orca_filament_id; }

get_agent_info()

AgentInfo Slic3r::PyPrinterAgentPluginCapabilityTrampoline::get_agent_info ( )

inlineoverridevirtual

Get agent information.

Implements Slic3r::PrinterAgentPluginCapability.

    {
        ORCA_PY_AGENT_OVERRIDE(AgentInfo, get_agent_info);
    }

References get_agent_info(), and ORCA_PY_AGENT_OVERRIDE.

Referenced by get_agent_info().

Here is the call graph for this function:

Here is the caller graph for this function:

get_camera_stream_mode()

CameraStreamMode Slic3r::PyPrinterAgentPluginCapabilityTrampoline::get_camera_stream_mode ( ) const

inlineoverridevirtual

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

    {
        ORCA_PY_AGENT_OVERRIDE_DEFAULT(CameraStreamMode, get_camera_stream_mode);
    }

References get_camera_stream_mode(), and ORCA_PY_AGENT_OVERRIDE_DEFAULT.

Referenced by get_camera_stream_mode().

Here is the call graph for this function:

Here is the caller graph for this function:

get_camera_url()

std::string Slic3r::PyPrinterAgentPluginCapabilityTrampoline::get_camera_url ( ) const

inlineoverridevirtual

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

    {
        ORCA_PY_AGENT_OVERRIDE_DEFAULT(std::string, get_camera_url);
    }

References get_camera_url(), and ORCA_PY_AGENT_OVERRIDE_DEFAULT.

Referenced by get_camera_url().

Here is the call graph for this function:

Here is the caller graph for this function:

get_config_ui()

std::string Slic3r::PyPluginCommonTrampoline< PrinterAgentPluginCapability >::get_config_ui ( ) const

inlineoverridevirtualinherited

Reimplemented from Slic3r::PluginCapabilityInterface.

    {
        ORCA_PY_OVERRIDE_AUDITED(
            [] {},
            PYBIND11_OVERRIDE,
            std::string,
            Base,
            get_config_ui);
    }

get_default_config()

nlohmann::json Slic3r::PyPluginCommonTrampoline< PrinterAgentPluginCapability >::get_default_config ( ) const

inlineoverridevirtualinherited

Reimplemented from Slic3r::PluginCapabilityInterface.

    {
        pybind11::gil_scoped_acquire gil;
        ORCA_PY_AUDIT_SCOPE();
        try {
            pybind11::function override = pybind11::get_override(static_cast<const Base*>(this), "get_default_config");
            if (!override)
                return Base::get_default_config();
 
            nlohmann::json config = ::Slic3r::py_to_json(override());
            if (!config.is_object()) {
                BOOST_LOG_TRIVIAL(warning)
                    << "Plugin capability '" << this->name() << "' of plugin '" << this->audit_plugin_key()
                    << "': get_default_config() returned " << config.type_name() << ", not an object; restoring an empty config";
                return Base::get_default_config();
            }
            return config;
        } catch (pybind11::error_already_set& err) {
            ::Slic3r::log_python_exception_keep(err);
            throw;
        }
    }

get_filament_sync_mode()

FilamentSyncMode Slic3r::PyPrinterAgentPluginCapabilityTrampoline::get_filament_sync_mode ( ) const

inlineoverridevirtual

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.

    {
        ORCA_PY_AGENT_OVERRIDE_DEFAULT(FilamentSyncMode, get_filament_sync_mode);
    }

References get_filament_sync_mode(), and ORCA_PY_AGENT_OVERRIDE_DEFAULT.

Referenced by get_filament_sync_mode().

Here is the call graph for this function:

Here is the caller graph for this function:

get_hms_snapshot()

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

inlineoverridevirtual

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.

    {
        ORCA_PY_AGENT_OVERRIDE_DEFAULT(int, get_hms_snapshot, dev_id, file_name, callback);
    }

References get_hms_snapshot(), and ORCA_PY_AGENT_OVERRIDE_DEFAULT.

Referenced by get_hms_snapshot().

Here is the call graph for this function:

Here is the caller graph for this function:

get_name()

std::string Slic3r::PyPluginCommonTrampoline< PrinterAgentPluginCapability >::get_name ( ) const

inlineoverridevirtualinherited

Implements Slic3r::PluginCapabilityInterface.

    {
        ORCA_PY_OVERRIDE_AUDITED([] {}, PYBIND11_OVERRIDE_PURE, std::string, Base, get_name);
    }

get_type()

PluginCapabilityType Slic3r::PrinterAgentPluginCapability::get_type ( ) const

inlineoverridevirtualinherited

Reimplemented from Slic3r::PluginCapabilityInterface.

{ return PluginCapabilityType::PrinterConnection; }

References Slic3r::PrinterConnection.

Referenced by RegisterBindings().

Here is the caller graph for this function:

get_user_selected_machine()

std::string Slic3r::PyPrinterAgentPluginCapabilityTrampoline::get_user_selected_machine ( )

inlineoverridevirtual

Return the currently selected printer ID.

Implements Slic3r::PrinterAgentPluginCapability.

    {
        ORCA_PY_AGENT_OVERRIDE(std::string, get_user_selected_machine);
    }

References get_user_selected_machine(), and ORCA_PY_AGENT_OVERRIDE.

Referenced by get_user_selected_machine().

Here is the call graph for this function:

Here is the caller graph for this function:

has_config_ui()

bool Slic3r::PyPluginCommonTrampoline< PrinterAgentPluginCapability >::has_config_ui ( ) const

inlineoverridevirtualinherited

Reimplemented from Slic3r::PluginCapabilityInterface.

    {
        ORCA_PY_OVERRIDE_AUDITED(
            [] {},
            PYBIND11_OVERRIDE,
            bool,
            Base,
            has_config_ui);
    }

identity()

PluginCapabilityId Slic3r::PluginCapabilityInterface::identity ( ) const

inlineinherited

{ return {m_type, m_name, m_audit_plugin_key}; }

References m_audit_plugin_key, m_name, and m_type.

Referenced by Slic3r::anonymous_namespace{PluginConfig.cpp}::capability_identity().

Here is the caller graph for this function:

increment()

void Slic3r::PluginCapabilityInterface::increment ( ) const

inlineinherited

{ m_refs.fetch_add(1, std::memory_order_acq_rel); }

References m_refs.

install_device_cert()

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

inlineoverridevirtual

Install or refresh device certificate for LAN TLS.

Reimplemented from Slic3r::IPrinterAgent.

    {
        ORCA_PY_AGENT_OVERRIDE_DEFAULT(void, install_device_cert, dev_id, lan_only);
    }

References install_device_cert(), and ORCA_PY_AGENT_OVERRIDE_DEFAULT.

Referenced by install_device_cert().

Here is the call graph for this function:

Here is the caller graph for this function:

is_enabled()

bool Slic3r::PluginCapabilityInterface::is_enabled ( ) const

inlineinherited

{ return m_enabled.load(std::memory_order_acquire); }

References m_enabled.

log_failure()

void Slic3r::PyPrinterAgentPluginCapabilityTrampoline::log_failure ( const char * operation, const char * error ) const

inlineprivate

    {
        BOOST_LOG_TRIVIAL(error) << "Printer agent plugin '" << this->audit_plugin_key() << "': " << operation << " failed: " << error;
    }

References Slic3r::PluginCapabilityInterface::audit_plugin_key().

Referenced by disconnect_printer_at_shutdown().

Here is the call graph for this function:

Here is the caller graph for this function:

name()

const std::string & Slic3r::PluginCapabilityInterface::name ( ) const

inlineinherited

{ return m_name; }

References m_name.

Referenced by Slic3r::PrinterAgentPluginCapability::RegisterBindings(), and set_resolved_identity().

Here is the caller graph for this function:

on_cancelled()

void Slic3r::PyPluginCommonTrampoline< PrinterAgentPluginCapability >::on_cancelled ( )

inlineoverridevirtualinherited

Reimplemented from Slic3r::PluginCapabilityInterface.

    {
        ORCA_PY_OVERRIDE_AUDITED([] {}, PYBIND11_OVERRIDE, void, Base, on_cancelled);
    }

on_lifecycle_event()

void Slic3r::PyPluginCommonTrampoline< PrinterAgentPluginCapability >::on_lifecycle_event ( LifecycleEvent event, const LifecycleEventContext & ctx )

inlineoverridevirtualinherited

Reimplemented from Slic3r::PluginCapabilityInterface.

    {
        ORCA_PY_OVERRIDE_AUDITED([] {}, PYBIND11_OVERRIDE, void, Base, on_lifecycle_event, event, ctx);
    }

on_load()

void Slic3r::PyPluginCommonTrampoline< PrinterAgentPluginCapability >::on_load ( )

inlineoverridevirtualinherited

Reimplemented from Slic3r::PluginCapabilityInterface.

    {
        ORCA_PY_OVERRIDE_AUDITED([] {}, PYBIND11_OVERRIDE, void, Base, on_load);
    }

on_unload()

void Slic3r::PyPluginCommonTrampoline< PrinterAgentPluginCapability >::on_unload ( )

inlineoverridevirtualinherited

Reimplemented from Slic3r::PluginCapabilityInterface.

    {
        ORCA_PY_OVERRIDE_AUDITED([] {}, PYBIND11_OVERRIDE, void, Base, on_unload);
    }

ping_bind()

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

inlineoverridevirtual

Ping the binding endpoint to check printer readiness.

Reimplemented from Slic3r::IPrinterAgent.

    {
        ORCA_PY_AGENT_OVERRIDE(int, ping_bind, ping_code);
    }

References ORCA_PY_AGENT_OVERRIDE, and ping_bind().

Referenced by ping_bind().

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:

python_disconnect_printer()

int Slic3r::PyPrinterAgentPluginCapabilityTrampoline::python_disconnect_printer ( )

inlineprivate

    {
        ORCA_PY_AGENT_OVERRIDE(int, disconnect_printer);
    }

References disconnect_printer(), and ORCA_PY_AGENT_OVERRIDE.

Referenced by disconnect_printer(), disconnect_printer_at_shutdown(), and run_shutdown_disconnect().

Here is the call graph for this function:

Here is the caller graph for this function:

ref_count()

int Slic3r::PluginCapabilityInterface::ref_count ( ) const

inlineinherited

{ return m_refs.load(std::memory_order_acquire); }

References m_refs.

RegisterBindings()

void Slic3r::PrinterAgentPluginCapability::RegisterBindings ( pybind11::module_ & module )

staticinherited

{
    auto printer_agent_module = module.def_submodule("printer_agent", "Printer Agent API");
 
    py::enum_<FilamentSyncMode>(printer_agent_module, "FilamentSyncMode")
        .value("None_", FilamentSyncMode::none)
        .value("Subscription", FilamentSyncMode::subscription)
        .value("Pull", FilamentSyncMode::pull)
        .export_values();
 
    py::enum_<CameraStreamMode>(printer_agent_module, "CameraStreamMode")
        .value("None_", CameraStreamMode::none)
        .value("HTTP", CameraStreamMode::http)
        .value("HTTPS", CameraStreamMode::https)
        .value("HTTP_SNAPSHOT", CameraStreamMode::http_snapshot)
        .value("RTSP", CameraStreamMode::rtsp)
        .export_values();
 
    py::class_<AgentInfo>(printer_agent_module, "AgentInfo")
        .def(py::init<>())
        .def(py::init([](std::string id, std::string name, std::string version, std::string description) {
                 return AgentInfo{std::move(id), std::move(name), std::move(version), std::move(description)};
             }),
             py::arg("id"), py::arg("name"), py::arg("version"), py::arg("description"))
        .def_readwrite("id", &AgentInfo::id)
        .def_readwrite("name", &AgentInfo::name)
        .def_readwrite("version", &AgentInfo::version)
        .def_readwrite("description", &AgentInfo::description);
 
    py::class_<detectResult>(printer_agent_module, "DetectResult")
        .def(py::init<>())
        .def_readwrite("result_msg", &detectResult::result_msg)
        .def_readwrite("command", &detectResult::command)
        .def_readwrite("dev_id", &detectResult::dev_id)
        .def_readwrite("model_id", &detectResult::model_id)
        .def_readwrite("dev_name", &detectResult::dev_name)
        .def_readwrite("version", &detectResult::version)
        .def_readwrite("bind_state", &detectResult::bind_state)
        .def_readwrite("connect_type", &detectResult::connect_type);
 
    py::class_<PrintParams>(printer_agent_module, "PrintParams")
        .def(py::init<>())
        .def_readwrite("dev_id", &PrintParams::dev_id)
        .def_readwrite("task_name", &PrintParams::task_name)
        .def_readwrite("project_name", &PrintParams::project_name)
        .def_readwrite("preset_name", &PrintParams::preset_name)
        .def_readwrite("filename", &PrintParams::filename)
        .def_readwrite("config_filename", &PrintParams::config_filename)
        .def_readwrite("plate_index", &PrintParams::plate_index)
        .def_readwrite("ftp_folder", &PrintParams::ftp_folder)
        .def_readwrite("ftp_file", &PrintParams::ftp_file)
        .def_readwrite("ftp_file_md5", &PrintParams::ftp_file_md5)
        .def_readwrite("nozzle_mapping", &PrintParams::nozzle_mapping)
        .def_readwrite("ams_mapping", &PrintParams::ams_mapping)
        .def_readwrite("ams_mapping2", &PrintParams::ams_mapping2)
        .def_readwrite("ams_mapping_info", &PrintParams::ams_mapping_info)
        .def_readwrite("nozzles_info", &PrintParams::nozzles_info)
        .def_readwrite("connection_type", &PrintParams::connection_type)
        .def_readwrite("comments", &PrintParams::comments)
        .def_readwrite("origin_profile_id", &PrintParams::origin_profile_id)
        .def_readwrite("stl_design_id", &PrintParams::stl_design_id)
        .def_readwrite("origin_model_id", &PrintParams::origin_model_id)
        .def_readwrite("print_type", &PrintParams::print_type)
        .def_readwrite("dst_file", &PrintParams::dst_file)
        .def_readwrite("dev_name", &PrintParams::dev_name)
        .def_readwrite("dev_ip", &PrintParams::dev_ip)
        .def_readwrite("use_ssl_for_ftp", &PrintParams::use_ssl_for_ftp)
        .def_readwrite("use_ssl_for_mqtt", &PrintParams::use_ssl_for_mqtt)
        .def_readwrite("username", &PrintParams::username)
        .def_readwrite("password", &PrintParams::password)
        .def_readwrite("task_bed_leveling", &PrintParams::task_bed_leveling)
        .def_readwrite("task_flow_cali", &PrintParams::task_flow_cali)
        .def_readwrite("task_vibration_cali", &PrintParams::task_vibration_cali)
        .def_readwrite("task_layer_inspect", &PrintParams::task_layer_inspect)
        .def_readwrite("task_record_timelapse", &PrintParams::task_record_timelapse)
        .def_readwrite("task_use_ams", &PrintParams::task_use_ams)
        .def_readwrite("task_bed_type", &PrintParams::task_bed_type)
        .def_readwrite("extra_options", &PrintParams::extra_options)
        .def_readwrite("auto_bed_leveling", &PrintParams::auto_bed_leveling)
        .def_readwrite("auto_flow_cali", &PrintParams::auto_flow_cali)
        .def_readwrite("auto_offset_cali", &PrintParams::auto_offset_cali)
        .def_readwrite("task_ext_change_assist", &PrintParams::task_ext_change_assist)
        .def_readwrite("try_emmc_print", &PrintParams::try_emmc_print);
 
    py::class_<PrinterConnectionParams>(printer_agent_module, "PrinterConnectionParams")
        .def(py::init<>())
        .def_readwrite("dev_id", &PrinterConnectionParams::dev_id)
        .def_readwrite("host", &PrinterConnectionParams::host)
        .def_readwrite("port", &PrinterConnectionParams::port)
        .def_readwrite("username", &PrinterConnectionParams::username)
        .def_readwrite("password", &PrinterConnectionParams::password)
        .def_readwrite("use_ssl", &PrinterConnectionParams::use_ssl)
        .def_readwrite("ca_file", &PrinterConnectionParams::ca_file);
 
    py::class_<PrinterAgentPluginCapability, PluginCapabilityInterface, PyPrinterAgentPluginCapabilityTrampoline, std::shared_ptr<PrinterAgentPluginCapability>>(
        printer_agent_module, "PrinterAgentBase")
        .def(py::init<>())
        .def("get_type", &PrinterAgentPluginCapability::get_type)
        .def("get_agent_info", &PrinterAgentPluginCapability::get_agent_info)
        .def("connect_printer", &PrinterAgentPluginCapability::connect_printer)
        .def("disconnect_printer", &PrinterAgentPluginCapability::disconnect_printer)
        .def("send_message", &PrinterAgentPluginCapability::send_message)
        .def("send_message_to_printer", &PrinterAgentPluginCapability::send_message_to_printer)
        .def("command_ams_refresh_rfid", &PrinterAgentPluginCapability::command_ams_refresh_rfid)
        .def("command_ams_calibrate", &PrinterAgentPluginCapability::command_ams_calibrate)
        .def("command_ams_select_tray", &PrinterAgentPluginCapability::command_ams_select_tray)
        .def("command_start_camera", &PrinterAgentPluginCapability::command_start_camera)
        .def("command_xyz_abs", &PrinterAgentPluginCapability::command_xyz_abs)
        .def("command_auto_leveling", &PrinterAgentPluginCapability::command_auto_leveling)
        .def("command_go_home", &PrinterAgentPluginCapability::command_go_home)
        .def("command_set_bed", &PrinterAgentPluginCapability::command_set_bed)
        .def("command_set_nozzle", &PrinterAgentPluginCapability::command_set_nozzle)
        .def("command_axis_control", &PrinterAgentPluginCapability::command_axis_control)
        .def("start_discovery", &PrinterAgentPluginCapability::start_discovery)
        .def("bind_detect", &PrinterAgentPluginCapability::bind_detect)
        .def("get_user_selected_machine", &PrinterAgentPluginCapability::get_user_selected_machine)
        .def("set_user_selected_machine", &PrinterAgentPluginCapability::set_user_selected_machine)
        .def("start_send_gcode_to_sdcard", &PrinterAgentPluginCapability::start_send_gcode_to_sdcard)
        .def("start_local_print", &PrinterAgentPluginCapability::start_local_print)
        .def("get_filament_sync_mode", &PrinterAgentPluginCapability::get_filament_sync_mode)
        .def("get_camera_stream_mode", &PrinterAgentPluginCapability::get_camera_stream_mode)
        .def("fetch_filament_info", &PrinterAgentPluginCapability::fetch_filament_info)
        .def("get_camera_url", &PrinterAgentPluginCapability::get_camera_url)
        .def("check_cert", &PrinterAgentPluginCapability::check_cert)
        .def("install_device_cert", &PrinterAgentPluginCapability::install_device_cert)
        .def("ping_bind", &PrinterAgentPluginCapability::ping_bind)
        .def("bind", &PrinterAgentPluginCapability::bind)
        .def("unbind", &PrinterAgentPluginCapability::unbind)
        .def("start_print", &PrinterAgentPluginCapability::start_print)
        .def("start_local_print_with_record", &PrinterAgentPluginCapability::start_local_print_with_record)
        .def("start_sdcard_print", &PrinterAgentPluginCapability::start_sdcard_print);
}

References Slic3r::PrintParams::ams_mapping, Slic3r::PrintParams::ams_mapping2, Slic3r::PrintParams::ams_mapping_info, Slic3r::PrintParams::auto_bed_leveling, Slic3r::PrintParams::auto_flow_cali, Slic3r::PrintParams::auto_offset_cali, Slic3r::IPrinterAgent::bind(), bind_detect(), Slic3r::detectResult::bind_state, Slic3r::PrinterConnectionParams::ca_file, Slic3r::IPrinterAgent::check_cert(), Slic3r::detectResult::command, Slic3r::IPrinterAgent::command_ams_calibrate(), Slic3r::IPrinterAgent::command_ams_refresh_rfid(), Slic3r::IPrinterAgent::command_ams_select_tray(), Slic3r::IPrinterAgent::command_auto_leveling(), Slic3r::IPrinterAgent::command_axis_control(), Slic3r::IPrinterAgent::command_go_home(), Slic3r::IPrinterAgent::command_set_bed(), Slic3r::IPrinterAgent::command_set_nozzle(), Slic3r::IPrinterAgent::command_start_camera(), Slic3r::IPrinterAgent::command_xyz_abs(), Slic3r::PrintParams::comments, Slic3r::PrintParams::config_filename, connect_printer(), Slic3r::detectResult::connect_type, Slic3r::PrintParams::connection_type, Slic3r::AgentInfo::description, Slic3r::detectResult::dev_id, Slic3r::PrinterConnectionParams::dev_id, Slic3r::PrintParams::dev_id, Slic3r::PrintParams::dev_ip, Slic3r::detectResult::dev_name, Slic3r::PrintParams::dev_name, Slic3r::IPrinterAgent::disconnect_printer(), Slic3r::PrintParams::dst_file, Slic3r::PrintParams::extra_options, Slic3r::IPrinterAgent::fetch_filament_info(), Slic3r::PrintParams::filename, Slic3r::PrintParams::ftp_file, Slic3r::PrintParams::ftp_file_md5, Slic3r::PrintParams::ftp_folder, get_agent_info(), Slic3r::IPrinterAgent::get_camera_stream_mode(), Slic3r::IPrinterAgent::get_camera_url(), Slic3r::IPrinterAgent::get_filament_sync_mode(), get_type(), get_user_selected_machine(), Slic3r::PrinterConnectionParams::host, Slic3r::http, Slic3r::http_snapshot, Slic3r::https, Slic3r::AgentInfo::id, Slic3r::IPrinterAgent::install_device_cert(), Slic3r::detectResult::model_id, Slic3r::module(), Slic3r::AgentInfo::name, Slic3r::PluginCapabilityInterface::name(), Slic3r::none, Slic3r::PrintParams::nozzle_mapping, Slic3r::PrintParams::nozzles_info, Slic3r::PrintParams::origin_model_id, Slic3r::PrintParams::origin_profile_id, Slic3r::PrinterConnectionParams::password, Slic3r::PrintParams::password, Slic3r::IPrinterAgent::ping_bind(), Slic3r::PrintParams::plate_index, Slic3r::PrinterConnectionParams::port, Slic3r::PrintParams::preset_name, Slic3r::PrintParams::print_type, Slic3r::PrintParams::project_name, Slic3r::pull, Slic3r::detectResult::result_msg, Slic3r::rtsp, send_message(), send_message_to_printer(), set_user_selected_machine(), start_discovery(), start_local_print(), start_local_print_with_record(), start_print(), start_sdcard_print(), start_send_gcode_to_sdcard(), Slic3r::PrintParams::stl_design_id, Slic3r::subscription, Slic3r::PrintParams::task_bed_leveling, Slic3r::PrintParams::task_bed_type, Slic3r::PrintParams::task_ext_change_assist, Slic3r::PrintParams::task_flow_cali, Slic3r::PrintParams::task_layer_inspect, Slic3r::PrintParams::task_name, Slic3r::PrintParams::task_record_timelapse, Slic3r::PrintParams::task_use_ams, Slic3r::PrintParams::task_vibration_cali, Slic3r::PrintParams::try_emmc_print, Slic3r::IPrinterAgent::unbind(), Slic3r::PrinterConnectionParams::use_ssl, Slic3r::PrintParams::use_ssl_for_ftp, Slic3r::PrintParams::use_ssl_for_mqtt, Slic3r::PrinterConnectionParams::username, Slic3r::PrintParams::username, Slic3r::AgentInfo::version, and Slic3r::detectResult::version.

Referenced by Slic3r::bind_python_api().

Here is the call graph for this function:

Here is the caller graph for this function:

request_bind_ticket()

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

inlineoverridevirtual

Request a one-time bind ticket from the server.

Reimplemented from Slic3r::IPrinterAgent.

    {
        try {
            ::Slic3r::PluginCapabilityInterface::RefCounter _orca_ref_counter(*this);
            ::Slic3r::PythonGILState gil;
            if (!gil)
                throw std::runtime_error("Python interpreter is shutting down");
            ORCA_PY_AUDIT_SCOPE();
            pybind11::function override =
                pybind11::get_override(static_cast<const PrinterAgentPluginCapability*>(this), "request_bind_ticket");
            if (!override)
                return printer_agent_failure<int>();
            try {
                pybind11::tuple result = override().cast<pybind11::tuple>();
                if (ticket)
                    *ticket = result[1].cast<std::string>();
                return result[0].cast<int>();
            } catch (pybind11::error_already_set& err) {
                ::Slic3r::log_python_exception_keep(err);
                throw;
            }
        } ORCA_PY_AGENT_CATCH(request_bind_ticket)
        return printer_agent_failure<int>();
    }

References Slic3r::cast(), Slic3r::log_python_exception_keep(), ORCA_PY_AGENT_CATCH, ORCA_PY_AUDIT_SCOPE, Slic3r::printer_agent_failure(), and request_bind_ticket().

Referenced by request_bind_ticket().

Here is the call graph for this function:

Here is the caller graph for this function:

run_shutdown_disconnect()

void Slic3r::PyPrinterAgentPluginCapabilityTrampoline::run_shutdown_disconnect ( PyPrinterAgentPluginCapabilityTrampoline * agent, ShutdownDisconnect & call )

inlinestaticprivate

    {
        ::Slic3r::PythonGILState gil;
        int                      expected = ShutdownDisconnect::Pending;
        if (!gil || !call.state.compare_exchange_strong(expected, ShutdownDisconnect::Started)) {
            // Abandoned before it started: the agent may already be gone, so it is not touched.
            call.result.set_value(printer_agent_failure<int>());
            return;
        }
        // The plugin may be force-unloaded while the call runs past its deadline. This reference keeps
        // the Python object, and with it the agent, alive until the call has fully unwound; it is
        // released before the GIL.
        const pybind11::object self = pybind11::cast(static_cast<PrinterAgentPluginCapability*>(agent),
                                                     pybind11::return_value_policy::reference);
        call.result.set_value(agent->python_disconnect_printer());
    }

References Slic3r::PyPrinterAgentPluginCapabilityTrampoline::ShutdownDisconnect::Pending, Slic3r::printer_agent_failure(), python_disconnect_printer(), Slic3r::PyPrinterAgentPluginCapabilityTrampoline::ShutdownDisconnect::result, Slic3r::PyPrinterAgentPluginCapabilityTrampoline::ShutdownDisconnect::Started, and Slic3r::PyPrinterAgentPluginCapabilityTrampoline::ShutdownDisconnect::state.

Referenced by disconnect_printer_at_shutdown().

Here is the call graph for this function:

Here is the caller graph for this function:

send_message()

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

inlineoverridevirtual

Publish a JSON command to a printer through cloud relay.

Implements Slic3r::PrinterAgentPluginCapability.

    {
        ORCA_PY_AGENT_OVERRIDE(int, send_message, dev_id, json_str, qos, flag);
    }

References ORCA_PY_AGENT_OVERRIDE, and send_message().

Referenced by send_message().

Here is the call graph for this function:

Here is the caller graph for this function:

send_message_to_printer()

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

inlineoverridevirtual

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

Implements Slic3r::PrinterAgentPluginCapability.

    {
        ORCA_PY_AGENT_OVERRIDE(int, send_message_to_printer, dev_id, json_str, qos, flag);
    }

References ORCA_PY_AGENT_OVERRIDE, and send_message_to_printer().

Referenced by send_message_to_printer().

Here is the call graph for this function:

Here is the caller graph for this function:

set_audit_plugin_key()

void Slic3r::PluginCapabilityInterface::set_audit_plugin_key ( std::string key )

inlineinherited

{ m_audit_plugin_key = std::move(key); }

References m_audit_plugin_key.

set_cloud_agent()

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

inlinefinaloverridevirtualinherited

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

Implements Slic3r::IPrinterAgent.

{ (void) cloud; }

set_config_ui_available()

void Slic3r::PluginCapabilityInterface::set_config_ui_available ( bool available )

inlineinherited

{ m_config_ui_available = available; }

References m_config_ui_available.

set_enabled()

void Slic3r::PluginCapabilityInterface::set_enabled ( bool enabled )

inlineinherited

{ m_enabled.store(enabled, std::memory_order_release); }

References m_enabled.

set_on_local_connect_fn()

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

inlineoverridevirtual

Register LAN connection status callback.

Implements Slic3r::PrinterAgentPluginCapability.

    {
        ORCA_PY_AGENT_OVERRIDE(int, set_on_local_connect_fn, fn);
    }

References ORCA_PY_AGENT_OVERRIDE, and set_on_local_connect_fn().

Referenced by set_on_local_connect_fn().

Here is the call graph for this function:

Here is the caller graph for this function:

set_on_local_message_fn()

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

inlineoverridevirtual

Register LAN message callback.

Implements Slic3r::PrinterAgentPluginCapability.

    {
        ORCA_PY_AGENT_OVERRIDE(int, set_on_local_message_fn, fn);
    }

References ORCA_PY_AGENT_OVERRIDE, and set_on_local_message_fn().

Referenced by set_on_local_message_fn().

Here is the call graph for this function:

Here is the caller graph for this function:

set_on_message_fn()

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

inlineoverridevirtual

Register cloud device message callback.

Implements Slic3r::PrinterAgentPluginCapability.

    {
        ORCA_PY_AGENT_OVERRIDE(int, set_on_message_fn, fn);
    }

References ORCA_PY_AGENT_OVERRIDE, and set_on_message_fn().

Referenced by set_on_message_fn().

Here is the call graph for this function:

Here is the caller graph for this function:

set_on_printer_connected_fn()

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

inlineoverridevirtual

Register printer MQTT connection callback.

Implements Slic3r::PrinterAgentPluginCapability.

    {
        ORCA_PY_AGENT_OVERRIDE(int, set_on_printer_connected_fn, fn);
    }

References ORCA_PY_AGENT_OVERRIDE, and set_on_printer_connected_fn().

Referenced by set_on_printer_connected_fn().

Here is the call graph for this function:

Here is the caller graph for this function:

set_on_ssdp_msg_fn()

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

inlineoverridevirtual

Register SSDP discovery callback.

Implements Slic3r::PrinterAgentPluginCapability.

    {
        ORCA_PY_AGENT_OVERRIDE(int, set_on_ssdp_msg_fn, fn);
    }

References ORCA_PY_AGENT_OVERRIDE, and set_on_ssdp_msg_fn().

Referenced by set_on_ssdp_msg_fn().

Here is the call graph for this function:

Here is the caller graph for this function:

set_on_subscribe_failure_fn()

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

inlineoverridevirtual

Register subscription failure callback.

Implements Slic3r::PrinterAgentPluginCapability.

    {
        ORCA_PY_AGENT_OVERRIDE(int, set_on_subscribe_failure_fn, fn);
    }

References ORCA_PY_AGENT_OVERRIDE, and set_on_subscribe_failure_fn().

Referenced by set_on_subscribe_failure_fn().

Here is the call graph for this function:

Here is the caller graph for this function:

set_on_user_message_fn()

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

inlineoverridevirtual

Register user-scoped message callback.

Implements Slic3r::PrinterAgentPluginCapability.

    {
        ORCA_PY_AGENT_OVERRIDE(int, set_on_user_message_fn, fn);
    }

References ORCA_PY_AGENT_OVERRIDE, and set_on_user_message_fn().

Referenced by set_on_user_message_fn().

Here is the call graph for this function:

Here is the caller graph for this function:

set_queue_on_main_fn()

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

inlineoverridevirtual

Provide main thread queue callback.

Implements Slic3r::PrinterAgentPluginCapability.

    {
        ORCA_PY_AGENT_OVERRIDE(int, set_queue_on_main_fn, fn);
    }

References ORCA_PY_AGENT_OVERRIDE, and set_queue_on_main_fn().

Referenced by set_queue_on_main_fn().

Here is the call graph for this function:

Here is the caller graph for this function:

set_resolved_identity()

void Slic3r::PluginCapabilityInterface::set_resolved_identity ( std::string name, PluginCapabilityType type )

inlineinherited

    {
        m_name = std::move(name);
        m_type = type;
    }

References m_name, m_type, name(), and type().

Here is the call graph for this function:

set_server_callback()

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

inlineoverridevirtual

Register callback for fatal HTTP errors.

Implements Slic3r::PrinterAgentPluginCapability.

    {
        ORCA_PY_AGENT_OVERRIDE(int, set_server_callback, fn);
    }

References ORCA_PY_AGENT_OVERRIDE, and set_server_callback().

Referenced by set_server_callback().

Here is the call graph for this function:

Here is the caller graph for this function:

set_user_selected_machine()

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

inlineoverridevirtual

Update the selected cloud machine preference.

Implements Slic3r::PrinterAgentPluginCapability.

    {
        ORCA_PY_AGENT_OVERRIDE(int, set_user_selected_machine, dev_id);
    }

References ORCA_PY_AGENT_OVERRIDE, and set_user_selected_machine().

Referenced by set_user_selected_machine().

Here is the call graph for this function:

Here is the caller graph for this function:

start_discovery()

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

inlineoverridevirtual

Start or stop SSDP discovery.

Implements Slic3r::PrinterAgentPluginCapability.

    {
        ORCA_PY_AGENT_OVERRIDE(bool, start_discovery, start, sending);
    }

References ORCA_PY_AGENT_OVERRIDE, and start_discovery().

Referenced by start_discovery().

Here is the call graph for this function:

Here is the caller graph for this function:

start_local_print()

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

inlineoverridevirtual

Start a LAN-only print.

Implements Slic3r::PrinterAgentPluginCapability.

    {
        ORCA_PY_AGENT_OVERRIDE(int, start_local_print, params, update_fn, cancel_fn);
    }

References ORCA_PY_AGENT_OVERRIDE, and start_local_print().

Referenced by start_local_print().

Here is the call graph for this function:

Here is the caller graph for this function:

start_local_print_with_record()

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

inlineoverridevirtual

Start a local print with cloud record.

Implements Slic3r::PrinterAgentPluginCapability.

    {
        ORCA_PY_AGENT_OVERRIDE(int, start_local_print_with_record, params, update_fn, cancel_fn, wait_fn);
    }

References ORCA_PY_AGENT_OVERRIDE, and start_local_print_with_record().

Referenced by start_local_print_with_record().

Here is the call graph for this function:

Here is the caller graph for this function:

start_print()

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

inlineoverridevirtual

Start a fully managed cloud print.

Implements Slic3r::PrinterAgentPluginCapability.

    {
        ORCA_PY_AGENT_OVERRIDE(int, start_print, params, update_fn, cancel_fn, wait_fn);
    }

References ORCA_PY_AGENT_OVERRIDE, and start_print().

Referenced by start_print().

Here is the call graph for this function:

Here is the caller graph for this function:

start_sdcard_print()

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

inlineoverridevirtual

Start a print from printer's SD card.

Implements Slic3r::PrinterAgentPluginCapability.

    {
        ORCA_PY_AGENT_OVERRIDE(int, start_sdcard_print, params, update_fn, cancel_fn);
    }

References ORCA_PY_AGENT_OVERRIDE, and start_sdcard_print().

Referenced by start_sdcard_print().

Here is the call graph for this function:

Here is the caller graph for this function:

start_send_gcode_to_sdcard()

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

inlineoverridevirtual

Upload gcode to printer's SD card without starting.

Implements Slic3r::PrinterAgentPluginCapability.

    {
        ORCA_PY_AGENT_OVERRIDE(int, start_send_gcode_to_sdcard, params, update_fn, cancel_fn, wait_fn);
    }

References ORCA_PY_AGENT_OVERRIDE, and start_send_gcode_to_sdcard().

Referenced by start_send_gcode_to_sdcard().

Here is the call graph for this function:

Here is the caller graph for this function:

start_subscribe()

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

inlinevirtualinherited

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 )

inlinevirtualinherited

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

inlinevirtualinherited

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; }

type()

PluginCapabilityType Slic3r::PluginCapabilityInterface::type ( ) const

inlineinherited

{ return m_type; }

References m_type.

Referenced by set_resolved_identity().

Here is the caller graph for this function:

unbind()

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

inlineoverridevirtual

Remove the association between account and printer.

Reimplemented from Slic3r::IPrinterAgent.

    {
        ORCA_PY_AGENT_OVERRIDE(int, unbind, dev_id);
    }

References ORCA_PY_AGENT_OVERRIDE, and unbind().

Referenced by unbind().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

m_audit_plugin_key

std::string Slic3r::PluginCapabilityInterface::m_audit_plugin_key

privateinherited

Referenced by audit_plugin_key(), identity(), and set_audit_plugin_key().

m_config_ui_available

bool Slic3r::PluginCapabilityInterface::m_config_ui_available = false

privateinherited

Referenced by config_ui_available(), and set_config_ui_available().

m_enabled

std::atomic<bool> Slic3r::PluginCapabilityInterface::m_enabled {true}

privateinherited

{true};

Referenced by is_enabled(), and set_enabled().

m_name

std::string Slic3r::PluginCapabilityInterface::m_name

privateinherited

Referenced by identity(), name(), and set_resolved_identity().

m_refs

std::atomic<int> Slic3r::PluginCapabilityInterface::m_refs {0}

mutableprivateinherited

{0};

Referenced by decrement(), increment(), and ref_count().

m_shutdown_disconnect

std::shared_ptr<ShutdownDisconnect> Slic3r::PyPrinterAgentPluginCapabilityTrampoline::m_shutdown_disconnect

private

Referenced by disconnect_printer_at_shutdown().

m_shutdown_disconnect_mutex

std::mutex Slic3r::PyPrinterAgentPluginCapabilityTrampoline::m_shutdown_disconnect_mutex

private

Referenced by disconnect_printer_at_shutdown().

m_type

PluginCapabilityType Slic3r::PluginCapabilityInterface::m_type = PluginCapabilityType::Unknown

privateinherited

Referenced by identity(), set_resolved_identity(), and type().

---

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

• /home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/plugin/pluginTypes/printerAgent/PrinterAgentPluginCapabilityTrampoline.hpp