1
0
mirror of https://github.com/MarlinFirmware/Marlin.git synced 2024-12-01 23:58:33 +00:00

🎨 Arduino IDE pins comments, generate version

This commit is contained in:
Scott Lahteine 2024-10-20 13:23:07 -05:00
parent 9192ae5213
commit fc769ef023
16 changed files with 95 additions and 264 deletions

View File

@ -43,6 +43,13 @@
*/ */
//#define STRING_DISTRIBUTION_DATE "2024-10-20" //#define STRING_DISTRIBUTION_DATE "2024-10-20"
/**
* The protocol for communication to the host. Protocol indicates communication
* standards such as the use of ASCII, "echo:" and "error:" line prefixes, etc.
* (Other behaviors are given by the firmware version and capabilities report.)
*/
//#define PROTOCOL_VERSION "1.0"
/** /**
* Defines a generic printer name to be output to the LCD after booting Marlin. * Defines a generic printer name to be output to the LCD after booting Marlin.
*/ */
@ -68,8 +75,8 @@
//#define WEBSITE_URL "marlinfw.org" //#define WEBSITE_URL "marlinfw.org"
/** /**
* Set the vendor info the serial USB interface, if changable * Set the vendor info the serial USB interface, if changeable.
* Currently only supported by DUE platform * Currently only supported by DUE platform.
*/ */
//#define USB_DEVICE_VENDOR_ID 0x0000 //#define USB_DEVICE_VENDOR_ID 0x0000
//#define USB_DEVICE_PRODUCT_ID 0x0000 //#define USB_DEVICE_PRODUCT_ID 0x0000

View File

@ -101,8 +101,8 @@
#endif #endif
/** /**
* Set the vendor info the serial USB interface, if changable * Set the vendor info the serial USB interface, if changeable.
* Currently only supported by DUE platform * Currently only supported by DUE platform.
*/ */
#ifndef USB_DEVICE_VENDOR_ID #ifndef USB_DEVICE_VENDOR_ID
#define USB_DEVICE_VENDOR_ID 0x03EB /* ATMEL VID */ #define USB_DEVICE_VENDOR_ID 0x03EB /* ATMEL VID */

View File

@ -51,20 +51,14 @@
*/ */
/** /**
* Another usable Arduino IDE extension (Boards Manager) can be found at * Requires this Arduino IDE extension for Boards Manager:
* https://github.com/Lauszus/Sanguino * https://github.com/Lauszus/Sanguino
* *
* This extension has been tested on Arduino 1.6.12 & 1.8.0 * Follow the installation instructions at https://learn.sparkfun.com/pages/CustomBoardsArduino
* * Just use this JSON URL instead of Sparkfun's:
* Here's the JSON path:
* https://raw.githubusercontent.com/Lauszus/Sanguino/master/package_lauszus_sanguino_index.json * https://raw.githubusercontent.com/Lauszus/Sanguino/master/package_lauszus_sanguino_index.json
* *
* When installing select 1.0.2 * Once installed select the SANGUINO board and then select the CPU.
*
* Installation instructions can be found at https://learn.sparkfun.com/pages/CustomBoardsArduino
* Just use the above JSON URL instead of Sparkfun's JSON.
*
* Once installed select the Sanguino board and then select the CPU.
*/ */
/** /**

View File

@ -27,26 +27,14 @@
*/ */
/** /**
* Rev B 26 DEC 2016 * Requires this Arduino IDE extension for Boards Manager:
*
* added pointer to a current Arduino IDE extension
*/
/**
* A useable Arduino IDE extension (Boards Manager) can be found at
* https://github.com/Lauszus/Sanguino * https://github.com/Lauszus/Sanguino
* *
* This extension has been tested on Arduino 1.6.12 & 1.8.0 * Follow the installation instructions at https://learn.sparkfun.com/pages/CustomBoardsArduino
* * Just use this JSON URL instead of Sparkfun's:
* Here's the JSON path:
* https://raw.githubusercontent.com/Lauszus/Sanguino/master/package_lauszus_sanguino_index.json * https://raw.githubusercontent.com/Lauszus/Sanguino/master/package_lauszus_sanguino_index.json
* *
* When installing select 1.0.2 * Once installed select the SANGUINO board and then select the CPU.
*
* Installation instructions can be found at https://learn.sparkfun.com/pages/CustomBoardsArduino
* Just use the above JSON URL instead of Sparkfun's JSON.
*
* Once installed select the Sanguino board and then select the CPU.
*/ */
#define REQUIRE_MEGA644P #define REQUIRE_MEGA644P

