El Generador de Componentes HAL

componente - Un componente es un módulo de tiempo real, único, que se carga con halcmd loadrt. Un componente se especifica con un archivo .comp. El nombre del componente y el nombre de archivo deben coincidir.

instancia - Un componente puede tener cero o más instancias. Cada instancia de un componente se crea igual (todas tienen los mismos pines, parámetros, funciones y datos) pero se comportan independientemente cuando sus pines, parámetros y datos tienen diferentes valores.

singleton: es posible que un componente sea un "singleton", en cuyo caso se crea una unica instancia. Rara vez tiene sentido escribir un componente singleton a menos que, literalmente, solo pueda haber un único objeto de ese tipo en el sistema (por ejemplo, un componente cuyo propósito es proporcionar un pin con la hora actual de UNIX, o un controlador de hardware para el altavoz interno de PC)

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;

notes DOC;

see_also DOC;

license LICENSE;

author AUTHOR;

include HEADERFILE;

NAME - Un identificador C estándar

STARREDNAME - Un identificador C con cero o más * antes de él. Esta sintaxis puede ser utilizada para declarar variables de instancia que son punteros. Tenga en cuenta que debido a la gramática, es posible que no haya espacios en blanco entre el * y el nombre de la variable.

HALNAME - Un identificador extendido. Cuando se usa para crear un identificador HAL, cualquier guión bajo se reemplaza con guiones, y cualquier guión o punto al final se elimina, por lo que "this_name_" se convertirá en "this-name", y si el nombre es "_", también se elimina un punto al final, de modo que "function _" da un nombre de función HAL como "component.<num>" en lugar de "component.<num>."

if CONDITION - Una expresión que involucra la variable personality , que no es cero cuando se debe crear el pin o parámetro

SIZE - Un número que da el tamaño de una matriz. Los elementos de la matriz están numerados de 0 a (SIZE-1).

MAXSIZE : CONDSIZE - Un número que da el tamaño máximo de la matriz seguido de una expresión que implica la variable personality y que siempre se evalúa a menos de MAXSIZE. Cuando la matriz se crea, su tamaño será CONDSIZE.

DOC - Una cadena que documenta el elemento. La cadena puede ser "double quoted" de estilo C, como:

"Selecciona el flanco deseado: VERDADERO significa descendente, FALSO significa ascendente"

"""El efecto de este parámetro, también conocido como "the orb of zot",
requerirá al menos dos párrafos para explicarlo.

Espero que estos párrafos te hayan permitido entender "zot"
mejor."""

"\\fIejemplo\\fB"

r"\fIexample\fB"

TYPE - Uno de los tipos HAL; bit, signed, unsigned o float. Los viejos nombres s32 y u32 también se pueden usar, pero se prefiere signed y unsigned.

PINDIRECTION - Uno de los siguientes; in, out o io. Un componente establece un valor para un pin out, lee un valor de un pin in, y puede leer o establecer el valor de un pin io.

PARAMDIRECTION - Uno de los siguientes: r o rw. Un componente establece un valor para un parámetro r, y puede leer o establecer el valor de un parámetro rw.

STARTVALUE: especifica el valor inicial de un pin o parámetro. Si no se especifica, el valor predeterminado es 0 o FALSE, según el tipo de objeto.

HEADERFILE - El nombre de un archivo de encabezado, ya sea entre comillas dobles (include "myfile.h";) o en corchetes angulares (include <systemfile.h>;). El archivo de encabezado se incluirá (usando #include) en la parte superior del archivo, antes de las declaraciones de pines y parámetros.

Cualquier cosa que comience con _comp.

comp_id

fperiod

rtapi_app_main

rtapi_app_exit

extra_setup

extra_cleanup

FUNCTION(name) - Use esta macro para comenzar la definición de una función en tiempo real que fue declarada previamente con function NAME. La función incluye un parámetro period que es el número entero de nanosegundos entre llamadas a la función.

EXTRA_SETUP() - Use esta macro para comenzar la definición de la función llamada a realizar una configuración adicional de esta instancia. Devuelve un errno negativo de Unix para indicar fallo (por ejemplo, return -EBUSY al no reservar un puerto de E/S) o 0 para indicar éxito.

EXTRA_CLEANUP() - Use esta macro para comenzar la definición de la función destinada a realizar una configuracion adicional del componente. Tenga en cuenta que esta función debe limpiar todas las instancias del componente, no solo una. Las macros "pin_name", "parameter_name" y "data" no se pueden usar aquí.

pin_name o parameter_name - Para cada pin pin_name o parametro parameter_name hay una macro que permite que el nombre se use solo para referirse al pin o parámetro. Cuando pin_name o parameter_name es una matriz, la macro es de la forma pin_name(idx) o param_name(idx) donde idx es el índice en la matriz. Cuando la matriz es de tamaño variable, solo es legal referirse a elementos hasta su condsize.

variable_name - Para cada variable variable_name hay una macro que permite usar el nombre que se utiliza para referirse a la variable. Cuando variable_name es una matriz, se usa el subíndice estilo C normal: variable_name[idx]

data - Si se especifica "option data", esta macro permite el acceso a los datos de la instancia.

fperiod: el número de segundos en, coma flotante, entre las llamadas a esta funcion de tiempo real.

FOR_ALL_INSTS() {…} - Para componentes de espacio de usuario. Esta macro itera sobre todas las instancias definidas. Dentro del cuerpo del lazo, las macros pin_name, parameter_name y data funcionan como lo harian en funciones en tiempo real.