From fc769ef023fa243de74bb32d9d0bef5ce0c866c3 Mon Sep 17 00:00:00 2001 From: Scott Lahteine Date: Sun, 20 Oct 2024 13:23:07 -0500 Subject: [PATCH] =?UTF-8?q?=F0=9F=8E=A8=20Arduino=20IDE=20pins=20comments,?= =?UTF-8?q?=20generate=20version?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- Marlin/Version.h | 11 ++- Marlin/src/inc/Version.h | 4 +- Marlin/src/pins/sanguino/pins_ANET_10.h | 14 +--- .../src/pins/sanguino/pins_GEN3_MONOLITHIC.h | 20 +---- Marlin/src/pins/sanguino/pins_GEN3_PLUS.h | 18 +--- Marlin/src/pins/sanguino/pins_GEN6.h | 22 +---- Marlin/src/pins/sanguino/pins_GEN6_DELUXE.h | 18 +--- Marlin/src/pins/sanguino/pins_GEN7_12.h | 22 +---- Marlin/src/pins/sanguino/pins_GEN7_13.h | 20 +---- Marlin/src/pins/sanguino/pins_GEN7_14.h | 22 +---- Marlin/src/pins/sanguino/pins_GEN7_CUSTOM.h | 22 +---- Marlin/src/pins/sanguino/pins_OMCA.h | 20 +---- Marlin/src/pins/sanguino/pins_OMCA_A.h | 20 +---- .../src/pins/sanguino/pins_SANGUINOLOLU_11.h | 22 +---- Marlin/src/pins/sanguino/pins_SETHI.h | 21 +---- buildroot/bin/generate_version | 83 ++++++++----------- 16 files changed, 95 insertions(+), 264 deletions(-) diff --git a/Marlin/Version.h b/Marlin/Version.h index 60a7ae41b84d..3982e43e0556 100644 --- a/Marlin/Version.h +++ b/Marlin/Version.h @@ -43,6 +43,13 @@ */ //#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. */ @@ -68,8 +75,8 @@ //#define WEBSITE_URL "marlinfw.org" /** - * Set the vendor info the serial USB interface, if changable - * Currently only supported by DUE platform + * Set the vendor info the serial USB interface, if changeable. + * Currently only supported by DUE platform. */ //#define USB_DEVICE_VENDOR_ID 0x0000 //#define USB_DEVICE_PRODUCT_ID 0x0000 diff --git a/Marlin/src/inc/Version.h b/Marlin/src/inc/Version.h index daf25f424bfd..29e64095ead1 100644 --- a/Marlin/src/inc/Version.h +++ b/Marlin/src/inc/Version.h @@ -101,8 +101,8 @@ #endif /** - * Set the vendor info the serial USB interface, if changable - * Currently only supported by DUE platform + * Set the vendor info the serial USB interface, if changeable. + * Currently only supported by DUE platform. */ #ifndef USB_DEVICE_VENDOR_ID #define USB_DEVICE_VENDOR_ID 0x03EB /* ATMEL VID */ diff --git a/Marlin/src/pins/sanguino/pins_ANET_10.h b/Marlin/src/pins/sanguino/pins_ANET_10.h index 189b5963c160..708df2219953 100644 --- a/Marlin/src/pins/sanguino/pins_ANET_10.h +++ b/Marlin/src/pins/sanguino/pins_ANET_10.h @@ -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 * - * This extension has been tested on Arduino 1.6.12 & 1.8.0 - * - * Here's the JSON path: + * Follow the installation instructions at https://learn.sparkfun.com/pages/CustomBoardsArduino + * Just use this JSON URL instead of Sparkfun's: * 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. */ /** diff --git a/Marlin/src/pins/sanguino/pins_GEN3_MONOLITHIC.h b/Marlin/src/pins/sanguino/pins_GEN3_MONOLITHIC.h index 2fa407d07e89..7befd7fe0a56 100644 --- a/Marlin/src/pins/sanguino/pins_GEN3_MONOLITHIC.h +++ b/Marlin/src/pins/sanguino/pins_GEN3_MONOLITHIC.h @@ -27,26 +27,14 @@ */ /** - * Rev B 26 DEC 2016 - * - * added pointer to a current Arduino IDE extension - */ - -/** - * A useable Arduino IDE extension (Boards Manager) can be found at + * Requires this Arduino IDE extension for Boards Manager: * https://github.com/Lauszus/Sanguino * - * This extension has been tested on Arduino 1.6.12 & 1.8.0 - * - * Here's the JSON path: + * Follow the installation instructions at https://learn.sparkfun.com/pages/CustomBoardsArduino + * Just use this JSON URL instead of Sparkfun's: * 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. */ #define REQUIRE_MEGA644P diff --git a/Marlin/src/pins/sanguino/pins_GEN3_PLUS.h b/Marlin/src/pins/sanguino/pins_GEN3_PLUS.h index 2340bb504036..86869fc85f31 100644 --- a/Marlin/src/pins/sanguino/pins_GEN3_PLUS.h +++ b/Marlin/src/pins/sanguino/pins_GEN3_PLUS.h @@ -26,25 +26,13 @@ */ /** - * Rev B 26 DEC 2016 - * - * added pointer to a current Arduino IDE extension - */ - -/** - * A useable Arduino IDE extension (Boards Manager) can be found at + * Requires this Arduino IDE extension for Boards Manager: * https://github.com/Lauszus/Sanguino * - * This extension has been tested on Arduino 1.6.12 & 1.8.0 - * - * Here's the JSON path: + * Follow the installation instructions at https://learn.sparkfun.com/pages/CustomBoardsArduino + * Just use this JSON URL instead of Sparkfun's: * 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. */ diff --git a/Marlin/src/pins/sanguino/pins_GEN6.h b/Marlin/src/pins/sanguino/pins_GEN6.h index 8ccb311ce3db..ad8ef97cb493 100644 --- a/Marlin/src/pins/sanguino/pins_GEN6.h +++ b/Marlin/src/pins/sanguino/pins_GEN6.h @@ -26,29 +26,15 @@ * 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 * - * This extension has been tested on Arduino 1.6.12 & 1.8.0 - * - * Here's the JSON path: + * Follow the installation instructions at https://learn.sparkfun.com/pages/CustomBoardsArduino + * Just use this JSON URL instead of Sparkfun's: * 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. */ #define ALLOW_MEGA644P diff --git a/Marlin/src/pins/sanguino/pins_GEN6_DELUXE.h b/Marlin/src/pins/sanguino/pins_GEN6_DELUXE.h index caf395fd9467..ffe14e69749d 100644 --- a/Marlin/src/pins/sanguino/pins_GEN6_DELUXE.h +++ b/Marlin/src/pins/sanguino/pins_GEN6_DELUXE.h @@ -26,25 +26,13 @@ */ /** - * Rev B 26 DEC 2016 - * - * added pointer to a current Arduino IDE extension - */ - -/** - * A useable Arduino IDE extension (Boards Manager) can be found at + * Requires this Arduino IDE extension for Boards Manager: * https://github.com/Lauszus/Sanguino * - * This extension has been tested on Arduino 1.6.12 & 1.8.0 - * - * Here's the JSON path: + * Follow the installation instructions at https://learn.sparkfun.com/pages/CustomBoardsArduino + * Just use this JSON URL instead of Sparkfun's: * 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. */ diff --git a/Marlin/src/pins/sanguino/pins_GEN7_12.h b/Marlin/src/pins/sanguino/pins_GEN7_12.h index 10b9780ab3f0..691199f64e86 100644 --- a/Marlin/src/pins/sanguino/pins_GEN7_12.h +++ b/Marlin/src/pins/sanguino/pins_GEN7_12.h @@ -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 */ - /** - * 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 * - * This extension has been tested on Arduino 1.6.12 & 1.8.0 - * - * Here's the JSON path: + * Follow the installation instructions at https://learn.sparkfun.com/pages/CustomBoardsArduino + * Just use this JSON URL instead of Sparkfun's: * 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. */ #define ALLOW_MEGA644 diff --git a/Marlin/src/pins/sanguino/pins_GEN7_13.h b/Marlin/src/pins/sanguino/pins_GEN7_13.h index a7c513cbcd82..8ec4d4928f04 100644 --- a/Marlin/src/pins/sanguino/pins_GEN7_13.h +++ b/Marlin/src/pins/sanguino/pins_GEN7_13.h @@ -26,26 +26,14 @@ */ /** - * Rev B 26 DEC 2016 - * - * added pointer to a current Arduino IDE extension - */ - -/** - * A useable Arduino IDE extension (Boards Manager) can be found at + * Requires this Arduino IDE extension for Boards Manager: * https://github.com/Lauszus/Sanguino * - * This extension has been tested on Arduino 1.6.12 & 1.8.0 - * - * Here's the JSON path: + * Follow the installation instructions at https://learn.sparkfun.com/pages/CustomBoardsArduino + * Just use this JSON URL instead of Sparkfun's: * 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. */ #define BOARD_INFO_NAME "Gen7 v1.3" diff --git a/Marlin/src/pins/sanguino/pins_GEN7_14.h b/Marlin/src/pins/sanguino/pins_GEN7_14.h index b4e6a5eac9b3..2e4cacb56ec8 100644 --- a/Marlin/src/pins/sanguino/pins_GEN7_14.h +++ b/Marlin/src/pins/sanguino/pins_GEN7_14.h @@ -28,28 +28,14 @@ */ /** - * 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 * - * This extension has been tested on Arduino 1.6.12 & 1.8.0 - * - * Here's the JSON path: + * Follow the installation instructions at https://learn.sparkfun.com/pages/CustomBoardsArduino + * Just use this JSON URL instead of Sparkfun's: * 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. */ #define ALLOW_MEGA644 diff --git a/Marlin/src/pins/sanguino/pins_GEN7_CUSTOM.h b/Marlin/src/pins/sanguino/pins_GEN7_CUSTOM.h index 6b4f2b823107..c363e528d380 100644 --- a/Marlin/src/pins/sanguino/pins_GEN7_CUSTOM.h +++ b/Marlin/src/pins/sanguino/pins_GEN7_CUSTOM.h @@ -29,28 +29,14 @@ */ /** - * 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 * - * This extension has been tested on Arduino 1.6.12 & 1.8.0 - * - * Here's the JSON path: + * Follow the installation instructions at https://learn.sparkfun.com/pages/CustomBoardsArduino + * Just use this JSON URL instead of Sparkfun's: * 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. */ #define ALLOW_MEGA644 diff --git a/Marlin/src/pins/sanguino/pins_OMCA.h b/Marlin/src/pins/sanguino/pins_OMCA.h index 19f14745fc6f..428151ed5101 100644 --- a/Marlin/src/pins/sanguino/pins_OMCA.h +++ b/Marlin/src/pins/sanguino/pins_OMCA.h @@ -53,26 +53,14 @@ */ /** - * Rev B 26 DEC 2016 - * - * added pointer to a current Arduino IDE extension - */ - -/** - * A useable Arduino IDE extension (Boards Manager) can be found at + * Requires this Arduino IDE extension for Boards Manager: * https://github.com/Lauszus/Sanguino * - * This extension has been tested on Arduino 1.6.12 & 1.8.0 - * - * Here's the JSON path: + * Follow the installation instructions at https://learn.sparkfun.com/pages/CustomBoardsArduino + * Just use this JSON URL instead of Sparkfun's: * 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: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. + * Once installed select the SANGUINO board and then select the CPU. */ #if NOT_TARGET(__AVR_ATmega644P__, __AVR_ATmega644__) diff --git a/Marlin/src/pins/sanguino/pins_OMCA_A.h b/Marlin/src/pins/sanguino/pins_OMCA_A.h index 73a678bff620..e3a46664b1e5 100644 --- a/Marlin/src/pins/sanguino/pins_OMCA_A.h +++ b/Marlin/src/pins/sanguino/pins_OMCA_A.h @@ -51,26 +51,14 @@ */ /** - * Rev B 26 DEC 2016 - * - * added pointer to a current Arduino IDE extension - */ - -/** - * A useable Arduino IDE extension (Boards Manager) can be found at + * Requires this Arduino IDE extension for Boards Manager: * https://github.com/Lauszus/Sanguino * - * This extension has been tested on Arduino 1.6.12 & 1.8.0 - * - * Here's the JSON path: + * Follow the installation instructions at https://learn.sparkfun.com/pages/CustomBoardsArduino + * Just use this JSON URL instead of Sparkfun's: * 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. */ #if NOT_TARGET(__AVR_ATmega644__) diff --git a/Marlin/src/pins/sanguino/pins_SANGUINOLOLU_11.h b/Marlin/src/pins/sanguino/pins_SANGUINOLOLU_11.h index d9b36591ee7d..50df2c95091a 100644 --- a/Marlin/src/pins/sanguino/pins_SANGUINOLOLU_11.h +++ b/Marlin/src/pins/sanguino/pins_SANGUINOLOLU_11.h @@ -31,28 +31,14 @@ */ /** - * 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 * - * This extension has been tested on Arduino 1.6.12 & 1.8.0 - * - * Here's the JSON path: + * Follow the installation instructions at https://learn.sparkfun.com/pages/CustomBoardsArduino + * Just use this JSON URL instead of Sparkfun's: * 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. */ #define ALLOW_MEGA644P diff --git a/Marlin/src/pins/sanguino/pins_SETHI.h b/Marlin/src/pins/sanguino/pins_SETHI.h index 9a21e2d23631..66e7e64d4fdd 100644 --- a/Marlin/src/pins/sanguino/pins_SETHI.h +++ b/Marlin/src/pins/sanguino/pins_SETHI.h @@ -26,27 +26,14 @@ */ /** - * Rev B 26 DEC 2016 - * - * 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 + * Requires this Arduino IDE extension for Boards Manager: * https://github.com/Lauszus/Sanguino * - * This extension has been tested on Arduino 1.6.12 & 1.8.0 - * - * Here's the JSON path: + * Follow the installation instructions at https://learn.sparkfun.com/pages/CustomBoardsArduino + * Just use this JSON URL instead of Sparkfun's: * 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. */ #define ALLOW_MEGA644 diff --git a/buildroot/bin/generate_version b/buildroot/bin/generate_version index 70a108b1fedb..ff85fe7ecf31 100755 --- a/buildroot/bin/generate_version +++ b/buildroot/bin/generate_version @@ -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')}" SHORT_BUILD_VERSION="${SHORT_BUILD_VERSION:-${BRANCH}}" DETAILED_BUILD_VERSION="${DETAILED_BUILD_VERSION:-${BRANCH}-${VERSION}}" +PROTOCOL_VERSION="1.0" # Gets some misc options from their defaults DEFAULT_MACHINE_UUID="${DEFAULT_MACHINE_UUID:-$(awk -F'"' \ @@ -65,68 +66,52 @@ cat > "${WRITE_FILE}" <