andrey
/
Marlin_FB4S
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Browse Source

Attempt to address Bernhard's comments 

Refactor configuration to try to make items clearer (what defines a
panel vs what is user changeable).
pull/1/head
Robert F-C 12 years ago
parent
839bef6d5d
commit
6beb42cdf6
4 changed files with 134 additions and 142 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 19
      Marlin/Configuration.h
  2. 17
      Marlin/Marlin.pde
  3. 14
      Marlin/ultralcd.cpp
  4. 198
      Marlin/ultralcd_implementation_hitachi_HD44780.h

19
Marlin/Configuration.h
View File

@ -343,10 +343,9 @@ const bool Z_ENDSTOPS_INVERTING = true; // set to true to invert the logic of th
// This uses the LiquidCrystal_I2C library ( https://bitbucket.org/fmalpartida/new-liquidcrystal/wiki/Home ) // This uses the LiquidCrystal_I2C library ( https://bitbucket.org/fmalpartida/new-liquidcrystal/wiki/Home )
// Make sure it is placed in the Arduino libraries directory. // Make sure it is placed in the Arduino libraries directory.
#define LCD_I2C_TYPE_PCF8575 #define LCD_I2C_TYPE_PCF8575
#define LCD_I2C
#define ULTIPANEL
#define NEWPANEL
#define LCD_I2C_ADDRESS 0x27 // I2C Address of the port expander #define LCD_I2C_ADDRESS 0x27 // I2C Address of the port expander
#define NEWPANEL
#define ULTIPANEL
#endif #endif
//PANELOLU2 LCD with status LEDs, separate encoder and click inputs //PANELOLU2 LCD with status LEDs, separate encoder and click inputs
@ -355,12 +354,10 @@ const bool Z_ENDSTOPS_INVERTING = true; // set to true to invert the logic of th
// This uses the LiquidTWI2 library ( https://github.com/lincomatic/LiquidTWI2 ). // This uses the LiquidTWI2 library ( https://github.com/lincomatic/LiquidTWI2 ).
// Make sure it is placed in the Arduino libraries directory. // Make sure it is placed in the Arduino libraries directory.
#define LCD_I2C_TYPE_MCP23017 #define LCD_I2C_TYPE_MCP23017
#define LCD_I2C #define LCD_I2C_ADDRESS 0x20 // I2C Address of the port expander
#define ULTIPANEL #define LCD_USE_I2C_BUZZER //comment out to disable buzzer on LCD
#define NEWPANEL #define NEWPANEL
#define LCD_I2C_ADDRESS 0x20 #define ULTIPANEL
#define LCD_HAS_I2C_BUZZ //comment out to disable buzzer on LCD
#define LCD_HAS_STATUS_INDICATORS
#endif #endif
//VIKI LCD with status LEDs, integrated click & L/R/U/P buttons, separate encoder inputs //VIKI LCD with status LEDs, integrated click & L/R/U/P buttons, separate encoder inputs
@ -369,11 +366,9 @@ const bool Z_ENDSTOPS_INVERTING = true; // set to true to invert the logic of th
// This uses the LiquidTWI2 library (https://github.com/lincomatic/LiquidTWI2). // This uses the LiquidTWI2 library (https://github.com/lincomatic/LiquidTWI2).
// Make sure it is placed in the Arduino libraries directory. // Make sure it is placed in the Arduino libraries directory.
#define LCD_I2C_TYPE_MCP23017 #define LCD_I2C_TYPE_MCP23017
#define LCD_I2C #define LCD_I2C_ADDRESS 0x20 // I2C Address of the port expander
#define ULTIPANEL
#define NEWPANEL #define NEWPANEL
#define LCD_I2C_ADDRESS 0x20 #define ULTIPANEL
#define LCD_HAS_STATUS_INDICATORS
#endif #endif
#ifdef ULTIPANEL #ifdef ULTIPANEL

17
Marlin/Marlin.pde
View File

