npe_gerber/README.md
2021-02-02 21:03:11 +00:00

35 lines
794 B
Markdown

# npe_gerber
![npm (scoped)](https://img.shields.io/npm/v/@nplayfair/npe_gerber)
**This is still being developed and isn't ready for production!**
Only tested with gerbers generated by EAGLE.
Requires node version 10 or higher.
## Usage
```
const { ImageGenerator } = require('@nplayfair/npe_gerber');
const folderConfig = {
tmpDir: path.join(__dirname, 'tmp'),
imgDir: path.join(__dirname, 'img')
}
const imageConfig = {
// Refer to the sharp documentation for these values
resizeWidth: 600,
density: 1000,
compLevel: 1
}
const gerberArchive = '/path/to/gerber.zip';
const fileProc = new ImageGenerator(folderConfig, imageConfig);
fileProc.gerberToImage(gerberArchive)
.then(filename => {
console.log(`Generated image ${filename}`);
})
```