Documentation warning update #45
Conversation
Added warning to calibration doc and calibration first page to remind users if this is the first use, they need to reset the chains and shuttle the sled before attempting calibration Added example description in events doc to remind users that regardless of makerverse folder name, the system references the base makerverse folder internally as makerverse and the files are then under the events folder, so it will always look like ~/makerverse/events/scriptfilename
| @@ -30,5 +30,5 @@ nav_order: 4 | |||
| ## Creating an Event | |||
|
|
|||
| - Go to Settings -> Events and press "+ Add" | |||
| - To run scripts, use a "system" trigger and follow the [commands](/features/commands/) instructions. | |||
| - To run scripts, use a "system" trigger and follow the [commands](/features/commands/) instructions. The event scripts reside in the events folder under the base makerverse folder and regardless of the makerverse folder name, the path to get to the event is ~/makerverse/events/scriptname. | |||
There was a problem hiding this comment.
Nitpick: please use backticks to indicate code: ~/makerverse/events/scriptname.
| Do a **pre-flight check**. | ||
| !!! WARNING !!! | ||
|
|
||
| - If this is the *first* use of your maslow, before you do anything, reset the chains !!! Even if the sled is not exactly in the middle, to establish a baseline location, reset the chains. Once that is complete, the sled should respond to the shuttle commands to move so then you can avoid costly disaster or erratic behavior. As with all new equipment, please make power shutoff to the system accessible in case you must shut it off quickly. In the makerverse, the RESET button will cut power to the motors, so keep that in mind. After calibration, the sled will be properly positioned and allow future chain resets to occur with chain marks to reset back to the middle of the work piece. |
There was a problem hiding this comment.
Are you aware that this is done automatically during the calibration process? When you get to the Chains tab, Makerverse will perform a reset chains implicitly as you complete that flow.
If that's still a concern, I could make the New Machine? modal do this automatically, as well.
My thinking, here, is that this is not the sort of problem which should require documentation. Rather, this sort of problem should be solved by the software. If the user needs to find the docs in order to avoid shooting themselves in the foot, the software is deficient.
| <br/> | ||
| -- DAMAGE MAY OCCUR -- | ||
| <br/> | ||
| If this is the first use of your system and you have not yet tested sled movement please close this window and reset your chains. |
There was a problem hiding this comment.
Why? This screen already performs a Reset Chains before it ever attempts to move the sled (or, it should do so). It would be redundant to close the modal and do so yourself.
| <br/> | ||
| If this is the first use of your system and you have not yet tested sled movement please close this window and reset your chains. | ||
| <br /> | ||
| Please run a pre-flight check before attempting to calibrate. |
There was a problem hiding this comment.
There's already a warning about this which you need to click "Okay" for before you can ever see this screen... try opening the calibration modal in version 1.1.2 and you'll see what I mean.
|
Thanks for the PR, @Orob-Maslow! I appreciate the help with the docs. However, I just want to make sure that this isn't redundant against the I'm generally of the opinion that "big, scary warnings" in the docs indicate that the software doesn't have enough guard-rails to protect the user. So if there's a way I can fix these "gochas" with code rather than docs, I'd prefer that... |
|
I agree with your assessment and most of my input was based on experience with 1.1.1g (I believe). If this pull is stale, we can kill it if the meat of it has been addressed, which ultimately was the goal. Thanks for your efforts. |
|
And today another user destroyed their ring on the sled. Maybe we should make better defaults in the firmware so Maslow Due doesn't have to be homed in order to be jogged without going nuts since a written warning that must be read probably isn't the best approach. |
|
What firmware were they using? I already tried to improve the defaults on the Due firmware. Since my updates a couple months ago, it attempts to default to thinking the sled is in the middle of the stock. But this assumes a standard frame build. And if there’s anything in the EEPROM, all bets are off. Also, Makerverse 1.1.2 asks you if it’s a newly flashed machine and performs a homing when you create the workspace. So I’m confused how this happened... you can’t skip the screen, you have to answer the question. So they would have had to explicitly answer incorrectly. |
Motivated by many users wondering why their systems have crashed upwards, or hit the floor for no reason when trying to use the Z axis for the first time, it is important that we try to prevent these user errors that can be avoided. Added warning to calibration doc and calibration first page to remind users if this is the first use, they need to reset the chains and shuttle the sled before attempting calibration. The only hesitation I have is I have not done this with a Mega yet, so I'm unsure if this should be Due specific information or both mega and due suggested actions.
Added example description in events doc to remind users that regardless of makerverse folder name, the system references the base makerverse folder internally as makerverse and the files are then under the events folder, so it will always look like ~/makerverse/events/scriptfilename from the event dialog window where you enter the script