G-code parser for Node.js
npm install gcode-parser
npm install --save gcode-parser
js
var fs = require('fs');
var parser = require('gcode-parser');// parseLine
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';
parser.parseFile(file, function(err, results) {
console.log(results);
});
// Synchronous version of parseFile.
results = parser.parseFileSync(file);
// parseStream
var stream = fs.createReadStream(file, { encoding: 'utf8' });
parser.parseStream(stream, function(err, results) {
console.log(results);
});
// parseString
var str = fs.readFileSync(file, 'utf8');
parser.parseString(str, function(err, results) {
console.log(results);
});
// Synchronous version of parseString.
results = parser.parseStringSync(file);
`Advanced Usage
js
var _ = require('lodash');
var parser = require('gcode-parser');parser.parseFile('example.nc', function(err, results) {
if (err) {
console.error(err);
return;
}
// Compose G-code
var list = _(results)
.map('words')
.map(function(words) {
return _.map(words, function(word) {
return word[0] + word[1];
}).join(' ');
})
.value();
console.log(list);
})
.on('data', function(data) {
console.log(data);
})
.on('end', function(results) {
console.log(results);
})
`Options
$3
Type:
Default: 1000The batch size.
$3
Type:
Default: True to flatten the array, false otherwise.
js
parser.parseLine('G0 X0 Y0');
// => { line: 'G0 X0 Y0', words: [ [ 'G', 0 ], [ 'X', 0 ], [ 'Y', 0 ] ] }parser.parseLine('G0 X0 Y0', { flatten: true });
// => { line: 'G0 X0 Y0', words: [ 'G0', 'X0', 'Y0' ] }
`$3
Type:
Default: 'original'The
option specifies how the parsed line should be formatted. The following values are supported:
- 'original': Retains the line exactly as is, including comments and whitespace. (This is the default when lineMode is not specified.)
- 'stripped': Removes comments, trims leading and trailing whitespace (spaces and tabs), but keeps the inner whitespace between code elements.
- 'compact': Removes both comments and all whitespace characters.Example usage:
`js
parser.parseLine('G0 X0 Y0 ; comment', { lineMode: 'original' });
// => { line: 'G0 X0 Y0 ; comment', words: [ [ 'G', 0 ], [ 'X', 0 ], [ 'Y', 0 ] ] }parser.parseLine('G0 X0 Y0 ; comment', { lineMode: 'stripped' });
// => { line: 'G0 X0 Y0', words: [ [ 'G', 0 ], [ 'X', 0 ], [ 'Y', 0 ] ] }
parser.parseLine('G0 X0 Y0 ; comment', { lineMode: 'compact' });
// => { line: 'G0X0Y0', words: [ [ 'G', 0 ], [ 'X', 0 ], [ 'Y', 0 ] ] }
``MIT