summaryrefslogtreecommitdiff
path: root/gerber/excellon.py
blob: d92d57c35df555ad459ff97a31acdd135c89f37f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
#!/usr/bin/env python
import re
from itertools import tee, izip
from .utils import parse_gerber_value


def read(filename):
    """ Read data from filename and return an ExcellonFile
    """
    return ExcellonParser().parse(filename)


class ExcellonFile(object):
    """ A class representing a single excellon file

    The ExcellonFile class represents a single excellon file.

    Parameters
    ----------
    tools : list
        list of gerber file statements

    hits : list of tuples
        list of drill hits as (<Tool>, (x, y))
    settings : dict
        Dictionary of gerber file settings

    filename : string
        Filename of the source gerber file

    Attributes
    ----------
    units : string
        either 'inch' or 'metric'.

    """
    def __init__(self, tools, hits, settings, filename):
        self.tools = tools
        self.hits = hits
        self.settings = settings
        self.filename = filename

    def report(self):
        """ Print drill report
        """
        pass

    def render(self, filename, ctx):
        """ Generate image of file
        """
        for tool, pos in self.hits:
            ctx.drill(pos[0], pos[1], tool.diameter)
        ctx.dump(filename)


class Tool(object):
    """ Excellon Tool class
    """
    @classmethod
    def from_line(cls, line, settings):
        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')

    def __repr__(self):
        unit = 'in.' if self.units == 'inch' else 'mm'
        return '<Tool %d: %0.3f%s dia.>' % (self.number, self.diameter, unit)


class ExcellonParser(object):
    def __init__(self, ctx=None):
        self.ctx = ctx
        self.notation = 'absolute'
        self.units = 'inch'
        self.zero_suppression = 'trailing'
        self.format = (2, 5)
        self.state = 'INIT'
        self.tools = []
        self.hits = []
        self.active_tool = None
        self.pos = [0., 0.]
        if ctx is not None:
            self.ctx.set_coord_format(zero_suppression='trailing',
                                      format=(2, 5), notation='absolute')

    def parse(self, filename):
        with open(filename, 'r') as f:
            for line in f:
                self._parse(line)
        settings = {'notation': self.notation, 'units': self.units,
                    'zero_suppression': self.zero_suppression,
                    'format': self.format}
        return ExcellonFile(self.tools, self.hits, settings, filename)

    def dump(self, filename):
        self.ctx.dump(filename)

    def _parse(self, line):
        if 'M48' in line:
            self.state = 'HEADER'

        if 'G00' in line:
            self.state = 'ROUT'

        if 'G05' in line:
            self.state = 'DRILL'

        elif line[0] == '%' and self.state == 'HEADER':
            self.state = 'DRILL'

        if 'INCH' in line or line.strip() == 'M72':
            self.units = 'inch'

        elif 'METRIC' in line or line.strip() == 'M71':
            self.units = 'metric'

        if 'LZ' in line:
            self.zeros = 'L'

        elif 'TZ' in line:
            self.zeros = 'T'

        if 'ICI' in line and 'ON' in line or line.strip() == 'G91':
            self.notation = 'incremental'

        if 'ICI' in line and 'OFF' in line or line.strip() == 'G90':
            self.notation = 'incremental'

        zs = self._settings()['zero_suppression']
        fmt = self._settings()['format']

        # tool definition
        if line[0] == 'T' and self.state == 'HEADER':
            tool = Tool.from_line(line, self._settings())
            self.tools[tool.number] = tool

        elif line[0] == 'T' and self.state != 'HEADER':
            self.active_tool = self.tools[int(line.strip().split('T')[1])]

        if line[0] in ['X', 'Y']:
            x = None
            y = None
            if line[0] == 'X':
                splitline = line.strip('X').split('Y')
                x = parse_gerber_value(splitline[0].strip(), fmt, zs)
                if len(splitline) == 2:
                    y = parse_gerber_value(splitline[1].strip(), fmt, zs)
            else:
                y = parse_gerber_value(line.strip(' Y'), fmt, zs)
            if self.notation == 'absolute':
                if x is not None:
                    self.pos[0] = x
                if y is not None:
                    self.pos[1] = y
            else:
                if x is not None:
                    self.pos[0] += x
                if y is not None:
                    self.pos[1] += y
            if self.state == 'DRILL':
                self.hits.append((self.active_tool, self.pos))
                if self.ctx is not None:
                    self.ctx.drill(self.pos[0], self.pos[1],
                                   self.active_tool.diameter)

    def _settings(self):
        return {'units': self.units, 'zero_suppression': self.zero_suppression,
                'format': self.format}


def pairwise(iterator):
    itr = iter(iterator)
    while True:
        yield tuple([itr.next() for i in range(2)])

if __name__ == '__main__':
    p = parser()
    p.parse('examples/ncdrill.txt')