FreeCAD

1
# -*- coding: utf-8 -*-
2
# ***************************************************************************
3
# *   Copyright (c) 2021 sliptonic <shopinthewoods@gmail.com>               *
4
# *                                                                         *
5
# *   This program is free software; you can redistribute it and/or modify  *
6
# *   it under the terms of the GNU Lesser General Public License (LGPL)    *
7
# *   as published by the Free Software Foundation; either version 2 of     *
8
# *   the License, or (at your option) any later version.                   *
9
# *   for detail see the LICENCE text file.                                 *
10
# *                                                                         *
11
# *   This program is distributed in the hope that it will be useful,       *
12
# *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
13
# *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
14
# *   GNU Library General Public License for more details.                  *
15
# *                                                                         *
16
# *   You should have received a copy of the GNU Library General Public     *
17
# *   License along with this program; if not, write to the Free Software   *
18
# *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  *
19
# *   USA                                                                   *
20
# *                                                                         *
21
# ***************************************************************************
22

23
import FreeCAD
24
import Part
25
import Path
26
import Path.Base.Generator.helix as generator
27
import Tests.PathTestUtils as PathTestUtils
28

29

30
Path.Log.setLevel(Path.Log.Level.INFO, Path.Log.thisModule())
31
Path.Log.trackModule(Path.Log.thisModule())
32

33

34
def _resetArgs():
35
    v1 = FreeCAD.Vector(5, 5, 20)
36
    v2 = FreeCAD.Vector(5, 5, 18)
37

38
    edg = Part.makeLine(v1, v2)
39

40
    return {
41
        "edge": edg,
42
        "hole_radius": 10.0,
43
        "step_down": 1.0,
44
        "step_over": 0.5,
45
        "tool_diameter": 5.0,
46
        "inner_radius": 0.0,
47
        "direction": "Climb",
48
        "startAt": "Inside",
49
    }
50

51

52
class TestPathHelixGenerator(PathTestUtils.PathTestBase):
53

54
    expectedHelixGCode = "G0 X7.500000 Y5.000000\
55
G1 Z20.000000\
56
G2 I-2.500000 J0.000000 X2.500000 Y5.000000 Z19.500000\
57
G2 I2.500000 J0.000000 X7.500000 Y5.000000 Z19.000000\
58
G2 I-2.500000 J0.000000 X2.500000 Y5.000000 Z18.500000\
59
G2 I2.500000 J0.000000 X7.500000 Y5.000000 Z18.000000\
60
G2 I-2.500000 J0.000000 X2.500000 Y5.000000 Z18.000000\
61
G2 I2.500000 J0.000000 X7.500000 Y5.000000 Z18.000000\
62
G0 X5.000000 Y5.000000 Z18.000000\
63
G0 Z20.000000G0 X10.000000 Y5.000000\
64
G1 Z20.000000\
65
G2 I-5.000000 J0.000000 X0.000000 Y5.000000 Z19.500000\
66
G2 I5.000000 J0.000000 X10.000000 Y5.000000 Z19.000000\
67
G2 I-5.000000 J0.000000 X0.000000 Y5.000000 Z18.500000\
68
G2 I5.000000 J0.000000 X10.000000 Y5.000000 Z18.000000\
69
G2 I-5.000000 J0.000000 X0.000000 Y5.000000 Z18.000000\
70
G2 I5.000000 J0.000000 X10.000000 Y5.000000 Z18.000000\
71
G0 X5.000000 Y5.000000 Z18.000000\
72
G0 Z20.000000G0 X12.500000 Y5.000000\
73
G1 Z20.000000\
74
G2 I-7.500000 J0.000000 X-2.500000 Y5.000000 Z19.500000\
75
G2 I7.500000 J0.000000 X12.500000 Y5.000000 Z19.000000\
76
G2 I-7.500000 J0.000000 X-2.500000 Y5.000000 Z18.500000\
77
G2 I7.500000 J0.000000 X12.500000 Y5.000000 Z18.000000\
78
G2 I-7.500000 J0.000000 X-2.500000 Y5.000000 Z18.000000\
79
G2 I7.500000 J0.000000 X12.500000 Y5.000000 Z18.000000\
80
G0 X5.000000 Y5.000000 Z18.000000G0 Z20.000000"
81

82
    def test00(self):
83
        """Test Basic Helix Generator Return"""
84
        args = _resetArgs()
85
        result = generator.generate(**args)
86
        self.assertTrue(type(result) is list)
87
        self.assertTrue(type(result[0]) is Path.Command)
88

89
        gcode = "".join([r.toGCode() for r in result])
90
        print(gcode)
91
        self.assertTrue(gcode == self.expectedHelixGCode, "Incorrect helix g-code generated")
92

93
    def test01(self):
94
        """Test Value and Type checking"""
95
        args = _resetArgs()
96
        args["hole_radius"] = "10"
