Changes for page Другие команды (фоновые операции)

Summary

• Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

...	...	@@ -1,233 +1,233 @@
1		-===== **bool IsGCodeRunning ()** =====
	1	+===== **bool IsGCodeRunning()** =====
2	2
3		-Checks if PUMOTIX is in G-code execution mode.
	3	+Позволяет проверить, находится ли PUMOTIX в режиме выполнения G-кода.
4	4
5		-Return value:
	5	+Возвращаемое значение:
6	6
7		-* true - if PUMOTIX is in G-code execution mode.
	7	+* true – если PUMOTIX находится в режиме выполнения G-кода;
8	8
9		-===== **bool IsMDIRunning ()** =====
	9	+===== **bool IsMDIRunning()** =====
10	10
11		-Checks if PUMOTIX is in manual command execution mode.
	11	+Позволяет проверить, находится ли PUMOTIX в режиме выполнения команды ручного ввода.
12	12
13		-Return value:
	13	+Возвращаемое значение:
14	14
15		-* true - if PUMOTIX is in the execution mode of the manual input command.
	15	+* true – если PUMOTIX находится в режиме выполнения команды ручного ввода;
16	16
17		-===== **bool IsRunning ()** =====
	17	+===== **bool IsRunning()** =====
18	18
19		-Checks if PUMOTIX is in G-code or manual entry mode.
	19	+Позволяет проверить, находится ли PUMOTIX в режиме выполнения G-кода или команды ручного ввода.
20	20
21		-Return value:
	21	+Возвращаемое значение:
22	22
23		-* true - if either of the two IsGCodeRunning () or IsMDIRunning () modes is active.
	23	+* true – если активен любой из двух режимов IsGCodeRunning() или IsMDIRunning();
24	24
25		-===== **bool IsIdle ()** =====
	25	+===== **bool IsIdle()** =====
26	26
27		-Allows you to check whether the PUMOTIX is in standby mode ("on" state of the power button).
	27	+Позволяет проверить, находится ли PUMOTIX в режиме ожидания (состояние Вкл кнопки включения).
28	28
29		-Return value:
	29	+Возвращаемое значение:
30	30
31		-* true - if PUMOTIX is in standby mode.
	31	+* true – если PUMOTIX находится в режиме ожидания;
32	32
33		-===== **bool IsEStop ()** =====
	33	+===== **bool IsEStop()** =====
34	34
35		-Checks if PUMOTIX is in EStop mode ("off" state of the power button).
	35	+Позволяет проверить, находится ли PUMOTIX в режиме EStop (состояние Выкл кнопки включения).
36	36
37		-Return value:
	37	+Возвращаемое значение:
38	38
39		-* true - if PUMOTIX is in EStop mode.
	39	+* true – если PUMOTIX находится в режиме EStop.
40	40
41		-===== **void FloodEnable ()** =====
	41	+===== **void FloodEnable()** =====
42	42
43		-Turn on the flood coolant.
	43	+Включение подачи охлаждающей жидкости поливом.
44	44
45		-===== **void FloodDisable ()** =====
	45	+===== **void FloodDisable()** =====
46	46
47		-Turn off the flood coolant.
	47	+Выключение подачи охлаждающей жидкости поливом.
48	48
49		-===== **void MistEnable ()** =====
	49	+===== **void MistEnable()** =====
50	50
51		-Turn on spray coolant.
	51	+Включение подачи охлаждающей жидкости распылением.
52	52
53		-===== **void MistDisable ()** =====
	53	+===== **void MistDisable()** =====
54	54
55		-Switch off the spray coolant.
	55	+Выключение подачи охлаждающей жидкости распылением.
56	56
57		-===== **void Stop ()** =====
	57	+===== **void Stop()** =====
58	58
59		-G-code execution stop.
	59	+Остановка выполнения G-кода.
60	60
61		-===== **void EStop ()** =====
	61	+===== **void EStop()** =====
62	62
63		-Emergency stop execution of the G-code and putting the system in Off mode.
	63	+Экстренная остановка выполнения G-кода и перевод системы в режим Выкл.
64	64
65		-===== **void Sleep (number milliseconds)** =====
	65	+===== **void Sleep(number milliseconds)** =====
66	66
67		-Waiting for the specified number of milliseconds.
	67	+Ожидание в течение указанного количества миллисекунд.
68	68
69		-Options:
	69	+Параметры:
70	70
71		-* number milliseconds - the number of milliseconds during which the execution of the background macro will be suspended.
	71	+* number milliseconds – количество миллисекунд, в течение которых выполнение фонового макроса будет приостановлено.
72	72
73		-===== **void DisplayMessage (string message)** =====
	73	+===== **void DisplayMessage(string message)** =====
74	74
75		-Display in the user interface of a message from a background macro.
	75	+Отображение в пользовательском интерфейсе сообщения от фонового макроса. Для корректного отображения символов национальных алфавитов файл макроса должен быть сохранён в кодировке UTF-8.
76	76
77		-Options:
	77	+Параметры:
