MarlinFirmware/Marlin/pins_RUMBA.h

/**
 * Marlin 3D Printer Firmware
 * Copyright (C) 2016 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 <http://www.gnu.org/licenses/>.
 *
 */

/**
 * RUMBA pin assignments
 */

#ifndef __AVR_ATmega2560__
  #error "Oops!  Make sure you have 'Arduino Mega' selected from the 'Tools -> Boards' menu."
#endif

#if HOTENDS > 3 || E_STEPPERS > 3
  #error "RUMBA supports up to 3 hotends / E-steppers. Comment out this line to continue."
#endif

#define DEFAULT_MACHINE_NAME "Rumba"
#define BOARD_NAME           "Rumba"

//
// Servos
//
#define SERVO0_PIN         5

//
// Limit Switches
//
#define X_MIN_PIN          37
#define X_MAX_PIN          36
#define Y_MIN_PIN          35
#define Y_MAX_PIN          34
#define Z_MIN_PIN          33
#define Z_MAX_PIN          32

//
// Z Probe (when not Z_MIN_PIN)
//
#ifndef Z_MIN_PROBE_PIN
  #define Z_MIN_PROBE_PIN  32
#endif

//
// Steppers
//
#define X_STEP_PIN         17
#define X_DIR_PIN          16
#define X_ENABLE_PIN       48

#define Y_STEP_PIN         54
#define Y_DIR_PIN          47
#define Y_ENABLE_PIN       55

#define Z_STEP_PIN         57
#define Z_DIR_PIN          56
#define Z_ENABLE_PIN       62

#define E0_STEP_PIN        23
#define E0_DIR_PIN         22
#define E0_ENABLE_PIN      24

#define E1_STEP_PIN        26
#define E1_DIR_PIN         25
#define E1_ENABLE_PIN      27

#define E2_STEP_PIN        29
#define E2_DIR_PIN         28
#define E2_ENABLE_PIN      39

//
// Temperature Sensors
//
#if TEMP_SENSOR_0 == -1
  #define TEMP_0_PIN        6   // Analog Input (connector *K1* on RUMBA thermocouple ADD ON is used)
#else
  #define TEMP_0_PIN       15   // Analog Input (default connector for thermistor *T0* on rumba board is used)
#endif

#if TEMP_SENSOR_1 == -1
  #define TEMP_1_PIN        5   // Analog Input (connector *K2* on RUMBA thermocouple ADD ON is used)
#else
  #define TEMP_1_PIN       14   // Analog Input (default connector for thermistor *T1* on rumba board is used)
#endif

#if TEMP_SENSOR_2 == -1
  #define TEMP_2_PIN        7   // Analog Input (connector *K3* on RUMBA thermocouple ADD ON is used <-- this can't be used when TEMP_SENSOR_BED is defined as thermocouple)
#else
  #define TEMP_2_PIN       13   // Analog Input (default connector for thermistor *T2* on rumba board is used)
#endif

// optional for extruder 4 or chamber:
//#define TEMP_X_PIN         12   // Analog Input (default connector for thermistor *T3* on rumba board is used)
//#define TEMP_CHAMBER_PIN   12   // Analog Input (default connector for thermistor *T3* on rumba board is used)

#if TEMP_SENSOR_BED == -1
  #define TEMP_BED_PIN      7   // Analog Input (connector *K3* on RUMBA thermocouple ADD ON is used <-- this can't be used when TEMP_SENSOR_2 is defined as thermocouple)
#else
  #define TEMP_BED_PIN     11   // Analog Input (default connector for thermistor *THB* on rumba board is used)
#endif

//
// Heaters / Fans
//
#define HEATER_0_PIN        2
#define HEATER_1_PIN        3
#define HEATER_2_PIN        6
#define HEATER_3_PIN        8
#define HEATER_BED_PIN      9

#ifndef FAN_PIN
  #define FAN_PIN           7
#endif
#define FAN1_PIN            8

//
// Misc. Functions
//
#define SDSS               53
#define LED_PIN            13
#define PS_ON_PIN          45
#define KILL_PIN           46
#define CASE_LIGHT_PIN     45

//
// M3/M4/M5 - Spindle/Laser Control
//
#ifndef SPINDLE_LASER_PWM_PIN
  #define SPINDLE_LASER_PWM_PIN     4   // MUST BE HARDWARE PWM. Pin 4 interrupts OC0* and OC1* always in use?
#endif
#ifndef SPINDLE_LASER_ENABLE_PIN
  #define SPINDLE_LASER_ENABLE_PIN 14   // Pin should have a pullup!