97
        self.assertRaises(TypeError, generator.generate, **args)
98

99
        args["hole_radius"] = -10.0
100
        self.assertRaises(ValueError, generator.generate, **args)
101

102
        args = _resetArgs()
103
        args["inner_radius"] = "2"
104
        self.assertRaises(TypeError, generator.generate, **args)
105

106
        args = _resetArgs()
107
        args["tool_diameter"] = "5"
108
        self.assertRaises(TypeError, generator.generate, **args)
109

110
        # require tool fit 2: hole diameter not greater than tool diam
111
        # with zero inner radius
112
        args = _resetArgs()
113
        args["hole_radius"] = 2.0
114
        args["inner_radius"] = 0.0
115
        args["tool_diameter"] = 5.0
116
        self.assertRaises(ValueError, generator.generate, **args)
117

118
        # require tool fit: actual hole diameter after taking Extra Offset into account >= tool diameter
119
        # 1. Extra Offset just small enough to leave room for tool should not raise an error
120
        args = _resetArgs()
121
        designed_hole_diameter = 10.0
122
        extra_offset = 2.49
123
        args["hole_radius"] = designed_hole_diameter / 2 - extra_offset
124
        args["inner_radius"] = extra_offset
125
        args["tool_diameter"] = 5.0
126
        result = generator.generate(**args)
127
        self.assertTrue(result)
128

129
        # 2. Extra Offset does not leave room for tool, should raise an error
130
        args = _resetArgs()
131
        designed_hole_diameter = 10.0
132
        extra_offset = 2.50
133
        args["hole_radius"] = designed_hole_diameter / 2 - extra_offset
134
        args["inner_radius"] = extra_offset
135
        args["tool_diameter"] = 5.0
136
        self.assertRaises(ValueError, generator.generate, **args)
137

138
        # step_over is a percent value between 0 and 1
139
        args = _resetArgs()
140
        args["step_over"] = 50
141
        self.assertRaises(ValueError, generator.generate, **args)
142
        args["step_over"] = "50"
143
        self.assertRaises(TypeError, generator.generate, **args)
144

145
        # Other argument testing
146
        args = _resetArgs()
147
        args["startAt"] = "Other"
148
        self.assertRaises(ValueError, generator.generate, **args)
149

150
        args = _resetArgs()
151
        args["direction"] = "clock"
152
        self.assertRaises(ValueError, generator.generate, **args)
153

154
    def test07(self):
155
        """Test Basic Helix Generator verify linear edge is vertical"""
156
        # verify linear edge is vertical: X
157
        args = _resetArgs()
158
        v1 = FreeCAD.Vector(5, 5, 20)
159
        v2 = FreeCAD.Vector(5.0001, 5, 10)
160
        edg = Part.makeLine(v1, v2)
161
        args["edge"] = edg
162
        self.assertRaises(ValueError, generator.generate, **args)
163

164
        # verify linear edge is vertical: Y
165
        args = _resetArgs()
166
        v1 = FreeCAD.Vector(5, 5.0001, 20)
167
        v2 = FreeCAD.Vector(5, 5, 10)
168
        edg = Part.makeLine(v1, v2)
169
        args["edge"] = edg
170
        self.assertRaises(ValueError, generator.generate, **args)
171

172
    def test08(self):
173
        """Test Helix Generator with horizontal edge"""
174
        args = _resetArgs()
175
        v1 = FreeCAD.Vector(10, 5, 5)
176
        v2 = FreeCAD.Vector(20, 5, 5)
177
        edg = Part.makeLine(v1, v2)
178
        args["edge"] = edg
179
        self.assertRaises(ValueError, generator.generate, **args)
180

181
    def test09(self):
182
        """Test Helix Generator with inverted vertical edge"""
183
        args = _resetArgs()
184
        v1 = FreeCAD.Vector(5, 5, 18)
185
        v2 = FreeCAD.Vector(5, 5, 20)
186
        edg = Part.makeLine(v1, v2)
187
        args["edge"] = edg
188

189
        self.assertRaises(ValueError, generator.generate, **args)
190

191
    def test10(self):
192
        """Test Helix Retraction"""
193

194
        # if center is clear, the second to last move should be a rapid away
195
        # from the wall
196
        args = _resetArgs()
197
        v1 = FreeCAD.Vector(0, 0, 20)
198
        v2 = FreeCAD.Vector(0, 0, 18)
199
        edg = Part.makeLine(v1, v2)
200
        args["edge"] = edg
201
        args["inner_radius"] = 0.0
202
        args["tool_diameter"] = 5.0
203
        result = generator.generate(**args)
204
        self.assertTrue(result[-2].Name == "G0")
205

206
        # if center is not clear, retraction is one straight up on the last
207
        # move. the second to last move should be a G2
208
        args["inner_radius"] = 2.0
209
        result = generator.generate(**args)
210
        self.assertTrue(result[-2].Name == "G2")
211