Skip to Content
Last modified by writer on 2023/09/08 18:33
Show last authors
1 ===== number AxisGetPos(number axisId) =====
2
3 Getting the current working coordinate of the specified axis.
4
5 Options:
6
7 * number axisId – axis number, an integer from 0 to 8 (one of the constants defined in the **[[Axes>>doc:||shape="rect"]]** list can be passed as this parameter).
8
9 Return value:
10
11 * value of the current working coordinate of the specified axis.
12
13 ===== number AxisGetMachinePos(number axisId) =====
14
15 Getting the current machine coordinate of the specified axis.
16
17 Options:
18
19 * number axisId – axis number, an integer from 0 to 8 (one of the constants defined in the **[[Axes>>doc:||shape="rect"]] **list can be passed as this parameter).
20
21 Return value:
22
23 * value of the current machine coordinate of the specified axis.
24
25 ===== number GetCurFeedrate() =====
26
27 Getting the current speed of movement.
28
29 Return value:
30
31 * the module of the velocity vector in XYZ space.
32
33 ===== void SetFeedrate(number value) =====
34
35 Setting the speed of movement.
36
37 Options:
38
39 * number value – the desired speed along the trajectory (equivalent to the parameter F in the G-code).
40
41 ===== number GetFeedrateOverridePercent() =====
42
43 Getting the percentage of overriding the current speed of movement.
44
45 Return value:
46
47 * percentage of the actual speed of movement from the set.
48
49 ===== number GetGCodeFeedrate() =====
50
51 Getting the speed of movement specified in the G-code.
52
53 Return value:
54
55 * movement speed specified in the G-code.
56
57 ===== void AxisZeroPos(number axisId) =====
58
59 Zeroing the current working coordinate of the specified axis.
60
61 Options:
62
63 * number axisId – axis number, an integer from 0 to 8 (one of the constants defined in the **[[Axes>>doc:||shape="rect"]]** list can be passed as this parameter).
64
65 ===== bool UseSafeZ() =====
66
67 Allows you to check whether climbing to a safe height is allowed in the parameters of the milling mode.
68
69 Return value:
70
71 * true – climbing to a safe height is allowed;
72 * false – climbing to a safe height is prohibited.
73
74 ===== number GetGeneralSafeZ() =====
75
76 Getting the safe height specified in the parameters of the milling mode.
77
78 Return value:
79
80 * safe height of single crossings, mm.
81
82 ===== string GetCurrentDistanceMode() =====
83
84 Getting the current positioning mode.
85
86 Return value:
87
88 * one of the constants: Abs – for absolute positioning ([[(% style="color:#a0be2d" %)//**G90**//>>doc:Руководство пользователя.Описание G-кодов.Список G-кодов, поддерживаемых системой.G90-G99.G90, G91\: Задание режима абсолютныхотносительных координат.WebHome]](%%)), Inc – for incremental positioning ([[(% style="color:#a0be2d" %)//**G91**//>>doc:Руководство пользователя.Описание G-кодов.Список G-кодов, поддерживаемых системой.G90-G99.G90, G91\: Задание режима абсолютныхотносительных координат.WebHome]](%%)).
89
90 ===== void PushCurrentDistanceMode() =====
91
92 Command to save the current positioning mode. Returned the system to the saving state after macros completing.
93
94 ===== number GetCurrentMotionMode() =====
95
96 Getting the current modal mode of movements ([[(% style="color:#a0be2d" %)//**G0**//>>doc:Руководство пользователя.Описание G-кодов.Список G-кодов, поддерживаемых системой.G0-G10.G0: Ускоренное линейное перемещение]](%%), [[(% style="color:#a0be2d" %)//**G1**//>>doc:Руководство пользователя.Описание G-кодов.Список G-кодов, поддерживаемых системой.G0-G10.G1: Линейное перемещение]](%%), [[(% style="color:#a0be2d" %)//**G2**//>>doc:Руководство пользователя.Описание G-кодов.Список G-кодов, поддерживаемых системой.G0-G10.G2, G3: Круговое перемещение]](%%), [[(% style="color:#a0be2d" %)//**G81**//>>doc:Руководство пользователя.Описание G-кодов.Список G-кодов, поддерживаемых системой.G80-G89\: Постоянные циклы.G81\: Цикл сверления.WebHome]](%%) etc.).
97
98 Return value:
99
100 * an integer corresponding to the current modal mode of movements; can be passed as a parameter to the **SetCurrentMotionMode(number motionMode)**.
101
102 ===== void SetCurrentMotionMode(number motionMode) =====
103
104 Setting the current modal mode of movements ([[(% style="color:#a0be2d" %)//**G0**//>>doc:Руководство пользователя.Описание G-кодов.Список G-кодов, поддерживаемых системой.G0-G10.G0: Ускоренное линейное перемещение]](%%), [[(% style="color:#a0be2d" %)//**G1**//>>doc:Руководство пользователя.Описание G-кодов.Список G-кодов, поддерживаемых системой.G0-G10.G1: Линейное перемещение]](%%), [[(% style="color:#a0be2d" %)//**G2**//>>doc:Руководство пользователя.Описание G-кодов.Список G-кодов, поддерживаемых системой.G0-G10.G2, G3: Круговое перемещение]](%%), [[(% style="color:#a0be2d" %)//**G81**//>>doc:Руководство пользователя.Описание G-кодов.Список G-кодов, поддерживаемых системой.G80-G89\: Постоянные циклы.G81\: Цикл сверления.WebHome]](%%) etc.).
105
106 Options:
107
108 * number motionMode – an integer corresponding to the set modal mode of movements; as this parameter, the value obtained when calling the **GetCurrentMotionMode()** function can be passed.
109
110 ===== void PushCurrentMotionMode() =====
111
112 Command to save the current modal mode of movements. Returned the system to the saving state after macros completing.
113
114 ===== void MotorEnable(number motorId) =====
115
116 Changes the motor state of the specified index to "motor active" (motor index starts at 0).
117
118 Options:
119
120 * number motorId – motor number to enable.
121
122 ===== void MotorDisable(number motorId) =====
123
124 Changes the motor state of the specified index to "motor inactive" (motor index starts at 0).
125
126 Options:
127
128 * number motorId – motor number to disable.
129
130 ===== void SwitchMotors(number motorIdToDisable, number motorIdToEnable) =====
131
132 Allows to perform dynamic switching of an active motor from several motors linked to an axis (motor index starts at 0).
133
134 Options:
135
136 * numberIdToDisable – motor number to disable.
137 * numberIdToEnable – motor number to enable.
138
139 ===== number GetActiveMotors() =====
140
141 Allows to get the bitmask of the active motor.
142
143 Return value:
144
145 * bitmask of the active motor.
146
147 ===== number GetSoftLimitLow(number axisId) =====
148
149 Getting the machine coordinate of limit low specified in the Axis Soft Limits Settings for the specified axis.
150
151 Options:
152
153 * number axisId – axis number, an integer from 0 to 8 (one of the constants defined in the **[[Axes>>doc:||rel="nofollow" shape="rect" style="text-decoration: none;"]]** list can be passed as this parameter).
154
155 Return value:
156
157 * the machine coord of limit low specified in the Axis Soft Limits Settings for the specified axis.
158
159 ===== number GetSoftLimitHigh(number axisId) =====
160
161 Getting the machine coordinate of limit high specified in the Axis Soft Limits Settings for the specified axis.
162
163 Options:
164
165 * number axisId – axis number, an integer from 0 to 8 (one of the constants defined in the **[[Axes>>doc:||rel="nofollow" shape="rect" style="text-decoration: none;"]]** list can be passed as this parameter).
166
167 Return value:
168
169 * the machine coord of limit high specified in the Axis Soft Limits Settings for the specified axis.
170
171 ===== number GetGcodeBoundMin(number axisId) =====
172
173 Getting the minimum machine coordinate of the bounds along a given axis.
174
175 Options:
176
177 * number axisId – axis number, an integer from 0 to 8 (one of the constants defined in the **[[Axes>>doc:||rel="nofollow" shape="rect" style="text-decoration: none;"]]** list can be passed as this parameter).
178
179 Return value:
180
181 * minimum machine coordinate of the bounds along a given axis.
182
183 ===== number GetGcodeBoundMax(number axisId) =====
184
185 Getting the maximum machine coordinate of the bounds along a given axis.
186
187 Options:
188
189 * number axisId – axis number, an integer from 0 to 8 (one of the constants defined in the **[[Axes>>doc:||rel="nofollow" shape="rect" style="text-decoration: none;"]]** list can be passed as this parameter).
190
191 Return value:
192
193 * maximum machine coordinate of the bounds along a given axis.
194
195 ===== number GetGcodeBoundMaxWithoutTraverse(number axisId) =====
196
197 Getting the maximum machine coordinate of the bounds along a given axis without traverse.
198
199 Options:
200
201 * number axisId – axis number, an integer from 0 to 8 (one of the constants defined in the **[[Axes>>doc:||rel="nofollow" shape="rect" style="text-decoration: none;"]]** list can be passed as this parameter).
202
203 Return value:
204
205 * maximum machine coordinate of the bounds along a given axis.
206
207 ===== number GetGcodeBoundMinWithoutTraverse(number axisId) =====
208
209 Getting the minimum machine coordinate of the bounds along a given axis without traverse.
210
211 Options:
212
213 * number axisId – axis number, an integer from 0 to 8 (one of the constants defined in the **[[Axes>>doc:||rel="nofollow" shape="rect" style="text-decoration: none;"]]** list can be passed as this parameter).
214
215 Return value:
216
217 * minimum machine coordinate of the bounds along a given axis.
218
219 ===== bool GcodeBoundsExist() =====
220
221 Allows you to check if the bouds of the G-code loaded into the program exist.
222
223 Return value:
224
225 * true – if the G-code loaded has bounds.
226
227 ===== bool GcodeBoundsWithoutTraverseExist() =====
228
229 Allows you to check if the bouds without traverse of the G-code loaded into the program exist.
230
231 Return value:
232
233 * true – if the G-code loaded has bounds without traverse.
234
235 ===== number GetG5xIndex() =====
236
237 Getting the index of selected coordinate system.
238
239 Return value:
240
241 * an integer indicating the selected coordinate system in accordance with the lookup table **[[CoordSystems>>]]**.
242
243 ===== number GetExternalRotation() =====
244
245 Getting the current coordinate system rotation angle.
246
247 Return value:
248
249 * coordinate system rotation angle value.
250
251 ===== Axes (axis identifiers) =====
252
253 * X;
254 * Y;
255 * Z;
256 * A;
257 * B;
258 * C;
259 * U;
260 * V;
261 * W.
262
263 ===== CoordSystems (coordinate systems) =====
264
265 (% style="width:94px" %)
266 |(% style="text-align:center; width:36px" %)1|(% style="text-align:center; width:55px" %)G54
267 |(% style="text-align:center" %)2|(% style="text-align:center" %)G55
268 |(% style="text-align:center" %)3|(% style="text-align:center" %)G56
269 |(% style="text-align:center" %)4|(% style="text-align:center" %)G57
270 |(% style="text-align:center" %)5|(% style="text-align:center" %)G58
271 |(% style="text-align:center" %)6|(% style="text-align:center" %)G59
272 |(% style="text-align:center" %)7|(% style="text-align:center" %)G59.1
273 |(% style="text-align:center" %)8|(% style="text-align:center" %)G59.2
274 |(% style="text-align:center" %)9|(% style="text-align:center" %)G59.3