#include "FirmwareDialog.hpp" #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include "libslic3r/Utils.hpp" #include "avrdude/avrdude-slic3r.hpp" #include "GUI.hpp" namespace fs = boost::filesystem; namespace Slic3r { // This enum discriminates the kind of information in EVT_AVRDUDE, // it's stored in the ExtraLong field of wxCommandEvent. enum AvrdudeEvent { AE_MESSAGE, AE_PRORGESS, AE_EXIT, }; wxDECLARE_EVENT(EVT_AVRDUDE, wxCommandEvent); wxDEFINE_EVENT(EVT_AVRDUDE, wxCommandEvent); // Private struct FirmwareDialog::priv { enum AvrDudeComplete { AC_NONE, AC_SUCCESS, AC_FAILURE, AC_CANCEL, }; FirmwareDialog *q; // PIMPL back pointer ("Q-Pointer") wxComboBox *port_picker; wxFilePickerCtrl *hex_picker; wxStaticText *txt_status; wxStaticText *txt_progress; wxGauge *progressbar; wxCollapsiblePane *spoiler; wxTextCtrl *txt_stdout; wxButton *btn_rescan; wxButton *btn_close; wxButton *btn_flash; wxString btn_flash_label_ready; wxString btn_flash_label_flashing; // This is a shared pointer holding the background AvrDude task // also serves as a status indication (it is set _iff_ the background task is running, otherwise it is reset). AvrDude::Ptr avrdude; std::string avrdude_config; unsigned progress_tasks_done; bool cancelled; priv(FirmwareDialog *q) : q(q), btn_flash_label_ready(_(L("Flash!"))), btn_flash_label_flashing(_(L("Cancel"))), avrdude_config((fs::path(::Slic3r::resources_dir()) / "avrdude" / "avrdude.conf").string()), progress_tasks_done(0), cancelled(false) {} void find_serial_ports(); void flashing_status(bool flashing, AvrDudeComplete complete = AC_NONE); void perform_upload(); void cancel(); void on_avrdude(const wxCommandEvent &evt); }; void FirmwareDialog::priv::find_serial_ports() { auto ports = GUI::scan_serial_ports(); port_picker->Clear(); for (const auto &port : ports) { port_picker->Append(port); } if (ports.size() > 0 && port_picker->GetValue().IsEmpty()) { port_picker->SetSelection(0); } } void FirmwareDialog::priv::flashing_status(bool value, AvrDudeComplete complete) { if (value) { txt_stdout->SetValue(wxEmptyString); txt_status->SetLabel(_(L("Flashing in progress. Please do not disconnect the printer!"))); txt_status->SetForegroundColour(GUI::get_label_clr_modified()); port_picker->Disable(); btn_rescan->Disable(); hex_picker->Disable(); btn_close->Disable(); btn_flash->SetLabel(btn_flash_label_flashing); progressbar->SetRange(200); // See progress callback below progressbar->SetValue(0); progress_tasks_done = 0; cancelled = false; } else { auto text_color = wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOWTEXT); port_picker->Enable(); btn_rescan->Enable(); hex_picker->Enable(); btn_close->Enable(); btn_flash->SetLabel(btn_flash_label_ready); txt_status->SetForegroundColour(text_color); progressbar->SetValue(200); switch (complete) { case AC_SUCCESS: txt_status->SetLabel(_(L("Flashing succeeded!"))); break; case AC_FAILURE: txt_status->SetLabel(_(L("Flashing failed. Please see the avrdude log below."))); break; case AC_CANCEL: txt_status->SetLabel(_(L("Flashing cancelled."))); break; } } } void FirmwareDialog::priv::perform_upload() { auto filename = hex_picker->GetPath(); auto port = port_picker->GetValue(); if (filename.IsEmpty() || port.IsEmpty()) { return; } flashing_status(true); std::vector args {{ "-v", "-p", "atmega2560", "-c", "wiring", "-P", port.ToStdString(), "-b", "115200", // XXX: is this ok to hardcode? "-D", "-U", (boost::format("flash:w:%1%:i") % filename.ToStdString()).str() }}; BOOST_LOG_TRIVIAL(info) << "Invoking avrdude, arguments: " << std::accumulate(std::next(args.begin()), args.end(), args[0], [](std::string a, const std::string &b) { return a + ' ' + b; }); // It is ok here to use the q-pointer to the FirmwareDialog // because the dialog ensures it doesn't exit before the background thread is done. auto q = this->q; avrdude = AvrDude() .sys_config(avrdude_config) .args(args) .on_message(std::move([q](const char *msg, unsigned /* size */) { auto evt = new wxCommandEvent(EVT_AVRDUDE, q->GetId()); evt->SetExtraLong(AE_MESSAGE); evt->SetString(msg); wxQueueEvent(q, evt); })) .on_progress(std::move([q](const char * /* task */, unsigned progress) { auto evt = new wxCommandEvent(EVT_AVRDUDE, q->GetId()); evt->SetExtraLong(AE_PRORGESS); evt->SetInt(progress); wxQueueEvent(q, evt); })) .on_complete(std::move([q](int status) { auto evt = new wxCommandEvent(EVT_AVRDUDE, q->GetId()); evt->SetExtraLong(AE_EXIT); evt->SetInt(status); wxQueueEvent(q, evt); })) .run(); } void FirmwareDialog::priv::cancel() { if (avrdude) { cancelled = true; txt_status->SetLabel(_(L("Cancelling..."))); avrdude->cancel(); } } void FirmwareDialog::priv::on_avrdude(const wxCommandEvent &evt) { AvrDudeComplete complete_kind; switch (evt.GetExtraLong()) { case AE_MESSAGE: txt_stdout->AppendText(evt.GetString()); break; case AE_PRORGESS: // We try to track overall progress here. // When uploading the firmware, avrdude first reads a littlebit of status data, // then performs write, then reading (verification). // We Pulse() during the first read and combine progress of the latter two tasks. if (progress_tasks_done == 0) { progressbar->Pulse(); } else { progressbar->SetValue(progress_tasks_done - 100 + evt.GetInt()); } if (evt.GetInt() == 100) { progress_tasks_done += 100; } break; case AE_EXIT: BOOST_LOG_TRIVIAL(info) << "avrdude exit code: " << evt.GetInt(); complete_kind = cancelled ? AC_CANCEL : (evt.GetInt() == 0 ? AC_SUCCESS : AC_FAILURE); flashing_status(false, complete_kind); // Make sure the background thread is collected and the AvrDude object reset if (avrdude) { avrdude->join(); } avrdude.reset(); break; default: break; } } // Public FirmwareDialog::FirmwareDialog(wxWindow *parent) : wxDialog(parent, wxID_ANY, _(L("Firmware flasher")), wxDefaultPosition, wxDefaultSize, wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER), p(new priv(this)) { enum { DIALOG_MARGIN = 15, SPACING = 10, MIN_WIDTH = 600, MIN_HEIGHT = 200, MIN_HEIGHT_EXPANDED = 500, }; wxFont status_font = wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT); status_font.MakeBold(); wxFont mono_font(wxFontInfo().Family(wxFONTFAMILY_TELETYPE)); mono_font.MakeSmaller(); auto *panel = new wxPanel(this); wxBoxSizer *vsizer = new wxBoxSizer(wxVERTICAL); panel->SetSizer(vsizer); auto *label_port_picker = new wxStaticText(panel, wxID_ANY, _(L("Serial port:"))); p->port_picker = new wxComboBox(panel, wxID_ANY); p->btn_rescan = new wxButton(panel, wxID_ANY, _(L("Rescan"))); auto *port_sizer = new wxBoxSizer(wxHORIZONTAL); port_sizer->Add(p->port_picker, 1, wxEXPAND | wxRIGHT, SPACING); port_sizer->Add(p->btn_rescan, 0); auto *label_hex_picker = new wxStaticText(panel, wxID_ANY, _(L("Firmware image:"))); p->hex_picker = new wxFilePickerCtrl(panel, wxID_ANY); auto *label_status = new wxStaticText(panel, wxID_ANY, _(L("Status:"))); p->txt_status = new wxStaticText(panel, wxID_ANY, _(L("Ready"))); p->txt_status->SetFont(status_font); auto *label_progress = new wxStaticText(panel, wxID_ANY, _(L("Progress:"))); p->progressbar = new wxGauge(panel, wxID_ANY, 1, wxDefaultPosition, wxDefaultSize, wxGA_HORIZONTAL | wxGA_SMOOTH); auto *grid = new wxFlexGridSizer(2, SPACING, SPACING); grid->AddGrowableCol(1); grid->Add(label_port_picker, 0, wxALIGN_CENTER_VERTICAL); grid->Add(port_sizer, 0, wxEXPAND); grid->Add(label_hex_picker, 0, wxALIGN_CENTER_VERTICAL); grid->Add(p->hex_picker, 0, wxEXPAND); grid->Add(label_status, 0, wxALIGN_CENTER_VERTICAL); grid->Add(p->txt_status, 0, wxEXPAND); grid->Add(label_progress, 0, wxALIGN_CENTER_VERTICAL); grid->Add(p->progressbar, 1, wxEXPAND | wxALIGN_CENTER_VERTICAL); vsizer->Add(grid, 0, wxEXPAND | wxTOP | wxBOTTOM, SPACING); p->spoiler = new wxCollapsiblePane(panel, wxID_ANY, _(L("Advanced: avrdude output log"))); auto *spoiler_pane = p->spoiler->GetPane(); auto *spoiler_sizer = new wxBoxSizer(wxVERTICAL); p->txt_stdout = new wxTextCtrl(spoiler_pane, wxID_ANY, wxEmptyString, wxDefaultPosition, wxDefaultSize, wxTE_MULTILINE | wxTE_READONLY); p->txt_stdout->SetFont(mono_font); spoiler_sizer->Add(p->txt_stdout, 1, wxEXPAND); spoiler_pane->SetSizer(spoiler_sizer); // The doc says proportion need to be 0 for wxCollapsiblePane. // Experience says it needs to be 1, otherwise things won't get sized properly. vsizer->Add(p->spoiler, 1, wxEXPAND | wxBOTTOM, SPACING); p->btn_close = new wxButton(panel, wxID_CLOSE); p->btn_flash = new wxButton(panel, wxID_ANY, p->btn_flash_label_ready); auto *bsizer = new wxBoxSizer(wxHORIZONTAL); bsizer->Add(p->btn_close); bsizer->AddStretchSpacer(); bsizer->Add(p->btn_flash); vsizer->Add(bsizer, 0, wxEXPAND); auto *topsizer = new wxBoxSizer(wxVERTICAL); topsizer->Add(panel, 1, wxEXPAND | wxALL, DIALOG_MARGIN); SetMinSize(wxSize(MIN_WIDTH, MIN_HEIGHT)); SetSizerAndFit(topsizer); const auto size = GetSize(); SetSize(std::max(size.GetWidth(), static_cast(MIN_WIDTH)), std::max(size.GetHeight(), static_cast(MIN_HEIGHT))); Layout(); p->spoiler->Bind(wxEVT_COLLAPSIBLEPANE_CHANGED, [this](wxCollapsiblePaneEvent &evt) { // Dialog size gets screwed up by wxCollapsiblePane, we need to fix it here if (evt.GetCollapsed()) { this->SetMinSize(wxSize(MIN_WIDTH, MIN_HEIGHT)); } else { this->SetMinSize(wxSize(MIN_WIDTH, MIN_HEIGHT_EXPANDED)); } this->Fit(); this->Layout(); }); p->btn_close->Bind(wxEVT_BUTTON, [this](wxCommandEvent &) { this->Close(); }); p->btn_rescan->Bind(wxEVT_BUTTON, [this](wxCommandEvent &) { this->p->find_serial_ports(); }); p->btn_flash->Bind(wxEVT_BUTTON, [this](wxCommandEvent &) { if (this->p->avrdude) { // Flashing is in progress, ask the user if they're really sure about canceling it wxMessageDialog dlg(this, _(L("Are you sure you want to cancel firmware flashing?\nThis could leave your printer in an unusable state!")), _(L("Confirmation")), wxYES_NO | wxNO_DEFAULT | wxICON_QUESTION); if (dlg.ShowModal() == wxID_YES) { this->p->cancel(); } } else { // Start a flashing task this->p->perform_upload(); } }); Bind(EVT_AVRDUDE, [this](wxCommandEvent &evt) { this->p->on_avrdude(evt); }); Bind(wxEVT_CLOSE_WINDOW, [this](wxCloseEvent &evt) { if (this->p->avrdude) { evt.Veto(); } else { evt.Skip(); } }); p->find_serial_ports(); } FirmwareDialog::~FirmwareDialog() { // Needed bacuse of forward defs } void FirmwareDialog::run(wxWindow *parent) { FirmwareDialog dialog(parent); dialog.ShowModal(); } }