View File

@ -26,25 +26,13 @@
*/ */
/** /**
* Rev B 26 DEC 2016 * Requires this Arduino IDE extension for Boards Manager:
*
* added pointer to a current Arduino IDE extension
*/
/**
* A useable Arduino IDE extension (Boards Manager) can be found at
* https://github.com/Lauszus/Sanguino * https://github.com/Lauszus/Sanguino
* *
* This extension has been tested on Arduino 1.6.12 & 1.8.0 * Follow the installation instructions at https://learn.sparkfun.com/pages/CustomBoardsArduino
* * Just use this JSON URL instead of Sparkfun's:
* Here's the JSON path:
* https://raw.githubusercontent.com/Lauszus/Sanguino/master/package_lauszus_sanguino_index.json * https://raw.githubusercontent.com/Lauszus/Sanguino/master/package_lauszus_sanguino_index.json
* *
* When installing select 1.0.2
*
* Installation instructions can be found at https://learn.sparkfun.com/pages/CustomBoardsArduino
* Just use the above JSON URL instead of Sparkfun's JSON.
*
* Once installed select the SANGUINO board and then select the CPU. * Once installed select the SANGUINO board and then select the CPU.
*/ */

View File

@ -26,29 +26,15 @@
* Schematic: https://reprap.org/mediawiki/images/0/0f/GEN6_Mendel_Circuit.pdf * Schematic: https://reprap.org/mediawiki/images/0/0f/GEN6_Mendel_Circuit.pdf
*/ */
/**
* Rev B 26 DEC 2016
*
* 1) added pointer to a current Arduino IDE extension
* 2) added support for M3, M4 & M5 spindle control commands
* 3) added case light pin definition
*/
/** /**
* A useable Arduino IDE extension (Boards Manager) can be found at * Requires this Arduino IDE extension for Boards Manager:
* https://github.com/Lauszus/Sanguino * https://github.com/Lauszus/Sanguino
* *
* This extension has been tested on Arduino 1.6.12 & 1.8.0 * Follow the installation instructions at https://learn.sparkfun.com/pages/CustomBoardsArduino
* * Just use this JSON URL instead of Sparkfun's:
* Here's the JSON path:
* https://raw.githubusercontent.com/Lauszus/Sanguino/master/package_lauszus_sanguino_index.json * https://raw.githubusercontent.com/Lauszus/Sanguino/master/package_lauszus_sanguino_index.json
* *
* When installing select 1.0.2 * Once installed select the SANGUINO board and then select the CPU.
*
* Installation instructions can be found at https://learn.sparkfun.com/pages/CustomBoardsArduino
* Just use the above JSON URL instead of Sparkfun's JSON.
*
* Once installed select the Sanguino board and then select the CPU.
*/ */
#define ALLOW_MEGA644P #define ALLOW_MEGA644P

View File

@ -26,25 +26,13 @@
*/ */
/** /**
* Rev B 26 DEC 2016 * Requires this Arduino IDE extension for Boards Manager:
*
* added pointer to a current Arduino IDE extension
*/
/**
* A useable Arduino IDE extension (Boards Manager) can be found at
* https://github.com/Lauszus/Sanguino * https://github.com/Lauszus/Sanguino
* *
* This extension has been tested on Arduino 1.6.12 & 1.8.0 * Follow the installation instructions at https://learn.sparkfun.com/pages/CustomBoardsArduino
* * Just use this JSON URL instead of Sparkfun's:
* Here's the JSON path:
* https://raw.githubusercontent.com/Lauszus/Sanguino/master/package_lauszus_sanguino_index.json * https://raw.githubusercontent.com/Lauszus/Sanguino/master/package_lauszus_sanguino_index.json
* *
* When installing select 1.0.2
*
* Installation instructions can be found at https://learn.sparkfun.com/pages/CustomBoardsArduino
* Just use the above JSON URL instead of Sparkfun's JSON.
*
* Once installed select the SANGUINO board and then select the CPU. * Once installed select the SANGUINO board and then select the CPU.
*/ */

