halcmd(1) Manual Page

Перш ніж розбирати середовище реального часу, запустіть інтерактивну команду halcmd. Тільки halrun. Якщо використовується -I, він має передувати всім іншим аргументам командного рядка.

Ігнорувати команди в командному рядку, натомість отримувати вхідні дані з file. Якщо file не вказано, отримувати вхідні дані з stdin.

Використовуйте змінні з вказаного INI-файлу для підстановок. Див. ПІДСТАВКА нижче.

Продовжувати після невдалої команди (команд). За замовчуванням виконується зупинка та повернення повідомлення про невдачу, якщо будь-яка команда завершується невдачею.

відображати лише помилки (за замовчуванням)

нічого не відображати, виконувати команди безшумно

Режим, зручний для скриптів. У цьому режимі show не виводитиме назви для показаних елементів. Також у списках pin, param та funct замість ідентифікаційних кодів будуть друкуватися назви модулів. Потоки друкуються в одному рядку, спочатку вказуючи період потоку, використання FP та назву, а потім усі функції в потоці в порядку виконання. Сигнали друкуються в одному рядку, спочатку вказуючи тип, значення та ім’я сигналу, а потім список контактів, підключених до сигналу, із зазначенням напрямку та імені контакту.

Звільнити м’ютекс HAL. Це корисно для відновлення після збою компонента HAL під час утримання м’ютексу HAL.

відображати результати кожної команди

відображати багато сміття для налагодження

відобразити екран довідки та вийти, відображає розширену довідку для command, якщо вказано

(скорочення від "load realtime module") Завантажує HAL-модуль реального часу під назвою modname. halcmd шукає модуль у каталозі, вказаному під час компіляції.

(Модуль unload realtime) Вивантажує модуль HAL реального часу з назвою modname. Якщо modname дорівнює «all», вивантажуються всі завантажені на даний момент модулі HAL реального часу. unloadrt також працює шляхом виконання linuxcnc_module_helper або rtapi_app, так само як і loadrt.

(load Userspace component) Executes the given UNIX-command, usually to load a non-realtime component. [flags] may be one or more of:

(wait для компонента Userspace) Чекає, поки компонент, що не працює в режимі реального часу, name від’єднається від HAL (зазвичай при виході). Компонент повинен бути вже завантажений. Корисно використовувати в кінці файлу HAL, щоб почекати, поки користувач закриє деякі компоненти інтерфейсу користувача, перш ніж приступити до очищення та виходу.

(компонент Userspace) Вивантажує компонент, що не працює в реальному часі, під назвою compname. Якщо compname має значення "all", він вивантажить усі компоненти, що не працюють в реальному часі. unloadusr працює шляхом надсилання SIGTERM усім компонентам, що не працюють в реальному часі.

Вивантажує компонент або модуль реального часу, що не працюють у реальному часі. Якщо compname має значення "all", буде вивантажено всі компоненти та модулі реального часу, що не працюють у реальному часі.

(ЗАСТАРІЛЕ - замість цього використовуйте net) (new signal) Створює новий сигнал HAL під назвою signame, який згодом може бути використаний для з’єднання двох або більше контактів компонентів HAL. type - це тип даних нового сигналу, який повинен бути одним із таких: "bit", "s32", "u32" або "float". Не вдається, якщо сигнал з такою ж назвою вже існує.

(delete signnal) Видаляє signame сигналу HAL. Будь-які контакти, що наразі підключені до сигналу, будуть від’єднані. Не вдається, якщо signame не існує.

(set signal) Встановлює значення сигналу signame на value. Не вдається, якщо signame не існує, якщо він вже має записувач або якщо value не є допустимим значенням. Допустимі значення залежать від типу сигналу.

(signal type) Отримує тип сигналу name. Не вдається, якщо name не існує як сигнал.

(get ssignal) Отримує значення сигналу signame. Не вдається, якщо signame не існує.

(ЗАСТАРІЛЕ - замість цього використовуйте net) (link pin to signal) Встановлює зв’язок між контактом компонента HAL pinname та сигналом HAL signame. Будь-який попередній зв’язок з pinname буде розірвано. arrow може бути "=>", "<=", "<=>" або опущено. halcmd ігнорує стрілки, але вони можуть бути корисними в командних файлах для документування напрямку потоку даних. Стрілки не слід використовувати в командному рядку, оскільки оболонка може спробувати їх інтерпретувати. Не вдається, якщо pinname або signame не існують або якщо вони не є одного типу.

(ЗАСТАРІЛО - використовуйте замість цього net) (link ssignal до pin) Працює як linkps, але змінює порядок аргументів на зворотний. halcmd обробляє обидві команди link однаково. Використовуйте ту, яка вам більше подобається.

(ЗАСТАРІЛЕ - використовуйте net замість цього) (link pin до pin) Скорочення для linkps, яке створює сигнал (названий як перший контакт), а потім пов’язує їх обох з цим сигналом. halcmd обробляє це так, ніби це було: halcmd newsig pinname1 halcmd linksp pinname1 pinname1 halcmd linksp pinname1 pinname2

