bissen21/Marlin_Firmware
1
0
Fork 0
Code Issues Pull Requests Projects Releases 4 Wiki Activity

Move ExtUI displays to sub-folder (#19070)

Browse Source
This commit is contained in:
Scott Lahteine
2020-08-20 01:38:22 -05:00
parent 7e7e870eae
commit d1aed52280
6 changed files with 36 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files

536
Marlin/src/lcd/extui/anycubic_chiron_lcd.cpp Normal file
View File

@ -0,0 +1,536 @@
/**
* Marlin 3D Printer Firmware
* Copyright (c) 2020 MarlinFirmware [https://github.com/MarlinFirmware/Marlin]
*
* Based on Sprinter and grbl.
* Copyright (c) 2011 Camiel Gubbels / Erik van der Zalm
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*
*/
/**
* anycubic_chiron_lcd.cpp
*
* Anycubic Chiron TFT support for Marlin
*/
#include "../../inc/MarlinConfigPre.h"
#if ENABLED(ANYCUBIC_LCD_CHIRON)
#include "ui_api.h"
#if ENABLED(AUTO_BED_LEVELING_BILINEAR)
#if GRID_MAX_POINTS_X != 5 || GRID_MAX_POINTS_Y != 5
#error ANYCUBIC CHIRON LCD requires a 5x5 bed leveling grid (GRID_MAX_POINTS_X and GRID_MAX_POINTS_Y)
#endif
#else
#error ANYCUBIC CHIRON LCD requires AUTO_BED_LEVELING_BILINEAR enabled
#endif
#if DISABLED(FILAMENT_RUNOUT_SENSOR)
#error ANYCUBIC CHIRON LCD requires FILAMENT_RUNOUT_SENSOR enabled
#endif
#if ENABLED(POWER_LOSS_RECOVERY)
#error ANYCUBIC CHIRON LCD does not currently support POWER_LOSS_RECOVERY
#endif
static bool is_auto_leveling = false;
static bool is_printing_from_sd = false;
static bool is_out_of_filament = false;
static void sendNewLine(void) {
ANYCUBIC_LCD_SERIAL.write('\r');
ANYCUBIC_LCD_SERIAL.write('\n');
}
static void send(const char *str) {
ANYCUBIC_LCD_SERIAL.print(str);
}
static void sendLine(const char *str) {
send(str);
sendNewLine();
}
static void send_P(PGM_P str) {
while (const char c = pgm_read_byte(str++))
ANYCUBIC_LCD_SERIAL.write(c);
}
static void sendLine_P(PGM_P str) {
send_P(str);
sendNewLine();
}
static void sendValue_P(PGM_P prefix, int value) {
send_P(prefix);
ANYCUBIC_LCD_SERIAL.print(value);
}
static void sendValue_P(PGM_P prefix, float value) {
send_P(prefix);
ANYCUBIC_LCD_SERIAL.print(value);
}
static void sendValueLine_P(PGM_P prefix, int value) {
send_P(prefix);
ANYCUBIC_LCD_SERIAL.print(value);
sendNewLine();
}
static void sendValueLine_P(PGM_P prefix, float value) {
send_P(prefix);
ANYCUBIC_LCD_SERIAL.print(value);
sendNewLine();
}
static int parseIntArgument(const char *buffer, char letterId) {
char *p = strchr(buffer, letterId);
if (!p)
return -1;
return atoi(p+1);
}
static float parseFloatArgument(const char *buffer, char letterId) {
char *p = strchr(buffer, letterId);
if (!p)
return NAN;
return strtof(p+1, nullptr);
}
static int mmToHundredths(float x) {
// Round
if (x >= 0)
x += 0.005f;
else
x -= 0.005f;
return (int)(x * 100.0f);
}
static float hundredthsToMm(int x) {
return x / 100.0f;
}
#define SEND_PGM(str) send_P(PSTR(str))
#define SENDLINE_PGM(str) sendLine_P(PSTR(str))
#define SENDVALUE_PGM(prefix, value) sendValue_P(PSTR(prefix), value)
#define SENDVALUELINE_PGM(prefix, value) sendValueLine_P(PSTR(prefix), value)
namespace ExtUI {
static void moveAxis(float delta, feedRate_t feedrate, axis_t axis) {
float pos = getAxisPosition_mm(axis);
pos += delta;
setAxisPosition_mm(pos, axis, feedrate);
}
static void handleCmd(const char *rx) {
static FileList fileList;
static char selectedFileShortName[8+1+3+1];
if (rx[0] != 'A') {
SERIAL_ECHOPGM("Unexpected RX: ");
SERIAL_ECHOLN(rx);
return;
}
const int cmd = atoi(&rx[1]);
// Uncomment for debugging RX
//if (cmd > 7 && cmd != 20) {
// SERIAL_ECHOPGM("RX: ");
// SERIAL_ECHOLN(rx);
//}
switch (cmd) {
case 0: // Get Hotend Actual Temperature
SENDVALUELINE_PGM("A0V ", (int)getActualTemp_celsius(E0));
break;
case 1: // Get Hotend Target Temperature
SENDVALUELINE_PGM("A1V ", (int)getTargetTemp_celsius(E0));
break;
case 2: // Get Bed Actual Temperature
SENDVALUELINE_PGM("A2V ", (int)getActualTemp_celsius(BED));
break;
case 3: // Get Bed Target Temperature
SENDVALUELINE_PGM("A3V ", (int)getTargetTemp_celsius(BED));
break;
case 4: // Get Fan Speed
SENDVALUELINE_PGM("A4V ", (int)getTargetFan_percent(FAN0));
break;
case 5: // Get Current Coordinates
SENDVALUE_PGM("A5V X: ", getAxisPosition_mm(X));
SENDVALUE_PGM(" Y: ", getAxisPosition_mm(Y));
SENDVALUE_PGM(" Z: ", getAxisPosition_mm(Z));
sendNewLine();
break;
case 6: // Get SD Card Print Status
if (isPrintingFromMedia())
SENDVALUELINE_PGM("A6V ", (int)getProgress_percent());
else
SENDLINE_PGM("A6V ---");
break;
case 7: // Get Printing Time
if (isPrinting()) {
const int totalMinutes = getProgress_seconds_elapsed() / 60;
SENDVALUE_PGM("A7V ", (int)(totalMinutes/60));
SENDVALUE_PGM(" H ", (int)(totalMinutes%60));
SENDLINE_PGM(" M");
} else {
SENDLINE_PGM("A7V 999:999");
}
break;
case 8: // Get SD Card File List
if (isMediaInserted()) {
const int startIndex = parseIntArgument(rx, 'S');
SENDLINE_PGM("FN ");
for (int i = 0, fileIndex = 0, numFiles = 0; i < (int)fileList.count() && numFiles < 4; i++) {
fileList.seek(i);
if (!fileList.isDir()) {
if (fileIndex >= startIndex) {
sendLine(fileList.shortFilename());
sendLine(fileList.longFilename());
numFiles++;
}
fileIndex++;
}
}
SENDLINE_PGM("END");
} else {
SENDLINE_PGM("J02");
}
break;
case 9: // Pause SD Card Print
if (isPrintingFromMedia()) {
pausePrint();
is_printing_from_sd = false;
SENDLINE_PGM("J05");
} else {
SENDLINE_PGM("J16"); // Print stopped
}
break;
case 10: // Resume SD Card Print
if (is_out_of_filament) {
is_out_of_filament = false;
// Filament change did eject the old filament automatically,
// now continue and load the new one
setUserConfirmed();
SENDLINE_PGM("J04"); // Printing from SD card
} else if (isPrintingFromMediaPaused()) {
resumePrint();
SENDLINE_PGM("J04"); // Printing from SD card
}
break;
case 11: // Stop SD Card Print
if (isPrintingFromMedia()) {
stopPrint();
is_printing_from_sd = false;
SENDLINE_PGM("J16"); // Print stopped
}
break;
//case 12: // Kill
// break;
case 13: // Select File
if (!isPrinting()) {
// Store selected file name
char *p = strchr(rx, ' ');
if (p != nullptr && strlen(p+1) < sizeof(selectedFileShortName)) {
strcpy(selectedFileShortName, p+1);
SENDLINE_PGM("J20"); // Open succeeded
}
else
SENDLINE_PGM("J21"); // Open failed
}
break;
case 14: // Start Print
if (!isPrinting() && strcmp(selectedFileShortName, "") != 0) {
printFile(selectedFileShortName);
is_printing_from_sd = true;
SENDLINE_PGM("J04"); // Printing from SD card
}
break;
case 15: // Resume from power outage
// This is not supported, just report print as completed
SENDLINE_PGM("J16"); // Print stopped
break;
case 16: // Set Hotend Target Temperature
{
int temp = parseIntArgument(rx, 'S');
if (temp >= 0)
setTargetTemp_celsius(temp, E0);
}
break;
case 17: // Set Bed Target Temperature
{
int temp = parseIntArgument(rx, 'S');
if (temp >= 0)
setTargetTemp_celsius(temp, BED);
}
break;
case 18: // Set Fan Speed
{
int temp = parseIntArgument(rx, 'S');
if (temp >= 0)
setTargetFan_percent(temp, FAN0);
}
break;
case 19: // Disable Motors
injectCommands_P(PSTR("M84"));
break;
case 20: // Get/Set Printing Speed
{
int newPerc = parseIntArgument(rx, 'S');
if (newPerc >= 0)
setFeedrate_percent(newPerc);
else
SENDVALUELINE_PGM("A20V ", (int)getFeedrate_percent());
}
break;
case 21: // Home axes
if (!isPrinting()) {
const bool hasX = strchr(rx, 'X') != nullptr,
hasY = strchr(rx, 'Y') != nullptr,
hasZ = strchr(rx, 'Z') != nullptr,
hasC = strchr(rx, 'C') != nullptr;
if (hasX || hasY || hasZ) {
if (hasX) injectCommands_P(PSTR("G28 X"));
if (hasY) injectCommands_P(PSTR("G28 Y"));
if (hasZ) injectCommands_P(PSTR("G28 Z"));
} else if (hasC) {
injectCommands_P(PSTR("G28"));
}
}
break;
case 22: // Move axes
if (!isPrinting()) {
const int feedrate = parseIntArgument(rx, 'F') / 60;
float delta;
if (!isnan(delta = parseFloatArgument(rx, 'X')))
moveAxis(delta, feedrate, X);
else if (!isnan(delta = parseFloatArgument(rx, 'Y')))
moveAxis(delta, feedrate, Y);
else if (!isnan(delta = parseFloatArgument(rx, 'Z')))
moveAxis(delta, feedrate, Z);
}
break;
case 23: // Preheat PLA
setTargetTemp_celsius(PREHEAT_1_TEMP_HOTEND, E0);
setTargetTemp_celsius(PREHEAT_1_TEMP_BED, BED);
SENDLINE_PGM("OK");
break;
case 24: // Preheat ABS
setTargetTemp_celsius(PREHEAT_2_TEMP_HOTEND, E0);
setTargetTemp_celsius(PREHEAT_2_TEMP_BED, BED);
SENDLINE_PGM("OK");
break;
case 25: // Cool down
setTargetTemp_celsius(0, E0);
setTargetTemp_celsius(0, BED);
SENDLINE_PGM("J12");
break;
case 26: // Refresh SD Card
fileList.refresh();
break;
//case 27: // Adjust Servo Angles
// break;
//case 28: // Filament Test
// break;
case 29: // Get Bed Autolevel Grid
{
int x = parseIntArgument(rx, 'X'),
y = parseIntArgument(rx, 'Y');
if (x != -1 && y != -1) {
xy_uint8_t coord;
coord.set(x, y);
const int value = mmToHundredths(getMeshPoint(coord));
SENDVALUELINE_PGM("A29V ", value);
}
}
break;
case 30: // Autolevel
if (strchr(rx, 'S')) { // Autoleveling started by clicking "PROBE" and then "OK"
// Note:
// We check for completion by monitoring the command queue.
// Since it will become empty *while* processing the last injected command,
// we enqueue an extra 10ms delay so we can the determine when all the others
// have completed.
if (isMachineHomed())
injectCommands_P(PSTR("G29\nG4 P10"));
else
injectCommands_P(PSTR("G28\nG29\nG4 P10"));
is_auto_leveling = true;
} else { // Entering Autoleveling screen
if (isPrinting())
SENDLINE_PGM("J24"); // Disallow autoleveling
else
SENDLINE_PGM("J26"); // Allow autoleveling
}
break;
case 31: // Set Bed Autolevel Z offset
if (strchr(rx, 'G')) { // Get
SENDVALUELINE_PGM("A31V ", getZOffset_mm());
} else if (strchr(rx, 'S')) { // Set
float delta = parseFloatArgument(rx, 'S');
delta = constrain(delta, -1.0, 1.0);
setZOffset_mm(getZOffset_mm() + delta);
SENDVALUELINE_PGM("A31V ", getZOffset_mm());
} else if (strchr(rx, 'D')) { // Save
injectCommands_P(PSTR("M500"));
}
break;
//case 32: // ?
// break;
case 33: // Get Version Info
SENDLINE_PGM("J33 " SHORT_BUILD_VERSION);
break;
case 34: // Set Bed Autolevel Grid
{
int x = parseIntArgument(rx, 'X'),
y = parseIntArgument(rx, 'Y'),
v = parseIntArgument(rx, 'V');
if (x != -1 && y != -1 && v != -1) { // Set new value
float value = hundredthsToMm(v);
value = constrain(value, -10, 10);
xy_uint8_t coord;
coord.set(x, y);
setMeshPoint(coord, value);
} else if (strchr(rx, 'S')) { // Save (apply new values)
injectCommands_P(PSTR("M500"));
} else if (strchr(rx, 'C')) { // Cancel (discard new values)
injectCommands_P(PSTR("M501"));
}
}
break;
}
}
#define RX_LEN_MAX 63
static void parseSerialRx() {
static char rxBuffer[RX_LEN_MAX+1];
static uint8_t rxLen = 0;
while (ANYCUBIC_LCD_SERIAL.available()) {
const char c = ANYCUBIC_LCD_SERIAL.read();
switch (c) {
case '\r': case '\n':
if (rxLen > 0 && rxLen <= RX_LEN_MAX) {
rxBuffer[rxLen] = '\0'; // Terminate string
handleCmd(rxBuffer);
}
rxLen = 0;
break;
default:
if (rxLen < RX_LEN_MAX)
rxBuffer[rxLen++] = c;
else {
rxLen = 0xFF; // Overrun
SERIAL_ECHOPGM("Warning: dropping long received line");
}
break;
}
}
}
static void detectPrintFromSdCompletion() {
// Note: printFile() queues some commands that actually start the print, so isPrintingFromMedia()
// initially returns false
if (is_printing_from_sd && !commandsInQueue() && !isPrintingFromMedia()) {
is_printing_from_sd = false;
SENDLINE_PGM("J14"); // Print done
}
}
static void detectAutolevelingCompletion() {
if (is_auto_leveling && !commandsInQueue()) {
is_auto_leveling = false;
injectCommands_P(PSTR("M500"));
SENDLINE_PGM("J25"); // Autoleveling done
}
}
void onStartup() {
ANYCUBIC_LCD_SERIAL.begin(115200);
sendNewLine();
SENDLINE_PGM("J17"); // Reset
delay_ms(10);
SENDLINE_PGM("J12"); // Ready
}
void onIdle() {
parseSerialRx();
detectAutolevelingCompletion();
detectPrintFromSdCompletion();
}
void onPrinterKilled(PGM_P const error, PGM_P const component) { }
void onMediaInserted() {
SENDLINE_PGM("J00"); // SD Inserted
}
void onMediaError() { }
void onMediaRemoved() {
SENDLINE_PGM("J01"); // SD Removed
}
void onPlayTone(const uint16_t frequency, const uint16_t duration) {
tone(BEEPER_PIN, frequency, duration);
}
void onPrintTimerStarted() { }
void onPrintTimerPaused() { }
void onPrintTimerStopped() { }
void onFilamentRunout(const extruder_t extruder) {
is_out_of_filament = true;
SENDLINE_PGM("J23"); // Filament runout
SENDLINE_PGM("J18"); // Print paused
// Note: printer will unload filament automatically
}
void onUserConfirmRequired(const char * const msg) { }
void onStatusChanged(const char * const msg) { }
void onFactoryReset() { }
void onStoreSettings(char *buff) { }
void onLoadSettings(const char *buff) { }
void onConfigurationStoreWritten(bool success) { }
void onConfigurationStoreRead(bool success) { }
void onMeshUpdate(const int8_t xpos, const int8_t ypos, const float zval) { }
#if ENABLED(POWER_LOSS_RECOVERY)
void onPowerLossResume() { }
#endif
#if HAS_PID_HEATING
void onPidTuning(const result_t rst) { }
#endif
}
#endif // ANYCUBIC_LCD_CHIRON

104
Marlin/src/lcd/extui/anycubic_i3mega_lcd.cpp Normal file
View File

@ -0,0 +1,104 @@
/**
* Marlin 3D Printer Firmware
* Copyright (c) 2020 MarlinFirmware [https://github.com/MarlinFirmware/Marlin]
*
* Based on Sprinter and grbl.
* Copyright (c) 2011 Camiel Gubbels / Erik van der Zalm
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*
*/
/**
* anycubic_i3mega_lcd.cpp
*/
#include "../../inc/MarlinConfigPre.h"
#if ENABLED(ANYCUBIC_LCD_I3MEGA)
#include "lib/anycubic_i3mega/anycubic_i3mega_lcd.h"
#include "ui_api.h"
#include <Arduino.h> // for the ::tone() call
namespace ExtUI {
void onStartup() { AnycubicTFT.OnSetup(); }
void onIdle() { AnycubicTFT.OnCommandScan(); }
void onPrinterKilled(PGM_P const error, PGM_P const component) { AnycubicTFT.OnKillTFT(); }
void onMediaInserted() { AnycubicTFT.OnSDCardStateChange(true); }
void onMediaError() { AnycubicTFT.OnSDCardError(); }
void onMediaRemoved() { AnycubicTFT.OnSDCardStateChange(false); }
void onPlayTone(const uint16_t frequency, const uint16_t duration) {
#if ENABLED(SPEAKER)
::tone(BEEPER_PIN, frequency, duration);
#endif
}
void onPrintTimerStarted() { AnycubicTFT.OnPrintTimerStarted(); }
void onPrintTimerPaused() { AnycubicTFT.OnPrintTimerPaused(); }
void onPrintTimerStopped() { AnycubicTFT.OnPrintTimerStopped(); }
void onFilamentRunout(const extruder_t extruder) { AnycubicTFT.OnFilamentRunout(); }
void onUserConfirmRequired(const char * const msg) { AnycubicTFT.OnUserConfirmRequired(msg); }
void onStatusChanged(const char * const msg) {}
void onFactoryReset() {}
void onStoreSettings(char *buff) {
// Called when saving to EEPROM (i.e. M500). If the ExtUI needs
// permanent data to be stored, it can write up to eeprom_data_size bytes
// into buff.
// Example:
// static_assert(sizeof(myDataStruct) <= ExtUI::eeprom_data_size);
// memcpy(buff, &myDataStruct, sizeof(myDataStruct));
}
void onLoadSettings(const char *buff) {
// Called while loading settings from EEPROM. If the ExtUI
// needs to retrieve data, it should copy up to eeprom_data_size bytes
// from buff
// Example:
// static_assert(sizeof(myDataStruct) <= ExtUI::eeprom_data_size);
// memcpy(&myDataStruct, buff, sizeof(myDataStruct));
}
void onConfigurationStoreWritten(bool success) {
// Called after the entire EEPROM has been written,
// whether successful or not.
}
void onConfigurationStoreRead(bool success) {
// Called after the entire EEPROM has been read,
// whether successful or not.
}
void onMeshUpdate(const int8_t xpos, const int8_t ypos, const float zval) {
// Called when any mesh points are updated
}
#if ENABLED(POWER_LOSS_RECOVERY)
void onPowerLossResume() {
// Called on resume from power-loss
}
#endif
#if HAS_PID_HEATING
void onPidTuning(const result_t rst) {
// Called for temperature PID tuning result
}
#endif
}
#endif // ANYCUBIC_LCD_I3MEGA

150
Marlin/src/lcd/extui/dgus_lcd.cpp Normal file
View File

@ -0,0 +1,150 @@
/**
* Marlin 3D Printer Firmware
* Copyright (c) 2020 MarlinFirmware [https://github.com/MarlinFirmware/Marlin]
*
* Based on Sprinter and grbl.
* Copyright (c) 2011 Camiel Gubbels / Erik van der Zalm
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*
*/
/**
* dgus_lcd.cpp
*
* DGUS implementation for Marlin by coldtobi, Feb-May 2019
*/
#include "../../inc/MarlinConfigPre.h"
#if HAS_DGUS_LCD
#include "ui_api.h"
#include "lib/dgus/DGUSDisplay.h"
#include "lib/dgus/DGUSDisplayDef.h"
#include "lib/dgus/DGUSScreenHandler.h"
extern const char NUL_STR[];
namespace ExtUI {
void onStartup() {
dgusdisplay.InitDisplay();
ScreenHandler.UpdateScreenVPData();
}
void onIdle() { ScreenHandler.loop(); }
void onPrinterKilled(PGM_P const error, PGM_P const component) {
ScreenHandler.sendinfoscreen(GET_TEXT(MSG_HALTED), error, NUL_STR, GET_TEXT(MSG_PLEASE_RESET), true, true, true, true);
ScreenHandler.GotoScreen(DGUSLCD_SCREEN_KILL);
while (!ScreenHandler.loop()); // Wait while anything is left to be sent
}
void onMediaInserted() { TERN_(SDSUPPORT, ScreenHandler.SDCardInserted()); }
void onMediaError() { TERN_(SDSUPPORT, ScreenHandler.SDCardError()); }
void onMediaRemoved() { TERN_(SDSUPPORT, ScreenHandler.SDCardRemoved()); }
void onPlayTone(const uint16_t frequency, const uint16_t duration) {}
void onPrintTimerStarted() {}
void onPrintTimerPaused() {}
void onPrintTimerStopped() {}
void onFilamentRunout(const extruder_t extruder) {}
void onUserConfirmRequired(const char * const msg) {
if (msg) {
ScreenHandler.sendinfoscreen(PSTR("Please confirm."), nullptr, msg, nullptr, true, true, false, true);
ScreenHandler.SetupConfirmAction(ExtUI::setUserConfirmed);
ScreenHandler.GotoScreen(DGUSLCD_SCREEN_POPUP);
}
else if (ScreenHandler.getCurrentScreen() == DGUSLCD_SCREEN_POPUP ) {
ScreenHandler.SetupConfirmAction(nullptr);
ScreenHandler.PopToOldScreen();
}
}
void onStatusChanged(const char * const msg) { ScreenHandler.setstatusmessage(msg); }
void onFactoryReset() {}
void onStoreSettings(char *buff) {
// Called when saving to EEPROM (i.e. M500). If the ExtUI needs
// permanent data to be stored, it can write up to eeprom_data_size bytes
// into buff.
// Example:
// static_assert(sizeof(myDataStruct) <= ExtUI::eeprom_data_size);
// memcpy(buff, &myDataStruct, sizeof(myDataStruct));
}
void onLoadSettings(const char *buff) {
// Called while loading settings from EEPROM. If the ExtUI
// needs to retrieve data, it should copy up to eeprom_data_size bytes
// from buff
// Example:
// static_assert(sizeof(myDataStruct) <= ExtUI::eeprom_data_size);
// memcpy(&myDataStruct, buff, sizeof(myDataStruct));
}
void onConfigurationStoreWritten(bool success) {
// Called after the entire EEPROM has been written,
// whether successful or not.
}
void onConfigurationStoreRead(bool success) {
// Called after the entire EEPROM has been read,
// whether successful or not.
}
#if HAS_MESH
void onMeshUpdate(const int8_t xpos, const int8_t ypos, const float zval) {
// Called when any mesh points are updated
}
void onMeshUpdate(const int8_t xpos, const int8_t ypos, const ExtUI::probe_state_t state) {
// Called to indicate a special condition
}
#endif
#if ENABLED(POWER_LOSS_RECOVERY)
void onPowerLossResume() {
// Called on resume from power-loss
ScreenHandler.GotoScreen(DGUSLCD_SCREEN_POWER_LOSS);
}
#endif
#if HAS_PID_HEATING
void onPidTuning(const result_t rst) {
// Called for temperature PID tuning result
switch (rst) {
case PID_BAD_EXTRUDER_NUM:
ScreenHandler.setstatusmessagePGM(GET_TEXT(MSG_PID_BAD_EXTRUDER_NUM));
break;
case PID_TEMP_TOO_HIGH:
ScreenHandler.setstatusmessagePGM(GET_TEXT(MSG_PID_TEMP_TOO_HIGH));
break;
case PID_TUNING_TIMEOUT:
ScreenHandler.setstatusmessagePGM(GET_TEXT(MSG_PID_TIMEOUT));
break;
case PID_DONE:
ScreenHandler.setstatusmessagePGM(GET_TEXT(MSG_PID_AUTOTUNE_DONE));
break;
}
ScreenHandler.GotoScreen(DGUSLCD_SCREEN_MAIN);
}
#endif
}
#endif // HAS_DGUS_LCD

115
Marlin/src/lcd/extui/example.cpp Normal file
View File

@ -0,0 +1,115 @@
/*********************
* example.cpp *
*********************/
/****************************************************************************
* Written By Marcio Teixeira 2018 - Aleph Objects, Inc. *
* *
* This program is free software: you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation, either version 3 of the License, or *
* (at your option) any later version. *
* *
* This program is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU General Public License for more details. *
* *
* To view a copy of the GNU General Public License, go to the following *
* location: <https://www.gnu.org/licenses/>. *
****************************************************************************/
#include "../../inc/MarlinConfigPre.h"
#if BOTH(EXTUI_EXAMPLE, EXTENSIBLE_UI)
#include "ui_api.h"
// To implement a new UI, complete the functions below and
// read or update Marlin's state using the methods in the
// ExtUI methods in "../ui_api.h"
//
// Although it may be possible to access other state
// variables from Marlin, using the API here possibly
// helps ensure future compatibility.
namespace ExtUI {
void onStartup() {
/* Initialize the display module here. The following
* routines are available for access to the GPIO pins:
*
* SET_OUTPUT(pin)
* SET_INPUT_PULLUP(pin)
* SET_INPUT(pin)
* WRITE(pin,value)
* READ(pin)
*/
}
void onIdle() {}
void onPrinterKilled(PGM_P const error, PGM_P const component) {}
void onMediaInserted() {};
void onMediaError() {};
void onMediaRemoved() {};
void onPlayTone(const uint16_t frequency, const uint16_t duration) {}
void onPrintTimerStarted() {}
void onPrintTimerPaused() {}
void onPrintTimerStopped() {}
void onFilamentRunout(const extruder_t extruder) {}
void onUserConfirmRequired(const char * const msg) {}
void onStatusChanged(const char * const msg) {}
void onFactoryReset() {}
void onStoreSettings(char *buff) {
// Called when saving to EEPROM (i.e. M500). If the ExtUI needs
// permanent data to be stored, it can write up to eeprom_data_size bytes
// into buff.
// Example:
// static_assert(sizeof(myDataStruct) <= ExtUI::eeprom_data_size);
// memcpy(buff, &myDataStruct, sizeof(myDataStruct));
}
void onLoadSettings(const char *buff) {
// Called while loading settings from EEPROM. If the ExtUI
// needs to retrieve data, it should copy up to eeprom_data_size bytes
// from buff
// Example:
// static_assert(sizeof(myDataStruct) <= ExtUI::eeprom_data_size);
// memcpy(&myDataStruct, buff, sizeof(myDataStruct));
}
void onConfigurationStoreWritten(bool success) {
// Called after the entire EEPROM has been written,
// whether successful or not.
}
void onConfigurationStoreRead(bool success) {
// Called after the entire EEPROM has been read,
// whether successful or not.
}
#if HAS_MESH
void onMeshUpdate(const int8_t xpos, const int8_t ypos, const float zval) {
// Called when any mesh points are updated
}
void onMeshUpdate(const int8_t xpos, const int8_t ypos, const ExtUI::probe_state_t state) {
// Called to indicate a special condition
}
#endif
#if ENABLED(POWER_LOSS_RECOVERY)
void onPowerLossResume() {
// Called on resume from power-loss
}
#endif
#if HAS_PID_HEATING
void onPidTuning(const result_t rst) {
// Called for temperature PID tuning result
}
#endif
}
#endif // EXTUI_EXAMPLE && EXTENSIBLE_UI

536
Marlin/src/lcd/extui/malyan_lcd.cpp Normal file
View File

@ -0,0 +1,536 @@
/**
* Marlin 3D Printer Firmware
* Copyright (c) 2020 MarlinFirmware [https://github.com/MarlinFirmware/Marlin]
*
* Based on Sprinter and grbl.
* Copyright (c) 2011 Camiel Gubbels / Erik van der Zalm
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*
*/
/**
* malyan_lcd.cpp
*
* LCD implementation for Malyan's LCD, a separate ESP8266 MCU running
* on Serial1 for the M200 board. This module outputs a pseudo-gcode
* wrapped in curly braces which the LCD implementation translates into
* actual G-code commands.
*
* Added to Marlin for Mini/Malyan M200
* Unknown commands as of Jan 2018: {H:}
* Not currently implemented:
* {E:} when sent by LCD. Meaning unknown.
*
* Notes for connecting to boards that are not Malyan:
* The LCD is 3.3v, so if powering from a RAMPS 1.4 board or
* other 5v/12v board, use a buck converter to power the LCD and
* the 3.3v side of a logic level shifter. Aux1 on the RAMPS board
* has Serial1 and 12v, making it perfect for this.
* Copyright (c) 2017 Jason Nelson (xC0000005)
*/
#include "../../inc/MarlinConfigPre.h"
#if ENABLED(MALYAN_LCD)
#define DEBUG_MALYAN_LCD
#include "ui_api.h"
#include "../ultralcd.h"
#include "../../sd/cardreader.h"
#include "../../module/temperature.h"
#include "../../module/stepper.h"
#include "../../module/motion.h"
#include "../../libs/duration_t.h"
#include "../../module/printcounter.h"
#include "../../gcode/queue.h"
#define DEBUG_OUT ENABLED(DEBUG_MALYAN_LCD)
#include "../../core/debug_out.h"
// On the Malyan M200, this will be Serial1. On a RAMPS board,
// it might not be.
#define LCD_SERIAL Serial1
// This is based on longest sys command + a filename, plus some buffer
// in case we encounter some data we don't recognize
// There is no evidence a line will ever be this long, but better safe than sorry
#define MAX_CURLY_COMMAND (32 + LONG_FILENAME_LENGTH) * 2
// Track incoming command bytes from the LCD
uint16_t inbound_count;
// For sending print completion messages
bool last_printing_status = false;
// Everything written needs the high bit set.
void write_to_lcd_P(PGM_P const message) {
char encoded_message[MAX_CURLY_COMMAND];
uint8_t message_length = _MIN(strlen_P(message), sizeof(encoded_message));
LOOP_L_N(i, message_length)
encoded_message[i] = pgm_read_byte(&message[i]) | 0x80;
LCD_SERIAL.Print::write(encoded_message, message_length);
}
void write_to_lcd(const char * const message) {
char encoded_message[MAX_CURLY_COMMAND];
const uint8_t message_length = _MIN(strlen(message), sizeof(encoded_message));
LOOP_L_N(i, message_length)
encoded_message[i] = message[i] | 0x80;
LCD_SERIAL.Print::write(encoded_message, message_length);
}
// {E:<msg>} is for error states.
void set_lcd_error_P(PGM_P const error, PGM_P const component=nullptr) {
write_to_lcd_P(PSTR("{E:"));
write_to_lcd_P(error);
if (component) {
write_to_lcd_P(PSTR(" "));
write_to_lcd_P(component);
}
write_to_lcd_P(PSTR("}"));
}
/**
* Process an LCD 'C' command.
* These are currently all temperature commands
* {C:T0190}
* Set temp for hotend to 190
* {C:P050}
* Set temp for bed to 50
*
* {C:S09} set feedrate to 90 %.
* {C:S12} set feedrate to 120 %.
*
* the command portion begins after the :
*/
void process_lcd_c_command(const char* command) {
const int target_val = command[1] ? atoi(command + 1) : -1;
if (target_val < 0) {
DEBUG_ECHOLNPAIR("UNKNOWN C COMMAND ", command);
return;
}
switch (command[0]) {
case 'C': // Cope with both V1 early rev and later LCDs.
case 'S':
feedrate_percentage = target_val * 10;
LIMIT(feedrate_percentage, 10, 999);
break;
case 'T':
// Sometimes the LCD will send commands to turn off both extruder and bed, though
// this should not happen since the printing screen is up. Better safe than sorry.
if (!print_job_timer.isRunning() || target_val > 0)
ExtUI::setTargetTemp_celsius(target_val, ExtUI::extruder_t::E0);
break;
#if HAS_HEATED_BED
case 'P': ExtUI::setTargetTemp_celsius(target_val, ExtUI::heater_t::BED); break;
#endif
default: DEBUG_ECHOLNPAIR("UNKNOWN C COMMAND ", command);
}
}
/**
* Process an LCD 'B' command.
* {B:0} results in: {T0:008/195}{T1:000/000}{TP:000/000}{TQ:000C}{TT:000000}
* T0/T1 are hot end temperatures, TP is bed, TQ is percent, and TT is probably
* time remaining (HH:MM:SS). The UI can't handle displaying a second hotend,
* but the stock firmware always sends it, and it's always zero.
*/
void process_lcd_eb_command(const char* command) {
char elapsed_buffer[10];
static uint8_t iteration = 0;
duration_t elapsed;
switch (command[0]) {
case '0': {
elapsed = print_job_timer.duration();
sprintf_P(elapsed_buffer, PSTR("%02u%02u%02u"), uint16_t(elapsed.hour()), uint16_t(elapsed.minute()) % 60, uint16_t(elapsed.second()) % 60);
char message_buffer[MAX_CURLY_COMMAND];
uint8_t done_pct = print_job_timer.isRunning() ? (iteration * 10) : 100;
iteration = (iteration + 1) % 10; // Provide progress animation
#if ENABLED(SDSUPPORT)
if (ExtUI::isPrintingFromMedia() || ExtUI::isPrintingFromMediaPaused())
done_pct = card.percentDone();
#endif
sprintf_P(message_buffer,
PSTR("{T0:%03i/%03i}{T1:000/000}{TP:%03i/%03i}{TQ:%03i}{TT:%s}"),
int(thermalManager.degHotend(0)), thermalManager.degTargetHotend(0),
#if HAS_HEATED_BED
int(thermalManager.degBed()), thermalManager.degTargetBed(),
#else
0, 0,
#endif
#if ENABLED(SDSUPPORT)
done_pct,
#else
0,
#endif
elapsed_buffer
);
write_to_lcd(message_buffer);
} break;
default: DEBUG_ECHOLNPAIR("UNKNOWN E/B COMMAND ", command);
}
}
/**
* Process an LCD 'J' command.
* These are currently all movement commands.
* The command portion begins after the :
* Move X Axis
*
* {J:E}{J:X-200}{J:E}
* {J:E}{J:X+200}{J:E}
* X, Y, Z, A (extruder)
*/
template<typename T>
void j_move_axis(const char* command, const T axis) {
const float dist = atof(command + 1) / 10.0;
ExtUI::setAxisPosition_mm(ExtUI::getAxisPosition_mm(axis) + dist, axis);
};
void process_lcd_j_command(const char* command) {
switch (command[0]) {
case 'E': break;
case 'A': j_move_axis<ExtUI::extruder_t>(command, ExtUI::extruder_t::E0); break;
case 'Y': j_move_axis<ExtUI::axis_t>(command, ExtUI::axis_t::Y); break;
case 'Z': j_move_axis<ExtUI::axis_t>(command, ExtUI::axis_t::Z); break;
case 'X': j_move_axis<ExtUI::axis_t>(command, ExtUI::axis_t::X); break;
default: DEBUG_ECHOLNPAIR("UNKNOWN J COMMAND ", command);
}
}
/**
* Process an LCD 'P' command, related to homing and printing.
* Cancel:
* {P:X}
*
* Home all axes:
* {P:H}
*
* Print a file:
* {P:000}
* The File number is specified as a three digit value.
* Printer responds with:
* {PRINTFILE:Mini_SNES_Bottom.gcode}
* {SYS:BUILD}echo:Now fresh file: Mini_SNES_Bottom.gcode
* File opened: Mini_SNES_Bottom.gcode Size: 5805813
* File selected
* {SYS:BUILD}
* T:-2526.8 E:0
* T:-2533.0 E:0
* T:-2537.4 E:0
* Note only the curly brace stuff matters.
*/
void process_lcd_p_command(const char* command) {
switch (command[0]) {
case 'P':
ExtUI::pausePrint();
write_to_lcd_P(PSTR("{SYS:PAUSED}"));
break;
case 'R':
ExtUI::resumePrint();
write_to_lcd_P(PSTR("{SYS:RESUMED}"));
break;
case 'X':
write_to_lcd_P(PSTR("{SYS:CANCELING}"));
ExtUI::stopPrint();
write_to_lcd_P(PSTR("{SYS:STARTED}"));
break;
case 'H': queue.enqueue_now_P(G28_STR); break; // Home all axes
default: {
#if ENABLED(SDSUPPORT)
// Print file 000 - a three digit number indicating which
// file to print in the SD card. If it's a directory,
// then switch to the directory.
// Find the name of the file to print.
// It's needed to echo the PRINTFILE option.
// The {S:L} command should've ensured the SD card was mounted.
card.selectFileByIndex(atoi(command));
// There may be a difference in how V1 and V2 LCDs handle subdirectory
// prints. Investigate more. This matches the V1 motion controller actions
// but the V2 LCD switches to "print" mode on {SYS:DIR} response.
if (card.flag.filenameIsDir) {
card.cd(card.filename);
write_to_lcd_P(PSTR("{SYS:DIR}"));
}
else {
char message_buffer[MAX_CURLY_COMMAND];
sprintf_P(message_buffer, PSTR("{PRINTFILE:%s}"), card.longest_filename());
write_to_lcd(message_buffer);
write_to_lcd_P(PSTR("{SYS:BUILD}"));
card.openAndPrintFile(card.filename);
}
#endif
} break; // default
} // switch
}
/**
* Handle an lcd 'S' command
* {S:I} - Temperature request
* {T0:999/000}{T1:000/000}{TP:004/000}
*
* {S:L} - File Listing request
* Printer Response:
* {FILE:buttons.gcode}
* {FILE:update.bin}
* {FILE:nupdate.bin}
* {FILE:fcupdate.flg}
* {SYS:OK}
*/
void process_lcd_s_command(const char* command) {
switch (command[0]) {
case 'I': {
// temperature information
char message_buffer[MAX_CURLY_COMMAND];
sprintf_P(message_buffer, PSTR("{T0:%03i/%03i}{T1:000/000}{TP:%03i/%03i}"),
int(thermalManager.degHotend(0)), thermalManager.degTargetHotend(0),
#if HAS_HEATED_BED
int(thermalManager.degBed()), thermalManager.degTargetBed()
#else
0, 0
#endif
);
write_to_lcd(message_buffer);
} break;
case 'L': {
#if ENABLED(SDSUPPORT)
if (!card.isMounted()) card.mount();
// A more efficient way to do this would be to
// implement a callback in the ls_SerialPrint code, but
// that requires changes to the core cardreader class that
// would not benefit the majority of users. Since one can't
// select a file for printing during a print, there's
// little reason not to do it this way.
char message_buffer[MAX_CURLY_COMMAND];
uint16_t file_count = card.get_num_Files();
for (uint16_t i = 0; i < file_count; i++) {
card.selectFileByIndex(i);
sprintf_P(message_buffer, card.flag.filenameIsDir ? PSTR("{DIR:%s}") : PSTR("{FILE:%s}"), card.longest_filename());
write_to_lcd(message_buffer);
}
write_to_lcd_P(PSTR("{SYS:OK}"));
#endif
} break;
default: DEBUG_ECHOLNPAIR("UNKNOWN S COMMAND ", command);
}
}
/**
* Receive a curly brace command and translate to G-code.
* Currently {E:0} is not handled. Its function is unknown,
* but it occurs during the temp window after a sys build.
*/
void process_lcd_command(const char* command) {
const char *current = command;
byte command_code = *current++;
if (*current == ':') {
current++; // skip the :
switch (command_code) {
case 'S': process_lcd_s_command(current); break;
case 'J': process_lcd_j_command(current); break;
case 'P': process_lcd_p_command(current); break;
case 'C': process_lcd_c_command(current); break;
case 'B':
case 'E': process_lcd_eb_command(current); break;
default: DEBUG_ECHOLNPAIR("UNKNOWN COMMAND ", command);
}
}
else
DEBUG_ECHOLNPAIR("UNKNOWN COMMAND FORMAT ", command);
}
//
// Parse LCD commands mixed with G-Code
//
void parse_lcd_byte(const byte b) {
static char inbound_buffer[MAX_CURLY_COMMAND];
static uint8_t parsing = 0; // Parsing state
static bool prevcr = false; // Was the last c a CR?
const char c = b & 0x7F;
if (parsing) {
const bool is_lcd = parsing == 1; // 1 for LCD
if ( ( is_lcd && c == '}') // Closing brace on LCD command
|| (!is_lcd && c == '\n') // LF on a G-code command
) {
inbound_buffer[inbound_count] = '\0'; // Reset before processing
inbound_count = 0; // Reset buffer index
if (parsing == 1)
process_lcd_command(inbound_buffer); // Handle the LCD command
else
queue.enqueue_one_now(inbound_buffer); // Handle the G-code command
parsing = 0; // Unflag and...
}
else if (inbound_count < MAX_CURLY_COMMAND - 2)
inbound_buffer[inbound_count++] = is_lcd ? c : b; // Buffer while space remains
}
else {
if (c == '{') parsing = 1; // Brace opens an LCD command
else if (prevcr && c == '\n') parsing = 2; // CRLF indicates G-code
prevcr = (c == '\r'); // Remember if it was a CR
}
}
/**
* UC means connected.
* UD means disconnected
* The stock firmware considers USB initialized as "connected."
*/
void update_usb_status(const bool forceUpdate) {
static bool last_usb_connected_status = false;
// This is mildly different than stock, which
// appears to use the usb discovery status.
// This is more logical.
if (last_usb_connected_status != MYSERIAL0 || forceUpdate) {
last_usb_connected_status = MYSERIAL0;
write_to_lcd_P(last_usb_connected_status ? PSTR("{R:UC}\r\n") : PSTR("{R:UD}\r\n"));
}
}
namespace ExtUI {
void onStartup() {
/**
* The Malyan LCD actually runs as a separate MCU on Serial 1.
* This code's job is to siphon the weird curly-brace commands from
* it and translate into ExtUI operations where possible.
*/
inbound_count = 0;
LCD_SERIAL.begin(500000);
// Signal init
write_to_lcd_P(PSTR("{SYS:STARTED}\r\n"));
// send a version that says "unsupported"
write_to_lcd_P(PSTR("{VER:99}\r\n"));
// No idea why it does this twice.
write_to_lcd_P(PSTR("{SYS:STARTED}\r\n"));
update_usb_status(true);
}
void onIdle() {
/**
* - from printer on startup:
* {SYS:STARTED}{VER:29}{SYS:STARTED}{R:UD}
*/
// First report USB status.
update_usb_status(false);
// now drain commands...
while (LCD_SERIAL.available())
parse_lcd_byte((byte)LCD_SERIAL.read());
#if ENABLED(SDSUPPORT)
// The way last printing status works is simple:
// The UI needs to see at least one TQ which is not 100%
// and then when the print is complete, one which is.
static uint8_t last_percent_done = 100;
// If there was a print in progress, we need to emit the final
// print status as {TQ:100}. Reset last percent done so a new print will
// issue a percent of 0.
const uint8_t percent_done = (ExtUI::isPrinting() || ExtUI::isPrintingFromMediaPaused()) ? ExtUI::getProgress_percent() : last_printing_status ? 100 : 0;
if (percent_done != last_percent_done) {
char message_buffer[16];
sprintf_P(message_buffer, PSTR("{TQ:%03i}"), percent_done);
write_to_lcd(message_buffer);
last_percent_done = percent_done;
last_printing_status = ExtUI::isPrinting();
}
#endif
}
void onPrinterKilled(PGM_P const error, PGM_P const component) {
set_lcd_error_P(error, component);
}
#if HAS_PID_HEATING
void onPidTuning(const result_t rst) {
// Called for temperature PID tuning result
//SERIAL_ECHOLNPAIR("OnPidTuning:", rst);
switch (rst) {
case PID_BAD_EXTRUDER_NUM:
set_lcd_error_P(GET_TEXT(MSG_PID_BAD_EXTRUDER_NUM));
break;
case PID_TEMP_TOO_HIGH:
set_lcd_error_P(GET_TEXT(MSG_PID_TEMP_TOO_HIGH));
break;
case PID_TUNING_TIMEOUT:
set_lcd_error_P(GET_TEXT(MSG_PID_TIMEOUT));
break;
case PID_DONE:
set_lcd_error_P(GET_TEXT(MSG_PID_AUTOTUNE_DONE));
break;
}
}
#endif
void onPrintTimerStarted() { write_to_lcd_P(PSTR("{SYS:BUILD}")); }
void onPrintTimerPaused() {}
void onPrintTimerStopped() { write_to_lcd_P(PSTR("{TQ:100}")); }
// Not needed for Malyan LCD
void onStatusChanged(const char * const) {}
void onMediaInserted() {};
void onMediaError() {};
void onMediaRemoved() {};
void onPlayTone(const uint16_t, const uint16_t) {}
void onFilamentRunout(const extruder_t extruder) {}
void onUserConfirmRequired(const char * const) {}
void onFactoryReset() {}
void onStoreSettings(char*) {}
void onLoadSettings(const char*) {}
void onConfigurationStoreWritten(bool) {}
void onConfigurationStoreRead(bool) {}
#if HAS_MESH
void onMeshUpdate(const int8_t xpos, const int8_t ypos, const float zval) {}
void onMeshUpdate(const int8_t xpos, const int8_t ypos, const ExtUI::probe_state_t state) {}
#endif
#if ENABLED(POWER_LOSS_RECOVERY)
void onPowerLossResume() {}
#endif
}
#endif // MALYAN_LCD