Функции для разработки фоновых макросов

1

=== bool PinGetState (number periphId) ===

2

3

Получение текущего состояния входа или выхода.

Параметры:

* 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

Получение текущего состояния входа или выхода, назначенного для двигателя.

Параметры:

* 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)||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

Установка состояния выхода.

Параметры:

* 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

Получение текущей рабочей координаты указанной оси.

Параметры:

* 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

Получение текущей машинной координаты указанной оси.

Параметры:

* 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

Задание процента переопределения текущей скорости перемещения.

Параметры:

* number value – желаемый процент переопределения текущей скорости перемещения.

130

131

=== number GetRapidrateOverridePercent () ===

132

133

Получение процента переопределения текущей скорости холостых переездов.

134

135

Возвращаемое значение:

136

137

* процент фактической скорости холостых переездов от заданной.

138

139

=== void SetRapidrateOverridePercent (number value) ===

140

141

Задание процента переопределения текущей скорости холостых переездов.

Параметры:

* number value – желаемый процент переопределения текущей скорости холостых переездов.

146

147

=== bool IsAxisReferenced (number axisId) ===

148

149

Позволяет проверить, выполнен ли поиск базы по указанной оси.

Параметры:

* 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.

Параметры:

* number axesMask – маска осей, целое число, в котором биты от 0 до 8 обозначают, выбраны ли соответствующие оси.

167

168

Возвращаемое значение:

169

170

* true – если поиск базы выполнен;

171

* false – если поиск базы не выполнен.

172

173

=== number GetCurSpindleRPM () ===

174

175

Получение текущей скорости вращения шпинделя.

176

177

Возвращаемое значение:

178

179

* текущая скорость вращения шпинделя, об/мин.

180

181

=== number GetGCodeSpindleRPM () ===

182

183

Получение скорости вращения шпинделя, заданной в G-коде.

184

185

Возвращаемое значение:

186

187

* Скорость вращения шпинделя, заданная в G-коде, об/мин.

188

189

=== number GetSpindleSpeedOverridePercent () ===

190

191

Получение процента переопределения текущей скорости вращения шпинделя.

192

193

Возвращаемое значение:

194

195

* процент, который фактическая скорость вращения шпинделя составляет от заданной.

196

197

=== void SetSpindleSpeedOverridePercent (number value) ===

198

199

Задание процента переопределения текущей скорости вращения шпинделя.

Параметры:

* number value – желаемый процент переопределения текущей скорости вращения шпинделя.

204

205

=== void FloodEnable () ===

206

207

Включение подачи охлаждающей жидкости поливом.

208

209

=== void FloodDisable () ===

210

211

Выключение подачи охлаждающей жидкости поливом.

212

213

=== void MistEnable () ===

214

215

Включение подачи охлаждающей жидкости распылением.

216

217

=== void MistDisable () ===

218

219

Выключение подачи охлаждающей жидкости распылением.

220

221

=== void Sleep (number milliseconds) ===

222

223

Ожидание в течение указанного количества миллисекунд.

Параметры:

* number milliseconds – количество миллисекунд, в течение которых выполнение фонового макроса будет приостановлено.

228

229

=== void DisplayMessage (string message) ===

230

231

Отображение в пользовательском интерфейсе сообщения от фонового макроса. Для корректного отображения символов национальных алфавитов файл макроса должен быть сохранён в кодировке UTF-8.

Параметры:

* string message – текст сообщения, которое должно быть показано пользователю.

=== void Stop () ===

Остановка выполнения G-кода.

240

241

=== void EStop () ===

242

243

Экстренная остановка выполнения G-кода и перевод системы в режим Выкл.

244

245

=== void SetUserVariable (number index, number value) ===

246

247

Установка значения пользовательской переменной. Данное значение может быть прочитано при выполнении другого макроса, в том числе после перезапуска PUMOTIX.

Параметры:

* number index – номер переменной, целое число от 0 до 99;

252

