Изменения документа Функции для разработки фоновых макросов
Редактировал(а) writer 2022/11/01 17:24
Сводка
-
Свойства страницы (2 изменено, 0 добавлено, 0 удалено)
Подробности
- Свойства страницы
-
- Автор документа
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki.k morozov1 +XWiki.knetyaga - Содержимое
-
... ... @@ -1,37 +1,7 @@ 1 -=== boolPinGetState (number periphId)===1 +=== === 2 2 3 - Получениетекущего состояния входа или выхода.3 +{{children style="h4"/}} 4 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)||style="text-decoration: none;" rel="nofollow" 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)||style="text-decoration: none;" rel="nofollow" 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)||rel="nofollow" style="text-decoration: none;" 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 35 === bool IsGCodeRunning () === 36 36 37 37 Позволяет проверить, находится ли PUMOTIX в режиме выполнения G-кода. ... ... @@ -70,106 +70,8 @@ 70 70 71 71 Возвращаемое значение: 72 72 73 -* true – если PUMOTIX находится в режиме EStop ;43 +* true – если PUMOTIX находится в режиме EStop. 74 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 GetGCodeFeedrate () === 108 - 109 -Получение скорости перемещения, заданной в G-коде. 110 - 111 -Возвращаемое значение: 112 - 113 -* скорость перемещения, заданная в G-коде. 114 - 115 -=== number GetFeedrateOverridePercent () === 116 - 117 -Получение процента переопределения текущей скорости перемещения. 118 - 119 -Возвращаемое значение: 120 - 121 -* процент фактической скорости перемещения от заданной. 122 - 123 -=== void SetFeedrateOverridePercent (number value) === 124 - 125 -Задание процента переопределения текущей скорости перемещения. 126 - 127 -Параметры: 128 - 129 -* number value – желаемый процент переопределения текущей скорости перемещения. 130 - 131 -=== number GetRapidrateOverridePercent () === 132 - 133 -Получение процента переопределения текущей скорости холостых переездов. 134 - 135 -Возвращаемое значение: 136 - 137 -* процент фактической скорости холостых переездов от заданной. 138 - 139 -=== void SetRapidrateOverridePercent (number value) === 140 - 141 -Задание процента переопределения текущей скорости холостых переездов. 142 - 143 -Параметры: 144 - 145 -* number value – желаемый процент переопределения текущей скорости холостых переездов. 146 - 147 -=== bool IsAxisReferenced (number axisId) === 148 - 149 -Позволяет проверить, выполнен ли поиск базы по указанной оси. 150 - 151 -Параметры: 152 - 153 -* number axisId – номер оси, целое число от 0 до 8 (в качестве этого параметра может передаваться одна из констант, определённых в списке **[[Axis>>url:http://doc.pumotix.ru/pages/viewpage.action?pageId=5180766||style="text-decoration: none;" shape="rect"]]**). 154 - 155 -Возвращаемое значение: 156 - 157 -* true – если поиск базы выполнен: 158 -* false – если поиск базы не выполнен. 159 - 160 -=== bool IsAxesMaskReferenced (number axesMask) === 161 - 162 -Позволяет проверить, выполнен ли поиск базы для всех осей, заданных маской axesMask. 163 - 164 -Параметры: 165 - 166 -* number axesMask – маска осей, целое число, в котором биты от 0 до 8 обозначают, выбраны ли соответствующие оси. 167 - 168 -Возвращаемое значение: 169 - 170 -* true – если поиск базы выполнен; 171 -* false – если поиск базы не выполнен. 172 - 173 173 === number GetCurSpindleRPM () === 174 174 175 175 Получение текущей скорости вращения шпинделя. ... ... @@ -398,117 +398,157 @@ 398 398 399 399 * true – если выбрано реальное устройство (не симулятор) и подключение к нему установлено. 400 400 401 -=== number Get JogOverridePercent(void) ===273 +=== number GetExecutingMCode () === 402 402 403 - Получение процентапереопределениятекущейскорости ручныхперемещений.275 +Возвращает номер, выполняющегося макроса. Если макрос не запущен возвращает -1. 404 404 405 405 Возвращаемое значение: 406 406 407 -* процент переопределенияскорости ручных перемещений.279 +* номер макроса. 408 408 409 -=== voidSetJogOverridePercent(numbervalue) ===281 +=== bool GetLedUserValue (number index) === 410 410 411 - Установкапроцентапереопределениятекущейскоростиручныхперемещений.283 +Выводит значение пользовательской переменной. 412 412 413 413 Параметры: 414 414 415 -* number value –процентфактической скоростиперемещенияотзаданной.287 +* number index – номер переменной, целое число от 0 до 29. 416 416 417 - **double GetAnalogInput(number index)**289 +Возвращаемое значение: 418 418 419 - Получитьзначениеаналогового входа(от0 до1) в видевещественного числа.291 +* bool - значение пользовательской переменной. 420 420 293 +=== void SetLedUserValue (number index, bool a_value) === 294 + 295 +Установка значения пользовательской переменной. Данное значение может быть прочитано при выполнении другого макроса, в том числе после перезапуска PUMOTIX. 296 + 421 421 Параметры: 422 422 423 -* number index – номер аналогового входа (начиная с 0). 299 +* number index – номер переменной, целое число от 0 до 29; 300 +* bool a_value – значение пользовательской переменной. 424 424 425 - Возвращаемоезначение:302 +=== number GetNumUserValue (number index) === 426 426 427 - *значениеаналогового входа(от0 до1)304 +Выводит значения пользовательской переменной. 428 428 429 - === number GetExecutingMCode (void) ===306 +Параметры: 430 430 431 - Возвращаетномер,выполняющегосямакроса.308 +* number index – номер переменной, целое число от 0 до 29. 432 432 433 433 Возвращаемое значение: 434 434 435 -* н омермакроса.312 +* number - значение пользовательской переменной. 436 436 437 -=== bool GetLedUserValue (number index) ===314 +=== void SetNumUserValue (number index, number value) === 438 438 439 - Выводит значениепользовательской переменной.316 +Установка значения пользовательской переменной. Данное значение может быть прочитано при выполнении другого макроса, в том числе после перезапуска PUMOTIX. 440 440 441 441 Параметры: 442 442 443 -* number index – номер переменной, целое число от 0 до 29 320 +* number index – номер переменной, целое число от 0 до 29; 321 +* number value – значение пользовательской переменной (вещественное число), которое необходимо установить. 444 444 323 +=== string GetStrUserValue (number index) === 324 + 325 +Выводит значения пользовательской переменной. 326 + 327 +Параметры: 328 + 329 +* number index – номер переменной, целое число от 0 до 29. 330 + 445 445 Возвращаемое значение: 446 446 447 -* bool- значение пользовательской переменной.333 +* string- значение пользовательской переменной. 448 448 449 -=== boolGetLedUserValue (number index) ===335 +=== void SetNumUserValue (number index, string value) === 450 450 451 - Выводит значения пользовательской переменной.337 +Установка значения пользовательской переменной. Данное значение может быть прочитано при выполнении другого макроса, в том числе после перезапуска PUMOTIX. 452 452 453 453 Параметры: 454 454 455 455 * number index – номер переменной, целое число от 0 до 29; 342 +* string value - значение пользовательской переменной (строка), которое необходимо установить. 456 456 344 +=== string Get_Message (number messageId) === 345 + 346 +Получение одного из предопределённых локализованных текстовых сообщений. 347 + 348 +Параметры: 349 + 350 +* number messageId – идентификатор сообщения (в качестве этого параметра должна передаваться одна из констант, определённых в списке Messages). 351 + 457 457 Возвращаемое значение: 458 458 459 -* bool - значение пользовательскойпеременной.354 +* локализованное текстовое сообщение. 460 460 461 -=== void SetLedUserValue (number index,bool a_value) ===356 +=== void RunGCode () === 462 462 463 - Установка значенияпользовательскойпеременной. Данноезначениеможетбыть прочитанопривыполнении другогомакроса, втом числепослеперезапускаPUMOTIX.358 +Запуск выполнения G-кода (аналогично нажатию кнопки Старт). 464 464 360 +=== void RunMDI (string command) === 361 + 362 +Выполнение заданной строки G-кода. Функция сразу же после вызова возвращает управление и выполнение фонового макроса продолжается. 363 + 465 465 Параметры: 466 466 467 -* number index – номер переменной, целое число от 0 до 29;, 468 -* bool a_value – значение пользовательской переменной. 366 +* string command – строка G-кода, которая должна быть выполнена. 469 469 470 -=== doubleGetNumUserValue (numberindex) ===368 +=== bool UseOmichSensor () === 471 471 472 - Выводитзначенияпользовательскойпеременной.370 +Позволяет проверить, включено ли в настройках использование омического датчика PLL-R2. 473 473 474 - Параметры:372 +Возвращаемое значение: 475 475 476 -* numberindex–номерпеременной, целоечислот0до29;374 +* true – если использование омического датчика PLL-R2 включено. 477 477 376 +=== number GetOmichSensorDelta () === 377 + 378 +Получение заданного в настройках омического датчика значения поправки dZ. 379 + 478 478 Возвращаемое значение: 479 479 480 -* double -значение пользовательскойпеременной.382 +* значение поправки dZ, заданное в настройках омического датчика. 481 481 482 -=== void NumUserValue (numberindex, numbervalue) ===384 +=== void SetOmichSensorDelta (number value) === 483 483 484 -Установка льзовательскойпеременной. Данное значениеможетбытьпрочитано при выполнении другогомакроса, втомчисле после перезапускаPUMOTIX.386 +Установка значения поправки dZ для омического датчика. 485 485 486 486 Параметры: 487 487 488 -* number index – номер переменной, целое число от 0 до 29; 489 -* number value – значение пользовательской переменной (вещественное число), которое необходимо установить. 390 +* number value – значение поправки dZ для омического датчика. 490 490 491 -=== do ubleGetStrUserValue(numberindex) ===392 +=== number1, ... , numberN, bool ReadModbusMultipleRegistersUpdated (string name, number count) === 492 492 493 - Выводитзначенияпользовательскойпеременной.394 +Получение значений нескольких расположенных подряд Modbus-регистров без использования кеша. 494 494 495 495 Параметры: 496 496 497 -* number index – номер переменной, целое число от 0 до 29; 398 +* string name – имя регистра, настроенного в меню Настройка Modbus. 399 +* number count – количество запрашиваемых регистров. 498 498 499 -Возвращаем ое значение:401 +Возвращаемые значения: 500 500 501 -* double - значение пользовательской переменной. 403 +* value1, ... , valueN – значения Modbus-регистров. 404 +* is_online – логическое значение, определяющее, была ли попытка прочитать значения Modbus-регистров успешной. 502 502 503 -=== voidSetNumUserValue(numberindex, stringvalue) ===406 +=== bool WriteModbusMultipleRegisters (string name, number count, number value1, ... , number valueN) === 504 504 505 -Установка япользовательскойпеременной. Данное значение может бытьпрочитано при выполнениидругогомакроса, в том числе после перезапуска PUMOTIX.408 +Установка значений нескольких расположенных подряд Modbus-регистров. 506 506 507 507 Параметры: 508 508 509 -* number index – номер переменной, целое число от 0 до 29; 510 -* string value - значение пользовательской переменной (строка), которое необходимо установить. 412 +* string name – имя регистра, настроенного в меню Настройка Modbus. 413 +* number count – количество записываемых регистров. 414 +* number value1, ... , number valueN – значения регистров, которые необходимо установить (16-битные целые числа). 511 511 512 - \\416 +Возвращаемое значение: 513 513 514 -\\ 418 +* true - если установка значений Modbus-регистров выполнена успешно. 419 + 420 +=== void WeldOscillatorEnable () === 421 + 422 +Включение колебателя. 423 + 424 +=== void WeldOscillatorDisable () === 425 + 426 +Выключение колебателя.