LinuxCNC Documentation

СИНТАКСИС

halrmt [--port <port number>] [--name <server name>] [--connectpw <password>] [--enablepw <password>] [--sessions <max sessions>] [-ini <INI file>]

ВАРІАНТИ

--port port

Очікує на сокетні з’єднання (telnet) на вказаному сокеті, без вказівки порту використовується порт за замовчуванням 5006. (Примітка: linuxcncrsh використовує порт 5007 за замовчуванням.)

--name server_name

Встановлює ім’я сервера на вказане ім’я для Hello.

--connectpw password

Встановлює пароль підключення на «password». За замовчуванням: EMC.

--enablepw password

Встановлює пароль для ввімкнення на password. За замовчуванням EMCTOO.

--sessions <max sessions>

Встановлює максимальну кількість одночасних підключень на max sessions. За замовчуванням обмеження відсутнє (-1).

-ini <INI file>

Використовує вказаний INI-файл замість стандартного emc.ini.

ОПИС

Програма halrmt підтримує шість команд, які призначені для відправки до екземпляра HAL, що працює на іншому комп’ютері. З них команди set та get містять специфічні для HAL підкоманди, які базуються на командах, що підтримуються програмою halcmd.

Команди та більшість параметрів не чутливі до регістру. Винятки становлять паролі, шляхи до файлів та текстові рядки. Підтримувані команди такі:

Hello <password> <client> <version>

Якщо було введено правильний пароль, сервер відповість «HELLO ACK <Назва сервера> <Версія сервера>», де назва сервера та версія сервера визначаються з реалізації. Якщо пароль неправильний або є інші синтаксичні помилки, сервер відповість «HELLO NAK».

Отримати

Команда get містить одну з підкоманд HAL, описаних нижче, та нуль або більше додаткових параметрів.

Набір

Команда set містить одну з підкоманд HAL, описаних нижче, та один або декілька додаткових параметрів.

Вийти

Команда quit розриває пов’язане з’єднання сокета.

Вимкнення

Команда shutdown повідомляє LinuxCNC про необхідність завершення роботи перед розривом з’єднання. Ця команда може бути видана тільки в тому випадку, якщо Hello було успішно узгоджено і з’єднання має контроль над CNC (див. підкоманду enable нижче). Ця команда не має параметрів.

Допомога

Команда help поверне довідкову інформацію у текстовому форматі через telnet-з’єднання. Якщо параметри не вказані, вона перелічить доступні команди. Якщо вказано команду, вона надасть інформацію про використання вказаної команди. Довідка відповість незалежно від того, чи було успішно узгоджено "Hello".

HAL sub-commands:

луна ввімкнена | вимкнена

Команда get поверне поточний стан echo, а команда set встановить стан echo. Коли echo увімкнено, всі команди будуть відображатися після отримання. Цей стан є локальним для кожного з’єднання.

багатослівний увімкнено | вимкнено

Команда get поверне поточний стан деталізації, а команда set встановить стан деталізації. Коли режим деталізації увімкнено, всі команди set повертають позитивне підтвердження у формі SET <КОМАНДА> ACK. Крім того, у режимі деталізації видаються текстові повідомлення про помилки. Цей стан є локальним для кожного з’єднання.

увімкнути <пароль> | вимкнути

Команда get поверне значення On або Off, яке вказує, чи поточне з’єднання має доступ до функцій управління. Команда set та дійсний пароль надають поточному з’єднанню доступ до функцій управління. «OFF» не може бути використано як пароль і вимикає функції управління для цього з’єднання.

конфігурація [буде оголошено пізніше] comm_mode ascii | бінарний файл

Команда get поверне поточний режим зв’язку. Команда set встановить режим зв’язку на вказаний. Бінарний протокол буде визначено пізніше.

comm_prot <version no>

З get повертає поточну версію протоколу, що використовується сервером, з set налаштовує сервер на використання вказаної версії протоколу, за умови, що вона нижча або дорівнює найвищому номеру версії, що підтримується реалізацією сервера.

Компенсації [<substring>]

Тільки отримати, повертає всі компоненти, що починаються з вказаного підрядка. Якщо підрядок не вказаний, повертає всі компоненти.

Піни [<substring>]

Тільки отримання, повертає всю інформацію про всі контакти, починаючи з вказаного підрядка. Якщо підрядок не вказано, то повертає всі контакти.

PinVals [<substring>]

Тільки отримати, повертає лише інформацію про значення всіх контактів, що починаються із зазначеного підрядка. Якщо підрядок не вказано, повертає всі контакти.

Сигнали [<substring>]

