Marlin-Artillery-M600/Marlin/src/pins/ramps/pins_AZTEEG_X3_PRO.h

/**
 * Marlin 3D Printer Firmware
 * Copyright (c) 2019 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/>.
 *
 */
#pragma once

/**
 * AZTEEG_X3_PRO (Arduino Mega) pin assignments
 */

#ifndef __AVR_ATmega2560__
  #error "Oops! Select 'Arduino/Genuino Mega or Mega 2560' in 'Tools > Board.'"
#endif

#if HOTENDS > 5 || E_STEPPERS > 5
  #error "Azteeg X3 Pro supports up to 5 hotends / E-steppers. Comment out this line to continue."
#endif

#define BOARD_NAME "Azteeg X3 Pro"

//
// RAMPS pins overrides
//

//
// Servos
//
// Tested this pin with bed leveling on a Delta with 1 servo.
// Physical wire attachment on EXT1: GND, 5V, D47.
//
#define SERVO0_PIN         47

//
// Limit Switches
//
#define X_STOP_PIN          3
#define Y_STOP_PIN         14
#define Z_STOP_PIN         18

#ifndef FAN_PIN
  #define FAN_PIN           6
#endif

#if ENABLED(CASE_LIGHT_ENABLE) && !PIN_EXISTS(CASE_LIGHT)
  #define CASE_LIGHT_PIN   44
#endif

//
// Import RAMPS 1.4 pins
//
#include "pins_RAMPS.h"

// DIGIPOT slave addresses
#ifndef DIGIPOT_I2C_ADDRESS_A
  #define DIGIPOT_I2C_ADDRESS_A 0x2C   // unshifted slave address for first DIGIPOT 0x2C (0x58 <- 0x2C << 1)
#endif
#ifndef DIGIPOT_I2C_ADDRESS_B
  #define DIGIPOT_I2C_ADDRESS_B 0x2E   // unshifted slave address for second DIGIPOT 0x2E (0x5C <- 0x2E << 1)
#endif

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

//
// Steppers
//
#define E2_STEP_PIN        23
#define E2_DIR_PIN         25
#define E2_ENABLE_PIN      40

#define E3_STEP_PIN        27
#define E3_DIR_PIN         29
#define E3_ENABLE_PIN      41

#define E4_STEP_PIN        43
#define E4_DIR_PIN         37
#define E4_ENABLE_PIN      42

//
// Temperature Sensors
//
#define TEMP_2_PIN         12   // Analog Input
#define TEMP_3_PIN         11   // Analog Input
#define TEMP_4_PIN         10   // Analog Input
#define TC1                 4   // Analog Input (Thermo couple on Azteeg X3Pro)
#define TC2                 5   // Analog Input (Thermo couple on Azteeg X3Pro)

//
// Heaters / Fans
//
#define HEATER_2_PIN       16
#define HEATER_3_PIN       17
#define HEATER_4_PIN        4
#define HEATER_5_PIN        5
#define HEATER_6_PIN        6
#define HEATER_7_PIN       11

#ifndef CONTROLLER_FAN_PIN
  #define CONTROLLER_FAN_PIN 4   // Pin used for the fan to cool motherboard (-1 to disable)
#endif

// Fans/Water Pump to cool the hotend cool side.
#define ORIG_E0_AUTO_FAN_PIN 5
#define ORIG_E1_AUTO_FAN_PIN 5
#define ORIG_E2_AUTO_FAN_PIN 5
#define ORIG_E3_AUTO_FAN_PIN 5

//
// LCD / Controller
//
#undef BEEPER_PIN
#define BEEPER_PIN         33

#if ANY(VIKI2, miniVIKI)
  #undef SD_DETECT_PIN
  #define SD_DETECT_PIN    49   // For easy adapter board
  #undef BEEPER_PIN
  #define  BEEPER_PIN      12   // 33 isn't physically available to the LCD display
#else
  #define STAT_LED_RED_PIN  32
  #define STAT_LED_BLUE_PIN 35
#endif