* number value – значение пользовательской переменной (вещественное число), которое необходимо установить.

253

254

=== number GetUserVariable (number index) ===

255

256

Получение значения пользовательской переменной.

Параметры:

* number index – номер переменной, целое число от 0 до 99.

261

262

Возвращаемое значение:

263

264

* текущее значение пользовательской переменной (вещественное число).

265

266

=== string str (number value) ===

267

268

Преобразование вещественного числа в строку.

269

270

Язык Lua поддерживает неявное преобразование числа в строку, но по умолчанию для очень маленького вещественного числа результат преобразования может иметь экспоненциальный формат, что не позволяет использовать строку как часть строки G-кода. Для удобства можно использовать функцию str, которая гарантирует, что число будет иметь десятичное представление.

Параметры:

* number value – вещественное число, которое необходимо преобразовать.

275

276

Возвращаемое значение:

277

278

* строковое представление заданного числа.

279

280

=== number GetSystemTickCount () ===

281

282

Получение количества миллисекунд, прошедшего с момента запуска операционной системы. Может использоваться для замера интервалов времени. Для получения текущих календарных даты и времени в UnixTime необходимо использовать стандартную функцию Lua (% style="color: rgb(36,39,41);" %)**os.time()**.

283

284

Возвращаемое значение:

285

286

* количество миллисекунд, прошедшее с момента запуска операционной системы.

287

288

=== bool Is_THC_Mode () ===

289

290

Позволяет проверить, находится ли PUMOTIX в режиме плазменной резки.

291

292

Возвращаемое значение:

293

294

* true – если PUMOTIX находится в режиме плазменной резки;

295

* false – если активен другой режим.

296

297

=== number GetCurrentVoltage () ===

298

299

Получение текущего значения напряжения в режиме плазменной резки.

300

301

Возвращаемое значение:

302

303

* текущее напряжение, В.

304

305

=== number GetDesiredVoltage () ===

306

307

Получение установленного значения желаемого напряжения в режиме плазменной резки.

308

309

Возвращаемое значение:

310

311

* желаемое напряжение, В.

312

313

=== void SetDesiredVoltage (number value) ===

314

315

Установка значения желаемого напряжения в режиме плазменной резки.

Параметры:

* number value – желаемое напряжение, В.

320

321

=== bool GetThcTorchOn () ===

322

323

Позволяет проверить, включен ли факел в режиме плазменной резки.

324

325

Возвращаемое значение:

326

327

* true – если факел в режиме плазменной резки включен;

328

329

=== bool Is_Oxy_Mode () ===

330

331

Позволяет проверить, находится ли PUMOTIX в режиме газовой резки.

332

333

Возвращаемое значение:

334

335

* true – если PUMOTIX находится в режиме газовой резки;

336

* false – если активен другой режим.

337

338

=== bool GetOxyCuttingOn () ===

339

340

Позволяет проверить, включен ли режущий факел в режиме газовой резки.

341

342

Возвращаемое значение:

343

344

* true – если режущий факел в режиме газовой резки включен.

345

346

=== bool GetOxyPreheatOn () ===

347

348

Позволяет проверить, включен ли прогрев в режиме газовой резки.

349

350

Возвращаемое значение:

351

352

* true – если прогрев в режиме газовой резки включен.

353

354

=== number, bool ReadModbusRegister (string name) ===

355

356

Получение значения Modbus-регистра.

Параметры:

* string name – имя регистра, настроенного в меню Настройка Modbus.

361

362

Возвращаемые значения:

363

364

* value - значение Modbus-регистра. Возвращает последнее успешно прочитанное значение из кеша, обновляющегося с интервалом 100 мс (периодичность обновления может изменяться в зависимости от определённых условий). Если значение ни разу не было успешно прочитано, возвращается 0.

365

* is_online - логическое значение, определяющее, была ли последняя попытка прочитать значение Modbus-регистра успешной.

366

367

=== number, bool ReadModbusRegisterUpdated (string name) ===