78	78
79		-* string message - the text of the message that should be shown to the user.
	79	+* string message – текст сообщения, которое должно быть показано пользователю.
80	80
81		-===== **string Get_Message (number messageId)** =====
	81	+===== **string Get_Message(number messageId)** =====
82	82
83		-Getting one of predefined localized text messages.
	83	+Получение одного из предопределённых локализованных текстовых сообщений.
84	84
85		-Options:
	85	+Параметры:
86	86
87		-* number messageId – message ID (one of the constants defined in the [[**Messages**>>doc:Руководство пользователя.Описание M-кодов.Описание функций макроязыка.Другие команды.WebHome]] list must be passed as this parameter).
	87	+* number messageId – идентификатор сообщения (в качестве этого параметра должна передаваться одна из констант, определённых в списке Messages).
88	88
89		-Return value:
	89	+Возвращаемое значение:
90	90
91		-* localized text message.
	91	+* локализованное текстовое сообщение.
92	92
93		-===== **bool IsRealDeviceConnected ()** =====
	93	+===== **bool IsRealDeviceConnected()** =====
94	94
95		-Allows you to check device connection.
	95	+Позволяет проверить, установлено ли подключение к контроллеру.
96	96
97		-Return value:
	97	+Возвращаемое значение:
98	98
99		-* true – if a real device (not a simulator) is selected and connected.
	99	+* true – если выбрано реальное устройство (не симулятор) и подключение к нему установлено.
100	100
101		-===== **number GetExecutingMCode ()** =====
	101	+===== **number GetExecutingMCode()** =====
102	102
103		-Getting an executing macro code. It returns -1 if no one macro is executed.
	103	+Возвращает номер, выполняющегося макроса. Если макрос не запущен возвращает -1.
104	104
105		-Return value:
	105	+Возвращаемое значение:
106	106
107		-* macro code.
	107	+* номер макроса.
108	108
109		-===== **string str (number value)** =====
	109	+===== **string str(number value)** =====
110	110
111		-Convert a real number to a string.
	111	+Преобразование вещественного числа в строку.
112	112
113		-The Lua language supports implicit conversion of a number into a string, but by default for a very small real number the conversion result can have an exponential format, which does not allow using the string as part of a G-code string. For convenience, you can use the str function, which ensures that the number has a decimal representation.
	113	+Язык Lua поддерживает неявное преобразование числа в строку, но по умолчанию для очень маленького вещественного числа результат преобразования может иметь экспоненциальный формат, что не позволяет использовать строку как часть строки G-кода. Для удобства можно использовать функцию str, которая гарантирует, что число будет иметь десятичное представление.
114	114
115		-Options:
	115	+Параметры:
116	116
117		-* number value - a real number to be converted.
	117	+* number value – вещественное число, которое необходимо преобразовать.
118	118
119		-Return value:
	119	+Возвращаемое значение:
120	120
121		-* string representation of a given number.
	121	+* строковое представление заданного числа.
122	122
123		-===== **number GetSystemTickCount ()** =====
	123	+===== **number GetSystemTickCount()** =====
124	124
125		-Getting the number of milliseconds since the operating system started. It can be used to measure time intervals. To get the current calendar date and time in UnixTime, you need to use the standard Lua **os.time()** function.
	125	+Получение количества миллисекунд, прошедшего с момента запуска операционной системы. Может использоваться для замера интервалов времени. Для получения текущих календарных даты и времени в UnixTime необходимо использовать стандартную функцию Lua (% style="color:#242729" %)**os.time()**.
126	126
127		-Return value:
	127	+Возвращаемое значение:
128	128
129		-* the number of milliseconds since the operating system started.
	129	+* количество миллисекунд, прошедшее с момента запуска операционной системы.
130	130
131		-===== **void SetUserVariable (number index, number value)** =====
	131	+===== **void SetUserVariable(number index, number value)** =====
132	132
133		-Setting the value of a user variable. This value can be read when another macro is executed, including after restarting PUMOTIX.
	133	+Установка значения пользовательской переменной. Данное значение может быть прочитано при выполнении другого макроса, в том числе после перезапуска PUMOTIX.
134	134
135		-Options:
	135	+Параметры:
136	136
137		-* number index - variable number, integer from 0 to 99;
138		-* number value - the value of the user variable (real number) that must be set.
	137	+* number index – номер переменной, целое число от 0 до 99;
	138	+* number value – значение пользовательской переменной (вещественное число), которое необходимо установить.
139	139
140		-===== **number GetUserVariable (number index)** =====
	140	+===== **number GetUserVariable(number index)** =====
141	141
142		-Getting the value of a user variable.
	142	+Получение значения пользовательской переменной.
143	143
144		-Options:
	144	+Параметры:
145	145
146		-* number index - the number of the variable, an integer from 0 to 99.
	146	+* number index – номер переменной, целое число от 0 до 99.
147	147
148		-Return value:
	148	+Возвращаемое значение:
149	149
150		-* current value of the user variable (real number).
	150	+* текущее значение пользовательской переменной (вещественное число).
