Skip to content

Commit 1f2944b

Browse files
committed
update help
1 parent 83a8948 commit 1f2944b

File tree

2 files changed

+33
-1
lines changed

2 files changed

+33
-1
lines changed
+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
layout: default
3+
title: Sync Settings
4+
nav_order: 4
5+
parent: Controller
6+
grand_parent: Actions
7+
---
8+
# Sync Settings
9+
10+
Release: >0.906
11+
{: .label .label-blue }
12+
13+
14+
### Description
15+
This function sends a command to the controller to return each of its settings. Upon receiving the setting, WebControl compares the setting's value and if different than what WebControl has in its settings, WebControl sends a setting update to the controller.
16+
17+
### Process
18+
19+
The process for syncing settings (based upon current stock firmware as of 11/27/19) is as follows:
20+
21+
* A special gcode command ($$) is sent to the controller
22+
* Controller reports each firmware setting's key and value in the $x=y format, where 'x' is the firmware setting's key and 'y' is the value.
23+
* WebControl compares the received setting value with the one in its memory.
24+
* If the two settings are not equal or not really, really close to each other, WebControl sends the setting value to the controller in the $x=y format.
25+
26+
### Notes
27+
28+
"Really, really close" is roughly defined as a difference so small that it would have no impact on the performance of the controller if the old setting was used. For example, if distance between motors in the firmware is 3000.0000 mm and in WebControl its 3000.0001 mm, the setting will not be updated because its "really, really close"
29+
30+
The routine to determine if the values are really, really close needs some work when dealing with really, really small numbers. It's possible (or likely) that you might see a setting update for something like "Chain Elasticity" everytime the controller and WebControl syncs. Don't Panic. It's fine.
31+
32+

docs/assets/Actions/Controller/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Release: >0.906
1111

1212
###### TABLE OF CONTENTS
1313

14-
[Test Motors/Encoders](Actions/DiagnosticsMaintenance/testMotorsEncoders.md)
14+
[Sync Settings](Actions/Controller/syncSettings.md)
1515

1616

1717

0 commit comments

Comments
 (0)