Slic3r::DevUpgrade Class Reference

#include </home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/GUI/DeviceCore/DevUpgrade.h>

Collaboration diagram for Slic3r::DevUpgrade:

Public Member Functions
bool	IsUpgrading () const
bool	IsUpgradeAvaliable () const
DevFirmwareUpgradeState	GetUpgradeState () const
std::string	GetUpgradeStatusStr () const
bool	IsUpgradeConsistencyRequest () const
bool	IsUpgradeForceUpgrade () const
bool	HasNewVersion () const
std::string	GetOtaNewVersion () const
std::map< std::string, DevFirmwareVersionInfo >	GetNewVersionList () const
std::string	GetUpgradeModuleStr () const
std::string	GetUpgradeProgressStr () const
int	GetUpgradeProgressInt () const
std::string	GetUpgradeMessageStr () const
wxString	GetUpgradeErrCodeStr () const
int	CtrlUpgradeConfirm ()
int	CtrlUpgradeConsistencyConfirm ()
int	CtrlUpgradeFirmware (FirmwareInfo info)
int	CtrlUpgradeModule (std::string url, std::string module_type, std::string version)
void	ParseUpgrade_V1_0 (const nlohmann::json &print_jj)
void	ParseUpgradeDisplayState (const nlohmann::json &upgrade_state_jj)

Static Public Member Functions
static std::shared_ptr< DevUpgrade >	Create (MachineObject *owner)

Protected Member Functions
	DevUpgrade (MachineObject *owner)

Private Attributes
MachineObject *	m_owner = nullptr
int	m_upgrade_new_version_state = 0
bool	m_upgrade_consistency_request = false
bool	m_upgrade_force_upgrade = false
std::string	m_ota_new_version_number
std::map< std::string, DevFirmwareVersionInfo >	m_new_ver_list
DevFirmwareUpgradeState	m_upgrade_display_state = DevFirmwareUpgradeState::DC
int	m_upgrade_err_code = 0
std::string	m_upgrade_status
std::string	m_upgrade_progress
std::string	m_upgrade_message
std::string	m_upgrade_module

Detailed Description

Constructor & Destructor Documentation

DevUpgrade()

Slic3r::DevUpgrade::DevUpgrade ( MachineObject * owner )

inlineprotected

: m_owner(owner) {}

References m_owner.

Referenced by Create().

Here is the caller graph for this function:

Member Function Documentation

Create()

std::shared_ptr< DevUpgrade > Slic3r::DevUpgrade::Create ( MachineObject * owner )

inlinestatic

{ return std::shared_ptr<DevUpgrade>(new DevUpgrade(owner)); }

References DevUpgrade().

Referenced by Slic3r::MachineObject::MachineObject().

Here is the call graph for this function:

Here is the caller graph for this function:

CtrlUpgradeConfirm()

int Slic3r::DevUpgrade::CtrlUpgradeConfirm

(

)

{
    json j;
    j["upgrade"]["command"]     = "upgrade_confirm";
    j["upgrade"]["sequence_id"] = std::to_string(MachineObject::m_sequence_id++);
    j["upgrade"]["src_id"]      = 1; // 1 for slicer
    return m_owner->publish_json(j);
}

References m_owner, and Slic3r::MachineObject::m_sequence_id.

CtrlUpgradeConsistencyConfirm()

int Slic3r::DevUpgrade::CtrlUpgradeConsistencyConfirm

(

)

{
    json j;
    j["upgrade"]["command"]     = "consistency_confirm";
    j["upgrade"]["sequence_id"] = std::to_string(MachineObject::m_sequence_id++);
    j["upgrade"]["src_id"]      = 1; // 1 for slicer
    return m_owner->publish_json(j);
}

References m_owner, and Slic3r::MachineObject::m_sequence_id.

CtrlUpgradeFirmware()

int Slic3r::DevUpgrade::CtrlUpgradeFirmware

(

FirmwareInfo

info

)

{
    std::string version     = info.version;
    std::string dst_url     = info.url;
    std::string module_name = info.module_type;
 
    json j;
    j["upgrade"]["command"]     = "start";
    j["upgrade"]["sequence_id"] = std::to_string(MachineObject::m_sequence_id++);
    j["upgrade"]["url"]         = info.url;
    j["upgrade"]["module"]      = info.module_type;
    j["upgrade"]["version"]     = info.version;
    j["upgrade"]["src_id"]      = 1;
 
    return m_owner->publish_json(j);
}