Створіть signname відповідно до типу pinname, якщо він ще не існує. Потім послідовно зв’яжіть signame з кожним pinname. Стрілки можна використовувати так само, як у linkps. При першому зв’язуванні контакту з сигналом значення сигналу успадковує значення контакту за замовчуванням.

(unlink pin) Розриває будь-яке попереднє посилання на pinname. Не вдається, якщо pinname не існує. Незв’язаний пін збереже останнє значення сигналу, з яким він був пов’язаний.

(set parameter або pin) Встановлює значення параметра або виводу name на value. Не працює, якщо name не існує як вивід або параметр, якщо це параметр, який не можна записувати, якщо це вивід, який є виходом, якщо це вивід, який вже приєднаний до сигналу, або якщо value не є допустимим значенням. Допустимі значення залежать від типу контакту або параметра. Якщо контакт і параметр існують з заданим іменем, виконується дія над параметром.

Ідентична до setp. Ця альтернативна форма команди може бути зручнішою та читабельнішою при використанні у файлі.

(parameter or pin type) Отримує тип параметра або pin name. Не вдається виконати дію, якщо name не існує як pin або параметр. Якщо pin та параметр існують із заданим ім’ям, виконується обробка параметра.

(get parameter or pin) Отримує значення параметра або pin name. Не вдається, якщо name не існує як pin або параметр. Якщо pin та параметр існують із заданим ім’ям, виконується обробка параметра.

(add function) Додає функцію functname до потоку реального часу threadname. functname буде виконуватися після всіх функцій, які були раніше додані до потоку. Не вдається, якщо functname або threadname не існують або якщо вони несумісні.

(init function) Registers functname to run once in realtime context on a dedicated init cycle of threadname, before the cyclic function list executes. Intended for one-shot setup that must run in the realtime task (for example EtherCAT slave configuration). Once the init cycle has run, further initf calls on that thread are rejected. Fails if either functname or threadname does not exist.

(delete function) Вилучає функцію functname з потоку реального часу threadname. Не вдається, якщо functname або threadname не існує, або якщо functname наразі не є частиною threadname.

Запускає виконання потоків реального часу. Кожен потік періодично викликає всі функції, додані до нього командою addf, у порядку їх додавання.

Зупиняє виконання потоків реального часу. Потоки більше не викликатимуть свої функції.

Виводить елементи HAL у stdout у форматі, зрозумілому для людини. item може бути одним із таких: "comp" (компоненти), "pin", "sig" (сигнали), "param" (параметри), "funct" (функції), "thread" або "alias". Тип "all" можна використовувати для відображення відповідних елементів усіх попередніх типів. Якщо item опущено, show виведе все.

Виводить елементи HAL у stdout у вигляді команд HAL. Ці команди можна перенаправити у файл і згодом виконати за допомогою halcmd -f, щоб відновити збережену конфігурацію. item може бути одним із таких:

Виконує команди з файлу.hal.

Присвоює «alias» як друге ім’я для контакту або параметра «name». Для більшості операцій псевдонім надає друге ім’я, яке можна використовувати для посилання на контакт або параметр, при цьому будуть працювати як оригінальне ім’я, так і псевдонім. «type» має бути pin або param. «name» має бути існуючим ім’ям або alias зазначеного типу. Зверніть увагу, що команда «show» покаже тільки псевдонім, але оригінальне ім’я все ще дійсне для використання в HAL. Оригінальні імена все ще можна побачити за допомогою «show all» або «show alias». Існуючі мережі будуть збережені, коли ім’я контакту буде замінено псевдонімом.

Вилучає будь-який псевдонім з псевдоніма виводу або параметра. "type" має бути pin або param. "alias" має бути існуючою назвою або псевдонімом зазначеного типу.

Prints the names of HAL items of the specified type. type is comp, pin, sig, param, funct, or thread. If pattern is specified it prints only those names that match the pattern, which may be a shell glob. For sig, pin and param, the first pattern may be -tdatatype where datatype is the data type (e.g., float) in this case, the listed pins, signals, or parameters are restricted to the given data type Names are printed on a single line, space separated.

Друкує ім’я файлу, номер рядка та необов’язкове повідомлення. За наявності пробілів бере повідомлення в лапки.

Блокує HAL певною мірою. none - блокування не виконано. tune - можливе деяке налаштування (setp тощо). all - HAL повністю заблоковано.

Деякою мірою розблоковує HAL. tune - можливе деяке налаштування (setp тощо). all - HAL повністю розблоковано.

Prints status info about HAL. type is lock, mem, or all. If type is omitted, it assumes all.

Встановлює рівень обміну повідомленнями rtapi (див. man3 rtapi_set_msg_level).

Надайте довідкову інформацію для команди. Якщо слово «команда» пропущено, перелічіть команду та її короткий опис.