https://github.com/cncjs/gcode-parser
G-code Parser
https://github.com/cncjs/gcode-parser
gcode gcode-parser
Last synced: 9 months ago
JSON representation
G-code Parser
- Host: GitHub
- URL: https://github.com/cncjs/gcode-parser
- Owner: cncjs
- License: mit
- Created: 2015-12-03T10:57:51.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2024-12-08T13:08:10.000Z (about 1 year ago)
- Last Synced: 2025-04-11T02:07:20.216Z (9 months ago)
- Topics: gcode, gcode-parser
- Language: JavaScript
- Homepage:
- Size: 162 KB
- Stars: 72
- Watchers: 9
- Forks: 14
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# gcode-parser [](https://codecov.io/gh/cncjs/gcode-parser)
[](https://www.npmjs.com/package/gcode-parser)
## Install
`npm install --save gcode-parser`
## Usage
```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
### batchSize
Type: `Number`
Default: 1000
The batch size.
### flatten
Type: `Boolean`
Default: `false`
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' ] }
```
### lineMode
Type: `String`
Default: `'original'`
The `lineMode` 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 ] ] }
```
## G-code Interpreter
https://github.com/cncjs/gcode-interpreter
## G-code Toolpath
https://github.com/cncjs/gcode-toolpath
## G-code Toolpath Visualizer
Check out the source code at https://github.com/cncjs/cncjs/blob/master/src/web/widgets/Visualizer/GCodeVisualizer.js
## License
MIT