Тільки отримання, повертає всю інформацію про всі сигнали, починаючи з вказаного підрядка. Якщо підрядок не вказаний, повертає всі сигнали.

SigVals [<substring>]

Тільки отримати, повертає лише інформацію про значення всіх сигналів, що починаються із зазначеного підрядка. Якщо підрядок не вказано, повертає всі виводи.

Параметри [<substring>]

Тільки отримання, повертає всю інформацію про всі параметри, починаючи з вказаного підрядка. Якщо підрядок не вказано, повертає всі параметри.

ParamVals [<substring>]

Тільки отримати, повертає лише інформацію про значення всіх параметрів, що починаються із зазначеного підрядка. Якщо підрядок не вказано, повертає всі параметри виводів.

Функції [<substring>]

Тільки отримання, повертає всю інформацію про всі функції, починаючи з вказаного підрядка. Якщо підрядок не вказано, то повертає всі функції.

Теми

Тільки отримання, повертає всю інформацію про всі функції.

Комп <name>

Тільки отримати, повертає компонент, що відповідає вказаному імені.

Закріпити <name>

Тільки отримати, повертає всю інформацію про PIN-код, що відповідає вказаній назві.

PinVal <name>

Тільки отримати, повертає значення виводу, що відповідає вказаній назві.

Скажи <name>

Тільки отримати, повертає всю інформацію про PIN-код, що відповідає вказаній назві.

SigVal <name>

Тільки отримати, повертає лише значення сигналу, що відповідає вказаній назві.

Параметр <name>

Тільки отримати, повертає всю інформацію про параметр, що відповідає вказаному імені.

ParamVal <name>

Тільки отримати, повертає лише значення параметра, що відповідає вказаному імені.

Функція <name>

Тільки отримати, повертає всю інформацію про параметр, що відповідає вказаному імені.

Нитка <name>

Тільки отримати, повертає всю інформацію про потік, що відповідає вказаному імені.

LoadRt <name>

Тільки встановити, завантажує виконуваний файл реального часу, вказаний за назвою.

Розвантажити <name>

Тільки встановлення, вивантажує виконуваний файл, вказаний за назвою.

LoadUsr <name>

Тільки встановлення, завантажує виконуваний файл користувача, вказаний за назвою.

Linkps <назва виводу> <назва сигналу>

Тільки встановлення, пов’язує вказаний контакт із вказаним сигналом.

Лівий <назва сигналу> <назва штифта>

Тільки встановлення, пов’язує вказаний сигнал із вказаним виводом.

Linkpp <назва піна 1> <назва піна 2>

Тільки налаштування, пов’язує контакт, визначений контактом 1, з контактом, визначеним контактом 2.

Мережа <список мереж>

Тільки встановити, об’єднує вказаний список мереж.

Від’єднати <назва піна 1> <назва піна 2>

Тільки встановлення, роз’єднує вказані контакти.

Замок

Розблокувати

NewSig <ім’я> <тип>

Тільки встановлення, створює сигнал, заданий іменем, та тип, заданий типом.

DelSig <name>

Тільки встановити, видаляє сигнал, вказаний за назвою.

SetP <ім’я> <значення>

Тільки встановити, встановлює параметр, заданий параметром name, на значення, задане параметром value.

SetS <ім’я> <значення>

Тільки встановити, встановлює сигнал, заданий параметром name, на значення, задане параметром value.

AddF <name> <thread> [<parameters>]

Тільки встановити, додає функцію, задану параметром name, до потоку, заданого параметром thread, з необов’язковими параметрами, заданими параметрами.

DelF <name>

Тільки встановлення, видаляє функцію, вказану за назвою.

Зберегти

Старт

Стій

ДИВІТЬСЯ ТАКОЖ

linuxcnc(1)

Набагато більше інформації про LinuxCNC та HAL доступно в посібниках користувача LinuxCNC та HAL, які можна знайти за адресою /usr/share/doc/LinuxCNC/.

ПОМИЛКИ

Невідомо, чи працює цей інтерфейс наразі.

АВТОР

Цю сторінку довідника написав Енді П’ю в рамках проєкту LinuxCNC.

ПОВІДОМЛЕННЯ ПРО ПОМИЛКИ

Повідомляйте про помилки за адресою https://github.com/LinuxCNC/linuxcnc/issues.

АВТОРСЬКЕ ПРАВО

Авторське право © 2020 Енді П’ю.

Це безкоштовне програмне забезпечення; дивіться вихідний код для умов копіювання. НЕМАЄ ЖОДНИХ гарантій; навіть щодо ТОВАРНОЇ ПРИДАТНОСТІ або ПРИДАТНОСТІ ДЛЯ ПЕВНОЇ МЕТИ.