@ -34,21 +34,14 @@
#include "pins.h" #include "pins.h"
#ifdef ULTRA_LCD #ifdef ULTRA_LCD
#ifdef LCD_I2C
#include <Wire.h>
#if defined(LCD_I2C_TYPE_PCF8575) #if defined(LCD_I2C_TYPE_PCF8575)
#include <Wire.h>
#include <LiquidCrystal_I2C.h> #include <LiquidCrystal_I2C.h>
#elif defined(LCD_I2C_TYPE_MCP23017) #elif defined(LCD_I2C_TYPE_MCP23017) || defined(LCD_I2C_TYPE_MCP23008)
#ifdef LCD_I2C_PANELOLU2 #include <Wire.h>
#include <LiquidTWI2.h>
#ifndef PANELOLU2
#error You must uncomment #define PANELOLU2 in LiquidTWI2.h for LiquidTWI2.cpp to compile correctly
#endif
#else
#include <LiquidTWI2.h> #include <LiquidTWI2.h>
#endif #if defined(LCD_I2C_PANELOLU2) && !defined(PANELOLU2)
#else #error You must uncomment "#define PANELOLU2" in LiquidTWI2.h for LiquidTWI2.cpp to compile correctly
#error Unknown I2C LCD type
#endif #endif
#else #else
#include <LiquidCrystal.h> #include <LiquidCrystal.h>

14
Marlin/ultralcd.cpp
View File

@ -705,7 +705,9 @@ void lcd_init()
lcd_oldcardstatus = IS_SD_INSERTED; lcd_oldcardstatus = IS_SD_INSERTED;
#endif//(SDCARDDETECT > -1) #endif//(SDCARDDETECT > -1)
lcd_buttons_update(); lcd_buttons_update();
#ifdef ULTIPANEL
encoderDiff = 0; encoderDiff = 0;
#endif
} }
void lcd_update() void lcd_update()
@ -714,8 +716,8 @@ void lcd_update()
lcd_buttons_update(); lcd_buttons_update();
#ifdef LCD_HAS_EXTRA_BUTTONS #ifdef LCD_HAS_SLOW_BUTTONS
buttons |= lcd_read_extra_buttons(); // buttons which take too long to read in interrupt context buttons |= lcd_implementation_read_slow_buttons(); // buttons which take too long to read in interrupt context
#endif #endif
#if (SDCARDDETECT > -1) #if (SDCARDDETECT > -1)
@ -751,8 +753,12 @@ void lcd_update()
if (LCD_CLICKED) if (LCD_CLICKED)
timeoutToStatus = millis() + LCD_TIMEOUT_TO_STATUS; timeoutToStatus = millis() + LCD_TIMEOUT_TO_STATUS;
#endif//ULTIPANEL #endif//ULTIPANEL
(*currentMenu)(); (*currentMenu)();
#ifdef LCD_HAS_STATUS_INDICATORS
lcd_implementation_update_indicators();
#endif
#ifdef ULTIPANEL #ifdef ULTIPANEL
if(timeoutToStatus < millis() && currentMenu != lcd_status_screen) if(timeoutToStatus < millis() && currentMenu != lcd_status_screen)
{ {
@ -860,12 +866,12 @@ void lcd_buttons_update()
} }
lastEncoderBits = enc; lastEncoderBits = enc;
} }
#endif//ULTIPANEL
bool lcd_clicked() bool lcd_clicked()
{ {
return LCD_CLICKED; return LCD_CLICKED;
} }
#endif//ULTIPANEL
/********************************/ /********************************/
/** Float conversion utilities **/ /** Float conversion utilities **/

198
Marlin/ultralcd_implementation_hitachi_HD44780.h
View File