References m_owner, Slic3r::MachineObject::m_sequence_id, Slic3r::FirmwareInfo::module_type, Slic3r::FirmwareInfo::url, and Slic3r::FirmwareInfo::version.

CtrlUpgradeModule()

int Slic3r::DevUpgrade::CtrlUpgradeModule	(	std::string	url,
		std::string	module_type,
		std::string	version )

{
    json j;
    j["upgrade"]["command"]     = "start";
    j["upgrade"]["sequence_id"] = std::to_string(MachineObject::m_sequence_id++);
    j["upgrade"]["url"]         = url;
    j["upgrade"]["module"]      = module_type;
    j["upgrade"]["version"]     = version;
    j["upgrade"]["src_id"]      = 1;
 
    return m_owner->publish_json(j);
}

References m_owner, and Slic3r::MachineObject::m_sequence_id.

GetNewVersionList()

std::map< std::string, DevFirmwareVersionInfo > Slic3r::DevUpgrade::GetNewVersionList ( ) const

inline

{ return m_new_ver_list; }

References m_new_ver_list.

GetOtaNewVersion()

std::string Slic3r::DevUpgrade::GetOtaNewVersion ( ) const

inline

{ return m_ota_new_version_number; }

References m_ota_new_version_number.

GetUpgradeErrCodeStr()

wxString Slic3r::DevUpgrade::GetUpgradeErrCodeStr

(

)

const

{
    switch (m_upgrade_err_code) {
    case UpgradeNoError: return _L("Update successful.");
    case UpgradeDownloadFailed: return _L("Downloading failed.");
    case UpgradeVerfifyFailed: return _L("Verification failed.");
    case UpgradeFlashFailed: return _L("Update failed.");
    case UpgradePrinting: return _L("Update failed.");
    default: return _L("Update failed.");
    }
 
    return "";
}

References _L, m_upgrade_err_code, UpgradeDownloadFailed, UpgradeFlashFailed, UpgradeNoError, UpgradePrinting, and UpgradeVerfifyFailed.

GetUpgradeMessageStr()

std::string Slic3r::DevUpgrade::GetUpgradeMessageStr ( ) const

inline

{ return m_upgrade_message; }

References m_upgrade_message.

GetUpgradeModuleStr()

std::string Slic3r::DevUpgrade::GetUpgradeModuleStr ( ) const

inline

{ return m_upgrade_module; }

References m_upgrade_module.

GetUpgradeProgressInt()

int Slic3r::DevUpgrade::GetUpgradeProgressInt

(

)

const

{
    try {
        return std::stoi(m_upgrade_progress);
    } catch (const std::exception &e) {
        BOOST_LOG_TRIVIAL(error) << __FUNCTION__ << ": " << e.what();
    }
 
    return 0;
}

References m_upgrade_progress.

GetUpgradeProgressStr()

std::string Slic3r::DevUpgrade::GetUpgradeProgressStr ( ) const

inline

{ return m_upgrade_progress; }

References m_upgrade_progress.

GetUpgradeState()

DevFirmwareUpgradeState Slic3r::DevUpgrade::GetUpgradeState ( ) const

inline

{ return m_upgrade_display_state; }

References m_upgrade_display_state.

GetUpgradeStatusStr()

std::string Slic3r::DevUpgrade::GetUpgradeStatusStr ( ) const

inline

{ return m_upgrade_status; }

References m_upgrade_status.

HasNewVersion()

bool Slic3r::DevUpgrade::HasNewVersion ( ) const

inline

{ return m_upgrade_new_version_state == 1; }

References m_upgrade_new_version_state.

Referenced by ParseUpgradeDisplayState().

Here is the caller graph for this function:

IsUpgradeAvaliable()

bool Slic3r::DevUpgrade::IsUpgradeAvaliable ( ) const

inline

{ return m_upgrade_display_state == DevFirmwareUpgradeState::UpgradingAvaliable; }

References m_upgrade_display_state, and Slic3r::UpgradingAvaliable.

IsUpgradeConsistencyRequest()

bool Slic3r::DevUpgrade::IsUpgradeConsistencyRequest ( ) const

inline

{ return m_upgrade_consistency_request; }

References m_upgrade_consistency_request.

IsUpgradeForceUpgrade()

bool Slic3r::DevUpgrade::IsUpgradeForceUpgrade ( ) const

inline

{ return m_upgrade_force_upgrade; }

References m_upgrade_force_upgrade.

IsUpgrading()

