Skip to content

Commit

Permalink
Update readme and sleep documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
chamnit committed Apr 4, 2016
1 parent 8693534 commit e87f4ea
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 5 deletions.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,17 +33,23 @@ Grbl includes full acceleration management with look ahead. That means the contr

***

##Update Summary for v1.0c
##Update Summary for v1.0d
- **IMPORTANT:** Your EEPROM will be wiped and restored with new settings. This is due to the addition of two new spindle speed '$' settings.

- Altered limit pin status reports from `Lim:000` to `Pin:000|0|0000`, where the `|` delimiters separate the new probe state and control pin states. Each new field may be disabled by the `$10` Grbl setting. NOTE: Commenting `REPORT_ALL_PIN_STATES` in config.h reverts to old `Lim:` reports, if needed.

- New status report proposal (not enabled by default) to help clean up and standardize the report. Essentially, use '|' as data field delimiters and ',' as multiple data value delimiters only. So, `,Pin:000|0|0000,` will be `|Pin:000,0,0000|` instead.

- New safety door parking motion as a compile-option. Grbl will retract, disable the spindle/coolant, and park near Z max. When resumed, it will perform these task in reverse order and continue the program. Highly configurable. See config.h for details.

- New sleep mode with optional auto-parking. If the spindle or coolant are powered and communication is lost or is idle, Grbl will shut these down and go into a sleep mode. Useful for USB disconnects.

- New '$' Grbl settings for max and min spindle rpm. Allows for tweaking the PWM output to more closely match true spindle rpm. When max rpm is set to zero or less than min rpm, the PWM pin D11 will act like a simple enable on/off output.

- Updated G28 and G30 behavior from NIST to LinuxCNC g-code description. In short, if a intermediate motion is specified, only the axes specified will move to the stored coordinates, not all axes as before.

- Single file configuration for custom firmware.

- A few bug fixes and lots of refactoring to make the code more efficient and flexible.


Expand Down
35 changes: 35 additions & 0 deletions doc/log/commit_log_v1.0d.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,38 @@
----------------
Date: 2016-04-03
Author: chamnit
Subject: Sleep feature. General re-org and bug fixes.

- New sleep safety feature. If powered components (spindle/coolant) are
enabled and if there is no motion, incoming data, or commands, Grbl
will start a short sleep countdown. Upon elapse, Grbl will depower and
enter a sleep state. If parking is enabled, sleep will also park the
machine. Only a reset will exit sleep and the job will be
unrecoverable. This is purely a safety feature to address serial
disconnection problems.

- Re-organized the cpu-map and default files and put them back into
single files. Makes it easier for OEMs to just drop in their
configuration files for a custom build.

- Introduced a single-file configuration method for OEMs. See config.h
for details. Basically just add the cpu_map and default files to the
bottom of config.h.

- Moved the control pin invert mask to config.h

- Refactored some cpu_map defines to be more descriptive of what they
belong to.

- Added invert coolant pins options to config.h

- Added a new realtime status report. Only a proposal at this time, and
the old classic report is enabled by default. Comment out the
USE_CLASSIC_REALTIME_REPORT define in config.h to use the new report.
Please note that the new report is not finalized and is subject to
change.


----------------
Date: 2016-03-20
Author: chamnit
Expand Down
10 changes: 6 additions & 4 deletions grbl/config.h
Original file line number Diff line number Diff line change
Expand Up @@ -405,13 +405,15 @@
// Must be positive value or equal to zero.

// Enables and configures Grbl's sleep mode feature. If the spindle or coolant are powered and Grbl
// is not actively moving or receiving any commands, a sleep timer will start. Once elasped without
// receiving any new data or commands, Grbl will execute the sleep mode by shutting down the spindle
// is not actively moving or receiving any commands, a sleep timer will start. If any data or commands
// are received, the sleep timer will reset and restart until the above condition are not satisfied.
// If the sleep timer elaspes, Grbl will immediately execute the sleep mode by shutting down the spindle
// and coolant and entering a safe sleep state. If parking is enabled, Grbl will park the machine as
// well. While in sleep mode, only a hard/soft reset will exit it and the job will be unrecoverable.
// NOTE: Sleep mode is a safety feature, primarily to address communication disconnect problems.
// NOTE: Sleep mode is a safety feature, primarily to address communication disconnect problems. To
// keep Grbl from sleeping, employ a stream of '?' status report commands as a connection "heartbeat".
// #define SLEEP_ENABLE // Default disabled. Uncomment to enable.
#define SLEEP_DURATION 5.0 // Seconds before sleep auto-park and power down procedures are executed.
#define SLEEP_DURATION 5.0 // Float (0.25 - 61.0) seconds before sleep mode is executed.


// ---------------------------------------------------------------------------------------
Expand Down

0 comments on commit e87f4ea

Please sign in to comment.