//
// Misc. Functions
//
#if ENABLED(CASE_LIGHT_ENABLE) && PIN_EXISTS(CASE_LIGHT) && defined(DOGLCD_A0) && DOGLCD_A0 == CASE_LIGHT_PIN
  #undef DOGLCD_A0              // Steal pin 44 for the case light; if you have a Viki2 and have connected it
  #define DOGLCD_A0        57   // following the Panucatt wiring diagram, you may need to tweak these pin assignments
                                // as the wiring diagram uses pin 44 for DOGLCD_A0
#endif

//
// M3/M4/M5 - Spindle/Laser Control
//
#undef SPINDLE_LASER_PWM_PIN    // Definitions in pins_RAMPS.h are no good with the AzteegX3pro board
#undef SPINDLE_LASER_ENA_PIN
#undef SPINDLE_DIR_PIN

#if HAS_CUTTER   // EXP2 header
  #if ANY(VIKI2, miniVIKI)
    #undef BTN_EN2
    #define BTN_EN2             31   // need 7 for the spindle speed PWM
  #endif
  #define SPINDLE_LASER_PWM_PIN     7   // must have a hardware PWM
  #define SPINDLE_LASER_ENA_PIN    20   // Pin should have a pullup!
  #define SPINDLE_DIR_PIN          21
#endif
Further cleanup of comments, partial Doxygen-style Following up on #3231 2016-03-25 07:19:46 +01:00			`/**`
Added gplv3 header to all Marlin files 2016-03-24 19:01:20 +01:00			`* Marlin 3D Printer Firmware`
Tweaky change from (C) to (c) 2019-06-28 06:57:50 +02:00			`* Copyright (c) 2019 MarlinFirmware [https://github.com/MarlinFirmware/Marlin]`
Added gplv3 header to all Marlin files 2016-03-24 19:01:20 +01:00			`*`
			`* Based on Sprinter and grbl.`
Tweaky change from (C) to (c) 2019-06-28 06:57:50 +02:00			`* Copyright (c) 2011 Camiel Gubbels / Erik van der Zalm`
Added gplv3 header to all Marlin files 2016-03-24 19:01:20 +01:00			`*`
			`* 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/>.`
			`*`
			`*/`
Add include guards to some headers 2019-07-05 05:44:12 +02:00			`#pragma once`
Added gplv3 header to all Marlin files 2016-03-24 19:01:20 +01:00
Split up pins to make it more manageable Hopefully this is helpful to organization and future expansion…. 2015-01-26 03:40:00 +01:00			`/**`
			`* AZTEEG_X3_PRO (Arduino Mega) pin assignments`
			`*/`