bool Slic3r::DevUpgrade::IsUpgrading ( ) const

inline

{ return m_upgrade_display_state == DevFirmwareUpgradeState::UpgradingInProgress; }

References m_upgrade_display_state, and Slic3r::UpgradingInProgress.

ParseUpgrade_V1_0()

void Slic3r::DevUpgrade::ParseUpgrade_V1_0

(

const nlohmann::json &

print_jj

)

{
    if (print_jj.contains("upgrade_state")) {
        const auto &upgrade_jj = print_jj["upgrade_state"];
 
        // status and steps
        DevJsonValParser::ParseVal(upgrade_jj, "status", m_upgrade_status);
        DevJsonValParser::ParseVal(upgrade_jj, "progress", m_upgrade_progress);
        DevJsonValParser::ParseVal(upgrade_jj, "message", m_upgrade_message);
        DevJsonValParser::ParseVal(upgrade_jj, "module", m_upgrade_module);
        DevJsonValParser::ParseVal(upgrade_jj, "err_code", m_upgrade_err_code);
 
        // version requested
        DevJsonValParser::ParseVal(upgrade_jj, "new_version_state", m_upgrade_new_version_state);
        DevJsonValParser::ParseVal(upgrade_jj, "consistency_request", m_upgrade_consistency_request);
        DevJsonValParser::ParseVal(upgrade_jj, "force_upgrade", m_upgrade_force_upgrade);
 
        // version info
        DevJsonValParser::ParseVal(upgrade_jj, "ota_new_version_number", m_ota_new_version_number);
 
        // version list
        if (upgrade_jj.contains("new_ver_list")) {
            m_new_ver_list.clear();
            for (auto ver_item = upgrade_jj["new_ver_list"].begin(); ver_item != upgrade_jj["new_ver_list"].end(); ver_item++) {
                DevFirmwareVersionInfo ver_info;
                DevJsonValParser::ParseVal(*ver_item, "name", ver_info.name);
                DevJsonValParser::ParseVal(*ver_item, "cur_ver", ver_info.sw_ver);
                DevJsonValParser::ParseVal(*ver_item, "new_ver", ver_info.sw_new_ver);
                m_new_ver_list[ver_info.name] = ver_info;
                if (ver_info.name == "ota" && m_ota_new_version_number.empty()) { m_ota_new_version_number = ver_info.sw_new_ver; }
            }
        } else {
            m_new_ver_list.clear();
        }
 
        // try to parse display state
        ParseUpgradeDisplayState(upgrade_jj);
    }
 
    if (print_jj.contains("cfg")) {
        const std::string &cfg = print_jj["cfg"].get<std::string>();
        if (!cfg.empty()) { m_upgrade_force_upgrade = DevUtil::get_flag_bits(cfg, 2); }
    }
}

References Slic3r::DevUtil::get_flag_bits(), m_new_ver_list, m_ota_new_version_number, m_upgrade_consistency_request, m_upgrade_err_code, m_upgrade_force_upgrade, m_upgrade_message, m_upgrade_module, m_upgrade_new_version_state, m_upgrade_progress, m_upgrade_status, Slic3r::DevFirmwareVersionInfo::name, ParseUpgradeDisplayState(), Slic3r::DevJsonValParser::ParseVal(), Slic3r::DevFirmwareVersionInfo::sw_new_ver, and Slic3r::DevFirmwareVersionInfo::sw_ver.

Here is the call graph for this function:

ParseUpgradeDisplayState()

void Slic3r::DevUpgrade::ParseUpgradeDisplayState

(

const nlohmann::json &

upgrade_state_jj

)

