summaryrefslogtreecommitdiff
path: root/gerber
diff options
context:
space:
mode:
Diffstat (limited to 'gerber')
-rwxr-xr-xgerber/excellon.py128
-rw-r--r--gerber/excellon_statements.py266
-rw-r--r--gerber/gerber.py2
-rw-r--r--gerber/gerber_statements.py (renamed from gerber/statements.py)0
-rw-r--r--gerber/tests/test_gerber_statements.py (renamed from gerber/tests/test_statements.py)3
5 files changed, 288 insertions, 111 deletions
diff --git a/gerber/excellon.py b/gerber/excellon.py
index 7c7d0c6..6ae182b 100755
--- a/gerber/excellon.py
+++ b/gerber/excellon.py
@@ -22,6 +22,7 @@ Excellon module
This module provides Excellon file classes and parsing utilities
"""
import re
+from .excellon_statements import *
from .utils import parse_gerber_value
from .cnc import CncFile, FileSettings
@@ -74,108 +75,6 @@ class ExcellonFile(CncFile):
ctx.dump(filename)
-class ExcellonTool(object):
- """ Excellon Tool class
-
- Parameters
- ----------
- settings : FileSettings (dict-like)
- File-wide settings.
-
- kwargs : dict-like
- Tool settings from the excellon statement. Valid keys are:
- diameter : Tool diameter [expressed in file units]
- rpm : Tool RPM
- feed_rate : Z-axis tool feed rate
- retract_rate : Z-axis tool retraction rate
- max_hit_count : Number of hits allowed before a tool change
- depth_offset : Offset of tool depth from tip of tool.
-
- Attributes
- ----------
- number : integer
- Tool number from the excellon file
-
- diameter : float
- Tool diameter in file units
-
- rpm : float
- Tool RPM
-
- feed_rate : float
- Tool Z-axis feed rate.
-
- retract_rate : float
- Tool Z-axis retract rate
-
- depth_offset : float
- Offset of depth measurement from tip of tool
-
- max_hit_count : integer
- Maximum number of tool hits allowed before a tool change
-
- hit_count : integer
- Number of tool hits in excellon file.
- """
-
- @classmethod
- def from_line(cls, line, settings):
- """ Create a Tool from an excellon gile tool definition line.
-
- Parameters
- ----------
- line : string
- Tool definition line from an excellon file.
-
- settings : FileSettings (dict-like)
- Excellon file-wide settings
-
- Returns
- -------
- tool : Tool
- An ExcellonTool representing the tool defined in `line`
- """
- commands = re.split('([BCFHSTZ])', line)[1:]
- commands = [(command, value) for command, value in pairwise(commands)]
- args = {}
- format = settings['format']
- zero_suppression = settings['zero_suppression']
- for cmd, val in commands:
- if cmd == 'B':
- args['retract_rate'] = parse_gerber_value(val, format, zero_suppression)
- elif cmd == 'C':
- args['diameter'] = parse_gerber_value(val, format, zero_suppression)
- elif cmd == 'F':
- args['feed_rate'] = parse_gerber_value(val, format, zero_suppression)
- elif cmd == 'H':
- args['max_hit_count'] = parse_gerber_value(val, format, zero_suppression)
- elif cmd == 'S':
- args['rpm'] = 1000 * parse_gerber_value(val, format, zero_suppression)
- elif cmd == 'T':
- args['number'] = int(val)
- elif cmd == 'Z':
- args['depth_offset'] = parse_gerber_value(val, format, zero_suppression)
- return cls(settings, **args)
-
- def __init__(self, settings, **kwargs):
- self.number = kwargs.get('number')
- self.feed_rate = kwargs.get('feed_rate')
- self.retract_rate = kwargs.get('retract_rate')
- self.rpm = kwargs.get('rpm')
- self.diameter = kwargs.get('diameter')
- self.max_hit_count = kwargs.get('max_hit_count')
- self.depth_offset = kwargs.get('depth_offset')
- self.units = settings.get('units', 'inch')
- self.hit_count = 0
-
- def _hit(self):
- self.hit_count += 1
-
- def __repr__(self):
- unit = 'in.' if self.units == 'inch' else 'mm'
- return '<ExcellonTool %d: %0.3f%s dia.>' % (self.number, self.diameter, unit)
-
-
class ExcellonParser(object):
""" Excellon File Parser
"""
@@ -186,6 +85,7 @@ class ExcellonParser(object):
self.zero_suppression = 'trailing'
self.format = (2, 5)
self.state = 'INIT'
+ self.statements = []
self.tools = {}
self.hits = []
self.active_tool = None
@@ -206,15 +106,23 @@ class ExcellonParser(object):
def _parse(self, line):
if 'M48' in line:
+ self.statements.append(HeaderBeginStmt())
self.state = 'HEADER'
- if 'G00' in line:
- self.state = 'ROUT'
+ elif line[0] == '%':
+ self.statements.append(RewindStopStmt())
+ if self.state == 'HEADER':
+ self.state = 'DRILL'
- if 'G05' in line:
- self.state = 'DRILL'
+ elif 'M95' in line:
+ self.statements.append(HeaderEndStmt())
+ if self.state == 'HEADER':
+ self.state = 'DRILL'
+
+ elif 'G00' in line:
+ self.state = 'ROUT'
- elif line[0] == '%' and self.state == 'HEADER':
+ elif 'G05' in line:
self.state = 'DRILL'
if 'INCH' in line or line.strip() == 'M72':
@@ -279,11 +187,15 @@ class ExcellonParser(object):
notation=self.notation)
-
def pairwise(iterator):
+ """ Iterate over list taking two elements at a time.
+
+ e.g. [1, 2, 3, 4, 5, 6] ==> [(1, 2), (3, 4), (5, 6)]
+ """
itr = iter(iterator)
while True:
yield tuple([itr.next() for i in range(2)])
+
if __name__ == '__main__':
p = parser()
diff --git a/gerber/excellon_statements.py b/gerber/excellon_statements.py
new file mode 100644
index 0000000..4544f08
--- /dev/null
+++ b/gerber/excellon_statements.py
@@ -0,0 +1,266 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+# copyright 2014 Hamilton Kibbe <ham@hamiltonkib.be>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+# http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from .utils import write_gerber_value
+
+
+__all__ = ['ExcellonTool', 'CommentStmt', 'HeaderBeginStmt', 'HeaderEndStmt',
+ ]
+
+
+class ExcellonStatement(object):
+ """ Excellon Statement abstract base class
+ """
+ def to_excellon(self):
+ pass
+
+
+class ExcellonTool(ExcellonStatement):
+ """ Excellon Tool class
+
+ Parameters
+ ----------
+ settings : FileSettings (dict-like)
+ File-wide settings.
+
+ kwargs : dict-like
+ Tool settings from the excellon statement. Valid keys are:
+ diameter : Tool diameter [expressed in file units]
+ rpm : Tool RPM
+ feed_rate : Z-axis tool feed rate
+ retract_rate : Z-axis tool retraction rate
+ max_hit_count : Number of hits allowed before a tool change
+ depth_offset : Offset of tool depth from tip of tool.
+
+ Attributes
+ ----------
+ number : integer
+ Tool number from the excellon file
+
+ diameter : float
+ Tool diameter in file units
+
+ rpm : float
+ Tool RPM
+
+ feed_rate : float
+ Tool Z-axis feed rate.
+
+ retract_rate : float
+ Tool Z-axis retract rate
+
+ depth_offset : float
+ Offset of depth measurement from tip of tool
+
+ max_hit_count : integer
+ Maximum number of tool hits allowed before a tool change
+
+ hit_count : integer
+ Number of tool hits in excellon file.
+ """
+
+ @classmethod
+ def from_line(cls, line, settings):
+ """ Create a Tool from an excellon file tool definition line.
+
+ Parameters
+ ----------
+ line : string
+ Tool definition line from an excellon file.
+
+ settings : FileSettings (dict-like)
+ Excellon file-wide settings
+
+ Returns
+ -------
+ tool : Tool
+ An ExcellonTool representing the tool defined in `line`
+ """
+ commands = re.split('([BCFHSTZ])', line)[1:]
+ commands = [(command, value) for command, value in pairwise(commands)]
+ args = {}
+ format = settings['format']
+ zero_suppression = settings['zero_suppression']
+ for cmd, val in commands:
+ if cmd == 'B':
+ args['retract_rate'] = parse_gerber_value(val, format, zero_suppression)
+ elif cmd == 'C':
+ args['diameter'] = parse_gerber_value(val, format, zero_suppression)
+ elif cmd == 'F':
+ args['feed_rate'] = parse_gerber_value(val, format, zero_suppression)
+ elif cmd == 'H':
+ args['max_hit_count'] = parse_gerber_value(val, format, zero_suppression)
+ elif cmd == 'S':
+ args['rpm'] = 1000 * parse_gerber_value(val, format, zero_suppression)
+ elif cmd == 'T':
+ args['number'] = int(val)
+ elif cmd == 'Z':
+ args['depth_offset'] = parse_gerber_value(val, format, zero_suppression)
+ return cls(settings, **args)
+
+ def from_dict(cls, settings, tool_dict):
+ return cls(settings, tool_dict)
+
+ def __init__(self, settings, **kwargs):
+ self.settings = settings
+ self.number = kwargs.get('number')
+ self.feed_rate = kwargs.get('feed_rate')
+ self.retract_rate = kwargs.get('retract_rate')
+ self.rpm = kwargs.get('rpm')
+ self.diameter = kwargs.get('diameter')
+ self.max_hit_count = kwargs.get('max_hit_count')
+ self.depth_offset = kwargs.get('depth_offset')
+ self.hit_count = 0
+
+ def to_excellon(self):
+ fmt = self.settings['format']
+ zs = self.settings['zero_suppression']
+ stmt = 'T%d' % self.number
+ if self.retract_rate:
+ stmt += 'B%s' % write_gerber_value(self.retract_rate, fmt, zs)
+ if self.diameter:
+ stmt += 'C%s' % write_gerber_value(self.diameter, fmt, zs)
+ if self.feed_rate:
+ stmt += 'F%s' % write_gerber_value(self.feed_rate, fmt, zs)
+ if self.max_hit_count:
+ stmt += 'H%s' % write_gerber_value(self.max_hit_count, fmt, zs)
+ if self.rpm:
+ if self.rpm < 100000.:
+ stmt += 'S%s' % write_gerber_value(self.rpm / 1000., fmt, zs)
+ else:
+ stmt += 'S%g' % self.rpm / 1000.
+ if self.depth_offset:
+ stmt += 'Z%s' % write_gerber_value(self.depth_offset, fmt, zs)
+ return stmt
+
+ def _hit(self):
+ self.hit_count += 1
+
+ def __repr__(self):
+ unit = 'in.' if self.settings.units == 'inch' else 'mm'
+ return '<ExcellonTool %d: %0.3f%s dia.>' % (self.number, self.diameter, unit)
+
+
+class CommentStmt(ExcellonStatement):
+ def __init__(self, comment):
+ self.comment = comment
+
+ def to_excellon(self):
+ return ';%s' % comment
+
+
+class HeaderBeginStmt(ExcellonStatement):
+
+ def __init__(self):
+ pass
+
+ def to_excellon(self):
+ return 'M48'
+
+
+class HeaderEndStmt(ExcellonStatement):
+
+ def __init__(self):
+ pass
+
+ def to_excellon(self):
+ return 'M95'
+
+
+class RewindStopStmt(ExcellonStatement):
+
+ def __init__(self):
+ pass
+
+ def to_excellon(self):
+ return '%'
+
+
+class EndOfProgramStmt(ExcellonStatement):
+
+ def __init__(self, x=None, y=None):
+ self.x = x
+ self.y = y
+
+ def to_excellon(self):
+ stmt = 'M30'
+ if self.x is not None:
+ stmt += 'X%s' % write_gerber_value(self.x)
+ if self.y is not None:
+ stmt += 'Y%s' % write_gerber_value(self.y)
+
+
+class UnitStmt(ExcellonStatement):
+
+ def __init__(self, units='inch', zero_suppression='trailing'):
+ self.units = units.lower()
+ self.zero_suppression = zero_suppression
+
+ def to_excellon(self):
+ stmt = '%s,%s' % ('INCH' if self.units == 'inch' else 'METRIC',
+ 'LZ' if self.zero_suppression == 'trailing' else 'TZ')
+
+
+class IncrementalModeStmt(ExcellonStatement):
+
+ def __init__(self, mode='off'):
+ if mode.lower() not in ['on', 'off']:
+ raise ValueError('Mode may be "on" or "off")
+ self.mode = 'off'
+
+ def to_excellon(self):
+ return 'ICI,%s' % 'OFF' if self.mode == 'off' else 'ON'
+
+
+class VersionStmt(ExcellonStatement):
+
+ def __init__(self, version=1):
+ self.version = int(version)
+
+ def to_excellon(self):
+ return 'VER,%d' % self.version
+
+
+class FormatStmt(ExcellonStatement):
+ def __init__(self, format=1):
+ self.format = int(format)
+
+ def to_excellon(self):
+ return 'FMAT,%d' % self.format
+
+
+class LinkToolStmt(ExcellonStatement):
+
+ def __init__(self, linked_tools):
+ self.linked_tools = [int(x) for x in linked_tools]
+
+ def to_excellon(self):
+ return '/'.join([str(x) for x in self.linked_tools])
+
+
+class MeasuringModeStmt(ExcellonStatement):
+
+ def __init__(self, units='inch'):
+ units = units.lower()
+ if units not in ['inch', 'metric']:
+ raise ValueError('units must be "inch" or "metric"')
+ self.units = units
+
+ def to_excellon(self):
+ return 'M72' if self.units == 'inch' else 'M71'
+
+
diff --git a/gerber/gerber.py b/gerber/gerber.py
index 3f93ed4..9ad5dc9 100644
--- a/gerber/gerber.py
+++ b/gerber/gerber.py
@@ -26,7 +26,7 @@ This module provides an RS-274-X class and parser
import re
import json
-from .statements import *
+from .gerber_statements import *
from .cnc import CncFile, FileSettings
diff --git a/gerber/statements.py b/gerber/gerber_statements.py
index 5a9d046..5a9d046 100644
--- a/gerber/statements.py
+++ b/gerber/gerber_statements.py
diff --git a/gerber/tests/test_statements.py b/gerber/tests/test_gerber_statements.py
index 4560521..121aa42 100644
--- a/gerber/tests/test_statements.py
+++ b/gerber/tests/test_gerber_statements.py
@@ -4,7 +4,7 @@
# Author: Hamilton Kibbe <ham@hamiltonkib.be>
from .tests import *
-from ..statements import *
+from ..gerber_statements import *
def test_FSParamStmt_factory():
@@ -93,5 +93,4 @@ def test_OFParamStmt_dump():
stmt = {'param': 'OF', 'a': '0.1234567', 'b': '0.1234567'}
of = OFParamStmt.from_dict(stmt)
assert_equal(of.to_gerber(), '%OFA0.123456B0.123456*%')
-