View File

@ -29,29 +29,15 @@
* Schematic (1.3.1): https://github.com/Traumflug/Generation_7_Electronics/blob/release-1.3.1/release%20documents/Gen7Board%20Schematic.pdf * Schematic (1.3.1): https://github.com/Traumflug/Generation_7_Electronics/blob/release-1.3.1/release%20documents/Gen7Board%20Schematic.pdf
*/ */
/**
* Rev B 26 DEC 2016
*
* 1) added pointer to a current Arduino IDE extension
* 2) added support for M3, M4 & M5 spindle control commands
* 3) added case light pin definition
*/
/** /**
* A useable Arduino IDE extension (Boards Manager) can be found at * Requires this Arduino IDE extension for Boards Manager:
* https://github.com/Lauszus/Sanguino * https://github.com/Lauszus/Sanguino
* *
* This extension has been tested on Arduino 1.6.12 & 1.8.0 * Follow the installation instructions at https://learn.sparkfun.com/pages/CustomBoardsArduino
* * Just use this JSON URL instead of Sparkfun's:
* Here's the JSON path:
* https://raw.githubusercontent.com/Lauszus/Sanguino/master/package_lauszus_sanguino_index.json * https://raw.githubusercontent.com/Lauszus/Sanguino/master/package_lauszus_sanguino_index.json
* *
* When installing select 1.0.2 * Once installed select the SANGUINO board and then select the CPU.
*
* Installation instructions can be found at https://learn.sparkfun.com/pages/CustomBoardsArduino
* Just use the above JSON URL instead of Sparkfun's JSON.
*
* Once installed select the Sanguino board and then select the CPU.
*/ */
#define ALLOW_MEGA644 #define ALLOW_MEGA644

View File

@ -26,26 +26,14 @@
*/ */
/** /**
* Rev B 26 DEC 2016 * Requires this Arduino IDE extension for Boards Manager:
*
* added pointer to a current Arduino IDE extension
*/
/**
* A useable Arduino IDE extension (Boards Manager) can be found at
* https://github.com/Lauszus/Sanguino * https://github.com/Lauszus/Sanguino
* *
* This extension has been tested on Arduino 1.6.12 & 1.8.0 * Follow the installation instructions at https://learn.sparkfun.com/pages/CustomBoardsArduino
* * Just use this JSON URL instead of Sparkfun's:
* Here's the JSON path:
* https://raw.githubusercontent.com/Lauszus/Sanguino/master/package_lauszus_sanguino_index.json * https://raw.githubusercontent.com/Lauszus/Sanguino/master/package_lauszus_sanguino_index.json
* *
* When installing select 1.0.2 * Once installed select the SANGUINO board and then select the CPU.
*
* Installation instructions can be found at https://learn.sparkfun.com/pages/CustomBoardsArduino
* Just use the above JSON URL instead of Sparkfun's JSON.
*
* Once installed select the Sanguino board and then select the CPU.
*/ */
#define BOARD_INFO_NAME "Gen7 v1.3" #define BOARD_INFO_NAME "Gen7 v1.3"

View File

@ -28,28 +28,14 @@
*/ */
/** /**
* Rev B 26 DEC 2016 * Requires this Arduino IDE extension for Boards Manager:
*
* 1) added pointer to a current Arduino IDE extension
* 2) added support for M3, M4 & M5 spindle control commands
* 3) added case light pin definition
*/
/**
* A useable Arduino IDE extension (Boards Manager) can be found at
* https://github.com/Lauszus/Sanguino * https://github.com/Lauszus/Sanguino
* *
* This extension has been tested on Arduino 1.6.12 & 1.8.0 * Follow the installation instructions at https://learn.sparkfun.com/pages/CustomBoardsArduino
* * Just use this JSON URL instead of Sparkfun's:
* Here's the JSON path:
* https://raw.githubusercontent.com/Lauszus/Sanguino/master/package_lauszus_sanguino_index.json * https://raw.githubusercontent.com/Lauszus/Sanguino/master/package_lauszus_sanguino_index.json
* *
* When installing select 1.0.2 * Once installed select the SANGUINO board and then select the CPU.
*
* Installation instructions can be found at https://learn.sparkfun.com/pages/CustomBoardsArduino
* Just use the above JSON URL instead of Sparkfun's JSON.
*
* Once installed select the Sanguino board and then select the CPU.
*/ */
#define ALLOW_MEGA644 #define ALLOW_MEGA644

