Skip to Content
Last modified by writer on 2023/09/08 19:06
From version 4.1
edited by writer
on 2023/06/07 16:59
Change comment: There is no comment for this version
To version 5.1
edited by writer
on 2023/09/08 19:06
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,4 +1,4 @@
1 -===== **bool IsGCodeRunning ()** =====
1 +===== bool IsGCodeRunning () =====
2 2  
3 3  Checks if PUMOTIX is in G-code execution mode.
4 4  
... ... @@ -6,7 +6,7 @@
6 6  
7 7  * true - if PUMOTIX is in G-code execution mode.
8 8  
9 -===== **bool IsMDIRunning ()** =====
9 +===== bool IsMDIRunning () =====
10 10  
11 11  Checks if PUMOTIX is in manual command execution mode.
12 12  
... ... @@ -14,7 +14,7 @@
14 14  
15 15  * true - if PUMOTIX is in the execution mode of the manual input command.
16 16  
17 -===== **bool IsRunning ()** =====
17 +===== bool IsRunning () =====
18 18  
19 19  Checks if PUMOTIX is in G-code or manual entry mode.
20 20  
... ... @@ -22,7 +22,7 @@
22 22  
23 23  * true - if either of the two IsGCodeRunning () or IsMDIRunning () modes is active.
24 24  
25 -===== **bool IsIdle ()** =====
25 +===== bool IsIdle () =====
26 26  
27 27  Allows you to check whether the PUMOTIX is in standby mode ("on" state of the power button).
28 28  
... ... @@ -30,7 +30,7 @@
30 30  
31 31  * true - if PUMOTIX is in standby mode.
32 32  
33 -===== **bool IsEStop ()** =====
33 +===== bool IsEStop () =====
34 34  
35 35  Checks if PUMOTIX is in EStop mode ("off" state of the power button).
36 36  
... ... @@ -38,31 +38,31 @@
38 38  
39 39  * true - if PUMOTIX is in EStop mode.
40 40  
41 -===== **void FloodEnable ()** =====
41 +===== void FloodEnable () =====
42 42  
43 43  Turn on the flood coolant.
44 44  
45 -===== **void FloodDisable ()** =====
45 +===== void FloodDisable () =====
46 46  
47 47  Turn off the flood coolant.
48 48  
49 -===== **void MistEnable ()** =====
49 +===== void MistEnable () =====
50 50  
51 51  Turn on spray coolant.
52 52  
53 -===== **void MistDisable ()** =====
53 +===== void MistDisable () =====
54 54  
55 55  Switch off the spray coolant.
56 56  
57 -===== **void Stop ()** =====
57 +===== void Stop () =====
58 58  
59 59  G-code execution stop.
60 60  
61 -===== **void EStop ()** =====
61 +===== void EStop () =====
62 62  
63 63  Emergency stop execution of the G-code and putting the system in Off mode.
64 64  
65 -===== **void Sleep (number milliseconds)** =====
65 +===== void Sleep (number milliseconds) =====
66 66  
67 67  Waiting for the specified number of milliseconds.
68 68  
... ... @@ -70,7 +70,7 @@
70 70  
71 71  * number milliseconds - the number of milliseconds during which the execution of the background macro will be suspended.
72 72  
73 -===== **void DisplayMessage (string message)** =====
73 +===== void DisplayMessage (string message) =====
74 74  
75 75  Display in the user interface of a message from a background macro.
76 76  
... ... @@ -78,7 +78,7 @@
78 78  
79 79  * string message - the text of the message that should be shown to the user.
80 80  
81 -===== **string Get_Message (number messageId)** =====
81 +===== string Get_Message (number messageId) =====
82 82  
83 83  Getting one of predefined localized text messages.
84 84  
... ... @@ -90,7 +90,7 @@
90 90  
91 91  * localized text message.
92 92  
93 -===== **bool IsRealDeviceConnected ()** =====
93 +===== bool IsRealDeviceConnected () =====
94 94  
95 95  Allows you to check device connection.
96 96  
... ... @@ -98,7 +98,7 @@
98 98  
99 99  * true – if a real device (not a simulator) is selected and connected.
100 100  
101 -===== **number GetExecutingMCode ()** =====
101 +===== number GetExecutingMCode () =====
102 102  
103 103  Getting an executing macro code. It returns -1 if no one macro is executed.
104 104  
... ... @@ -106,7 +106,7 @@
106 106  
107 107  * macro code.
108 108  
109 -===== **string str (number value)** =====
109 +===== string str (number value) =====
110 110  
111 111  Convert a real number to a string.
112 112  
... ... @@ -120,7 +120,7 @@
120 120  
121 121  * string representation of a given number.
122 122  
123 -===== **number GetSystemTickCount ()** =====
123 +===== number GetSystemTickCount () =====
124 124  
125 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.
126 126  
... ... @@ -128,7 +128,7 @@
128 128  
129 129  * the number of milliseconds since the operating system started.
130 130  
131 -===== **void SetUserVariable (number index, number value)** =====
131 +===== void SetUserVariable (number index, number value) =====
132 132  
133 133  Setting the value of a user variable. This value can be read when another macro is executed, including after restarting PUMOTIX.
134 134  
... ... @@ -137,7 +137,7 @@
137 137  * number index - variable number, integer from 0 to 99;
138 138  * number value - the value of the user variable (real number) that must be set.
139 139  
140 -===== **number GetUserVariable (number index)** =====
140 +===== number GetUserVariable (number index) =====
141 141  
142 142  Getting the value of a user variable.
143 143  
... ... @@ -149,7 +149,7 @@
149 149  
150 150  * current value of the user variable (real number).
151 151  
152 -===== **bool GetLedUserValue (number index)** =====
152 +===== bool GetLedUserValue (number index) =====
153 153  
154 154  Getting a value of user led (boolean).
155 155  
... ... @@ -161,7 +161,7 @@
161 161  
162 162  * bool - user variable value.
163 163  
164 -===== **void SetLedUserValue (number index, bool a_value)** =====
164 +===== void SetLedUserValue (number index, bool a_value) =====
165 165  
166 166  Setting a user variable value. This value can be read in another macro, including after PUMOTIX rebooting.
167 167  
... ... @@ -170,7 +170,7 @@
170 170  * number index – variable number, integer from 0 to 29;
171 171  * bool a_value – user variable value.
172 172  
173 -===== **number GetNumUserValue (number index)** =====
173 +===== number GetNumUserValue (number index) =====
174 174  
175 175  Getting a user number value (real).
176 176  
... ... @@ -182,7 +182,7 @@
182 182  
183 183  * number - user variable value.
184 184  
185 -===== **void SetNumUserValue (number index, number value)** =====
185 +===== void SetNumUserValue (number index, number value) =====
186 186  
187 187  Setting a user variable value. This value can be read in another macro, including after PUMOTIX rebooting.
188 188  
... ... @@ -191,7 +191,7 @@
191 191  * number index – variable number, integer from 0 to 29;
192 192  * number value – user variable value (real number) to set.
193 193  
194 -===== **string GetStrUserValue (number index)** =====
194 +===== string GetStrUserValue (number index) =====
195 195  
196 196  Getting a user string value.
197 197  
... ... @@ -203,7 +203,7 @@
203 203  
204 204  * string – user variable value.
205 205  
206 -===== **void SetStrUserValue (number index, string value)** =====
206 +===== void SetStrUserValue (number index, string value) =====
207 207  
208 208  Setting a user variable value. This value can be read in another macro, including after PUMOTIX rebooting.
209 209  
... ... @@ -212,11 +212,11 @@
212 212  * number index – variable number, integer from 0 to 29;
213 213  * string value – user variable value (string) to set.
214 214  
215 -===== **void RunGCode ()** =====
215 +===== void RunGCode () =====
216 216  
217 217  Start G-code running (similar to pressing the Start button).
218 218  
219 -===== **void RunMDI (string command)** =====
219 +===== void RunMDI (string command) =====
220 220  
221 221  Execute a given string of G-code. The function returns immediately after the call and execution of the background operation continues.
222 222  
... ... @@ -224,10 +224,10 @@
224 224  
225 225  * string command – G-code string to execute.
226 226  
227 -===== **void WeldOscillatorEnable ()** =====
227 +===== void WeldOscillatorEnable () =====
228 228  
229 229  Oscillator on.
230 230  
231 -===== **void WeldOscillatorDisable ()** =====
231 +===== void WeldOscillatorDisable () =====
232 232  
233 233  Oscilator off.