#endif
#ifndef SPINDLE_DIR_PIN
  #define SPINDLE_DIR_PIN          15
#endif

//
// LCD / Controller
//
#define SD_DETECT_PIN      49
#define BEEPER_PIN         44
#define LCD_PINS_D7        40
#define BTN_EN1            11
#define BTN_EN2            12
#define BTN_ENC            43

#if ENABLED(MKS_12864OLED) || ENABLED(MKS_12864OLED_SSD1306)
  #define LCD_PINS_DC      38 // Set as output on init
  #define LCD_PINS_RS      41 // Pull low for 1s to init
  // DOGM SPI LCD Support
  #define DOGLCD_CS        19
  #define DOGLCD_MOSI      42
  #define DOGLCD_SCK       18
  #define DOGLCD_A0        LCD_PINS_DC
#else
  #define LCD_PINS_RS      19
  #define LCD_PINS_ENABLE  42
  #define LCD_PINS_D4      18
  #define LCD_PINS_D5      38
  #define LCD_PINS_D6      41
#endif
Further cleanup of comments, partial Doxygen-style Following up on #3231 2016-03-25 06:19:46 +00:00			`/**`
Added gplv3 header to all Marlin files 2016-03-24 18:01:20 +00:00			`* Marlin 3D Printer Firmware`
			`* Copyright (C) 2016 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 <http://www.gnu.org/licenses/>.`
			`*`
			`*/`

Split up pins to make it more manageable Hopefully this is helpful to organization and future expansion…. 2015-01-26 02:40:00 +00:00			`/**`
			`* RUMBA pin assignments`
			`*/`

			`#ifndef __AVR_ATmega2560__`
Enclose all #error strings with apostrophes 2016-05-13 12:10:23 +00:00			`#error "Oops! Make sure you have 'Arduino Mega' selected from the 'Tools -> Boards' menu."`
Split up pins to make it more manageable Hopefully this is helpful to organization and future expansion…. 2015-01-26 02:40:00 +00:00			`#endif`

Patch pins files hotends/e-steppers sanity check 2017-04-06 22:15:09 +00:00			`#if HOTENDS > 3 \|\| E_STEPPERS > 3`
			`#error "RUMBA supports up to 3 hotends / E-steppers. Comment out this line to continue."`
Cleanup of temperature code - Reduce calls to millis() - General cleanup of manage_heaters - General cleanup of pid autotune - Formatting here & there - Macros to clean up and shrink ISR code (reduced by ~364 lines) 2015-02-24 12:46:11 +00:00			`#endif`

Move default machine info to pins files 2016-04-03 01:53:05 +00:00			`#define DEFAULT_MACHINE_NAME "Rumba"`
Add "About Printer" information menu. Includes: firmware version / branch / date. extruder count board information (name, serial details, power supply type) thermistors (names, min/max temperatures) *printer statistics (PRINTCOUNTER details) Thanks to @thinkyhead for contributions. 2016-06-30 09:24:29 +00:00			`#define BOARD_NAME "Rumba"`
Move default machine info to pins files 2016-04-03 01:53:05 +00:00
Follow-up the PR #4955, etc ・More ANALOG NUMBERING to Analog Input ・Add comment header to all the section of all the pins files ・Sort sections as follows: 1. Some special definitions (USBCON, LARGE_FLASH, etc) 2. Servos 3. Limit Switches 4. Z Probe 5. Steppers 6. Temperature Sensors 7. Heaters / Fans 8. Misc. Functions 9. LCD / Controller ・Move MAX6675_SS into "Temperature Sensors" section ・Adjust spacing 2016-10-08 20:27:04 +00:00			`//`
			`// Servos`
			`//`
			`#define SERVO0_PIN 5`

Consistent order/formatting of pins files 2016-08-22 22:05:22 +00:00			`//`
			`// Limit Switches`
			`//`
			`#define X_MIN_PIN 37`
			`#define X_MAX_PIN 36`
			`#define Y_MIN_PIN 35`
			`#define Y_MAX_PIN 34`
			`#define Z_MIN_PIN 33`
			`#define Z_MAX_PIN 32`

			`//`
			`// Z Probe (when not Z_MIN_PIN)`
			`//`
			`#ifndef Z_MIN_PROBE_PIN`
			`#define Z_MIN_PROBE_PIN 32`
			`#endif`

			`//`
			`// Steppers`
			`//`
