v1.3.0

* Support % and $ commands * Add new `flatten` option to flatten the output array

Author: cheton

README.md

@@ -12,9 +12,12 @@ var fs = require('fs');
 var parser = require('gcode-parser');
 
 // parseLine
-var line = 'G0 X0 Y0';
-var result = parser.parseLine(line);
-console.log(result);
+parser.parseLine('G0 X0 Y0');
+// => { line: 'G0 X0 Y0', words: [ [ 'G', 0 ], [ 'X', 0 ], [ 'Y', 0 ] ] }
+
+// parseLine (flatten mode)
+parser.parseLine('G0 X0 Y0', { flatten: true });
+// => { line: 'G0 X0 Y0', words: [ 'G0', 'X0', 'Y0' ] }
 
 // parseFile
 var file = 'example.nc';
@@ -81,6 +84,17 @@ Default: `1000`
 
 The batch size.
 
+### flatten
+
+Type: `Boolean`
+Default: `false`
+
+True to flatten the array, false otherwise.
+
+```js
+parser.parseLine('G0 X0 Y0', { flatten: true });
+```
+
 ### noParseLine
 
 Type: `Boolean`

package.json

@@ -1,6 +1,6 @@
 {
  "name": "gcode-parser",
- "version": "1.2.0",
+ "version": "1.3.0",
  "description": "G-code parser for Node.js",
  "author": "Cheton Wu <cheton@gmail.com>",
  "homepage": "https://github.com/cncjs/gcode-parser",

src/index.js

@@ -70,53 +70,74 @@ const parseLine = (() => {
  const re3 = new RegExp(/\s+/g);
  return (line => line.replace(re1, '').replace(re2, '').replace(re3, ''));
  })();
- const re = /([a-zA-Z][0-9\+\-\.]*)|(\*[0-9]+)|(\$[a-zA-Z0-9$#]*)/igm;
+ const re = /(%[a-zA-Z][a-zA-Z0-9_]*)|([a-zA-Z][0-9\+\-\.]*)|(\*[0-9]+)|((?:\$\$)|(?:\$[a-zA-Z0-9#]*))/igm;
 
  return (line, options) => {
  options = options || {};
- options.noParseLine = options.noParseLine || false;
+ options.flatten = !!options.flatten;
+ options.noParseLine = !!options.noParseLine;
 
  const result = {
  line: line
  };
 
- if (!options.noParseLine) {
- result.words = [];
-
- let ln; // Line number
- let cs; // Checksum
- const words = stripComments(line).match(re) || [];
- for (let i = 0; i < words.length; ++i) {
- const word = words[i];
- const letter = word[0].toUpperCase();
- const argument = word.slice(1);
-
- // $: Grbl-specific commands
- if (letter === '$') {
- continue;
- }
-
- // N: Line number
- if (letter === 'N' && typeof ln === 'undefined') {
- // Line (block) number in program
- ln = Number(argument);
- continue;
- }
-
- // *: Checksum
- if (letter === '*' && typeof cs === 'undefined') {
- cs = Number(argument);
- continue;
- }
+ if (options.noParseLine) {
+ return result;
+ }
 
- result.words.push([letter, Number(argument)]);
+ result.words = [];
+
+ let ln; // Line number
+ let cs; // Checksum
+ const words = stripComments(line).match(re) || [];
+
+ for (let i = 0; i < words.length; ++i) {
+ const word = words[i];
+ const letter = word[0].toUpperCase();
+ const argument = word.slice(1);
+
+ // Parse % commands for bCNC and CNCjs
+ // - %wait Wait until the planner queue is empty
+ if (letter === '%') {
+ result.cmds = (result.cmds || []).concat(`${letter}${argument}`);
+ continue;
+ }
+
+ // Parse $ commands for Grbl
+ // - $C Check gcode mode
+ // - $H Run homing cycle
+ if (letter === '$') {
+ result.cmds = (result.cmds || []).concat(`${letter}${argument}`);
+ continue;
  }
 
- (typeof(ln) !== 'undefined') && (result.ln = ln); // Line number
- (typeof(cs) !== 'undefined') && (result.cs = cs); // Checksum
- if (result.cs && (computeChecksum(line) !== result.cs)) {
- result.err = true; // checksum failed
+ // N: Line number
+ if (letter === 'N' && typeof ln === 'undefined') {
+ // Line (block) number in program
+ ln = Number(argument);
+ continue;
  }
+
+ // *: Checksum
+ if (letter === '*' && typeof cs === 'undefined') {
+ cs = Number(argument);
+ continue;
+ }
+
+ if (options.flatten) {
+ result.words.push(`${letter}${argument}`);
+ } else {
+ result.words.push([letter, Number(argument)]);
+ }
+ }
+
+ // Line number
+ (typeof(ln) !== 'undefined') && (result.ln = ln);
+
+ // Checksum
+ (typeof(cs) !== 'undefined') && (result.cs = cs);
+ if (result.cs && (computeChecksum(line) !== result.cs)) {
+ result.err = true; // checksum failed
  }
 
  return result;
@@ -184,7 +205,7 @@ const parseString = (str, options, callback = noop) => {
 };
 
 const parseStringSync = (str, options) => {
- const { noParseLine = false } = { ...options };
+ const { flatten = false, noParseLine = false } = { ...options };
  const results = [];
  const lines = str.split('\n');
 
@@ -193,7 +214,10 @@ const parseStringSync = (str, options) => {
  if (line.length === 0) {
  continue;
  }
- const result = parseLine(line, { noParseLine });
+ const result = parseLine(line, {
+ flatten,
+ noParseLine
+ });
  results.push(result);
  }
 
@@ -218,6 +242,7 @@ class GCodeLineStream extends Transform {
 
  // @param {object} [options] The options object
  // @param {number} [options.batchSize] The batch size.
+ // @param {boolean} [options.flatten] True to flatten the array, false otherwise.
  // @param {boolean} [options.noParseLine] True to not parse line, false otherwise.
  constructor(options = {}) {
  super({ objectMode: true });
@@ -271,6 +296,7 @@ class GCodeLineStream extends Transform {
  line = line.trim();
  if (line.length > 0) {
  const result = parseLine(line, {
+ flatten: this.options.flatten,
  noParseLine: this.options.noParseLine
  });
  this.push(result);
@@ -282,6 +308,7 @@ class GCodeLineStream extends Transform {
  const line = this.lineBuffer.trim();
  if (line.length > 0) {
  const result = parseLine(line, {
+ flatten: this.options.flatten,
  noParseLine: this.options.noParseLine
  });
  this.push(result);

test/index.js

@@ -2,6 +2,7 @@ import chai from 'chai';
 import fs from 'fs';
 import {
  GCodeParser,
+ parseLine,
  parseStream,
  parseString,
  parseStringSync,
@@ -64,8 +65,27 @@ describe('gcode-parser', () => {
  });
  });
 
+ describe('Commands', () => {
+ it('should parse $ commands for Grbl.', (done) => {
+ const data = parseLine('$H $C');
+ expect(data).to.be.an('object');
+ expect(data.line).to.be.an('string');
+ expect(data.words).to.be.empty;
+ expect(data.cmds).to.deep.equal(['$H', '$C']);
+ done();
+ });
+ it('should parse % commands for bCNC and CNCjs.', (done) => {
+ const data = parseLine('%wait');
+ expect(data).to.be.an('object');
+ expect(data.line).to.be.an('string');
+ expect(data.words).to.be.empty;
+ expect(data.cmds).to.deep.equal(['%wait']);
+ done();
+ });
+ });
+
  describe('Comments', () => {
- it('should strip everything after %, #, or ; to the end of the loine including preceding spaces.', (done) => {
+ it('should strip everything after a semi-colon to the end of the loine including preceding spaces.', (done) => {
  const sampleText = [
  ' % ',
  ' #',
@@ -122,7 +142,6 @@ describe('gcode-parser', () => {
 
  parseString(sampleText, (err, results) => {
  results = results.map(result => {
- console.error('###', result);
  const words = result.words.map(word => {
  return word.join('');
  });
@@ -192,6 +211,20 @@ describe('gcode-parser', () => {
  });
  });
 
+ describe('parseLine()', () => {
+ it('should return expected results.', (done) => {
+ expect(parseLine('G0 X0 Y0')).to.deep.equal({
+ line: 'G0 X0 Y0',
+ words: [ [ 'G', 0 ], [ 'X', 0 ], [ 'Y', 0 ] ]
+ });
+ expect(parseLine('G0 X0 Y0', { flatten: true })).to.deep.equal({
+ line: 'G0 X0 Y0',
+ words: [ 'G0', 'X0', 'Y0' ]
+ });
+ done();
+ });
+ });
+
  describe('parseStream()', () => {
  const expectedResults = [
  {