View File

@ -29,28 +29,14 @@
*/ */
/** /**
* Rev B 26 DEC 2016 * Requires this Arduino IDE extension for Boards Manager:
*
* 1) added pointer to a current Arduino IDE extension
* 2) added support for M3, M4 & M5 spindle control commands
* 3) added case light pin definition
*/
/**
* A useable Arduino IDE extension (Boards Manager) can be found at
* https://github.com/Lauszus/Sanguino * https://github.com/Lauszus/Sanguino
* *
* This extension has been tested on Arduino 1.6.12 & 1.8.0 * Follow the installation instructions at https://learn.sparkfun.com/pages/CustomBoardsArduino
* * Just use this JSON URL instead of Sparkfun's:
* Here's the JSON path:
* https://raw.githubusercontent.com/Lauszus/Sanguino/master/package_lauszus_sanguino_index.json * https://raw.githubusercontent.com/Lauszus/Sanguino/master/package_lauszus_sanguino_index.json
* *
* When installing select 1.0.2 * Once installed select the SANGUINO board and then select the CPU.
*
* Installation instructions can be found at https://learn.sparkfun.com/pages/CustomBoardsArduino
* Just use the above JSON URL instead of Sparkfun's JSON.
*
* Once installed select the Sanguino board and then select the CPU.
*/ */
#define ALLOW_MEGA644 #define ALLOW_MEGA644

View File

@ -53,26 +53,14 @@
*/ */
/** /**
* Rev B 26 DEC 2016 * Requires this Arduino IDE extension for Boards Manager:
*
* added pointer to a current Arduino IDE extension
*/
/**
* A useable Arduino IDE extension (Boards Manager) can be found at
* https://github.com/Lauszus/Sanguino * https://github.com/Lauszus/Sanguino
* *
* This extension has been tested on Arduino 1.6.12 & 1.8.0 * Follow the installation instructions at https://learn.sparkfun.com/pages/CustomBoardsArduino
* * Just use this JSON URL instead of Sparkfun's:
* Here's the JSON path:
* https://raw.githubusercontent.com/Lauszus/Sanguino/master/package_lauszus_sanguino_index.json * https://raw.githubusercontent.com/Lauszus/Sanguino/master/package_lauszus_sanguino_index.json
* *
* When installing select 1.0.2 * Once installed select the SANGUINO board and then select the CPU.
*
* Installation instructions can be found at https://learn.sparkfun.com:443/pages/CustomBoardsArduino
* Just use the above JSON URL instead of Sparkfun's JSON.
*
* Once installed select the Sanguino board and then select the CPU.
*/ */
#if NOT_TARGET(__AVR_ATmega644P__, __AVR_ATmega644__) #if NOT_TARGET(__AVR_ATmega644P__, __AVR_ATmega644__)

View File

@ -51,26 +51,14 @@
*/ */
/** /**
* Rev B 26 DEC 2016 * Requires this Arduino IDE extension for Boards Manager:
*
* added pointer to a current Arduino IDE extension
*/
/**
* A useable Arduino IDE extension (Boards Manager) can be found at
* https://github.com/Lauszus/Sanguino * https://github.com/Lauszus/Sanguino
* *
* This extension has been tested on Arduino 1.6.12 & 1.8.0 * Follow the installation instructions at https://learn.sparkfun.com/pages/CustomBoardsArduino
* * Just use this JSON URL instead of Sparkfun's:
* Here's the JSON path:
* https://raw.githubusercontent.com/Lauszus/Sanguino/master/package_lauszus_sanguino_index.json * https://raw.githubusercontent.com/Lauszus/Sanguino/master/package_lauszus_sanguino_index.json
* *
* When installing select 1.0.2 * Once installed select the SANGUINO board and then select the CPU.
*
* Installation instructions can be found at https://learn.sparkfun.com/pages/CustomBoardsArduino
* Just use the above JSON URL instead of Sparkfun's JSON.
*
* Once installed select the Sanguino board and then select the CPU.
*/ */
#if NOT_TARGET(__AVR_ATmega644__) #if NOT_TARGET(__AVR_ATmega644__)