151	151
152		-===== **bool GetLedUserValue (number index)** =====
	152	+===== **bool GetLedUserValue(number index)** =====
153	153
154		-Getting a value of user led (boolean).
	154	+Выводит значение пользовательской переменной.
155	155
156		-Options:
	156	+Параметры:
157	157
158		-* number index – variable number, integer from 0 to 29.
	158	+* number index – номер переменной, целое число от 0 до 29.
159	159
160		-Return value:
	160	+Возвращаемое значение:
161	161
162		-* bool - user variable value.
	162	+* bool - значение пользовательской переменной.
163	163
164		-===== **void SetLedUserValue (number index, bool a_value)** =====
	164	+===== **void SetLedUserValue(number index, bool a_value)** =====
165	165
166		-Setting a user variable value. This value can be read in another macro, including after PUMOTIX rebooting.
	166	+Установка значения пользовательской переменной. Данное значение может быть прочитано при выполнении другого макроса, в том числе после перезапуска PUMOTIX.
167	167
168		-Options:
	168	+Параметры:
169	169
170		-* number index – variable number, integer from 0 to 29;
171		-* bool a_value – user variable value.
	170	+* number index – номер переменной, целое число от 0 до 29;
	171	+* bool a_value – значение пользовательской переменной.
172	172
173		-===== **number GetNumUserValue (number index)** =====
	173	+===== **number GetNumUserValue(number index)** =====
174	174
175		-Getting a user number value (real).
	175	+Выводит значения пользовательской переменной.
176	176
177		-Options:
	177	+Параметры:
178	178
179		-* number index – variable number, integer from 0 to 29.
	179	+* number index – номер переменной, целое число от 0 до 29.
180	180
181		-Return value:
	181	+Возвращаемое значение:
182	182
183		-* number - user variable value.
	183	+* number - значение пользовательской переменной.
184	184
185		-===== **void SetNumUserValue (number index, number value)** =====
	185	+===== **void SetNumUserValue(number index, number value)** =====
186	186
187		-Setting a user variable value. This value can be read in another macro, including after PUMOTIX rebooting.
	187	+Установка значения пользовательской переменной. Данное значение может быть прочитано при выполнении другого макроса, в том числе после перезапуска PUMOTIX.
188	188
189		-Options:
	189	+Параметры:
190	190
191		-* number index – variable number, integer from 0 to 29;
192		-* number value – user variable value (real number) to set.
	191	+* number index – номер переменной, целое число от 0 до 29;
	192	+* number value – значение пользовательской переменной (вещественное число), которое необходимо установить.
193	193
194		-===== **string GetStrUserValue (number index)** =====
	194	+===== **string GetStrUserValue(number index)** =====
195	195
196		-Getting a user string value.
	196	+Выводит значения пользовательской переменной.
197	197
198		-Options:
	198	+Параметры:
199	199
200		-* number index – variable number, integer from 0 to 29.
	200	+* number index – номер переменной, целое число от 0 до 29.
201	201
202		-Return value:
	202	+Возвращаемое значение:
203	203
204		-* string – user variable value.
	204	+* string- значение пользовательской переменной.
205	205
206		-===== **void SetStrUserValue (number index, string value)** =====
	206	+===== **void SetStrUserValue(number index, string value)** =====
207	207
208		-Setting a user variable value. This value can be read in another macro, including after PUMOTIX rebooting.
	208	+Установка значения пользовательской переменной. Данное значение может быть прочитано при выполнении другого макроса, в том числе после перезапуска PUMOTIX.
209	209
210		-Options:
	210	+Параметры:
211	211
212		-* number index – variable number, integer from 0 to 29;
213		-* string value – user variable value (string) to set.
	212	+* number index – номер переменной, целое число от 0 до 29;
	213	+* string value - значение пользовательской переменной (строка), которое необходимо установить.
214	214
215		-===== **void RunGCode ()** =====
	215	+===== **void RunGCode()** =====
216	216
217		-Start G-code running (similar to pressing the Start button).
	217	+Запуск выполнения G-кода (аналогично нажатию кнопки Старт).
218	218
219		-===== **void RunMDI (string command)** =====
	219	+===== **void RunMDI(string command)** =====
220	220
221		-Execute a given string of G-code. The function returns immediately after the call and execution of the background operation continues.
	221	+Выполнение заданной строки G-кода. Функция сразу же после вызова возвращает управление и выполнение фонового макроса продолжается.
222	222
223		-Options:
	223	+Параметры:
224	224
225		-* string command – G-code string to execute.
	225	+* string command – строка G-кода, которая должна быть выполнена.
226	226
227		-===== **void WeldOscillatorEnable ()** =====
	227	+===== **void WeldOscillatorEnable()** =====
228	228
229		-Oscillator on.
	229	+Включение колебателя.
230	230
231		-===== **void WeldOscillatorDisable ()** =====
	231	+===== **void WeldOscillatorDisable()** =====
232	232
233		-Oscilator off.
	233	+Выключение колебателя.