368

369

Получение значения Modbus-регистра без использования кеша. Значение регистра запрашивается каждый раз при вызове команды.

Параметры:

* string name – имя регистра, настроенного в меню Настройка Modbus.

374

375

Возвращаемые значения:

376

377

* value - значение Modbus-регистра.

378

* is_online - логическое значение, определяющее, была ли последняя попытка прочитать значение Modbus-регистра успешной.

379

380

=== bool WriteModbusRegister (string name, number value) ===

381

382

Установка значения Modbus-регистра.

Параметры:

* string name – имя регистра, настроенного в меню Настройка Modbus.

387

* number value - значение регистра, которое необходимо установить (16-битное целое число).

388

389

Возвращаемое значение:

390

391

* true - если установка значения Modbus-регистра выполнена успешно.

392

393

=== bool IsRealDeviceConnected () ===

394

395

Позволяет проверить, установлено ли подключение к контроллеру.

396

397

Возвращаемое значение:

398

399

* true – если выбрано реальное устройство (не симулятор) и подключение к нему установлено.

400

401

=== number GetJogOverridePercent (void) ===

402

403

Получение процента переопределения текущей скорости ручных перемещений.

404

405

Возвращаемое значение:

406

407

* процент переопределения скорости ручных перемещений.

408

409

=== void SetJogOverridePercent (number value) ===

410

411

Установка процента переопределения текущей скорости ручных перемещений.

Параметры:

* number value – процент фактической скорости перемещения от заданной.

416

417

=== double GetAnalogInput (number index) ===

418

419

Получить значение аналогового входа (от 0 до 1) в виде вещественного числа.

Параметры:

* number index – номер аналогового входа (начиная с 0).

424

425

Возвращаемое значение:

426

427

* значение аналогового входа (от 0 до 1)

428

429

=== number GetExecutingMCode () ===

430

431

Возвращает номер, выполняющегося макроса. Если макрос не запущен возвращает -1.

432

433

Возвращаемое значение:

* номер макроса.

=== bool GetLedUserValue (number index) ===

438

439

Выводит значение пользовательской переменной.

Параметры:

* number index – номер переменной, целое число от 0 до 29.

444

445

Возвращаемое значение:

446

447

* bool - значение пользовательской переменной.

448

449

=== void SetLedUserValue (number index, bool a_value) ===

450

451

Установка значения пользовательской переменной. Данное значение может быть прочитано при выполнении другого макроса, в том числе после перезапуска PUMOTIX.

Параметры:

* number index – номер переменной, целое число от 0 до 29;,

456

* bool a_value – значение пользовательской переменной.

457

458

=== number GetNumUserValue (number index) ===

459

460

Выводит значения пользовательской переменной.

Параметры:

* number index – номер переменной, целое число от 0 до 29.

465

466

Возвращаемое значение:

467

468

* number - значение пользовательской переменной.

469

470

=== void SetNumUserValue (number index, number value) ===

471

472

Установка значения пользовательской переменной. Данное значение может быть прочитано при выполнении другого макроса, в том числе после перезапуска PUMOTIX.

Параметры:

* number index – номер переменной, целое число от 0 до 29;

477

* number value – значение пользовательской переменной (вещественное число), которое необходимо установить.

478

479

=== string GetStrUserValue (number index) ===

480

481

Выводит значения пользовательской переменной.

Параметры:

* number index – номер переменной, целое число от 0 до 29.

486

487

Возвращаемое значение:

488

489

* string- значение пользовательской переменной.

490

491

=== void SetNumUserValue (number index, string value) ===

492

493

Установка значения пользовательской переменной. Данное значение может быть прочитано при выполнении другого макроса, в том числе после перезапуска PUMOTIX.

Параметры:

* number index – номер переменной, целое число от 0 до 29;

498

* string value - значение пользовательской переменной (строка), которое необходимо установить.

Исходный код вики Функции для разработки фоновых макросов

Page Tree