View File

@ -31,28 +31,14 @@
*/ */
/** /**
* Rev B 26 DEC 2016 * Requires this Arduino IDE extension for Boards Manager:
*
* 1) added pointer to a current Arduino IDE extension
* 2) added support for M3, M4 & M5 spindle control commands
* 3) added case light pin definition
*/
/**
* A useable Arduino IDE extension (Boards Manager) can be found at
* https://github.com/Lauszus/Sanguino * https://github.com/Lauszus/Sanguino
* *
* This extension has been tested on Arduino 1.6.12 & 1.8.0 * Follow the installation instructions at https://learn.sparkfun.com/pages/CustomBoardsArduino
* * Just use this JSON URL instead of Sparkfun's:
* Here's the JSON path:
* https://raw.githubusercontent.com/Lauszus/Sanguino/master/package_lauszus_sanguino_index.json * https://raw.githubusercontent.com/Lauszus/Sanguino/master/package_lauszus_sanguino_index.json
* *
* When installing select 1.0.2 * Once installed select the SANGUINO board and then select the CPU.
*
* Installation instructions can be found at https://learn.sparkfun.com/pages/CustomBoardsArduino
* Just use the above JSON URL instead of Sparkfun's JSON.
*
* Once installed select the Sanguino board and then select the CPU.
*/ */
#define ALLOW_MEGA644P #define ALLOW_MEGA644P

View File

@ -26,27 +26,14 @@
*/ */
/** /**
* Rev B 26 DEC 2016 * Requires this Arduino IDE extension for Boards Manager:
*
* added pointer to a current Arduino IDE extension
* this assumes that this board uses the Sanguino pin map
*/
/**
* A useable Arduino IDE extension (Boards Manager) can be found at
* https://github.com/Lauszus/Sanguino * https://github.com/Lauszus/Sanguino
* *
* This extension has been tested on Arduino 1.6.12 & 1.8.0 * Follow the installation instructions at https://learn.sparkfun.com/pages/CustomBoardsArduino
* * Just use this JSON URL instead of Sparkfun's:
* Here's the JSON path:
* https://raw.githubusercontent.com/Lauszus/Sanguino/master/package_lauszus_sanguino_index.json * https://raw.githubusercontent.com/Lauszus/Sanguino/master/package_lauszus_sanguino_index.json
* *
* When installing select 1.0.2 * Once installed select the SANGUINO board and then select the CPU.
*
* Installation instructions can be found at https://learn.sparkfun.com/pages/CustomBoardsArduino
* Just use the above JSON URL instead of Sparkfun's JSON.
*
* Once installed select the Sanguino board and then select the CPU.
*/ */
#define ALLOW_MEGA644 #define ALLOW_MEGA644

View File