@ -6,72 +6,35 @@
* When selecting the rusian language, a slightly different LCD implementation is used to handle UTF8 characters. * When selecting the rusian language, a slightly different LCD implementation is used to handle UTF8 characters.
**/ **/
// Declare LCD class to use
#if defined(LCD_I2C_TYPE_PCF8575)
// note: these are virtual pins on the PCF8575 controller not Arduino pins
#define LCD_I2C_PIN_BL 3
#define LCD_I2C_PIN_EN 2
#define LCD_I2C_PIN_RW 1
#define LCD_I2C_PIN_RS 0
#define LCD_I2C_PIN_D4 4
#define LCD_I2C_PIN_D5 5
#define LCD_I2C_PIN_D6 6
#define LCD_I2C_PIN_D7 7
#include <Wire.h>
#include <LCD.h>
#include <LiquidCrystal_I2C.h>
#define LCD_CLASS LiquidCrystal_I2C
LCD_CLASS lcd(LCD_I2C_ADDRESS,LCD_I2C_PIN_EN,LCD_I2C_PIN_RW,LCD_I2C_PIN_RS,LCD_I2C_PIN_D4,LCD_I2C_PIN_D5,LCD_I2C_PIN_D6,LCD_I2C_PIN_D7);
#elif defined(LCD_I2C_TYPE_MCP23017)
//for the LED indicators (which maybe mapped to different things in lcd_implementation_update_indicators())
#define LED_A 0x04 //100
#define LED_B 0x02 //010
#define LED_C 0x01 //001
#include <Wire.h>
#include <LiquidTWI2.h>
#define LCD_CLASS LiquidTWI2
LCD_CLASS lcd(LCD_I2C_ADDRESS); //An alternative I2C master address can be used in place of "0"
#elif defined(LCD_I2C_TYPE_MCP23008)
#include <Wire.h>
#include <LiquidTWI2.h>
#define LCD_CLASS LiquidTWI2
LCD_CLASS lcd(LCD_I2C_ADDRESS); //An alternative I2C master address can be used in place of "0"
#else
#if LANGUAGE_CHOICE == 6
#include "LiquidCrystalRus.h"
#define LCD_CLASS LiquidCrystalRus
#else
#include <LiquidCrystal.h>
#define LCD_CLASS LiquidCrystal
#endif
LCD_CLASS lcd(LCD_PINS_RS, LCD_PINS_ENABLE, LCD_PINS_D4, LCD_PINS_D5,LCD_PINS_D6,LCD_PINS_D7); //RS,Enable,D4,D5,D6,D7
#endif
extern volatile uint8_t buttons; //the last checked buttons in a bit array. extern volatile uint8_t buttons; //the last checked buttons in a bit array.
// provide default button bitmask and encoder definitions (note this is not pin or motherboard specific) ////////////////////////////////////
#ifdef LCD_I2C_VIKI // Setup button and encode mappings for each panel (into 'buttons' variable)
//encoder rotation values //
#define encrot0 0 // This is just to map common functions (across different panels) onto the same
#define encrot1 2 // macro name. The mapping is independent of whether the button is directly connected or
#define encrot2 3 // via a shift/i2c register.
#define encrot3 1
#define BLEN_C 2 #ifdef ULTIPANEL
// All Ultipanels might have an encoder - so this is always be mapped onto first two bits
#define BLEN_B 1 #define BLEN_B 1
#define BLEN_A 0 #define BLEN_A 0
#define EN_C (1<<BLEN_C) // The stop/pause/resume button comes through BTN_ENC pin (for consistency with NEWPANEL code)
#define EN_B (1<<BLEN_B) // The two encoder pins are connected through BTN_EN1 and BTN_EN2 #define EN_B (1<<BLEN_B) // The two encoder pins are connected through BTN_EN1 and BTN_EN2
#define EN_A (1<<BLEN_A) #define EN_A (1<<BLEN_A)
#define B_I2C_BTN_OFFSET 3 // (the first three bit positions reserved for EN_A, EN_B, EN_C) //
// Setup other button mappings of each panel
//
#if defined(LCD_I2C_VIKI)
#define BLEN_C 2 // == pause/stop/restart button connected to BTN_ENC pin (named for consistency with NEWPANEL code)
#define EN_C (1<<BLEN_C)
#define B_I2C_BTN_OFFSET (BLEN_C+1) // (the first three bit positions reserved for EN_A, EN_B, EN_C)
// button and encoder bit positions within 'buttons' // button and encoder bit positions within 'buttons'
#define B_ST (EN_C) // The pause/stop/resume button is mapped to EN_C for consistency with NEWPANEL #define B_ST (EN_C) // Map the pause/stop/resume button into its normalized functional name
#define B_LE (BUTTON_LEFT<<B_I2C_BTN_OFFSET) // The remaining buttons are I2C read buttons. #define B_LE (BUTTON_LEFT<<B_I2C_BTN_OFFSET) // The remaining normalized buttons are all read via I2C
#define B_UP (BUTTON_UP<<B_I2C_BTN_OFFSET) #define B_UP (BUTTON_UP<<B_I2C_BTN_OFFSET)
#define B_MI (BUTTON_SELECT<<B_I2C_BTN_OFFSET) #define B_MI (BUTTON_SELECT<<B_I2C_BTN_OFFSET)
#define B_DW (BUTTON_DOWN<<B_I2C_BTN_OFFSET) #define B_DW (BUTTON_DOWN<<B_I2C_BTN_OFFSET)
@ -79,41 +42,16 @@ extern volatile uint8_t buttons; //the last checked buttons in a bit array.
#define LCD_CLICKED (buttons&(B_MI|B_RI|B_ST)) // pause/stop button also acts as click until we implement proper pause/stop. #define LCD_CLICKED (buttons&(B_MI|B_RI|B_ST)) // pause/stop button also acts as click until we implement proper pause/stop.
// I2C buttons are likely to take too long to read inside interrupt context and so we read them during lcd_update // I2C buttons take too long to read inside an interrupt context and so we read them during lcd_update
#define LCD_HAS_EXTRA_BUTTONS #define LCD_HAS_SLOW_BUTTONS
#elif defined(NEWPANEL) #elif defined(NEWPANEL)
//from the same bit in the RAMPS Newpanel define // Standard Newpanel has just a single button (all direclty connected)
//encoder rotation values #define BLEN_C 2 // == select button
#define encrot0 0
#define encrot1 2
#define encrot2 3
#define encrot3 1
#define BLEN_C 2
#define BLEN_B 1
#define BLEN_A 0
#define EN_C (1<<BLEN_C) #define EN_C (1<<BLEN_C)
#define EN_B (1<<BLEN_B)
#define EN_A (1<<BLEN_A)
#define LCD_CLICKED (buttons&EN_C) #define LCD_CLICKED (buttons&EN_C)
#else // old style ULTIPANEL #else // old style ULTIPANEL
//encoder rotation values
#ifndef ULTIMAKERCONTROLLER
#define encrot0 0
#define encrot1 2
#define encrot2 3
#define encrot3 1
#else
#define encrot0 0
#define encrot1 1
#define encrot2 3
#define encrot3 2
#endif
//bits in the shift register that carry the buttons for: //bits in the shift register that carry the buttons for:
// left up center down right red(stop) // left up center down right red(stop)
#define BL_LE 7 #define BL_LE 7
@ -123,9 +61,6 @@ extern volatile uint8_t buttons; //the last checked buttons in a bit array.
#define BL_RI 3 #define BL_RI 3
#define BL_ST 2 #define BL_ST 2
#define BLEN_B 1
#define BLEN_A 0
//automatic, do not change //automatic, do not change
#define B_LE (1<<BL_LE) #define B_LE (1<<BL_LE)
#define B_UP (1<<BL_UP) #define B_UP (1<<BL_UP)
@ -133,15 +68,78 @@ extern volatile uint8_t buttons; //the last checked buttons in a bit array.
#define B_DW (1<<BL_DW) #define B_DW (1<<BL_DW)
#define B_RI (1<<BL_RI) #define B_RI (1<<BL_RI)
#define B_ST (1<<BL_ST) #define B_ST (1<<BL_ST)
#define EN_B (1<<BLEN_B)
#define EN_A (1<<BLEN_A)
#define LCD_CLICKED (buttons&(B_MI|B_ST)) #define LCD_CLICKED (buttons&(B_MI|B_ST))
#endif//else NEWPANEL #endif//else NEWPANEL
#ifdef LCD_HAS_STATUS_INDICATORS ////////////////////////
//forward declaration // Setup Rotary Encoder Bit Values (for two pin encoders to indicate movement)
static void lcd_implementation_update_indicators(); // These values are independent of which pins are used for EN_A and EN_B indications
// The rotary encoder part is also independent to the chipset used for the LCD
#if defined(EN_A) && defined(EN_B)
#ifndef ULTIMAKERCONTROLLER
#define encrot0 0
#define encrot1 2
#define encrot2 3
#define encrot3 1
#else
#define encrot0 0
#define encrot1 1
#define encrot2 3
#define encrot3 2
#endif
#endif
#endif //ULTIPANEL
////////////////////////////////////
// Create LCD class instance and chipset-specific information
#if defined(LCD_I2C_TYPE_PCF8575)
// note: these are register mapped pins on the PCF8575 controller not Arduino pins
#define LCD_I2C_PIN_BL 3
#define LCD_I2C_PIN_EN 2
#define LCD_I2C_PIN_RW 1
#define LCD_I2C_PIN_RS 0
#define LCD_I2C_PIN_D4 4
#define LCD_I2C_PIN_D5 5
#define LCD_I2C_PIN_D6 6
#define LCD_I2C_PIN_D7 7
#include <Wire.h>
#include <LCD.h>
#include <LiquidCrystal_I2C.h>
#define LCD_CLASS LiquidCrystal_I2C
LCD_CLASS lcd(LCD_I2C_ADDRESS,LCD_I2C_PIN_EN,LCD_I2C_PIN_RW,LCD_I2C_PIN_RS,LCD_I2C_PIN_D4,LCD_I2C_PIN_D5,LCD_I2C_PIN_D6,LCD_I2C_PIN_D7);
#elif defined(LCD_I2C_TYPE_MCP23017)
//for the LED indicators (which maybe mapped to different things in lcd_implementation_update_indicators())
#define LED_A 0x04 //100
#define LED_B 0x02 //010
#define LED_C 0x01 //001
#define LCD_HAS_STATUS_INDICATORS
#include <Wire.h>
#include <LiquidTWI2.h>
#define LCD_CLASS LiquidTWI2
LCD_CLASS lcd(LCD_I2C_ADDRESS);
#elif defined(LCD_I2C_TYPE_MCP23008)
#include <Wire.h>
#include <LiquidTWI2.h>
#define LCD_CLASS LiquidTWI2
LCD_CLASS lcd(LCD_I2C_ADDRESS);
#else
// Standard directly connected LCD implementations
#if LANGUAGE_CHOICE == 6
#include "LiquidCrystalRus.h"
#define LCD_CLASS LiquidCrystalRus
#else
#include <LiquidCrystal.h>
#define LCD_CLASS LiquidCrystal
#endif
LCD_CLASS lcd(LCD_PINS_RS, LCD_PINS_ENABLE, LCD_PINS_D4, LCD_PINS_D5,LCD_PINS_D6,LCD_PINS_D7); //RS,Enable,D4,D5,D6,D7
#endif #endif
/* Custom characters defined in the first 8 characters of the LCD */ /* Custom characters defined in the first 8 characters of the LCD */
@ -247,13 +245,16 @@ static void lcd_implementation_init()
lcd.setBacklightPin(LCD_I2C_PIN_BL,POSITIVE); lcd.setBacklightPin(LCD_I2C_PIN_BL,POSITIVE);
lcd.setBacklight(HIGH); lcd.setBacklight(HIGH);
#endif #endif
#elif defined(LCD_I2C_TYPE_MCP23017) #elif defined(LCD_I2C_TYPE_MCP23017)
lcd.setMCPType(LTI_TYPE_MCP23017); lcd.setMCPType(LTI_TYPE_MCP23017);
lcd.begin(LCD_WIDTH, LCD_HEIGHT); lcd.begin(LCD_WIDTH, LCD_HEIGHT);
lcd.setBacklight(0); //set all the LEDs off to begin with lcd.setBacklight(0); //set all the LEDs off to begin with
#elif defined(LCD_I2C_TYPE_MCP23008) #elif defined(LCD_I2C_TYPE_MCP23008)
lcd.setMCPType(LTI_TYPE_MCP23008); lcd.setMCPType(LTI_TYPE_MCP23008);
lcd.begin(LCD_WIDTH, LCD_HEIGHT); lcd.begin(LCD_WIDTH, LCD_HEIGHT);
#else #else
lcd.begin(LCD_WIDTH, LCD_HEIGHT); lcd.begin(LCD_WIDTH, LCD_HEIGHT);
#endif #endif
@ -439,9 +440,6 @@ static void lcd_implementation_status_screen()
//Status message line on the last line //Status message line on the last line
lcd.setCursor(0, LCD_HEIGHT - 1); lcd.setCursor(0, LCD_HEIGHT - 1);
lcd.print(lcd_status_message); lcd.print(lcd_status_message);
#ifdef LCD_HAS_STATUS_INDICATORS
lcd_implementation_update_indicators();
#endif
} }
static void lcd_implementation_drawmenu_generic(uint8_t row, const char* pstr, char pre_char, char post_char) static void lcd_implementation_drawmenu_generic(uint8_t row, const char* pstr, char pre_char, char post_char)
{ {
@ -630,7 +628,7 @@ static void lcd_implementation_drawmenu_sddirectory(uint8_t row, const char* pst
static void lcd_implementation_quick_feedback() static void lcd_implementation_quick_feedback()
{ {
#ifdef LCD_HAS_I2C_BUZZ #ifdef LCD_USE_I2C_BUZZER
lcd.buzz(300,4000); lcd.buzz(300,4000);
#elif defined(BEEPER) && BEEPER > -1 #elif defined(BEEPER) && BEEPER > -1
SET_OUTPUT(BEEPER); SET_OUTPUT(BEEPER);
@ -665,12 +663,12 @@ static void lcd_implementation_update_indicators()
} }
#endif #endif
#ifdef LCD_HAS_EXTRA_BUTTONS #ifdef LCD_HAS_SLOW_BUTTONS
static uint8_t lcd_read_extra_buttons() static uint8_t lcd_implementation_read_slow_buttons()
{ {
#ifdef LCD_I2C_TYPE_MCP23017 #ifdef LCD_I2C_TYPE_MCP23017
// the I2C button bit positions are shifted by three bits from the native LiquidTWI2 position // Reading these buttons this is likely to be too slow to call inside interrupt context
// this is potentially too slow to call inside interrupt context // so they are called during normal lcd_update
return lcd.readButtons() << B_I2C_BTN_OFFSET; return lcd.readButtons() << B_I2C_BTN_OFFSET;
#endif #endif
} }

Write Preview
Loading…
Cancel
Save