Package Exports

node-gerber-plotter

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (node-gerber-plotter) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

gerber plotter

Streaming Gerber / NC drill layer image plotter

A printed circuit board Gerber and drill file plotter. Implemented as a Node transform stream that consumes objects output by gerber-parser and outputs PCB image objects.

Part of the tracespace collection of PCB visualization tools.

install

npm install --save gerber-plotter
# or
yarn add gerber-plotter

gerber-parser is a peer dependency, so you probably want to install it too:

npm install --save gerber-parser
# or
yarn add gerber-parser

Or, use a script tag:

<script src="https://unpkg.com/gerber-plotter@^4.0.0/dist/gerber-plotter.min.js"></script>
<script>
  // global variable gerberPlotter now available
  var plotter = gerberPlotter()
</script>

example

var fs = require('fs')
var gerberParser = require('node-gerber-parser')
var gerberPlotter = require('node-gerber-plotter')

var parser = gerberParser()
var plotter = gerberPlotter()

plotter.on('warning', function(w) {
  console.warn('plotter warning at line ' + w.line + ': ' + w.message)
})

plotter.once('error', function(e) {
  console.error('plotter error: ' + e.message)
})

fs.createReadStream('/path/to/gerber/file.gbr')
  .pipe(parser)
  .pipe(plotter)
  .on('data', function(obj) {
    console.log(JSON.stringify(obj))
  })

To run this module in a browser, it should be bundled with a tool like browserify or webpack. If you are using the script tag installation method instead, there will be a global variable gerberPlotter available after you have included gerber-plotter.min.js.

api

See API.md