Skip to content

Commit f51268e

Browse files
committed
Additional build info in the $I printout.
- [new] Added total available planner buffer blocks (15 shown, but there are 16. one is used by the ring buffer and to execute system motions) and serial RX buffer bytes. This information is useful for GUIs to setup and optimize their streaming protocols easily. [doc] Updated the interface document to reflect the change.
1 parent beaa405 commit f51268e

File tree

4 files changed

+25
-8
lines changed

4 files changed

+25
-8
lines changed

doc/log/commit_log_v1.1.txt

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,16 @@
1+
----------------
2+
Date: 2017-01-29
3+
Author: Sonny Jeon
4+
Subject: Tidying up parking override control implementation
5+
6+
[new] Added a default configuration for the parking override control
7+
upon a reset or power-up. By default, parking is enabled, but this may
8+
be disabled via a config.h option.
9+
10+
[fix] Parking override control should be checking if the command word
11+
is passed, rather than the value.
12+
13+
114
----------------
215
Date: 2017-01-28
316
Author: chamnit

doc/markdown/interface.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -408,16 +408,16 @@ Feedback messages provide non-critical information on what Grbl is doing, what i
408408
- `[VER:]` and `[OPT:]`: Indicates build info data from a `$I` user query. These build info messages are followed by an `ok` to confirm the `$I` was executed, like so:
409409
410410
```
411-
[VER:v1.1d.20161014:Some string]
412-
[OPT:VL]
411+
[VER:v1.1f.20170131:Some string]
412+
[OPT:VL,16,128]
413413
ok
414414
```
415415
416416
- The first line `[VER:]` contains the build version and date.
417417
- A string may appear after the second `:` colon. It is a stored EEPROM string a user via a `$I=line` command or OEM can place there for personal use or tracking purposes.
418-
- The `[OPT:]` line follows immediately after and contains character codes for compile-time options that were either enabled or disabled. The codes are defined below and a CSV file is also provided for quick parsing. This is generally only used for quickly diagnosing firmware bugs or compatibility issues.
418+
- The `[OPT:]` line follows immediately after and contains character codes for compile-time options that were either enabled or disabled and two values separated by commas, which indicates the total usable planner blocks and serial RX buffer bytes, respectively. The codes are defined below and a CSV file is also provided for quick parsing. This is generally only used for quickly diagnosing firmware bugs or compatibility issues.
419419
420-
| `OPT` Code | Setting Description, Units |
420+
| `OPT` Code | Setting Description, Units |
421421
|:-------------:|----|
422422
| **`V`** | Variable spindle enabled |
423423
| **`N`** | Line numbers enabled |
@@ -439,7 +439,7 @@ Feedback messages provide non-critical information on what Grbl is doing, what i
439439
| **`E`** | Force sync upon EEPROM write disabled |
440440
| **`W`** | Force sync upon work coordinate offset change disabled |
441441
| **`L`** | Homing initialization auto-lock disabled |
442-
442+
443443
- `[echo:]` : Indicates an automated line echo from a command just prior to being parsed and executed. May be enabled only by a config.h option. Often used for debugging communication issues. A typical line echo message is shown below. A separate `ok` will eventually appear to confirm the line has been parsed and executed, but may not be immediate as with any line command containing motions.
444444
```
445445
[echo:G1X0.540Y10.4F100]

grbl/grbl.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323

2424
// Grbl versioning system
2525
#define GRBL_VERSION "1.1f"
26-
#define GRBL_VERSION_BUILD "20170129"
26+
#define GRBL_VERSION_BUILD "20170131"
2727

2828
// Define standard libraries used by Grbl.
2929
#include <avr/io.h>

grbl/report.c

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -433,9 +433,13 @@ void report_build_info(char *line)
433433
#ifndef HOMING_INIT_LOCK
434434
serial_write('L');
435435
#endif
436+
436437
// NOTE: Compiled values, like override increments/max/min values, may be added at some point later.
437-
// These will likely have a comma delimiter to separate them.
438-
438+
serial_write(',');
439+
print_uint8_base10(BLOCK_BUFFER_SIZE-1);
440+
serial_write(',');
441+
print_uint8_base10(RX_BUFFER_SIZE);
442+
439443
report_util_feedback_line_feed();
440444
}
441445

0 commit comments

Comments
 (0)