Skip to content

Commit

Permalink
Merge 'upstream/master' into pr/573
Browse files Browse the repository at this point in the history
  • Loading branch information
thinkyhead committed Aug 22, 2024
2 parents 9603b34 + 1d8d550 commit f9c4295
Show file tree
Hide file tree
Showing 19 changed files with 76 additions and 30 deletions.
2 changes: 1 addition & 1 deletion _basics/install_platformio_vscode.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Visit the [Setting up Visual Studio Code](//code.visualstudio.com/docs/setup/set

You can download the latest Marlin source code from the [Downloads](/meta/download/) page. Older versions and detailed Release Notes can be downloaded from the [Marlin Releases](//github.com/MarlinFirmware/Marlin/releases) page on GitHub.

The 'latest' version might not always be the 'greatest' version for your setup. Be sure to ask around in our [Discord community](//discord.gg/marlin-firmware-461605380783472640) if you need assistance with any version of Marlin Firmware.
The 'latest' version might not always be the 'greatest' version for your setup. Be sure to ask around in our [Discord community](//discord.com/servers/marlin-firmware-461605380783472640) if you need assistance with any version of Marlin Firmware.

### 3. Install PlatformIO IDE

Expand Down
2 changes: 1 addition & 1 deletion _basics/reporting_bugs.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ In addition to following the guidelines above, we ask that you follow a thorough
- [Issue Queue](//github.com/MarlinFirmware/Marlin/issues)
- [Post a New Issue](//github.com/MarlinFirmware/Marlin/issues/new?labels=Bug%3A+Potential+%3F&template=bug_report.yml&title=%5BBUG%5D+%28bug+summary%29)
- [Bug Fix branch](//github.com/MarlinFirmware/Marlin/tree/bugfix-2.1.x)
- [MarlinFirmware on Discord](//discord.gg/marlin-firmware-461605380783472640) - Realtime chat with users and developers
- [MarlinFirmware on Discord](//discord.com/servers/marlin-firmware-461605380783472640) - Realtime chat with users and developers
- [Marlin Firmware](//www.facebook.com/groups/1049718498464482/) and [Marlin Firmware for 3D Printers](//www.facebook.com/groups/3Dtechtalk/) Facebook Groups
- [Marlin Forum](//forums.reprap.org/list.php?415) at RepRap.org
- [Marlin YouTube Videos](//youtube.com/results?search_query=marlin+firmware)
2 changes: 1 addition & 1 deletion _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ social:
- https://fosstodon.org/@marlinfirmware
- https://www.facebook.com/groups/1049718498464482/
- http://forums.reprap.org/list.php?415
- https://discord.gg/marlin-firmware-461605380783472640
- https://discord.com/servers/marlin-firmware-461605380783472640

repository:
main: 'https://github.com/MarlinFirmware/Marlin'
Expand Down
2 changes: 1 addition & 1 deletion _configuration/config-ini.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Marlin configurations include `#if` blocks to group dependent options, although

It can be tricky to migrate from older versions of Marlin as settings change. Marlin checks for old settings and tells you what to change during the build, but the final result is never fully up to date. Wouldn't it be nice if Marlin would automatically migrate old settings to a new configuration for you?

We're currently working on tools to improve the situation, with the goal to build a schema and a database of configurations across all Marlin versions so we can generate complete configuration headers, perform migrations, and even generate searchable documentation for this website. That is a big project unto itself, so feel free to [get involved on Discord](https://discord.gg/marlin-firmware-461605380783472640)!
We're currently working on tools to improve the situation, with the goal to build a schema and a database of configurations across all Marlin versions so we can generate complete configuration headers, perform migrations, and even generate searchable documentation for this website. That is a big project unto itself, so feel free to [get involved on Discord](https://discord.com/servers/marlin-firmware-461605380783472640)!

## Meta Configuration

Expand Down
4 changes: 2 additions & 2 deletions _configuration/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -2490,8 +2490,8 @@ Fixed-time-based Motion Control. Enable/disable and set parameters with G-code [
#if ENABLED(FT_MOTION)
#define FTM_DEFAULT_MODE ftMotionMode_ENABLED // Default mode of fixed time control. (Enums in ft_types.h)
#define FTM_DEFAULT_DYNFREQ_MODE dynFreqMode_DISABLED // Default mode of dynamic frequency calculation. (Enums in ft_types.h)
#define FTM_SHAPING_DEFAULT_X_FREQ 37.0f // (Hz) Default peak frequency used by input shapers.
#define FTM_SHAPING_DEFAULT_Y_FREQ 37.0f // (Hz) Default peak frequency used by input shapers.
#define FTM_SHAPING_DEFAULT_FREQ_X 37.0f // (Hz) Default peak frequency used by input shapers.
#define FTM_SHAPING_DEFAULT_FREQ_Y 37.0f // (Hz) Default peak frequency used by input shapers.
#define FTM_LINEAR_ADV_DEFAULT_ENA false // Default linear advance enable (true) or disable (false).
#define FTM_LINEAR_ADV_DEFAULT_K 0.0f // Default linear advance gain.
#define FTM_SHAPING_ZETA 0.1f // Zeta used by input shapers.
Expand Down
4 changes: 2 additions & 2 deletions _development/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The core Marlin team consists of a few maintainers who review contributions, dis
## Ways to contribute

### Donate
The current maintainer of Marlin is [Scott Lahteine](//www.thinkyhead.com/donate-to-marlin) aka [@thinkyhead](https://github.com/thinkyhead/). Scott has been writing software since 1977 mostly focusing on shareware and open source. He reviews every contribution before it goes into Marlin, maintains documentation, hosts the [Facebook](https://www.facebook.com/groups/marlinfirmware) and [Marlin Discord](https://discord.gg/marlin-firmware-461605380783472640), and maintains a test lab in Austin, TX.
The current maintainer of Marlin is [Scott Lahteine](//www.thinkyhead.com/donate-to-marlin) aka [@thinkyhead](https://github.com/thinkyhead/). Scott has been writing software since 1977 mostly focusing on shareware and open source. He reviews every contribution before it goes into Marlin, maintains documentation, hosts the [Facebook](https://www.facebook.com/groups/marlinfirmware) and [Marlin Discord](https://discord.com/servers/marlin-firmware-461605380783472640), and maintains a test lab in Austin, TX.

Your sponsorship accelerates development, testing, and advancement of the most ambitious open source multi-platform 3D printing firmware in the world. Several support options are available:

Expand Down Expand Up @@ -50,7 +50,7 @@ Are you skilled in information design? This website is far from complete, and it
There are now many community resources for users of Marlin. If you're looking for help installing or troubleshooting these are the best places to go.
- [MarlinFirmware on Discord](//discord.gg/marlin-firmware-461605380783472640) - Realtime chat with users and developers
- [MarlinFirmware on Discord](//discord.com/servers/marlin-firmware-461605380783472640) - Realtime chat with users and developers
- [Marlin Firmware](//www.facebook.com/groups/1049718498464482/) and [Marlin Firmware for 3D Printers](//www.facebook.com/groups/3Dtechtalk/) Facebook Groups
- [Marlin Forum](//forums.reprap.org/list.php?415) at RepRap.org
- [Marlin YouTube Videos](//youtube.com/results?search_query=marlin+firmware)
Expand Down
31 changes: 30 additions & 1 deletion _gcode/M115.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,20 +13,49 @@ codes: [ M115 ]
This command causes Marlin to output a string like this:

```
FIRMWARE_NAME:Marlin 1.1.0 (Github) SOURCE_CODE_URL:https://github.com/MarlinFirmware/Marlin PROTOCOL_VERSION:1.0 MACHINE_TYPE:RepRap EXTRUDER_COUNT:1 UUID:cede2a2f-41a2-4748-9b12-c55c62f367ff
FIRMWARE_NAME:Marlin 2.1.3 (Aug 1 2024 12:00:00) SOURCE_CODE_URL:github.com/MarlinFirmware/Marlin PROTOCOL_VERSION:1.0 MACHINE_TYPE:3D Printer KINEMATICS:Cartesian EXTRUDER_COUNT:1 UUID:cede2a2f-41a2-4748-9b12-c55c62f367ff
```

When `EXTENDED_CAPABILITIES_REPORT` is enabled, Marlin also reports its capabilities:

```
Cap:SERIAL_XON_XOFF:0
Cap:BINARY_FILE_TRANSFER:1
Cap:EEPROM:1
Cap:VOLUMETRIC:1
Cap:AUTOREPORT_POS:0
Cap:AUTOREPORT_TEMP:1
Cap:PROGRESS:0
Cap:PRINT_JOB:1
Cap:AUTOLEVEL:1
Cap:RUNOUT:0
Cap:Z_PROBE:1
Cap:LEVELING_DATA:0
Cap:BUILD_PERCENT:0
Cap:SOFTWARE_POWER:0
Cap:TOGGLE_LIGHTS:0
Cap:CASE_LIGHT_BRIGHTNESS:0
Cap:EMERGENCY_PARSER:1
Cap:HOST_ACTION_COMMANDS:0
Cap:PROMPT_SUPPORT:0
Cap:SDCARD:1
Cap:MULTI_VOLUME:0
Cap:REPEAT:0
Cap:SD_WRITE:1
Cap:AUTOREPORT_SD_STATUS:0
Cap:LONG_FILENAME:0
Cap:LFN_WRITE:0
Cap:CUSTOM_FIRMWARE_UPLOAD:1
Cap:EXTENDED_M20:0
Cap:THERMAL_PROTECTION:1
Cap:MOTION_MODES:0
Cap:ARCS:1
Cap:BABYSTEPPING:0
Cap:EP_BABYSTEP:0
Cap:CHAMBER_TEMPERATURE:0
Cap:COOLER_TEMPERATURE:0
Cap:MEATPACK:0
Cap:CONFIG_EXPORT:0
```

Hosts use this information to improve interoperability, so it's a good feature to enable.
Expand Down
3 changes: 2 additions & 1 deletion _gcode/M205.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,8 @@ parameters:

- tag: J
optional: true
description: Junction deviation (requires `JUNCTION_DEVIATION_MM`)
requires: JUNCTION_DEVIATION_MM
description: Junction deviation
values:
- tag: deviation
type: float
Expand Down
11 changes: 11 additions & 0 deletions _gcode/M207.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,3 +47,14 @@ parameters:
---

Use this command to set various parameters for firmware-based retraction. Send `M207` with no parameters to get the current firmware-based retraction settings.

### Retract/Recover tuning

Calibrating retract/recover lengths and speeds can be challenging because it requires just the right balance of 4 parameters. Fortunately you can print this simple test pattern by JCZD with only a little bit of filament:

![retract-recover helper](//engrenage.ch/files/marlin_retract_recover_helper.png)

* [3x3x3x3 pattern](//engrenage.ch/files/retract_recover_3x3x3x3-jczd.gcode) - 81 individual samples, you probably want to start with this and it should give you a decent approximation
* [4x4x4x4 pattern](//engrenage.ch/files/retract_recover_3x3x3x3-jczd.gcode) - 256 individual samples, for fine-tuning

These G-codes should work for bed sizes 300x300mm and smaller. A customizer is under construction, but in the meantime you can use search-and-replace. These G-code files **must be modified** to work on your printer. Read the comments in the header and the first few lines and update the indicated values for your machine and material.
6 changes: 4 additions & 2 deletions _gcode/M421.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,15 @@ parameters:
optional: true
description: X index into the mesh array
values:
- type: int
- tag: index
type: int

- tag: J
optional: true
description: Y index into the mesh array
values:
- type: int
- tag: index
type: int

- tag: X
optional: true
Expand Down
6 changes: 5 additions & 1 deletion _gcode/M592.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,8 @@ example:
---
Get or set Nonlinear Extrusion parameters.

_Nonlinear Extrusion_ adjusts the amount of extrusion based on the instantaneous velocity of extrusion, as a multiplier. The amount of extrusion is multiplied by `max(C, A*v^2 + B*v + C)` where `v` is extruder velocity in mm/s. Only adjusts forward extrusions, since those are the ones affected by back-pressure.
When Nonlinear Extrusion is enabled the extrusion volume is adjusted (as a multiplier) based on the instantaneous extrusion velocity. The extrusion length is multiplied by `max(C, A * v^2 + B * v + C)` where `v` is extruder velocity in mm/s.

The adjustment only applies when…
- …performing a forward extrusion, since those are the ones affected by back-pressure.
- …another axis is also moving (i.e., it's not a simple unretract). This is to prevent blobs at the line start.
2 changes: 1 addition & 1 deletion _gcode/M600.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ parameters:

- tag: L
optional: true
description: Load length, longer for bowden (negative)
description: Load length, longer for bowden (positive)
values:
- tag: pos
type: float
Expand Down
2 changes: 1 addition & 1 deletion _gcode/M603.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ parameters:

- tag: L
optional: true
description: Load length, longer for bowden (negative)
description: Load length, longer for bowden (positive)
values:
- tag: pos
type: float
Expand Down
10 changes: 5 additions & 5 deletions _gcode/M871.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,17 +21,17 @@ parameters:

- tag: V
optional: true
description: Z adjustment value, in micrometers.
description: Z adjustment value, in µm (micrometers).
values:
- tag: µm
- tag: value
type: int

- tag: I
optional: true
description: Index at which to store the given Z adjustment value.
values:
- tag: flag
type: bool
- tag: index
type: int

- tag: B
optional: true
Expand Down Expand Up @@ -65,8 +65,8 @@ example:
- code:
- M871 ; print current values
- M871 R ; reset all values factory default (zero, effectively disabling compensation)
- M871 P I1 V-5 ; set probe compensation value at index 1 to -5µm
- M871 B I2 V20 ; set bed compensation value at index 2 to 20µm
- M871 P I1 V-5 ; set probe compensation value at index 1 to -5µm
- M871 E I4 V-13 ; set extruder compensation value at index 4 to -13µm

---
Expand Down
6 changes: 3 additions & 3 deletions _hardware/tmc_drivers.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ Driver | Control | StealthChop | Sensorless<br>homing/probing | Driver monitori
:------:|:-------:|:-----------:|:----------------------------:|:-----------------:|:----------------:|:---------
TMC2100 | none | yes | no | no | no | Standalone mode only
TMC2130 | SPI | yes | yes | yes | yes |
TMC2160 | SPI | ??? | ??? | ??? | ??? |
TMC5130 | SPI | ??? | ??? | ??? | ??? |
TMC2160 | SPI | yes | yes | yes | yes |
TMC5130 | SPI | yes | yes | yes | yes |
TMC5160 | SPI |yes | yes | yes | yes |
TMC2208<br/>TMC2225 | UART | yes | no | yes | yes | UART RX line requires an interrupt capable pin.<br>Software UART not support on all platforms, such as DUE based boards.
TMC2208<br/>TMC2225 | UART | yes | no | yes | yes | UART RX line requires an interrupt capable pin.<br>Software UART isn't supported on all platforms, such as DUE based boards.
TMC2209<br/>TMC2226 | UART | yes | yes | yes | yes |
TMC2660 | SPI | no | not implemented | yes | no |

Expand Down
4 changes: 2 additions & 2 deletions _layouts/default.html
Original file line number Diff line number Diff line change
Expand Up @@ -105,8 +105,8 @@
<div class="container {% if page.url == '/' or page.collection == 'tools' or page.collection == 'meta' %} noshift-footer {% else %} shift-footer {% endif %}">
<div class="row">
<div class="col-8">
<p>Brought to you with <i class="fa fa-heart text-danger" aria-hidden="true"></i> lack of
<i class="fa fa-bed" aria-hidden="true"></i> and lots of
<p class="text-center">Brought to you with <i class="fa fa-heart text-danger" aria-hidden="true"></i>, lack of
<i class="fa fa-bed" aria-hidden="true"></i>, and lots of
<i class="fa fa-coffee" aria-hidden="true"></i>. <br />
The contents of this website are &copy; {{ site.time | date: '%Y' }} under the terms of the <a href="//www.gnu.org/licenses/gpl-3.0.txt">GPLv3</a> License.</p>
</div>
Expand Down
2 changes: 1 addition & 1 deletion _meta/releases.html
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
- The `2.1.x` branch will be copied to `lts-2.1.3` and branch `2.1.x` will go dormant.

The release process will work like this:
- Ahead of each release we'll make a snapshot of `dev` as a pre-release intended only for testers and announce it on [Discord](//discord.gg/marlin-firmware-461605380783472640).
- Ahead of each release we'll make a snapshot of `dev` as a pre-release intended only for testers and announce it on [Discord](//discord.com/servers/marlin-firmware-461605380783472640).
- During the testing period all development within `dev` will take the lead from the pre-release branch, so nothing will go into `dev` that isn't also going into the pending release. New features and other non-bug-fixing PRs will be held during this period.
- Once the pre-release is certified by testers (or at least hasn't exploded dramatically) it will be tagged and released to the world.
- Releases may be followed up with "fixup" patches within the first week after a release. Volunteer testers catch a lot of bugs, but they don't always catch 'em all!
Expand Down
5 changes: 2 additions & 3 deletions _sass/_custom.scss
Original file line number Diff line number Diff line change
Expand Up @@ -1216,7 +1216,7 @@ summary h3 { display: inline; }
footer>.container { display: block; clear: both; width: 100%}
.noshift-footer, .shift-footer {
padding: 1em;
.back-to-top { margin-top: -3pc; }
.back-to-top { margin-top: -0.5pc; }
}
@media (min-width: 991px) {
.shift-footer { padding-left: 369px !important; }
Expand Down Expand Up @@ -1284,8 +1284,7 @@ footer>.container { display: block; clear: both; width: 100%}
@media (max-width: $screen-sm-min) {
li#searchbox input[type="search"] { width: 10em; }
.tocify.bigtoc, .custom-fixed-sidebar .tocify { width: 324px; }
//footer>.container { width: 100%; padding-left: 0; }
footer>.container { width: ($screen-lg-min - 30px - 20px); padding-left: 312px; }
footer>.container { width: 100%; padding-left: 0; }
}
// Fix headings in panels
div.panel.panel-info, div.panel.panel-warning {
Expand Down
2 changes: 1 addition & 1 deletion index.html
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ <h2 id="tagline">Open Source 3D Printer Driver</h2>
<div class="panel-body">Contribute to our ever expanding open source Marlin project on GitHub!</div>
</div>
</a>
<a class="col-sm-4 animation-element slide-up panel-wrapper" href="//discord.gg/marlin-firmware-461605380783472640">
<a class="col-sm-4 animation-element slide-up panel-wrapper" href="//discord.com/servers/marlin-firmware-461605380783472640">
<div class="panel">
<div class="panel-heading panel-discord"><h4><em class="fa-brands fa-discord" aria-hidden="true"></em> Join Our Discord</h4></div>
<div class="panel-body">Get help, chat, and share with other Marlin users on our Discord channel.</div>
Expand Down

0 comments on commit f9c4295

Please sign in to comment.