@ -19,6 +19,7 @@ VERSION="$(git -C "${DIR}" describe --tags --first-parent 2>/dev/null || true)"
STRING_DISTRIBUTION_DATE="${STRING_DISTRIBUTION_DATE:-$(date '+%Y-%m-%d %H:%M')}" STRING_DISTRIBUTION_DATE="${STRING_DISTRIBUTION_DATE:-$(date '+%Y-%m-%d %H:%M')}"
SHORT_BUILD_VERSION="${SHORT_BUILD_VERSION:-${BRANCH}}" SHORT_BUILD_VERSION="${SHORT_BUILD_VERSION:-${BRANCH}}"
DETAILED_BUILD_VERSION="${DETAILED_BUILD_VERSION:-${BRANCH}-${VERSION}}" DETAILED_BUILD_VERSION="${DETAILED_BUILD_VERSION:-${BRANCH}-${VERSION}}"
PROTOCOL_VERSION="1.0"
# Gets some misc options from their defaults # Gets some misc options from their defaults
DEFAULT_MACHINE_UUID="${DEFAULT_MACHINE_UUID:-$(awk -F'"' \ DEFAULT_MACHINE_UUID="${DEFAULT_MACHINE_UUID:-$(awk -F'"' \
@ -65,68 +66,52 @@ cat > "${WRITE_FILE}" <<EOF
*/ */
/** /**
* Marlin release version identifier * Marlin release version identifier
*/ */
#ifndef SHORT_BUILD_VERSION #define SHORT_BUILD_VERSION "${SHORT_BUILD_VERSION}"
#define SHORT_BUILD_VERSION "${SHORT_BUILD_VERSION}"
#endif
/** /**
* Verbose version identifier which should contain a reference to the location * Verbose version identifier which should contain a reference to the location
* from where the binary was downloaded or the source code was compiled. * from where the binary was downloaded or the source code was compiled.
*/ */
#ifndef DETAILED_BUILD_VERSION #define DETAILED_BUILD_VERSION "${DETAILED_BUILD_VERSION}"
#define DETAILED_BUILD_VERSION "${DETAILED_BUILD_VERSION}"
#endif
/** /**
* The STRING_DISTRIBUTION_DATE represents when the binary file was built, * The STRING_DISTRIBUTION_DATE represents when the binary file was built,
* here we define this default string as the date where the latest release * here we define this default string as the date where the latest release
* version was tagged. * version was tagged.
*/ */
#ifndef STRING_DISTRIBUTION_DATE #define STRING_DISTRIBUTION_DATE "${STRING_DISTRIBUTION_DATE}"
#define STRING_DISTRIBUTION_DATE "${STRING_DISTRIBUTION_DATE}"
#endif
/** /**
* The protocol for communication to the host. Protocol indicates communication * The protocol for communication to the host. Protocol indicates communication
* standards such as the use of ASCII, "echo:" and "error:" line prefixes, etc. * standards such as the use of ASCII, "echo:" and "error:" line prefixes, etc.
* (Other behaviors are given by the firmware version and capabilities report.) * (Other behaviors are given by the firmware version and capabilities report.)
*/ */
#ifndef PROTOCOL_VERSION #define PROTOCOL_VERSION "${PROTOCOL_VERSION}"
#define PROTOCOL_VERSION "${PROTOCOL_VERSION}"
#endif
/** /**
* Defines a generic printer name to be output to the LCD after booting Marlin. * Defines a generic printer name to be output to the LCD after booting Marlin.
*/ */
#ifndef MACHINE_NAME #define MACHINE_NAME "${MACHINE_NAME}"
#define MACHINE_NAME "${MACHINE_NAME}"
#endif
/** /**
* The SOURCE_CODE_URL is the location where users will find the Marlin Source * The SOURCE_CODE_URL is the location where users will find the Marlin Source
* Code which is installed on the device. In most cases —unless the manufacturer * Code which is installed on the device. In most cases —unless the manufacturer
* has a distinct Github fork— the Source Code URL should just be the main * has a distinct Github fork— the Source Code URL should just be the main
* Marlin repository. * Marlin repository.
*/ */
#ifndef SOURCE_CODE_URL #define SOURCE_CODE_URL "${SOURCE_CODE_URL}"
#define SOURCE_CODE_URL "${SOURCE_CODE_URL}"
#endif
/** /**
* Default generic printer UUID. * Default generic printer UUID.
*/ */
#ifndef DEFAULT_MACHINE_UUID #define DEFAULT_MACHINE_UUID "${DEFAULT_MACHINE_UUID}"
#define DEFAULT_MACHINE_UUID "${DEFAULT_MACHINE_UUID}"
#endif
/** /**
* The WEBSITE_URL is the location where users can get more information such as * The WEBSITE_URL is the location where users can get more information such as
* documentation about a specific Marlin release. * documentation about a specific Marlin release.
*/ */
#ifndef WEBSITE_URL #define WEBSITE_URL "${WEBSITE_URL}"
#define WEBSITE_URL "${WEBSITE_URL}"
#endif
EOF EOF