Learn how companies like Phone2Action are using npm in their front-end developmentJoin the conversation »

whats-that-gerber

4.2.0 • Public • Published

what's that gerber?

latest next david

Identify Gerber and drill files by filename

Have you got a bunch of Gerber files lying around without any idea what they're for? We've all been there. whats-that-gerber is here to help.

Part of the tracespace collection of PCB visualization tools.

install

npm install --save whats-that-gerber
# or 
yarn add whats-that-gerber

Or, use a script tag:

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

usage

Pass whatsThatGerber an array of filenames from a PCB, and it will give you back an object keyed by filename with the best guess it can make for the type and side of each file. If both side and type are null, the filename cannot be identified as a Gerber / drill file.

const whatsThatGerber = require('whats-that-gerber')
 
const filenames = ['my-board-F_Cu.gbr', 'my-board-B_Cu.gbr', 'foo.bar']
const typeByFilename = whatsThatGerber(filenames)
// {
//   'my-board-F_Cu.gbr': {type: 'copper', side: 'top'},
//   'my-board-B_Cu.gbr': {type: 'copper', side: 'bottom'},
//   'my-board-notes.gbr': {type: 'drawing', side: null},
//   'foo.bar': {type: null, side: null},
// }

layer types and names

There are 12 available layer types, were a type is an object of the format:

{
  side: 'top' | 'bottom' | 'inner' | 'all' | null,
  type: 'copper' | 'soldermask' | 'silkscreen' | 'solderpaste' | 'drill' | 'outline' | 'drawing' | null,
}

You can get an array of all types with:

const {getAllLayers} = require('whats-that-gerber')
const allLayers = getAllLayers()
side type
'top' 'copper'
'top' 'soldermask'
'top' 'silkscreen'
'top' 'solderpaste'
'bottom' 'copper'
'bottom' 'soldermask'
'bottom' 'silkscreen'
'bottom' 'solderpaste'
'inner' 'copper'
'all' 'outline'
'all' 'drill'
null 'drawing'

constants

Side and type constants are exported for your usage:

const {
  // layer types 
  TYPE_COPPER, // 'copper'
  TYPE_SOLDERMASK, // 'soldermask'
  TYPE_SILKSCREEN, // 'silkscreen'
  TYPE_SOLDERPASTE, // 'solderpaste'
  TYPE_DRILL, // 'drill'
  TYPE_OUTLINE, // 'outline'
  TYPE_DRAWING, // 'drawing'
 
  // board sides
  SIDE_TOP, // 'top'
  SIDE_BOTTOM, // 'bottom'
  SIDE_INNER, // 'inner'
  SIDE_ALL, // 'all'
= require('whats-that-gerber')

checking if a layer type is valid

You can check if any given string is a valid layer type with:

const {validate} = require('whats-that-gerber')
 
const type1 = {side: 'top', type: 'copper'}
const type2 = {side: 'foo', type: 'silkscreen'}
const type3 = {side: 'bottom', type: 'bar'}
 
console.log(validate(type1)) // {valid: true, side: 'top', type: 'copper'}
console.log(validate(type2)) // {valid: false, side: null, type: 'silkscreen'}
console.log(validate(type3)) // {valid: false, side: 'bottom', type: null}

supported cad programs

We should be able to identify files output by the following programs:

  • KiCad
  • Eagle
  • Altium
  • Orcad
  • gEDA PCB
  • DipTrace

contributing

Please read the Contributing Section of the main README for development setup instructions.

If you're adding or modifying a filetype matcher, please remember to add or modify an example filename in @tracespace/fixtures/gerber-filenames.json to ensure your change is tested.

Install

npm i whats-that-gerber

DownloadsWeekly Downloads

20

Version

4.2.0

License

MIT

Unpacked Size

62.6 kB

Total Files

17

Last publish

Collaborators

  • avatar
  • avatar