Split up pins to make it more manageable Hopefully this is helpful to organization and future expansion…. 2015-01-26 02:40:00 +00:00			`#define X_STEP_PIN 17`
			`#define X_DIR_PIN 16`
			`#define X_ENABLE_PIN 48`

			`#define Y_STEP_PIN 54`
			`#define Y_DIR_PIN 47`
			`#define Y_ENABLE_PIN 55`

			`#define Z_STEP_PIN 57`
			`#define Z_DIR_PIN 56`
			`#define Z_ENABLE_PIN 62`

			`#define E0_STEP_PIN 23`
			`#define E0_DIR_PIN 22`
			`#define E0_ENABLE_PIN 24`

			`#define E1_STEP_PIN 26`
			`#define E1_DIR_PIN 25`
			`#define E1_ENABLE_PIN 27`

			`#define E2_STEP_PIN 29`
			`#define E2_DIR_PIN 28`
			`#define E2_ENABLE_PIN 39`

Consistent order/formatting of pins files 2016-08-22 22:05:22 +00:00			`//`
			`// Temperature Sensors`
			`//`
Always define temp sensor, heater pins for RUMBA 2016-06-28 23:27:22 +00:00			`#if TEMP_SENSOR_0 == -1`
Follow-up the PR #4955, etc ・More ANALOG NUMBERING to Analog Input ・Add comment header to all the section of all the pins files ・Sort sections as follows: 1. Some special definitions (USBCON, LARGE_FLASH, etc) 2. Servos 3. Limit Switches 4. Z Probe 5. Steppers 6. Temperature Sensors 7. Heaters / Fans 8. Misc. Functions 9. LCD / Controller ・Move MAX6675_SS into "Temperature Sensors" section ・Adjust spacing 2016-10-08 20:27:04 +00:00			`#define TEMP_0_PIN 6 // Analog Input (connector K1 on RUMBA thermocouple ADD ON is used)`
Always define temp sensor, heater pins for RUMBA 2016-06-28 23:27:22 +00:00			`#else`
Follow-up the PR #4955, etc ・More ANALOG NUMBERING to Analog Input ・Add comment header to all the section of all the pins files ・Sort sections as follows: 1. Some special definitions (USBCON, LARGE_FLASH, etc) 2. Servos 3. Limit Switches 4. Z Probe 5. Steppers 6. Temperature Sensors 7. Heaters / Fans 8. Misc. Functions 9. LCD / Controller ・Move MAX6675_SS into "Temperature Sensors" section ・Adjust spacing 2016-10-08 20:27:04 +00:00			`#define TEMP_0_PIN 15 // Analog Input (default connector for thermistor T0 on rumba board is used)`
Split up pins to make it more manageable Hopefully this is helpful to organization and future expansion…. 2015-01-26 02:40:00 +00:00			`#endif`

Always define temp sensor, heater pins for RUMBA 2016-06-28 23:27:22 +00:00			`#if TEMP_SENSOR_1 == -1`
Follow-up the PR #4955, etc ・More ANALOG NUMBERING to Analog Input ・Add comment header to all the section of all the pins files ・Sort sections as follows: 1. Some special definitions (USBCON, LARGE_FLASH, etc) 2. Servos 3. Limit Switches 4. Z Probe 5. Steppers 6. Temperature Sensors 7. Heaters / Fans 8. Misc. Functions 9. LCD / Controller ・Move MAX6675_SS into "Temperature Sensors" section ・Adjust spacing 2016-10-08 20:27:04 +00:00			`#define TEMP_1_PIN 5 // Analog Input (connector K2 on RUMBA thermocouple ADD ON is used)`
Always define temp sensor, heater pins for RUMBA 2016-06-28 23:27:22 +00:00			`#else`
Follow-up the PR #4955, etc ・More ANALOG NUMBERING to Analog Input ・Add comment header to all the section of all the pins files ・Sort sections as follows: 1. Some special definitions (USBCON, LARGE_FLASH, etc) 2. Servos 3. Limit Switches 4. Z Probe 5. Steppers 6. Temperature Sensors 7. Heaters / Fans 8. Misc. Functions 9. LCD / Controller ・Move MAX6675_SS into "Temperature Sensors" section ・Adjust spacing 2016-10-08 20:27:04 +00:00			`#define TEMP_1_PIN 14 // Analog Input (default connector for thermistor T1 on rumba board is used)`
Split up pins to make it more manageable Hopefully this is helpful to organization and future expansion…. 2015-01-26 02:40:00 +00:00			`#endif`

