Исходный код вики Функции для разработки фоновых макросов
Версия 2.1 от abolgov на 2019/08/01 13:54
Последние авторы
| author | version | line-number | content |
|---|---|---|---|
| 1 | === bool PinGetState (number periphId) === | ||
| 2 | |||
| 3 | Получение текущего состояния входа или выхода. | ||
| 4 | |||
| 5 | Параметры: | ||
| 6 | |||
| 7 | * number periphId – идентификатор входа или выхода (в качестве этого параметра должна передаваться одна из констант, определённых в списке **[[Inputs>>url:http://doc.pumotix.ru/pages/viewpage.action?pageId=5180768#id-%D0%92%D1%85%D0%BE%D0%B4%D1%8B%D0%B8%D0%B2%D1%8B%D1%85%D0%BE%D0%B4%D1%8B-Inputs(%D0%B8%D0%B4%D0%B5%D0%BD%D1%82%D0%B8%D1%84%D0%B8%D0%BA%D0%B0%D1%82%D0%BE%D1%80%D1%8B%D0%B2%D1%85%D0%BE%D0%B4%D0%BE%D0%B2)||rel="nofollow" style="text-decoration: none;" shape="rect"]]** или **[[Outputs>>url:http://doc.pumotix.ru/pages/viewpage.action?pageId=5180768#id-%D0%92%D1%85%D0%BE%D0%B4%D1%8B%D0%B8%D0%B2%D1%8B%D1%85%D0%BE%D0%B4%D1%8B-Outputs(%D0%B8%D0%B4%D0%B5%D0%BD%D1%82%D0%B8%D1%84%D0%B8%D0%BA%D0%B0%D1%82%D0%BE%D1%80%D1%8B%D0%B2%D1%8B%D1%85%D0%BE%D0%B4%D0%BE%D0%B2)||style="text-decoration: none;" rel="nofollow" shape="rect"]]**). | ||
| 8 | |||
| 9 | Возвращаемое значение: | ||
| 10 | |||
| 11 | * текущее состояние входа (выхода): true – активен, false – неактивен (если в настройках выходов установлен флажок «Инвертировать», активному выходу соответствует физический уровень сигнала 0, и наоборот). | ||
| 12 | |||
| 13 | === bool MotorPinGetState (number motorId, number motorPeriphId) === | ||
| 14 | |||
| 15 | Получение текущего состояния входа или выхода, назначенного для двигателя. | ||
| 16 | |||
| 17 | Параметры: | ||
| 18 | |||
| 19 | * number motorId – номер двигателя, начиная с 0, в порядке назначения двигателей в списке //[[«Параметры двигателей»>>url:http://doc.pumotix.ru/pages/viewpage.action?pageId=5180816||style="text-decoration: none;" shape="rect"]]//; | ||
| 20 | * number motorPeriphId – идентификатор входа или выхода для указанного двигателя (в качестве этого параметра должна передаваться одна из констант, определённых в списке **[[MotorInputs>>url:http://doc.pumotix.ru/pages/viewpage.action?pageId=5180768#id-%D0%92%D1%85%D0%BE%D0%B4%D1%8B%D0%B8%D0%B2%D1%8B%D1%85%D0%BE%D0%B4%D1%8B-MotorInputs(%D0%B8%D0%B4%D0%B5%D0%BD%D1%82%D0%B8%D1%84%D0%B8%D0%BA%D0%B0%D1%82%D0%BE%D1%80%D1%8B%D0%B2%D1%85%D0%BE%D0%B4%D0%BE%D0%B2%D0%B4%D0%B2%D0%B8%D0%B3%D0%B0%D1%82%D0%B5%D0%BB%D0%B5%D0%B9)||rel="nofollow" style="text-decoration: none;" shape="rect"]]** или **[[MotorOutputs>>url:http://doc.pumotix.ru/pages/viewpage.action?pageId=5180768#id-%D0%92%D1%85%D0%BE%D0%B4%D1%8B%D0%B8%D0%B2%D1%8B%D1%85%D0%BE%D0%B4%D1%8B-MotorOutputs(%D0%B8%D0%B4%D0%B5%D0%BD%D1%82%D0%B8%D1%84%D0%B8%D0%BA%D0%B0%D1%82%D0%BE%D1%80%D1%8B%D0%B2%D1%8B%D1%85%D0%BE%D0%B4%D0%BE%D0%B2%D0%B4%D0%B2%D0%B8%D0%B3%D0%B0%D1%82%D0%B5%D0%BB%D0%B5%D0%B9)||style="text-decoration: none;" rel="nofollow" shape="rect"]]**). | ||
| 21 | |||
| 22 | Возвращаемое значение: | ||
| 23 | |||
| 24 | * текущее состояние входа (выхода) двигателя: true – активен, false – неактивен (если в настройках выходов установлен флажок «Инвертировать», активному выходу соответствует физический уровень сигнала 0, и наоборот). | ||
| 25 | |||
| 26 | === void PinSetState (number periphId, bool state) === | ||
| 27 | |||
| 28 | Установка состояния выхода. | ||
| 29 | |||
| 30 | Параметры: | ||
| 31 | |||
| 32 | * number periphId – идентификатор выхода (в качестве этого параметра должна передаваться одна из констант, определённых в списке **[[Outputs>>url:http://doc.pumotix.ru/pages/viewpage.action?pageId=5180768#id-%D0%92%D1%85%D0%BE%D0%B4%D1%8B%D0%B8%D0%B2%D1%8B%D1%85%D0%BE%D0%B4%D1%8B-Outputs(%D0%B8%D0%B4%D0%B5%D0%BD%D1%82%D0%B8%D1%84%D0%B8%D0%BA%D0%B0%D1%82%D0%BE%D1%80%D1%8B%D0%B2%D1%8B%D1%85%D0%BE%D0%B4%D0%BE%D0%B2)||style="text-decoration: none;" rel="nofollow" shape="rect"]]**); | ||
| 33 | * bool state – состояние выхода, которое необходимо установить: true – активен, false – неактивен (если в настройках выходов установлен флажок «Инвертировать», активному выходу соответствует физический уровень сигнала 0, и наоборот). | ||
| 34 | |||
| 35 | === bool IsGCodeRunning () === | ||
| 36 | |||
| 37 | Позволяет проверить, находится ли PUMOTIX в режиме выполнения G-кода. | ||
| 38 | |||
| 39 | Возвращаемое значение: | ||
| 40 | |||
| 41 | * true – если PUMOTIX находится в режиме выполнения G-кода; | ||
| 42 | |||
| 43 | === bool IsMDIRunning () === | ||
| 44 | |||
| 45 | Позволяет проверить, находится ли PUMOTIX в режиме выполнения команды ручного ввода. | ||
| 46 | |||
| 47 | Возвращаемое значение: | ||
| 48 | |||
| 49 | * true – если PUMOTIX находится в режиме выполнения команды ручного ввода; | ||
| 50 | |||
| 51 | === bool IsRunning () === | ||
| 52 | |||
| 53 | Позволяет проверить, находится ли PUMOTIX в режиме выполнения G-кода или команды ручного ввода. | ||
| 54 | |||
| 55 | Возвращаемое значение: | ||
| 56 | |||
| 57 | * true – если активен любой из двух режимов IsGCodeRunning() или IsMDIRunning(); | ||
| 58 | |||
| 59 | === bool IsIdle () === | ||
| 60 | |||
| 61 | Позволяет проверить, находится ли PUMOTIX в режиме ожидания (состояние Вкл кнопки включения). | ||
| 62 | |||
| 63 | Возвращаемое значение: | ||
| 64 | |||
| 65 | * true – если PUMOTIX находится в режиме ожидания; | ||
| 66 | |||
| 67 | === bool IsEStop () === | ||
| 68 | |||
| 69 | Позволяет проверить, находится ли PUMOTIX в режиме EStop (состояние Выкл кнопки включения). | ||
| 70 | |||
| 71 | Возвращаемое значение: | ||
| 72 | |||
| 73 | * true – если PUMOTIX находится в режиме EStop; | ||
| 74 | |||
| 75 | === number AxisGetPos (number axisId) === | ||
| 76 | |||
| 77 | Получение текущей рабочей координаты указанной оси. | ||
| 78 | |||
| 79 | Параметры: | ||
| 80 | |||
| 81 | * number axisId – номер оси, целое число от 0 до 8 (в качестве этого параметра может передаваться одна из констант, определённых в списке **[[Axis>>url:http://doc.pumotix.ru/pages/viewpage.action?pageId=5180766#id-%D0%A3%D0%BF%D1%80%D0%B0%D0%B2%D0%BB%D0%B5%D0%BD%D0%B8%D0%B5%D0%BE%D1%81%D1%8F%D0%BC%D0%B8-Axis(%D0%B8%D0%B4%D0%B5%D0%BD%D1%82%D0%B8%D1%84%D0%B8%D0%BA%D0%B0%D1%82%D0%BE%D1%80%D1%8B%D0%BE%D1%81%D0%B5%D0%B9)||style="text-decoration: none;" rel="nofollow" shape="rect"]]**). | ||
| 82 | |||
| 83 | Возвращаемое значение: | ||
| 84 | |||
| 85 | * значение текущей рабочей координаты указанной оси. | ||
| 86 | |||
| 87 | === number AxisGetMachinePos (number axisId) === | ||
| 88 | |||
| 89 | Получение текущей машинной координаты указанной оси. | ||
| 90 | |||
| 91 | Параметры: | ||
| 92 | |||
| 93 | * number axisId – номер оси, целое число от 0 до 8 (в качестве этого параметра может передаваться одна из констант, определённых в списке **[[Axis>>url:http://doc.pumotix.ru/pages/viewpage.action?pageId=5180766#id-%D0%A3%D0%BF%D1%80%D0%B0%D0%B2%D0%BB%D0%B5%D0%BD%D0%B8%D0%B5%D0%BE%D1%81%D1%8F%D0%BC%D0%B8-Axis(%D0%B8%D0%B4%D0%B5%D0%BD%D1%82%D0%B8%D1%84%D0%B8%D0%BA%D0%B0%D1%82%D0%BE%D1%80%D1%8B%D0%BE%D1%81%D0%B5%D0%B9)||rel="nofollow" style="text-decoration: none;" shape="rect"]]**). | ||
| 94 | |||
| 95 | Возвращаемое значение: | ||
| 96 | |||
| 97 | * значение текущей машинной координаты указанной оси. | ||
| 98 | |||
| 99 | === number GetCurFeedrate () === | ||
| 100 | |||
| 101 | Получение текущей скорости перемещения. | ||
| 102 | |||
| 103 | Возвращаемое значение: | ||
| 104 | |||
| 105 | * модуль вектора скорости перемещения в пространстве XYZ. | ||
| 106 | |||
| 107 | === number GetFeedrateOverridePercent () === | ||
| 108 | |||
| 109 | Получение процента переопределения текущей скорости перемещения. | ||
| 110 | |||
| 111 | Возвращаемое значение: | ||
| 112 | |||
| 113 | * процент фактической скорости перемещения от заданной. | ||
| 114 | |||
| 115 | === void SetFeedrateOverridePercent (number value) === | ||
| 116 | |||
| 117 | Задание процента переопределения текущей скорости перемещения. | ||
| 118 | |||
| 119 | Параметры: | ||
| 120 | |||
| 121 | * number value – желаемый процент переопределения текущей скорости перемещения. | ||
| 122 | |||
| 123 | === number GetRapidrateOverridePercent () === | ||
| 124 | |||
| 125 | Получение процента переопределения текущей скорости холостых переездов. | ||
| 126 | |||
| 127 | Возвращаемое значение: | ||
| 128 | |||
| 129 | * процент фактической скорости холостых переездов от заданной. | ||
| 130 | |||
| 131 | === void SetRapidrateOverridePercent (number value) === | ||
| 132 | |||
| 133 | Задание процента переопределения текущей скорости холостых переездов. | ||
| 134 | |||
| 135 | Параметры: | ||
| 136 | |||
| 137 | * number value – желаемый процент переопределения текущей скорости холостых переездов. | ||
| 138 | |||
| 139 | === bool IsAxisReferenced (number axisId) === | ||
| 140 | |||
| 141 | Позволяет проверить, выполнен ли поиск базы по указанной оси. | ||
| 142 | |||
| 143 | Параметры: | ||
| 144 | |||
| 145 | * number axisId – номер оси, целое число от 0 до 8 (в качестве этого параметра может передаваться одна из констант, определённых в списке **[[Axis>>url:http://doc.pumotix.ru/pages/viewpage.action?pageId=5180766||style="text-decoration: none;" shape="rect"]]**). | ||
| 146 | |||
| 147 | Возвращаемое значение: | ||
| 148 | |||
| 149 | * true – если поиск базы выполнен: | ||
| 150 | * false – если поиск базы не выполнен. | ||
| 151 | |||
| 152 | === bool IsAxesMaskReferenced (number axesMask) === | ||
| 153 | |||
| 154 | Позволяет проверить, выполнен ли поиск базы для всех осей, заданных маской axesMask. | ||
| 155 | |||
| 156 | Параметры: | ||
| 157 | |||
| 158 | * number axesMask – маска осей, целое число, в котором биты от 0 до 8 обозначают, выбраны ли соответствующие оси. | ||
| 159 | |||
| 160 | Возвращаемое значение: | ||
| 161 | |||
| 162 | * true – если поиск базы выполнен; | ||
| 163 | * false – если поиск базы не выполнен. | ||
| 164 | |||
| 165 | === number GetCurSpindleRPM () === | ||
| 166 | |||
| 167 | Получение текущей скорости вращения шпинделя. | ||
| 168 | |||
| 169 | Возвращаемое значение: | ||
| 170 | |||
| 171 | * текущая скорость вращения шпинделя, об/мин. | ||
| 172 | |||
| 173 | === number GetSpindleSpeedOverridePercent () === | ||
| 174 | |||
| 175 | Получение процента переопределения текущей скорости вращения шпинделя. | ||
| 176 | |||
| 177 | Возвращаемое значение: | ||
| 178 | |||
| 179 | * процент, который фактическая скорость вращения шпинделя составляет от заданной. | ||
| 180 | |||
| 181 | === void SetSpindleSpeedOverridePercent (number value) === | ||
| 182 | |||
| 183 | Задание процента переопределения текущей скорости вращения шпинделя. | ||
| 184 | |||
| 185 | Параметры: | ||
| 186 | |||
| 187 | * number value – желаемый процент переопределения текущей скорости вращения шпинделя. | ||
| 188 | |||
| 189 | === void FloodEnable () === | ||
| 190 | |||
| 191 | Включение подачи охлаждающей жидкости поливом. | ||
| 192 | |||
| 193 | === void FloodDisable () === | ||
| 194 | |||
| 195 | Выключение подачи охлаждающей жидкости поливом. | ||
| 196 | |||
| 197 | === void MistEnable () === | ||
| 198 | |||
| 199 | Включение подачи охлаждающей жидкости распылением. | ||
| 200 | |||
| 201 | === void MistDisable () === | ||
| 202 | |||
| 203 | Выключение подачи охлаждающей жидкости распылением. | ||
| 204 | |||
| 205 | === void Sleep (number milliseconds) === | ||
| 206 | |||
| 207 | Ожидание в течение указанного количества миллисекунд. | ||
| 208 | |||
| 209 | Параметры: | ||
| 210 | |||
| 211 | * number milliseconds – количество миллисекунд, в течение которых выполнение фонового макроса будет приостановлено. | ||
| 212 | |||
| 213 | === void DisplayMessage (string message) === | ||
| 214 | |||
| 215 | Отображение в пользовательском интерфейсе сообщения от фонового макроса. | ||
| 216 | |||
| 217 | Параметры: | ||
| 218 | |||
| 219 | * string message – текст сообщения, которое должно быть показано пользователю. | ||
| 220 | |||
| 221 | === void Stop () === | ||
| 222 | |||
| 223 | Остановка выполнения G-кода. | ||
| 224 | |||
| 225 | === void EStop () === | ||
| 226 | |||
| 227 | Экстренная остановка выполнения G-кода и перевод системы в режим Выкл. | ||
| 228 | |||
| 229 | === void SetUserVariable (number index, number value) === | ||
| 230 | |||
| 231 | Установка значения пользовательской переменной. Данное значение может быть прочитано при выполнении другого макроса, в том числе после перезапуска PUMOTIX. | ||
| 232 | |||
| 233 | Параметры: | ||
| 234 | |||
| 235 | * number index – номер переменной, целое число от 0 до 99; | ||
| 236 | * number value – значение пользовательской переменной (вещественное число), которое необходимо установить. | ||
| 237 | |||
| 238 | === number GetUserVariable (number index) === | ||
| 239 | |||
| 240 | Получение значения пользовательской переменной. | ||
| 241 | |||
| 242 | Параметры: | ||
| 243 | |||
| 244 | * number index – номер переменной, целое число от 0 до 99. | ||
| 245 | |||
| 246 | Возвращаемое значение: | ||
| 247 | |||
| 248 | * текущее значение пользовательской переменной (вещественное число). | ||
| 249 | |||
| 250 | === string str (number value) === | ||
| 251 | |||
| 252 | Преобразование вещественного числа в строку. | ||
| 253 | |||
| 254 | Язык Lua поддерживает неявное преобразование числа в строку, но по умолчанию для очень маленького вещественного числа результат преобразования может иметь экспоненциальный формат, что не позволяет использовать строку как часть строки G-кода. Для удобства можно использовать функцию str, которая гарантирует, что число будет иметь десятичное представление. | ||
| 255 | |||
| 256 | Параметры: | ||
| 257 | |||
| 258 | * number value – вещественное число, которое необходимо преобразовать. | ||
| 259 | |||
| 260 | Возвращаемое значение: | ||
| 261 | |||
| 262 | * строковое представление заданного числа. | ||
| 263 | |||
| 264 | === number GetSystemTickCount () === | ||
| 265 | |||
| 266 | Получение количества миллисекунд, прошедшего с момента запуска операционной системы. Может использоваться для замера интервалов времени. Для получения текущих календарных даты и времени в UnixTime необходимо использовать стандартную функцию Lua (% style="color: rgb(36,39,41);" %)**os.time()**. | ||
| 267 | |||
| 268 | Возвращаемое значение: | ||
| 269 | |||
| 270 | * количество миллисекунд, прошедшее с момента запуска операционной системы. | ||
| 271 | |||
| 272 | === bool Is_THC_Mode () === | ||
| 273 | |||
| 274 | Позволяет проверить, находится ли PUMOTIX в режиме плазменной резки. | ||
| 275 | |||
| 276 | Возвращаемое значение: | ||
| 277 | |||
| 278 | * true – если PUMOTIX находится в режиме плазменной резки; | ||
| 279 | * false – если активен другой режим. | ||
| 280 | |||
| 281 | === number GetCurrentVoltage () === | ||
| 282 | |||
| 283 | Получение текущего значения напряжения в режиме плазменной резки. | ||
| 284 | |||
| 285 | Возвращаемое значение: | ||
| 286 | |||
| 287 | * текущее напряжение, В. | ||
| 288 | |||
| 289 | === number GetDesiredVoltage () === | ||
| 290 | |||
| 291 | Получение установленного значения желаемого напряжения в режиме плазменной резки. | ||
| 292 | |||
| 293 | Возвращаемое значение: | ||
| 294 | |||
| 295 | * желаемое напряжение, В. | ||
| 296 | |||
| 297 | === void SetDesiredVoltage (number value) === | ||
| 298 | |||
| 299 | Установка значения желаемого напряжения в режиме плазменной резки. | ||
| 300 | |||
| 301 | Параметры: | ||
| 302 | |||
| 303 | * number value – желаемое напряжение, В. | ||
| 304 | |||
| 305 | === bool Is_Oxy_Mode () === | ||
| 306 | |||
| 307 | Позволяет проверить, находится ли PUMOTIX в режиме газовой резки. | ||
| 308 | |||
| 309 | Возвращаемое значение: | ||
| 310 | |||
| 311 | * true – если PUMOTIX находится в режиме газовой резки; | ||
| 312 | * false – если активен другой режим. | ||
| 313 | |||
| 314 | \\ | ||
| 315 | |||
| 316 | \\ |