HAL Генератор компонентов

component - A component is a single real-time module, which is loaded with Halcmd loadrt. One .comp file specifies one component. The component name and file name must match.

instance - A component can have zero or more instances. Each instance of a component is created equal (they all have the same pins, parameters, functions, and data) but behave independently when their pins, parameters, and data have different values.

singleton - It is possible for a component to be a "singleton", in which case exactly one instance is created. It seldom makes sense to write a singleton component, unless there can literally only be a single object of that kind in the system (for instance, a component whose purpose is to provide a pin with the current UNIX time, or a hardware driver for the internal PC speaker).

component HALNAME (DOC);

pin PINDIRECTION TYPE HALNAME ([SIZE]|[MAXSIZE: CONDSIZE]) (if CONDITION) (= STARTVALUE) (DOC) ;

param PARAMDIRECTION TYPE HALNAME ([SIZE]|[MAXSIZE: CONDSIZE]) (if CONDITION) (= STARTVALUE) (DOC) ;

function HALNAME (fp | nofp) (DOC);

option OPT (VALUE);

variable CTYPE STARREDNAME ([SIZE]);

description DOC;

examples DOC;

notes DOC;

see_also DOC;

license LICENSE;

author AUTHOR;

include HEADERFILE;

NAME - Стандартный идентификатор C

STARREDNAME - Идентификатор C с нулем или более * перед ним. Этот синтаксис можно использовать для объявления переменных экземпляра, которые являются указателями. Обратите внимание, что из-за грамматики между * и именем переменной может отсутствовать пробел.

HALNAME - Расширенный идентификатор. При использовании для создания идентификатора HAL все подчеркивания заменяются дефисами, а любые конечные дефисы или точки удаляются, так что "this_name_" будет преобразовано в "this-name", а если имя "_", то завершающая точка также удаляется, так что "function _" дает имя функции HAL, например "component.<num>" вместо "component.<num>."

if CONDITION — выражение, включающее переменную personality, которая не равна нулю, когда необходимо создать вывод или параметр.

SIZE - A number that gives the size of an array, at most 256. The array items are numbered from 0 to SIZE-1.

MAXSIZE : CONDSIZE - A number that gives the maximum size of the array, at most 256, followed by an expression involving the variable personality and which always evaluates to less than MAXSIZE. When the array is created its size will be CONDSIZE.

DOC - Строка, документирующая элемент. Строка может быть строкой в стиле C с "двойными кавычками", например:

"Выбирает желаемые параметры импульса: TRUE означает срез, FALSE означает фронт"

"""The effect of this parameter, also known as "the orb of zot",
will require at least two paragraphs to explain.

Hopefully these paragraphs have allowed you to understand "zot"
better."""

TYPE - One of the HAL types: bool, sint, uint or real.

PINDIRECTION - One of the following: in, out, or io. A component sets a value for an out pin, it reads a value from an in pin, and it may read or set the value of an io pin.

PARAMDIRECTION - One of the following: r or rw. A component sets a value for a r parameter, and it may read or set the value of a rw parameter.

STARTVALUE - Specifies the initial value of a pin or parameter. If it is not specified, then the default is 0 or FALSE, depending on the type of the item.

HEADERFILE - Имя заголовочного файла в двойных кавычках (include "myfile.h";) или в угловых скобках (include <systemfile.h>;). Файл заголовка будет включен (с использованием #include языка C) в начало файла, перед объявлениями контактов и параметров.

Все, что начинается с _comp.

comp_id

fperiod

rtapi_app_main

rtapi_app_exit

extra_setup

extra_cleanup

post_export

FUNCTION(`__name__)` — используйте этот макрос, чтобы начать определение функции реального времени, которая ранее была объявлена с помощью function NAME. Функция включает параметр period, который представляет собой целое число наносекунд между вызовами функции. См. также «период опции» выше.

EXTRA_SETUP() — используйте этот макрос, чтобы начать определение функции, вызываемой для выполнения дополнительной настройки этого экземпляра. Возвращает отрицательное значение UNIX errno, чтобы указать на ошибку (например, return -EBUSY, если не удалось зарезервировать порт ввода-вывода), или 0, чтобы указать на успех.

EXTRA_CLEANUP() — используйте этот макрос, чтобы начать определение функции, вызываемой для дополнительной очистки компонента. Обратите внимание, что эта функция должна очищать все экземпляры компонента, а не только один. Макросы «pin_name», «parameter_name» и «data» здесь использовать нельзя.

POST_EXPORT() - Use this macro to begin the definition of the function called to perform extra setup after all pins and parameters have been created for this instance. This function is called just before the export() function returns. You can use the POST_EXPORT() function to preset parameter values you otherwise would not be able to set. Return a negative UNIX errno value to indicate failure, or 0 to indicate success.
Note: POST_EXPORT() should not change personality. If you need to adapt personality, then you must do so in EXTRA_SETUP(), which runs before pins and parameters are created.

pin_name или parameter_name — для каждого контакта имя_контакта или параметра имя_параметра существует макрос, который позволяет использовать имя отдельно для ссылки на контакт или параметр. Если pin_name или parameter_name представляет собой массив, макрос имеет форму pin_name(idx) или param_name(idx), где idx — это индекс в массиве контактов. Когда массив представляет собой массив переменного размера, разрешено ссылаться только на элементы до его condsize.

variable_name — для каждой переменной variable_name существует макрос, который позволяет использовать имя отдельно для ссылки на переменную. Когда variable_name представляет собой массив, используется обычный индекс в стиле C: variable_name[idx].

data — если указаны "option data", этот макрос разрешает доступ к данным экземпляра.

fperiod — число секунд с плавающей запятой между вызовами этой функции реального времени. См. также «период опции» выше.

FOR_ALL_INSTS() {…​} — для компонентов, не работающих в режиме реального времени. Этот макрос перебирает все определенные экземпляры. Внутри тела цикла макросы pin_name, parameter_name и data работают так же, как и в функциях реального времени.