123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115 |
- /*********************
- * 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
|