Always define temp sensor, heater pins for RUMBA 2016-06-28 23:27:22 +00:00			`#if TEMP_SENSOR_2 == -1`
Pins-related cleanup, formatting 2017-05-21 00:30:36 +00:00			`#define TEMP_2_PIN 7 // Analog Input (connector K3 on RUMBA thermocouple ADD ON is used <-- this can't be used when TEMP_SENSOR_BED is defined as thermocouple)`
Follow-up the PR #4955, etc ・More ANALOG NUMBERING to Analog Input ・Add comment header to all the section of all the pins files ・Sort sections as follows: 1. Some special definitions (USBCON, LARGE_FLASH, etc) 2. Servos 3. Limit Switches 4. Z Probe 5. Steppers 6. Temperature Sensors 7. Heaters / Fans 8. Misc. Functions 9. LCD / Controller ・Move MAX6675_SS into "Temperature Sensors" section ・Adjust spacing 2016-10-08 20:27:04 +00:00			`#else`
			`#define TEMP_2_PIN 13 // Analog Input (default connector for thermistor T2 on rumba board is used)`
			`#endif`

			`// optional for extruder 4 or chamber:`
			`//#define TEMP_X_PIN 12 // Analog Input (default connector for thermistor T3 on rumba board is used)`
Chamber temperature monitoring and auto fan control. This is an initial cut for feedback. Chamber temperature is currently reported along with hot end and bed temperatures to serial. The format is just like that used for hot end and bed temperatures, but using 'C' prefix. As there is no heater, target is always 0. Is this appropriate, is there a better way to report chamber temperatures? Chamber temperatures are not reported on the LCD in any way. When auto chamber fan is enabled, it currently just uses the same temperature threshold as the other auto controlled fans. As the chamber temperature is not connected to any heater, it doesn't undergo mintemp/maxtemp monitoring. This would need to change in the future if chamber heating became a feature. 2018-02-24 06:38:58 +00:00			`//#define TEMP_CHAMBER_PIN 12 // Analog Input (default connector for thermistor T3 on rumba board is used)`
Follow-up the PR #4955, etc ・More ANALOG NUMBERING to Analog Input ・Add comment header to all the section of all the pins files ・Sort sections as follows: 1. Some special definitions (USBCON, LARGE_FLASH, etc) 2. Servos 3. Limit Switches 4. Z Probe 5. Steppers 6. Temperature Sensors 7. Heaters / Fans 8. Misc. Functions 9. LCD / Controller ・Move MAX6675_SS into "Temperature Sensors" section ・Adjust spacing 2016-10-08 20:27:04 +00:00
			`#if TEMP_SENSOR_BED == -1`
Pins-related cleanup, formatting 2017-05-21 00:30:36 +00:00			`#define TEMP_BED_PIN 7 // Analog Input (connector K3 on RUMBA thermocouple ADD ON is used <-- this can't be used when TEMP_SENSOR_2 is defined as thermocouple)`
Always define temp sensor, heater pins for RUMBA 2016-06-28 23:27:22 +00:00			`#else`
Follow-up the PR #4955, etc ・More ANALOG NUMBERING to Analog Input ・Add comment header to all the section of all the pins files ・Sort sections as follows: 1. Some special definitions (USBCON, LARGE_FLASH, etc) 2. Servos 3. Limit Switches 4. Z Probe 5. Steppers 6. Temperature Sensors 7. Heaters / Fans 8. Misc. Functions 9. LCD / Controller ・Move MAX6675_SS into "Temperature Sensors" section ・Adjust spacing 2016-10-08 20:27:04 +00:00			`#define TEMP_BED_PIN 11 // Analog Input (default connector for thermistor THB on rumba board is used)`
Split up pins to make it more manageable Hopefully this is helpful to organization and future expansion…. 2015-01-26 02:40:00 +00:00			`#endif`

Consistent order/formatting of pins files 2016-08-22 22:05:22 +00:00			`//`
			`// Heaters / Fans`
			`//`
			`#define HEATER_0_PIN 2`
			`#define HEATER_1_PIN 3`
			`#define HEATER_2_PIN 6`
			`#define HEATER_3_PIN 8`
			`#define HEATER_BED_PIN 9`

