Newer
Older
####################################################################################################
#
# PythonicGcodeMachine - @licence_header_description@
# Copyright (C) 2018 Fabrice Salvaire
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
####################################################################################################
"""Module to implement an AST for RS-274 G-code.
"""
####################################################################################################
__all__ = [
'Program',
'ParameterMixin',
'ParameterSetting',
'Parameter',
'AbsoluteValue',
'ArcCosine',
'ArcSine',
'ArcTangent',
'Cosine',
'ERaisedTo',
'FixDown',
'FixUp',
'NaturalLogOf',
'Round',
'Sine',
'SquareRoot',
'Tangent',
]
####################################################################################################
import math
####################################################################################################
class Program:
"""Class to implement a G-code program
Usage::
program = Program()
program += line
# Array interface
for line in programs:
print(line)
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
str(program)
"""
##############################################
def __init__(self):
self._lines = []
##############################################
def push(self, line):
self._lines.append(line)
def __iadd__(self, item):
self.push(item)
return self
##############################################
def __len__(self):
return len(self._lines)
def __iter__(self):
return iter(self._lines)
def __getitem__(self, _slice):
return self._lines[_slice]
def iter_on_not_deleted(self):
for line in self._lines:
if line:
yield line
##############################################
def __repr__(self):
text = 'Program(\n'
for line in self:
text += repr(line) + '\n'
text += ')\n'
return text
##############################################
def __str__(self):
return '\n'.join(map(str, self))
####################################################################################################
class LineItem:
####################################################################################################
class Line:
"""Class to implement a G-code line
Usage::
line = Line(deleted=False, line_number=1, comment='a comment')
line.deleted = True
print(line.deleted)
# same apply for line_number and comment
# Is line not deleted ?
bool(line)
# Push some items
# Note: order doesn't matter, see RS-274 for details
line += Word('G', 0)
line += Comment('move')
line += Word('X', 10)
line += Comment('Y value')
line += Word('Y', 20)
line += ParameterSetting('1', 1.2)
# using expression
line += Word('Z', Addition(30, Multiply(Parameter(100), Cosine(30))))
# Array interface
for item in line:
print(item)
print(line.ansi_str()) # use ANSI colors, see Line.ANSI_... attributes
Expression can be evaluated using :code:`float(obj.value)`, excepted when we must access a parameter
value.
ANSI_DELETED = colors.red
ANSI_LINE_NUMBER = colors.blue
ANSI_COMMENT = colors.green
ANSI_SETTING = colors.blue
ANSI_G = colors.red
ANSI_X = colors.blue
ANSI_VALUE = colors.black
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
##############################################
def __init__(self, deleted=False, line_number=None, comment=None):
self.deleted = deleted
self.line_number = line_number
self.comment = comment
self._items = []
##############################################
@property
def deleted(self):
return self._deleted
@deleted.setter
def deleted(self, value):
self._deleted = bool(value)
@property
def line_number(self):
return self._line_number
@line_number.setter
def line_number(self, value):
if value is not None:
value = float(value)
if value.is_integer():
value = int(value)
self._line_number = value
@property
def comment(self):
return self._comment
@comment.setter
def comment(self, value):
if value is not None:
self._comment = str(value)
else:
self._comment = None
##############################################
def push(self, item):
if isinstance(item, LineItem):
self._items.append(item)
else:
raise ValueError
def __iadd__(self, item):
self.push(item)
return self
##############################################
def __bool__(self):
return not self._deleted
##############################################
def __len__(self):
return len(self._items)
def __iter__(self):
return iter(self._items)
def __getitem__(self, _slice):
return self._items[_slice]
##############################################
def iter_on_word(self):
for item in self:
if isinstance(item, Word):
yield item
def iter_on_setting(self):
for item in self:
if isinstance(item, ParameterSetting):
yield item
##############################################
def __repr__(self):
items = []
if not self:
items.append('Deleted')
items += list(map(repr, self))
if self._comment:
items.append(self._comment)
return 'Line{}'.format(self, items)
##############################################
def __str__(self):
line = ''
if not self:
if self._line_number:
line += 'N{} '.format(self._line_number)
line += ' '.join(map(str, self))
if self._comment:
line += ' ; ' + self._comment
return line
##############################################
def ansi_str(self):
line = ''
if not self:
# line += self.ANSI_DELETED('/ ')
return self.ANSI_DELETED(str(self))
if self._line_number:
line += self.ANSI_LINE_NUMBER('N{} '.format(self._line_number))
line += ' '.join([item.ansi_str() for item in self])
if self._comment:
line += ' ' + self.ANSI_COMMENT('; ' + self._comment)
return line
####################################################################################################
class Comment(LineItem):
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
##############################################
def __init__(self, text):
self.set(text)
##############################################
def set(self, text):
if '(' in text:
raise ValueError('Comment cannot contains a "("')
self._text = str(text)
##############################################
@property
def text(self):
return self._text
@text.setter
def text(self, value):
self.set(value)
##############################################
def __repr__(self):
return 'Comment({0._text})'.format(self)
def __str__(self):
return '({0._text})'.format(self)
def ansi_str(self):
return Line.ANSI_COMMENT(str(self))
####################################################################################################
class Word(LineItem):
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
LETTERS = (
'A', 'B', 'C', 'D',
'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M', # 'N',
'P', 'Q', 'R', 'S', 'T',
'X', 'Y', 'Z',
)
##############################################
def __init__(self, letter, value):
self.letter = letter
self.value = value
##############################################
@property
def letter(self):
return self._letter
@letter.setter
def letter(self, value):
value = str(value).upper()
if value not in self.LETTERS:
raise ValueError
self._letter = value
@property
def value(self):
return self._value
@value.setter
def value(self, value):
# float expression ...
self._value = value
##############################################
def __repr__(self):
return 'Word({0._letter} {0._value})'.format(self)
def __str__(self):
return '{0._letter}{0._value}'.format(self)
def ansi_str(self):
if self._letter in 'GM':
return Line.ANSI_G(str(self))
else:
return Line.ANSI_X(self._letter) + Line.ANSI_VALUE(str(self._value))
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
####################################################################################################
class RealValue:
pass
####################################################################################################
class ParameterMixin:
##############################################
def __init__(self, parameter):
self.parameter = parameter
##############################################
@property
def parameter(self):
return self._parameter
@parameter.setter
def parameter(self, value):
try:
value = int(value)
except ValueError:
value = str(value)
self._parameter = value
####################################################################################################
class ParameterSetting(LineItem, ParameterMixin):
##############################################
def __init__(self, parameter, value):
ParameterMixin.__init__(self, parameter)
self.value = value
##############################################
@property
def value(self):
return self._value
@value.setter
def value(self, value):
# float expression ...
self._value = value
##############################################
def __repr__(self):
return 'ParameterSetting({0._parameter} = {0._value})'.format(self)
def __str__(self):
return '#{0._parameter}={0._value}'.format(self)
def ansi_str(self):
return Line.ANSI_SETTING('#{0._parameter}='.format(self)) + Line.ANSI_VALUE(str(self._value))
####################################################################################################
class Parameter(RealValue, ParameterMixin):
##############################################
def __init__(self, parameter):
ParameterMixin.__init__(self, parameter)
##############################################
def __repr__(self):
return 'Parameter({0._parameter})'.format(self)
def __str__(self):
return '#{0._parameter}'.format(self)
##############################################
def __float__(self):
raise NotImplementedError
####################################################################################################
class UnaryOperation(RealValue):
__function__ = None
__gcode__ = None
##############################################
def __init__(self, arg):
self.arg = arg
##############################################
@property
def arg(self):
return self._arg
@arg.setter
def arg(self, value):
self._arg = value
##############################################
return self.__function__(float(self._arg))
##############################################
def __repr__(self):
return '{}({})'.format(self.__class__.__name__, repr(self._arg))
##############################################
def __str__(self):
return '{0.__gcode__}[{0._arg}]'.format(self)
####################################################################################################
class AbsoluteValue(UnaryOperation):
__gcode__ = 'abs'
class ArcCosine(UnaryOperation):
__function__ = staticmethod(lambda x: math.acos(math.radians(x)))
__gcode__ = 'acos'
class ArcSine(UnaryOperation):
__function__ = staticmethod(lambda x: math.degrees(math.asin(x)))
__gcode__ = 'asin'
class ArcTangent(UnaryOperation):
__function__ = staticmethod(lambda x: math.degrees(math.atan(x)))
__gcode__ = 'atan'
class Cosine(UnaryOperation):
__function__ = staticmethod(lambda x: math.cos(math.radians(x)))
__gcode__ = 'cos'
class ERaisedTo(UnaryOperation):
__gcode__ = 'exp'
class FixDown(UnaryOperation):
__gcode__ = 'fix'
class FixUp(UnaryOperation):
__gcode__ = 'fup'
class NaturalLogOf(UnaryOperation):
__gcode__ = 'ln'
class Round(UnaryOperation):
__gcode__ = 'round'
class Sine(UnaryOperation):
__function__ = staticmethod(lambda x: math.sin(math.radians(x)))
__gcode__ = 'sin'
class SquareRoot(UnaryOperation):
__gcode__ = 'sqrt'
class Tangent(UnaryOperation):
__function__ = staticmethod(lambda x: ath.tan(math.radians(x)))
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
__gcode__ = 'tan'
####################################################################################################
class BinaryOperation(RealValue):
__function__ = None
__gcode__ = None
##############################################
def __init__(self, arg1, arg2):
self.arg1 = arg1
self.arg2 = arg2
##############################################
@property
def arg1(self):
return self._arg1
@arg1.setter
def arg1(self, value):
self._arg1 = value
@property
def arg2(self):
return self._arg2
@arg2.setter
def arg2(self, value):
self._arg2 = value
##############################################
return self.__function__(float(self._arg1), float(self._arg2))
##############################################
def __repr__(self):
return '{}({})'.format(self.__class__.__name__, repr(self._arg))
##############################################
def __str__(self):
return '[{0._arg1} {0.__gcode__} {0._arg2}]'.format(self)
####################################################################################################
class Power(BinaryOperation):
__gcode__ = '**'
class DividedBy(BinaryOperation):
__gcode__ = '/'
class Modulo(BinaryOperation):
__gcode__ = 'and'
class ExclusiveOr(BinaryOperation):
class Subtraction(BinaryOperation):
__function__ = staticmethod(lambda a, b: a - b)
class Or(BinaryOperation):
__function__ = staticmethod(lambda a, b: a | b)
class Addition(BinaryOperation):
__function__ = staticmethod(lambda a, b: a + b)