{
    if (upgrade_state_jj.contains("dis_state")) {
        if ((int) m_upgrade_display_state != upgrade_state_jj["dis_state"].get<int>()) {
            DevJsonValParser::ParseVal(upgrade_state_jj, "dis_state", m_upgrade_display_state);
 
            // update the version after upgrade finished
            if (m_upgrade_display_state == DevFirmwareUpgradeState::UpgradingFinished) {
                Slic3r::GUI::wxGetApp().CallAfter([this] {
                    m_owner->command_get_version();
                });
            }
 
            // lan mode printer, hide upgrade avaliable state
            if (m_upgrade_display_state == DevFirmwareUpgradeState::UpgradingAvaliable &&
                m_owner->is_lan_mode_printer()) {
                m_upgrade_display_state = DevFirmwareUpgradeState::UpgradingUnavaliable;
            }
        }
    } else {
        // BBS compatibility with old version
        if (m_upgrade_status == "DOWNLOADING" ||
            m_upgrade_status == "FLASHING" ||
            m_upgrade_status == "UPGRADE_REQUEST" ||
            m_upgrade_status == "PRE_FLASH_START" ||
            m_upgrade_status == "PRE_FLASH_SUCCESS") {
            m_upgrade_display_state = DevFirmwareUpgradeState::UpgradingInProgress;
        } else if (m_upgrade_status == "UPGRADE_SUCCESS" ||
                   m_upgrade_status == "DOWNLOAD_FAIL" ||
                   m_upgrade_status == "FLASH_FAIL" ||
                   m_upgrade_status == "PRE_FLASH_FAIL" ||
                   m_upgrade_status == "UPGRADE_FAIL") {
            m_upgrade_display_state = DevFirmwareUpgradeState::UpgradingFinished;
        } else {
            if (HasNewVersion()) {
                m_upgrade_display_state = DevFirmwareUpgradeState::UpgradingAvaliable;
            } else {
                m_upgrade_display_state = DevFirmwareUpgradeState::UpgradingUnavaliable;
            }
        }
    }
}

References HasNewVersion(), m_owner, m_upgrade_display_state, m_upgrade_status, Slic3r::DevJsonValParser::ParseVal(), Slic3r::UpgradingAvaliable, Slic3r::UpgradingFinished, Slic3r::UpgradingInProgress, and Slic3r::UpgradingUnavaliable.

Referenced by ParseUpgrade_V1_0().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

m_new_ver_list

std::map<std::string, DevFirmwareVersionInfo> Slic3r::DevUpgrade::m_new_ver_list

private

Referenced by GetNewVersionList(), and ParseUpgrade_V1_0().

m_ota_new_version_number

std::string Slic3r::DevUpgrade::m_ota_new_version_number

private

Referenced by GetOtaNewVersion(), and ParseUpgrade_V1_0().

m_owner

MachineObject* Slic3r::DevUpgrade::m_owner = nullptr

private

Referenced by DevUpgrade(), CtrlUpgradeConfirm(), CtrlUpgradeConsistencyConfirm(), CtrlUpgradeFirmware(), CtrlUpgradeModule(), and ParseUpgradeDisplayState().

m_upgrade_consistency_request

bool Slic3r::DevUpgrade::m_upgrade_consistency_request = false

private

Referenced by IsUpgradeConsistencyRequest(), and ParseUpgrade_V1_0().

m_upgrade_display_state

DevFirmwareUpgradeState Slic3r::DevUpgrade::m_upgrade_display_state = DevFirmwareUpgradeState::DC

private

Referenced by GetUpgradeState(), IsUpgradeAvaliable(), IsUpgrading(), and ParseUpgradeDisplayState().

m_upgrade_err_code

int Slic3r::DevUpgrade::m_upgrade_err_code = 0

private

Referenced by GetUpgradeErrCodeStr(), and ParseUpgrade_V1_0().

m_upgrade_force_upgrade

bool Slic3r::DevUpgrade::m_upgrade_force_upgrade = false

private

Referenced by IsUpgradeForceUpgrade(), and ParseUpgrade_V1_0().

m_upgrade_message

std::string Slic3r::DevUpgrade::m_upgrade_message

private

Referenced by GetUpgradeMessageStr(), and ParseUpgrade_V1_0().

m_upgrade_module

std::string Slic3r::DevUpgrade::m_upgrade_module

private

Referenced by GetUpgradeModuleStr(), and ParseUpgrade_V1_0().

m_upgrade_new_version_state

int Slic3r::DevUpgrade::m_upgrade_new_version_state = 0

private

Referenced by HasNewVersion(), and ParseUpgrade_V1_0().

m_upgrade_progress

std::string Slic3r::DevUpgrade::m_upgrade_progress

private

Referenced by GetUpgradeProgressInt(), GetUpgradeProgressStr(), and ParseUpgrade_V1_0().

m_upgrade_status

std::string Slic3r::DevUpgrade::m_upgrade_status

private

Referenced by GetUpgradeStatusStr(), ParseUpgrade_V1_0(), and ParseUpgradeDisplayState().

---

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

• /home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/GUI/DeviceCore/DevUpgrade.h
• /home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/GUI/DeviceCore/DevUpgrade.cpp
• /home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/GUI/DeviceCore/DevUpgradeCtrl.cpp