Allow FAN_PIN override, pins cleanup (#10956) 2018-06-07 23:46:13 +02:00			`#ifndef __AVR_ATmega2560__`
Extend pins errors to include the processor 2018-11-09 04:57:15 +01:00			`#error "Oops! Select 'Arduino/Genuino Mega or Mega 2560' in 'Tools > Board.'"`
Allow FAN_PIN override, pins cleanup (#10956) 2018-06-07 23:46:13 +02:00			`#endif`

Header and pins changes to support 5 extruders 2017-04-06 23:46:30 +02:00			`#if HOTENDS > 5 \|\| E_STEPPERS > 5`
			`#error "Azteeg X3 Pro supports up to 5 hotends / E-steppers. Comment out this line to continue."`
			`#endif`

Allow FAN_PIN override, pins cleanup (#10956) 2018-06-07 23:46:13 +02:00			`#define BOARD_NAME "Azteeg X3 Pro"`

			`//`
			`// RAMPS pins overrides`
			`//`
config_adv (#7941) get rid of twi.h move to board files 2017-10-11 22:42:24 +02: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 22:27:04 +02:00			`//`
			`// Servos`
Consistent order/formatting of pins files 2016-08-23 00:05:22 +02:00			`//`
			`// Tested this pin with bed leveling on a Delta with 1 servo.`
			`// Physical wire attachment on EXT1: GND, 5V, D47.`
			`//`
			`#define SERVO0_PIN 47`
Use #undef in AZTEEG_X3_PRO for RAMPS overrides 2016-04-29 03:04:45 +02: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 22:27:04 +02:00			`//`
			`// Limit Switches`
Azteeg X3 Pro Pin Revisions I added the fan pins in here and left them at -1 in configuration_adv.h and it works fine. Pinned for a 4 extruder from 1-4 and HE5 being the controller fan, HE6 being the Extruder Auto Fan/Water pump in the Kraken case, and HE7 being for part cooling fan. Added in descriptions for the MIN MAX pin swap and for servo motor additions. 2015-03-29 04:14:42 +02:00			`//`
Use limit switch overrides 2019-06-06 04:32:10 +02:00			`#define X_STOP_PIN 3`
			`#define Y_STOP_PIN 14`
			`#define Z_STOP_PIN 18`

			`#ifndef FAN_PIN`
			`#define FAN_PIN 6`
			`#endif`

			`#if ENABLED(CASE_LIGHT_ENABLE) && !PIN_EXISTS(CASE_LIGHT)`
			`#define CASE_LIGHT_PIN 44`
			`#endif`

			`//`
			`// Import RAMPS 1.4 pins`
Azteeg X3 Pro Pin Revisions I added the fan pins in here and left them at -1 in configuration_adv.h and it works fine. Pinned for a 4 extruder from 1-4 and HE5 being the controller fan, HE6 being the Extruder Auto Fan/Water pump in the Kraken case, and HE7 being for part cooling fan. Added in descriptions for the MIN MAX pin swap and for servo motor additions. 2015-03-29 04:14:42 +02:00			`//`
Use limit switch overrides 2019-06-06 04:32:10 +02:00			`#include "pins_RAMPS.h"`

			`// DIGIPOT slave addresses`
			`#ifndef DIGIPOT_I2C_ADDRESS_A`
			`#define DIGIPOT_I2C_ADDRESS_A 0x2C // unshifted slave address for first DIGIPOT 0x2C (0x58 <- 0x2C << 1)`
			`#endif`
			`#ifndef DIGIPOT_I2C_ADDRESS_B`
			`#define DIGIPOT_I2C_ADDRESS_B 0x2E // unshifted slave address for second DIGIPOT 0x2E (0x5C <- 0x2E << 1)`
Styling adjustments (PR#2668 & PR#2670) Keep "astyled" reformatting 2015-10-03 08:08:58 +02:00			`#endif`
Use #undef in AZTEEG_X3_PRO for RAMPS overrides 2016-04-29 03:04:45 +02:00
Consistent order/formatting of pins files 2016-08-23 00:05:22 +02:00			`//`
			`// Z Probe (when not Z_MIN_PIN)`
			`//`
Define Z_MIN_PROBE_PIN always, allowing override 2016-08-03 05:31:44 +02:00			`#ifndef Z_MIN_PROBE_PIN`
Consistent order/formatting of pins files 2016-08-23 00:05:22 +02:00			`#define Z_MIN_PROBE_PIN 18`
Styling adjustments (PR#2668 & PR#2670) Keep "astyled" reformatting 2015-10-03 08:08:58 +02:00			`#endif`
Define Z_MIN_PROBE_PIN always, allowing override 2016-08-03 05:31:44 +02:00
Consistent order/formatting of pins files 2016-08-23 00:05:22 +02:00			`//`
			`// Steppers`
			`//`
Split up pins to make it more manageable Hopefully this is helpful to organization and future expansion…. 2015-01-26 03:40:00 +01:00			`#define E2_STEP_PIN 23`
			`#define E2_DIR_PIN 25`
			`#define E2_ENABLE_PIN 40`

			`#define E3_STEP_PIN 27`
			`#define E3_DIR_PIN 29`
			`#define E3_ENABLE_PIN 41`

			`#define E4_STEP_PIN 43`
			`#define E4_DIR_PIN 37`
			`#define E4_ENABLE_PIN 42`

Consistent order/formatting of pins files 2016-08-23 00:05:22 +02:00			`//`
			`// Temperature Sensors`
			`//`
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 22:27:04 +02:00			`#define TEMP_2_PIN 12 // Analog Input`
			`#define TEMP_3_PIN 11 // Analog Input`
			`#define TEMP_4_PIN 10 // Analog Input`
			`#define TC1 4 // Analog Input (Thermo couple on Azteeg X3Pro)`
			`#define TC2 5 // Analog Input (Thermo couple on Azteeg X3Pro)`
Consistent order/formatting of pins files 2016-08-23 00:05:22 +02:00
			`//`
			`// Heaters / Fans`
			`//`
Split up pins to make it more manageable Hopefully this is helpful to organization and future expansion…. 2015-01-26 03:40:00 +01:00			`#define HEATER_2_PIN 16`
			`#define HEATER_3_PIN 17`
Merge branch 'Development' into fixup_ramps_boards - Also apply cleanup for #1514 2015-02-20 02:26:22 +01:00			`#define HEATER_4_PIN 4`
			`#define HEATER_5_PIN 5`
			`#define HEATER_6_PIN 6`
Split up pins to make it more manageable Hopefully this is helpful to organization and future expansion…. 2015-01-26 03:40:00 +01:00			`#define HEATER_7_PIN 11`

Implement USE_CONTROLLER_FAN as a feature 2017-05-03 03:18:31 +02:00			`#ifndef CONTROLLER_FAN_PIN`
Apply spacing in pins files 2018-03-28 19:51:59 +02:00			`#define CONTROLLER_FAN_PIN 4 // Pin used for the fan to cool motherboard (-1 to disable)`
Implement USE_CONTROLLER_FAN as a feature 2017-05-03 03:18:31 +02:00			`#endif`
Consistent order/formatting of pins files 2016-08-23 00:05:22 +02:00
			`// Fans/Water Pump to cool the hotend cool side.`
Predefine auto fan pins in some pins files 2016-10-23 01:25:59 +02:00			`#define ORIG_E0_AUTO_FAN_PIN 5`
			`#define ORIG_E1_AUTO_FAN_PIN 5`
			`#define ORIG_E2_AUTO_FAN_PIN 5`
			`#define ORIG_E3_AUTO_FAN_PIN 5`
Azteeg X3 Pro Pin Revisions I added the fan pins in here and left them at -1 in configuration_adv.h and it works fine. Pinned for a 4 extruder from 1-4 and HE5 being the controller fan, HE6 being the Extruder Auto Fan/Water pump in the Kraken case, and HE7 being for part cooling fan. Added in descriptions for the MIN MAX pin swap and for servo motor additions. 2015-03-29 04:14:42 +02:00
			`//`
Consistent order/formatting of pins files 2016-08-23 00:05:22 +02:00			`// LCD / Controller`
Azteeg X3 Pro Pin Revisions I added the fan pins in here and left them at -1 in configuration_adv.h and it works fine. Pinned for a 4 extruder from 1-4 and HE5 being the controller fan, HE6 being the Extruder Auto Fan/Water pump in the Kraken case, and HE7 being for part cooling fan. Added in descriptions for the MIN MAX pin swap and for servo motor additions. 2015-03-29 04:14:42 +02:00			`//`
Consistent order/formatting of pins files 2016-08-23 00:05:22 +02:00			`#undef BEEPER_PIN`
			`#define BEEPER_PIN 33`
Revert "Undesired behavior with endstops swapped" This reverts commit 15028e9b0817a819a52fa62f3d7b8c638cf95e1b. 2015-03-29 08:52:53 +02:00
Extended condition macros (#13419) Allow `ENABLED`, `DISABLED`, `PIN_EXISTS`, and `BUTTON_EXISTS` to take multiple arguments. Also add: - Alias `ANY(...)` for `!DISABLED(...)` - Alias `ANY_PIN(...)` for `PIN_EXISTS(a) \|\| PIN_EXISTS(b) ...` - Alias `EITHER(A,B)` for `ANY(...)` - Alias `ALL(...)` and `BOTH(A,B)` for `ENABLED(...)` - `NONE(...)` for `DISABLED(...)` 2019-03-17 05:43:06 +01:00			`#if ANY(VIKI2, miniVIKI)`
Support for VIKI2 in RAMPS and derivatives 2016-06-29 03:11:32 +02:00			`#undef SD_DETECT_PIN`
Unify AVR90USB: Pins cleanup 2017-06-09 01:08:03 +02:00			`#define SD_DETECT_PIN 49 // For easy adapter board`
SPINDLE/LASER pins changes 2017-04-07 20:52:21 +02:00			`#undef BEEPER_PIN`
Apply spacing in pins files 2018-03-28 19:51:59 +02:00			`#define BEEPER_PIN 12 // 33 isn't physically available to the LCD display`
Consistent order/formatting of pins files 2016-08-23 00:05:22 +02:00			`#else`
Modernize configs 2017-10-09 23:18:10 +02:00			`#define STAT_LED_RED_PIN 32`
Always define status LED pins 2016-09-24 23:26:41 +02:00			`#define STAT_LED_BLUE_PIN 35`
Styling adjustments (PR#2668 & PR#2670) Keep "astyled" reformatting 2015-10-03 08:08:58 +02:00			`#endif`
SPINDLE/LASER pins changes 2017-04-07 20:52:21 +02:00
			`//`
			`// Misc. Functions`
			`//`
Extended condition macros (#13419) Allow `ENABLED`, `DISABLED`, `PIN_EXISTS`, and `BUTTON_EXISTS` to take multiple arguments. Also add: - Alias `ANY(...)` for `!DISABLED(...)` - Alias `ANY_PIN(...)` for `PIN_EXISTS(a) \|\| PIN_EXISTS(b) ...` - Alias `EITHER(A,B)` for `ANY(...)` - Alias `ALL(...)` and `BOTH(A,B)` for `ENABLED(...)` - `NONE(...)` for `DISABLED(...)` 2019-03-17 05:43:06 +01:00			`#if ENABLED(CASE_LIGHT_ENABLE) && PIN_EXISTS(CASE_LIGHT) && defined(DOGLCD_A0) && DOGLCD_A0 == CASE_LIGHT_PIN`
Apply spacing in pins files 2018-03-28 19:51:59 +02:00			`#undef DOGLCD_A0 // Steal pin 44 for the case light; if you have a Viki2 and have connected it`
			`#define DOGLCD_A0 57 // following the Panucatt wiring diagram, you may need to tweak these pin assignments`
			`// as the wiring diagram uses pin 44 for DOGLCD_A0`
SPINDLE/LASER pins changes 2017-04-07 20:52:21 +02:00			`#endif`

			`//`
			`// M3/M4/M5 - Spindle/Laser Control`
			`//`
Fix case light logic on Azteeg_X3 boards. 2017-06-01 19:33:24 +02:00			`#undef SPINDLE_LASER_PWM_PIN // Definitions in pins_RAMPS.h are no good with the AzteegX3pro board`
SPINDLE_LASER_ENABLE => SPINDLE_LASER_ENA 2019-04-09 00:52:33 +02:00			`#undef SPINDLE_LASER_ENA_PIN`
SPINDLE/LASER pins changes 2017-04-07 20:52:21 +02:00			`#undef SPINDLE_DIR_PIN`

Singleton for cutting tools (#14429) 2019-06-28 06:06:49 +02:00			`#if HAS_CUTTER // EXP2 header`
Extended condition macros (#13419) Allow `ENABLED`, `DISABLED`, `PIN_EXISTS`, and `BUTTON_EXISTS` to take multiple arguments. Also add: - Alias `ANY(...)` for `!DISABLED(...)` - Alias `ANY_PIN(...)` for `PIN_EXISTS(a) \|\| PIN_EXISTS(b) ...` - Alias `EITHER(A,B)` for `ANY(...)` - Alias `ALL(...)` and `BOTH(A,B)` for `ENABLED(...)` - `NONE(...)` for `DISABLED(...)` 2019-03-17 05:43:06 +01:00			`#if ANY(VIKI2, miniVIKI)`
SPINDLE/LASER pins changes 2017-04-07 20:52:21 +02:00			`#undef BTN_EN2`
Apply spacing in pins files 2018-03-28 19:51:59 +02:00			`#define BTN_EN2 31 // need 7 for the spindle speed PWM`
SPINDLE/LASER pins changes 2017-04-07 20:52:21 +02:00			`#endif`
Apply spacing in pins files 2018-03-28 19:51:59 +02:00			`#define SPINDLE_LASER_PWM_PIN 7 // must have a hardware PWM`
SPINDLE_LASER_ENABLE => SPINDLE_LASER_ENA 2019-04-09 00:52:33 +02:00			`#define SPINDLE_LASER_ENA_PIN 20 // Pin should have a pullup!`
SPINDLE/LASER pins changes 2017-04-07 20:52:21 +02:00			`#define SPINDLE_DIR_PIN 21`
			`#endif`