Allow FAN_PIN override, pins cleanup (#10957) 2018-06-07 21:39:11 +00:00			`#ifndef FAN_PIN`
			`#define FAN_PIN 7`
			`#endif`
Consistent order/formatting of pins files 2016-08-22 22:05:22 +00:00			`#define FAN1_PIN 8`

Follow-up the PR #4955, etc ・More ANALOG NUMBERING to Analog Input ・Add comment header to all the section of all the pins files ・Sort sections as follows: 1. Some special definitions (USBCON, LARGE_FLASH, etc) 2. Servos 3. Limit Switches 4. Z Probe 5. Steppers 6. Temperature Sensors 7. Heaters / Fans 8. Misc. Functions 9. LCD / Controller ・Move MAX6675_SS into "Temperature Sensors" section ・Adjust spacing 2016-10-08 20:27:04 +00:00			`//`
			`// Misc. Functions`
			`//`
Split up pins to make it more manageable Hopefully this is helpful to organization and future expansion…. 2015-01-26 02:40:00 +00:00			`#define SDSS 53`
Follow-up the PR #4955, etc ・More ANALOG NUMBERING to Analog Input ・Add comment header to all the section of all the pins files ・Sort sections as follows: 1. Some special definitions (USBCON, LARGE_FLASH, etc) 2. Servos 3. Limit Switches 4. Z Probe 5. Steppers 6. Temperature Sensors 7. Heaters / Fans 8. Misc. Functions 9. LCD / Controller ・Move MAX6675_SS into "Temperature Sensors" section ・Adjust spacing 2016-10-08 20:27:04 +00:00			`#define LED_PIN 13`
			`#define PS_ON_PIN 45`
			`#define KILL_PIN 46`
SPINDLE/LASER pins changes 2017-04-07 18:52:21 +00:00			`#define CASE_LIGHT_PIN 45`
Follow-up the PR #4955, etc ・More ANALOG NUMBERING to Analog Input ・Add comment header to all the section of all the pins files ・Sort sections as follows: 1. Some special definitions (USBCON, LARGE_FLASH, etc) 2. Servos 3. Limit Switches 4. Z Probe 5. Steppers 6. Temperature Sensors 7. Heaters / Fans 8. Misc. Functions 9. LCD / Controller ・Move MAX6675_SS into "Temperature Sensors" section ・Adjust spacing 2016-10-08 20:27:04 +00:00
SPINDLE/LASER pins changes 2017-04-07 18:52:21 +00:00			`//`
			`// M3/M4/M5 - Spindle/Laser Control`
			`//`
Pins spacing, 2.0.x parity 2018-02-18 03:43:47 +00:00			`#ifndef SPINDLE_LASER_PWM_PIN`
Apply three spaces after pin defines 2018-03-28 17:26:44 +00:00			`#define SPINDLE_LASER_PWM_PIN 4 // MUST BE HARDWARE PWM. Pin 4 interrupts OC0* and OC1* always in use?`
Pins spacing, 2.0.x parity 2018-02-18 03:43:47 +00:00			`#endif`
			`#ifndef SPINDLE_LASER_ENABLE_PIN`
Apply three spaces after pin defines 2018-03-28 17:26:44 +00:00			`#define SPINDLE_LASER_ENABLE_PIN 14 // Pin should have a pullup!`
Pins spacing, 2.0.x parity 2018-02-18 03:43:47 +00:00			`#endif`
			`#ifndef SPINDLE_DIR_PIN`
			`#define SPINDLE_DIR_PIN 15`
			`#endif`
MKS OLED support for RUMBA Based on #10519 Co-Authored-By: Alex <alex18881@users.noreply.github.com> 2018-04-26 03:56:43 +00:00
			`//`
			`// LCD / Controller`
			`//`
			`#define SD_DETECT_PIN 49`
			`#define BEEPER_PIN 44`
			`#define LCD_PINS_D7 40`
			`#define BTN_EN1 11`
			`#define BTN_EN2 12`
			`#define BTN_ENC 43`

			`#if ENABLED(MKS_12864OLED) \|\| ENABLED(MKS_12864OLED_SSD1306)`
			`#define LCD_PINS_DC 38 // Set as output on init`
			`#define LCD_PINS_RS 41 // Pull low for 1s to init`
			`// DOGM SPI LCD Support`
			`#define DOGLCD_CS 19`
			`#define DOGLCD_MOSI 42`
			`#define DOGLCD_SCK 18`
			`#define DOGLCD_A0 LCD_PINS_DC`
			`#else`
			`#define LCD_PINS_RS 19`
			`#define LCD_PINS_ENABLE 42`
			`#define LCD_PINS_D4 18`
			`#define LCD_PINS_D5 38`
			`#define LCD_PINS_D6 41`
			`#endif`