Перейти к содержимому
Версия 2.3 от knetyaga на 2022/06/10 13:58
Скрыть последних авторов
knetyaga 1.1 1 === bool IsGCodeRunning () ===
2
3 Позволяет проверить, находится ли PUMOTIX в режиме выполнения G-кода.
4
5 Возвращаемое значение:
6
7 * true – если PUMOTIX находится в режиме выполнения G-кода;
8
9 === bool IsMDIRunning () ===
10
11 Позволяет проверить, находится ли PUMOTIX в режиме выполнения команды ручного ввода.
12
13 Возвращаемое значение:
14
15 * true – если PUMOTIX находится в режиме выполнения команды ручного ввода;
16
17 === bool IsRunning () ===
18
19 Позволяет проверить, находится ли PUMOTIX в режиме выполнения G-кода или команды ручного ввода.
20
21 Возвращаемое значение:
22
23 * true – если активен любой из двух режимов IsGCodeRunning() или IsMDIRunning();
24
25 === bool IsIdle () ===
26
27 Позволяет проверить, находится ли PUMOTIX в режиме ожидания (состояние Вкл кнопки включения).
28
29 Возвращаемое значение:
30
31 * true – если PUMOTIX находится в режиме ожидания;
32
33 === bool IsEStop () ===
34
35 Позволяет проверить, находится ли PUMOTIX в режиме EStop (состояние Выкл кнопки включения).
36
37 Возвращаемое значение:
38
39 * true – если PUMOTIX находится в режиме EStop.
40
41 === void FloodEnable () ===
42
43 Включение подачи охлаждающей жидкости поливом.
44
45 === void FloodDisable () ===
46
47 Выключение подачи охлаждающей жидкости поливом.
48
49 === void MistEnable () ===
50
51 Включение подачи охлаждающей жидкости распылением.
52
53 === void MistDisable () ===
54
55 Выключение подачи охлаждающей жидкости распылением.
56
57 === void Stop () ===
58
59 Остановка выполнения G-кода.
60
61 === void EStop () ===
62
63 Экстренная остановка выполнения G-кода и перевод системы в режим Выкл.
64
65 === void Sleep (number milliseconds) ===
66
67 Ожидание в течение указанного количества миллисекунд.
68
69 Параметры:
70
71 * number milliseconds – количество миллисекунд, в течение которых выполнение фонового макроса будет приостановлено.
72
73 === void DisplayMessage (string message) ===
74
75 Отображение в пользовательском интерфейсе сообщения от фонового макроса. Для корректного отображения символов национальных алфавитов файл макроса должен быть сохранён в кодировке UTF-8.
76
77 Параметры:
78
79 * string message – текст сообщения, которое должно быть показано пользователю.
80
81 === string Get_Message (number messageId) ===
82
83 Получение одного из предопределённых локализованных текстовых сообщений.
84
85 Параметры:
86
87 * number messageId – идентификатор сообщения (в качестве этого параметра должна передаваться одна из констант, определённых в списке Messages).
88
89 Возвращаемое значение:
90
91 * локализованное текстовое сообщение.
92
93 === bool IsRealDeviceConnected () ===
94
95 Позволяет проверить, установлено ли подключение к контроллеру.
96
97 Возвращаемое значение:
98
99 * true – если выбрано реальное устройство (не симулятор) и подключение к нему установлено.
100
101 === number GetExecutingMCode () ===
102
103 Возвращает номер, выполняющегося макроса. Если макрос не запущен возвращает -1.
104
105 Возвращаемое значение:
106
107 * номер макроса.
108
109 === string str (number value) ===
110
111 Преобразование вещественного числа в строку.
112
113 Язык Lua поддерживает неявное преобразование числа в строку, но по умолчанию для очень маленького вещественного числа результат преобразования может иметь экспоненциальный формат, что не позволяет использовать строку как часть строки G-кода. Для удобства можно использовать функцию str, которая гарантирует, что число будет иметь десятичное представление.
114
115 Параметры:
116
117 * number value – вещественное число, которое необходимо преобразовать.
118
119 Возвращаемое значение:
120
121 * строковое представление заданного числа.
122
123 === number GetSystemTickCount () ===
124
125 Получение количества миллисекунд, прошедшего с момента запуска операционной системы. Может использоваться для замера интервалов времени. Для получения текущих календарных даты и времени в UnixTime необходимо использовать стандартную функцию Lua (% style="color: rgb(36,39,41);" %)**os.time()**.
126
127 Возвращаемое значение:
128
129 * количество миллисекунд, прошедшее с момента запуска операционной системы.
130
131 === void SetUserVariable (number index, number value) ===
132
133 Установка значения пользовательской переменной. Данное значение может быть прочитано при выполнении другого макроса, в том числе после перезапуска PUMOTIX.
134
135 Параметры:
136
137 * number index – номер переменной, целое число от 0 до 99;
138 * number value – значение пользовательской переменной (вещественное число), которое необходимо установить.
139
140 === number GetUserVariable (number index) ===
141
142 Получение значения пользовательской переменной.
143
144 Параметры:
145
146 * number index – номер переменной, целое число от 0 до 99.
147
148 Возвращаемое значение:
149
150 * текущее значение пользовательской переменной (вещественное число).
151
152 === bool GetLedUserValue (number index) ===
153
154 Выводит значение пользовательской переменной.
155
156 Параметры:
157
158 * number index – номер переменной, целое число от 0 до 29.
159
160 Возвращаемое значение:
161
162 * bool - значение пользовательской переменной.
163
164 === void SetLedUserValue (number index, bool a_value) ===
165
166 Установка значения пользовательской переменной. Данное значение может быть прочитано при выполнении другого макроса, в том числе после перезапуска PUMOTIX.
167
168 Параметры:
169
170 * number index – номер переменной, целое число от 0 до 29;
171 * bool a_value – значение пользовательской переменной.
172
173 === number GetNumUserValue (number index) ===
174
175 Выводит значения пользовательской переменной.
176
177 Параметры:
178
179 * number index – номер переменной, целое число от 0 до 29.
180
181 Возвращаемое значение:
182
183 * number - значение пользовательской переменной.
184
185 === void SetNumUserValue (number index, number value) ===
186
187 Установка значения пользовательской переменной. Данное значение может быть прочитано при выполнении другого макроса, в том числе после перезапуска PUMOTIX.
188
189 Параметры:
190
191 * number index – номер переменной, целое число от 0 до 29;
192 * number value – значение пользовательской переменной (вещественное число), которое необходимо установить.
193
194 === string GetStrUserValue (number index) ===
195
196 Выводит значения пользовательской переменной.
197
198 Параметры:
199
200 * number index – номер переменной, целое число от 0 до 29.
201
202 Возвращаемое значение:
203
204 * string- значение пользовательской переменной.
205
206 === void SetStrUserValue (number index, string value) ===
207
208 Установка значения пользовательской переменной. Данное значение может быть прочитано при выполнении другого макроса, в том числе после перезапуска PUMOTIX.
209
210 Параметры:
211
212 * number index – номер переменной, целое число от 0 до 29;
213 * string value - значение пользовательской переменной (строка), которое необходимо установить.
214
215 === void RunGCode () ===
216
217 Запуск выполнения G-кода (аналогично нажатию кнопки Старт).
218
219 === void RunMDI (string command) ===
220
221 Выполнение заданной строки G-кода. Функция сразу же после вызова возвращает управление и выполнение фонового макроса продолжается.
222
223 Параметры:
224
225 * string command – строка G-кода, которая должна быть выполнена.
226
227 === void WeldOscillatorEnable () ===
228
229 Включение колебателя.
230
231 === void WeldOscillatorDisable () ===
232
233 Выключение колебателя.