|
From: John T. <gi...@gi...> - 2011-12-15 12:30:16
|
Docs: markup fixes Signed-off-by: John Thornton <jth...@gn...> http://git.linuxcnc.org/?p=emc2.git;a=commitdiff;h=b028540 --- docs/src/hal/components.txt | 703 ++++++++++++++-------------------------- docs/src/hal/components_de.txt | 703 ++++++++++++++-------------------------- docs/src/hal/components_es.txt | 703 ++++++++++++++-------------------------- docs/src/hal/components_pl.txt | 703 ++++++++++++++-------------------------- 4 files changed, 980 insertions(+), 1832 deletions(-) diff --git a/docs/src/hal/components.txt b/docs/src/hal/components.txt index d05faa6..a1564dd 100644 --- a/docs/src/hal/components.txt +++ b/docs/src/hal/components.txt @@ -1,3 +1,6 @@ +:lang: en +:toc: + = HAL Components[[cha:HAL-Components]] == Commands and Userspace Components[[sec:Commands-and-Userspace-Components]] @@ -6,597 +9,381 @@ All of the commands in the following list have man pages. Some will have expanded descriptions, some will have limited descriptions. Also, all of the components listed below have man pages. From these two lists you know what components exist, -and you can use `man n name` to get additional information. +and you can use 'man n name' to get additional information. To view the information in the man page, in a terminal window type: -*man axis* (or perhaps *man 1 axis* if your system requires it.) - -*axis* = AXIS EMC (The Enhanced Machine Controller) Graphical User Interface. + -*axis-remote* = AXIS Remote Interface. + -*comp* = Build, compile and install EMC HAL components. + -*emc* = EMC (The Enhanced Machine Controller). + -*gladevcp* = Virtual Control Panel for EMC2 based on Glade, Gtk and HAL widgets. + -*gs2* = HAL userspace component for Automation Direct GS2 VFD's. + -*halcmd* = Manipulate the Enhanced Machine Controller HAL from the command line. + -*hal_input* = Control HAL pins with any Linux input device, including USB HID devices. + -*halmeter* = Observe HAL pins, signals, and parameters. + -*halrun* = Manipulate the Enhanced Machine Controller HAL from the command line. + -*halsampler* = Sample data from HAL in realtime. + -*halstreamer* = Stream file data into HAL in real time. + -*halui* = Observe HAL pins and command EMC through NML. + -*io* = Accepts NML I/O commands, interacts with HAL in userspace. + -*iocontrol* = Accepts NML I/O commands, interacts with HAL in userspace. + -*pyvcp* = Virtual Control Panel for EMC2. + -*shuttlexpress* = control HAL pins with the ShuttleXpress device made by Contour Design. + +---- +man axis (or perhaps 'man 1 axis' if your system requires it.) +---- +[horizontal] +axis:: AXIS EMC (The Enhanced Machine Controller) Graphical User Interface. +axis-remote:: AXIS Remote Interface. +comp:: Build, compile and install EMC HAL components. +emc:: EMC (The Enhanced Machine Controller). +gladevcp:: Virtual Control Panel for EMC2 based on Glade, Gtk and HAL widgets. +gs2:: HAL userspace component for Automation Direct GS2 VFD's. +halcmd:: Manipulate the Enhanced Machine Controller HAL from the command line. +hal_input:: Control HAL pins with any Linux input device, including USB HID devices. +halmeter:: Observe HAL pins, signals, and parameters. +halrun:: Manipulate the Enhanced Machine Controller HAL from the command line. +halsampler:: Sample data from HAL in realtime. +halstreamer:: Stream file data into HAL in real time. +halui:: Observe HAL pins and command EMC through NML. +io:: Accepts NML I/O commands, interacts with HAL in userspace. +iocontrol:: Accepts NML I/O commands, interacts with HAL in userspace. +pyvcp:: Virtual Control Panel for EMC2. +shuttlexpress:: control HAL pins with the ShuttleXpress device made by Contour Design. == Realtime Components[[sec:Realtime-Components]] Some of these will have expanded descriptions from the man pages. Some will have limited descriptions. All of the components have man pages. -From this list you know what components exist and can use `man n name` to +From this list you know what components exist and can use 'man n name' to get additional information in a terminal window. -=== abs (((abs))) - -Compute the absolute value and sign of the input signal. - -=== and2 (((and2))) - -Two-input AND gate. For out to be true both inputs must be true. - -=== at_pid (((at_pid))) - -Proportional/integral/derivative controller with auto tuning. - -=== axis (((axis))) - -Accepts NML motion commands, interacts with HAL in realtime. - -=== biquad (((biquad))) - -Biquad IIR filter - -=== bldc_hall3 (((bldc_hall3))) - -3-wire Bipolar trapezoidal commutation BLDC motor driver using Hall sensors. - -=== blend (((blend))) - -Perform linear interpolation between two values. - -=== charge_pump (((charge_pump))) - -Create a square-wave for the "charge pump" input of some controller boards. - -=== clarke2 (((clarke2))) - -Two input version of Clarke transform. - -=== clarke3 (((clarke3))) - -Clarke (3 phase to cartesian) transform. - -=== clarkeinv (((clarkeinv))) - -Inverse Clarke transform. - -=== classicladder (((classicladder))) - -Realtime software PLC based on ladder logic. See Classic Ladder manual for more information. - -=== comp (((comp))) - -Two input comparator with hysteresis. - -=== constant (((constant))) - -Use a parameter to set the value of a pin. +[horizontal] +abs:: (((abs)))Compute the absolute value and sign of the input signal. -=== conv_bit_s32 (((conv_bit_s32))) +and2:: (((and2)))Two-input AND gate. For out to be true both inputs must be true. -Convert a value from bit to s32. +at_pid:: (((at_pid)))Proportional/integral/derivative controller with auto tuning. -=== conv_bit_u32 (((conv_bit_u32))) +axis:: (((axis)))Accepts NML motion commands, interacts with HAL in realtime. -Convert a value from bit to u32. +biquad:: (((biquad)))Biquad IIR filter -=== conv_float_s32 (((conv_float_s32))) +bldc_hall3:: (((bldc_hall3)))3-wire Bipolar trapezoidal commutation BLDC motor driver using Hall sensors. -Convert a value from float to s32. +blend:: (((blend)))Perform linear interpolation between two values. -=== conv_float_u32 (((conv_float_u32))) +charge_pump:: (((charge_pump)))Create a square-wave for the 'charge pump' input of some controller boards. -Convert a value from float to u32. +clarke2:: (((clarke2)))Two input version of Clarke transform. -=== conv_s32_bit (((conv_s32_bit))) +clarke3:: (((clarke3)))Clarke (3 phase to cartesian) transform. -Convert a value from s32 to bit. +clarkeinv:: (((clarkeinv)))Inverse Clarke transform. -=== conv_s32_float (((conv_s32_float))) +classicladder:: (((classicladder)))Realtime software PLC based on ladder logic. See Classic Ladder manual for more information. -Convert a value from s32 to float. +comp:: (((comp)))Two input comparator with hysteresis. -=== conv_s32_u32 (((conv_s32_u32))) +constant:: (((constant)))Use a parameter to set the value of a pin. -Convert a value from s32 to u32. +conv_bit_s32:: (((conv_bit_s32)))Convert a value from bit to s32. -=== conv_u32_bit (((conv_u32_bit))) +conv_bit_u32:: (((conv_bit_u32)))Convert a value from bit to u32. -Convert a value from u32 to bit. +conv_float_s32:: (((conv_float_s32)))Convert a value from float to s32. -=== conv_u32_float (((conv_u32_float))) +conv_float_u32:: (((conv_float_u32)))Convert a value from float to u32. -Convert a value from u32 to float. +conv_s32_bit:: (((conv_s32_bit)))Convert a value from s32 to bit. -=== conv_u32_s32 (((conv_u32_s32))) +conv_s32_float:: (((conv_s32_float)))Convert a value from s32 to float. -Convert a value from u32 to s32. +conv_s32_u32:: (((conv_s32_u32)))Convert a value from s32 to u32. -=== counter (((counter))) +conv_u32_bit:: (((conv_u32_bit)))Convert a value from u32 to bit. -Counts input pulses (deprecated). + -Use the *encoder* component with "...counter-mode" = TRUE. See <<sec:Encoder>>. +conv_u32_float:: (((conv_u32_float)))Convert a value from u32 to float. -=== ddt (((ddt))) +conv_u32_s32:: (((conv_u32_s32)))Convert a value from u32 to s32. -Compute the derivative of the input function. +counter:: (((counter)))Counts input pulses (deprecated). +Use the 'encoder' component See <<sec:Encoder>>. -=== deadzone (((deadzone))) +ddt:: (((ddt)))Compute the derivative of the input function. -Return the center if within the threshold. +deadzone:: (((deadzone)))Return the center if within the threshold. -=== debounce (((debounce))) +debounce:: (((debounce)))Filter noisy digital inputs, for more information see <<sec:Debounce>>. -Filter noisy digital inputs, for more information see <<sec:Debounce>>. +edge:: (((edge)))Edge detector. -=== edge (((edge))) - -Edge detector. - -=== encoder (((encoder))) - -Software counting of quadrature encoder signals, for more information +encoder:: (((encoder)))Software counting of quadrature encoder signals, for more information see <<sec:Encoder>>. -=== encoder_ratio (((encoder_ratio))) - -An electronic gear to synchronize two axes. - -=== estop_latch (((estop_latch))) - -ESTOP latch. - -=== feedcomp (((feedcomp))) +encoder_ratio:: (((encoder_ratio)))An electronic gear to synchronize two axes. -Multiply the input by the ratio of current velocity to the feed rate. +estop_latch:: (((estop_latch)))ESTOP latch. -=== flipflop (((flipflop))) +feedcomp:: (((feedcomp)))Multiply the input by the ratio of current velocity to the feed rate. -D type flip-flop. +flipflop:: (((flipflop)))D type flip-flop. -=== freqgen (((freqgen))) +freqgen:: (((freqgen)))Software step pulse generation. -Software step pulse generation. +gantrykins:: (((gantrykins)))A kinematics module that maps one axis to multiple joints. -=== gantrykins (((gantrykins))) +gearchange:: (((gearchange)))Select from one of two speed ranges. -A kinematics module that maps one axis to multiple joints. - -=== gearchange (((gearchange))) - -Select from one of two speed ranges. - -=== genhexkins (((genhexkins))) - -Gives six degrees of freedom in position and orientation (XYZABC). +genhexkins:: (((genhexkins)))Gives six degrees of freedom in position and orientation (XYZABC). The location of the motors is defined at compile time. -=== genserkins (((genserkins))) - -Kinematics that can model a general serial-link manipulator with up to +genserkins:: (((genserkins)))Kinematics that can model a general serial-link manipulator with up to 6 angular joints. -=== gladevcp (((gladevcp))) - -Displays Virtual Control Panels built with GTK/Glade. - -=== hm2_7i43 (((hm2_7i43))) +gladevcp:: (((gladevcp)))Displays Virtual Control Panels built with GTK/Glade. -HAL driver for the Mesa Electronics 7i43 EPP Anything IO board with +hm2_7i43:: (((hm2_7i43)))HAL driver for the Mesa Electronics 7i43 EPP Anything IO board with HostMot2. -=== hm2_pci (((hm2_pci))) - -HAL driver for the Mesa Electronics 5i20, 5i22, 5i23, 4i65, and 4i68 +hm2_pci:: (((hm2_pci)))HAL driver for the Mesa Electronics 5i20, 5i22, 5i23, 4i65, and 4i68 Anything I/O boards, with HostMot2 firmware. -=== hostmot2 (((hostmot2))) - -HAL driver for the Mesa Electronics HostMot2 firmware. - -=== hypot (((hypot))) - -Three-input hypotenuse (Euclidean distance) calculator. - -=== ilowpass (((ilowpass))) - -Low-pass filter with integer inputs and outputs. - -=== integ (((integ))) - -Integrator. - -=== invert (((invert))) - -Compute the inverse of the input signal. - -=== joyhandle (((joyhandle))) - -Sets nonlinear joypad movements, deadbands and scales. - -=== kins (((kins))) - -kinematics definitions for EMC2. +hostmot2:: (((hostmot2)))HAL driver for the Mesa Electronics HostMot2 firmware. -=== knob2float (((knob2float))) +hypot:: (((hypot)))Three-input hypotenuse (Euclidean distance) calculator. -Convert counts (probably from an encoder) to a float value. +ilowpass:: (((ilowpass)))Low-pass filter with integer inputs and outputs. -=== limit1 (((limit1))) +integ:: (((integ)))Integrator. -1) Limit the output signal to fall between min and max. footnote:[When the input -is a position, this means that the *position* is limited.] +invert:: (((invert)))Compute the inverse of the input signal. -=== limit2 (((limit2))) +joyhandle:: (((joyhandle)))Sets nonlinear joypad movements, deadbands and scales. -1) Limit the output signal to fall between min and max. + -2) Limit its slew rate to less than maxv per second. footnote:[When the input -is a position, this means that *position* and *velocity* are limited.] +kins:: (((kins)))kinematics definitions for EMC2. -=== limit3 (((limit3))) +knob2float:: (((knob2float)))Convert counts (probably from an encoder) to a float value. -1) Limit the output signal to fall between min and max. + -2) Limit its slew rate to less than maxv per second. + -3) Limit its second derivative to less than MaxA per second squared. footnote:[When -the input is a position, this means that the *position*, *velocity*, and -*acceleration* are limited.] +limit1:: (((limit1)))Limit the output signal to fall between min and max. footnote:[When the input +is a position, this means that the 'position' is limited.] -=== logic (((logic))) +limit2:: (((limit2)))Limit the output signal to fall between min and max. +Limit its slew rate to less than maxv per second. footnote:[When the input +is a position, this means that 'position' and 'velocity' are limited.] -Experimental general logic function component. +limit3:: (((limit3)))Limit the output signal to fall between min and max. +Limit its slew rate to less than maxv per second. +Limit its second derivative to less than MaxA per second squared. footnote:[When +the input is a position, this means that the 'position', 'velocity', and +'acceleration' are limited.] -=== lowpass (((lowpass))) +logic:: (((logic)))Experimental general logic function component. -Low-pass filter +lowpass:: (((lowpass)))Low-pass filter -=== lut5 (((lut5))) +lut5:: (((lut5)))Arbitrary 5-input logic function based on a look-up table. -Arbitrary 5-input logic function based on a look-up table. +maj3:: (((maj3)))Compute the majority of 3 inputs. -=== maj3 (((maj3))) +match8:: (((match8)))8-bit binary match detector. -Compute the majority of 3 inputs. - -=== match8 (((match8))) - -8-bit binary match detector. - -=== maxkins (((maxkins))) - -Kinematics for a tabletop 5 axis mill named "max" with tilting head (B axis) and +maxkins:: (((maxkins)))Kinematics for a tabletop 5 axis mill named 'max' with tilting head (B axis) and horizontal rotary mounted to the table (C axis). Provides UVW motion in the rotated coordinate system. The source file, maxkins.c, may be a useful starting point for other 5-axis systems. -=== mesa_7i65 (((7i65))) - -Support for the Mesa 7i65 eight-axis servo card. - -=== minmax (((minmax))) - -Track the minimum and maximum values of the input to the outputs. - -=== motion (((motion))) - -Accepts NML motion commands, interacts with HAL in realtime. - -=== mult2 (((mult2))) - -Product of two inputs. - -=== mux16 (((mux16))) - -Select from one of sixteen input values. - -=== mux2 (((mux2))) - -Select from one of two input values. +mesa_7i65:: (((7i65)))Support for the Mesa 7i65 eight-axis servo card. -=== mux4 (((mux4))) +minmax:: (((minmax)))Track the minimum and maximum values of the input to the outputs. -Select from one of four input values. +motion:: (((motion)))Accepts NML motion commands, interacts with HAL in realtime. -=== mux8 (((mux8))) +mult2:: (((mult2)))Product of two inputs. -Select from one of eight input values. +mux16:: (((mux16)))Select from one of sixteen input values. -=== near (((near))) +mux2:: (((mux2)))Select from one of two input values. -Determine whether two values are roughly equal. +mux4:: (((mux4)))Select from one of four input values. -=== not (((not))) +mux8:: (((mux8)))Select from one of eight input values. -Inverter. +near:: (((near)))Determine whether two values are roughly equal. -=== offset (((offset))) +not:: (((not)))Inverter. -Adds an offset to an input, and subtracts it from the feedback value. +offset:: (((offset)))Adds an offset to an input, and subtracts it from the feedback value. -=== oneshot (((oneshot))) +oneshot:: (((oneshot)))One-shot pulse generator. -One-shot pulse generator. +or2:: (((or2)))Two-input OR gate. -=== or2 (((or2))) - -Two-input OR gate. - -=== pid (((pid))) - -Proportional/integral/derivative controller, for more information +pid:: (((pid)))Proportional/integral/derivative controller, for more information see <<sec:PID>>. -=== pluto_servo (((pluto_servo))) - -Hardware driver and firmware for the Pluto-P parallel-port FPGA, for +pluto_servo:: (((pluto_servo)))Hardware driver and firmware for the Pluto-P parallel-port FPGA, for use with servos. -=== pluto_step (((pluto_step))) - -Hardware driver and firmware for the Pluto-P parallel-port FPGA, for +pluto_step:: (((pluto_step)))Hardware driver and firmware for the Pluto-P parallel-port FPGA, for use with steppers. -=== pumakins (((pumakins))) - -Kinematics for PUMA-style robots. - -=== pwmgen (((pwmgen))) - -Software PWM/PDM generation, for more information see <<sec:PWMgen>>. - -=== rotatekins (((rotatekins))) - -The X and Y axes are rotated 45 degrees compared to the joints 0 and 1. - -=== sample_hold (((sample_hold))) - -Sample and Hold. - -=== sampler (((sampler))) - -Sample data from HAL in real time. +pumakins:: (((pumakins)))Kinematics for PUMA-style robots. -=== scale (((scale))) +pwmgen:: (((pwmgen)))Software PWM/PDM generation, for more information see <<sec:PWMgen>>. -Applies a scale and offset to its input. +rotatekins:: (((rotatekins)))The X and Y axes are rotated 45 degrees compared to the joints 0 and 1. -=== scarakins (((scarakins))) +sample_hold:: (((sample_hold)))Sample and Hold. -Kinematics for SCARA-type robots. +sampler:: (((sampler)))Sample data from HAL in real time. -=== select8 (((select8))) +scale:: (((scale)))Applies a scale and offset to its input. -8-bit binary match detector. +scarakins:: (((scarakins)))Kinematics for SCARA-type robots. -=== serport (((serport))) +select8:: (((select8)))8-bit binary match detector. -Hardware driver for the digital I/O bits of the 8250 and 16550 serial port. +serport:: (((serport)))Hardware driver for the digital I/O bits of the 8250 and 16550 serial port. -=== siggen (((siggen))) +siggen:: (((siggen)))Signal generator, for more information see <<sec:Siggen>>. -Signal generator, for more information see <<sec:Siggen>>. +sim_encoder:: (((sim_encoder)))Simulated quadrature encoder, for more information see <<sec:Simulated-Encoder>>. -=== sim_encoder (((sim_encoder))) +sphereprobe:: (((sphereprobe)))Probe a pretend hemisphere. -Simulated quadrature encoder, for more information see <<sec:Simulated-Encoder>>. +stepgen:: (((stepgen)))Software step pulse generation, for more information see <<sec:Stepgen>>. -=== sphereprobe (((sphereprobe))) +steptest:: (((steptest)))Used by Stepconf to allow testing of acceleration and velocity values for an axis. -Probe a pretend hemisphere. +streamer:: (((streamer)))Stream file data into HAL in real time. -=== stepgen (((stepgen))) +sum2:: (((sum2)))Sum of two inputs (each with a gain) and an offset. -Software step pulse generation, for more information see <<sec:Stepgen>>. +supply:: (((supply)))Set output pins with values from parameters (deprecated). -=== steptest (((steptest))) +thc:: (((torch height control)))Torch Height Control using a Mesa THC card. -Used by Stepconf to allow testing of acceleration and velocity values for an axis. +threads:: (((threads)))Creates hard realtime HAL threads. -=== streamer (((streamer))) +threadtest:: (((threadtest)))Component for testing thread behavior. -Stream file data into HAL in real time. +time:: (((time)))Accumulated run-time timer counts HH:MM:SS of 'active' input. -=== sum2 (((sum2))) +timedelay:: (((timedelay)))The equivalent of a time-delay relay. -Sum of two inputs (each with a gain) and an offset. +timedelta:: (((timedelta)))Component that measures thread scheduling timing behavior. -=== sum2 (((sum2))) +toggle2nist:: (((toggle2nist)))Toggle button to nist logic. -Set output pins with values from parameters (deprecated). +toggle:: (((toggle)))Push-on, push-off from momentary pushbuttons. -=== thc - -Torch Height Control using a Mesa THC card. - -=== threads (((threads))) - -Creates hard realtime HAL threads. - -=== threadtest (((threadtest))) - -Component for testing thread behavior. - -=== time (((time))) - -Accumulated run-time timer counts HH:MM:SS of "active" input. - -=== timedelay (((timedelay))) - -The equivalent of a time-delay relay. - -=== timedelta (((timedelta))) - -Component that measures thread scheduling timing behavior. - -=== toggle2nist (((toggle2nist))) - -Toggle button to nist logic. - -=== toggle (((toggle))) - -Push-on, push-off from momentary pushbuttons. - -=== tripodkins (((tripodkins))) - -The joints represent the distance of the controlled point from three +tripodkins:: (((tripodkins)))The joints represent the distance of the controlled point from three predefined locations (the motors), giving three degrees of freedom in position (XYZ). -=== tristate_bit (((tristate_bit))) - -Place a signal on an I/O pin only when enabled, similar to a tristate +tristate_bit:: (((tristate_bit)))Place a signal on an I/O pin only when enabled, similar to a tristate buffer in electronics. -=== tristate_float (((tristate_float))) - -Place a signal on an I/O pin only when enabled, similar to a tristate +tristate_float:: (((tristate_float)))Place a signal on an I/O pin only when enabled, similar to a tristate buffer in electronics. -=== trivkins (((trivkins))) - -There is a 1:1 correspondence between joints and axes. Most standard +trivkins:: (((trivkins)))There is a 1:1 correspondence between joints and axes. Most standard milling machines and lathes use the trivial kinematics module. -=== updown (((updown))) - -Counts up or down, with optional limits and wraparound behavior. - -=== watchdog (((watchdog))) - -Monitor one to thirty-two inputs for a "heartbeat". - -=== wcomp (((wcomp))) - -Window comparator. - -=== weighted_sum (((weighted_sum))) - -Convert a group of bits to an integer. - -=== xor2 (((xor2))) +updown:: (((updown)))Counts up or down, with optional limits and wraparound behavior. -Two-input XOR (exclusive OR) gate. +watchdog:: (((watchdog)))Monitor one to thirty-two inputs for a 'heartbeat'. +wcomp:: (((wcomp)))Window comparator. -== HAL and RTAPI (list of man 3 pages) +weighted_sum:: (((weighted_sum)))Convert a group of bits to an integer. -As long as we have just given a list of man 1 and man 9 pages, -let's finish the job and give a list of the man 3 pages. -Maybe some of the files are for housekeeping and don't really belong here. -This should probably be fixed up later somehow. -Consider this a *FIX ME* note, or a TODO note. -Anyway, here's the list: +xor2:: (((xor2)))Two-input XOR (exclusive OR) gate. -EXPORT_FUNCTION.3rtapi + -hal_add_funct_to_thread.3hal + -hal_bit_t.3hal + -hal_create_thread.3hal + -hal_del_funct_from_thread.3hal + -hal_exit.3hal + -hal_export_funct.3hal + -hal_float_t.3hal + -hal_get_lock.3hal + -hal_init.3hal + -hal_link.3hal + -hal_malloc.3hal + -hal_param_bit_new.3hal + -hal_param_bit_newf.3hal + -hal_param_float_new.3hal + -hal_param_float_newf.3hal + -hal_param_new.3hal + -hal_param_s32_new.3hal + -hal_param_s32_newf.3hal + -hal_param_u32_new.3hal + -hal_param_u32_newf.3hal + -hal_parport.3hal + -hal_pin_bit_new.3hal + -hal_pin_bit_newf.3hal + -hal_pin_float_new.3hal + -hal_pin_float_newf.3hal + -hal_pin_new.3hal + -hal_pin_s32_new.3hal + -hal_pin_s32_newf.3hal + -hal_pin_u32_new.3hal + -hal_pin_u32_newf.3hal + -hal_ready.3hal + -hal_s32_t.3hal + -hal_set_constructor.3hal + -hal_set_lock.3hal + -hal_signal_delete.3hal + -hal_signal_new.3hal + -hal_start_threads.3hal + -hal_type_t.3hal + -hal_u32_t.3hal + -hal_unlink.3hal + -intro.3hal + -intro.3rtapi + -MODULE_AUTHOR.3rtapi + -MODULE_DESCRIPTION.3rtapi + -MODULE_LICENSE.3rtapi + -PM_ROTATION_VECTOR.3 + -rtapi_app_exit.3rtapi + -rtapi_app_main.3rtapi + -rtapi_clock_set_period.3rtapi + -rtapi_delay.3rtapi + -rtapi_delay_max.3rtapi + -rtapi_exit.3rtapi + -rtapi_get_clocks.3rtapi + -rtapi_get_msg_level.3rtapi + -rtapi_get_time.3rtapi + -rtapi_inb.3rtapi + -rtapi_init.3rtapi + -rtapi_module_param.3rtapi + -RTAPI_MP_ARRAY_INT.3rtapi + -RTAPI_MP_ARRAY_LONG.3rtapi + -RTAPI_MP_ARRAY_STRING.3rtapi + -RTAPI_MP_INT.3rtapi + -RTAPI_MP_LONG.3rtapi + -RTAPI_MP_STRING.3rtapi + -rtapi_mutex.3rtapi + -rtapi_outb.3rtapi + -rtapi_print.3rtapi + -rtapi_prio.3rtapi + -rtapi_prio_highest.3rtapi + -rtapi_prio_lowest.3rtapi + -rtapi_prio_next_higher.3rtapi + -rtapi_prio_next_lower.3rtapi + -rtapi_region.3rtapi + -rtapi_release_region.3rtapi + -rtapi_request_region.3rtapi + -rtapi_set_msg_level.3rtapi + -rtapi_shmem.3rtapi + -rtapi_shmem_delete.3rtapi + -rtapi_shmem_getptr.3rtapi + -rtapi_shmem_new.3rtapi + -rtapi_snprintf.3rtapi + -rtapi_task_delete.3rtpi + -rtapi_task_new.3rtapi + -rtapi_task_pause.3rtapi + -rtapi_task_resume.3rtapi + -rtapi_task_start.3rtapi + -rtapi_task_wait.3rtapi + -skeleton.3hal + -skeleton.3rtapi + -undocumented.3hal + -undocumented.3rtapi + +== HAL API calls +.... +hal_add_funct_to_thread.3hal +hal_bit_t.3hal +hal_create_thread.3hal +hal_del_funct_from_thread.3hal +hal_exit.3hal +hal_export_funct.3hal +hal_float_t.3hal +hal_get_lock.3hal +hal_init.3hal +hal_link.3hal +hal_malloc.3hal +hal_param_bit_new.3hal +hal_param_bit_newf.3hal +hal_param_float_new.3hal +hal_param_float_newf.3hal +hal_param_new.3hal +hal_param_s32_new.3hal +hal_param_s32_newf.3hal +hal_param_u32_new.3hal +hal_param_u32_newf.3hal +hal_parport.3hal +hal_pin_bit_new.3hal +hal_pin_bit_newf.3hal +hal_pin_float_new.3hal +hal_pin_float_newf.3hal +hal_pin_new.3hal +hal_pin_s32_new.3hal +hal_pin_s32_newf.3hal +hal_pin_u32_new.3hal +hal_pin_u32_newf.3hal +hal_ready.3hal +hal_s32_t.3hal +hal_set_constructor.3hal +hal_set_lock.3hal +hal_signal_delete.3hal +hal_signal_new.3hal +hal_start_threads.3hal +hal_type_t.3hal +hal_u32_t.3hal +hal_unlink.3hal +intro.3hal +undocumented.3hal +.... +== RTAPI calls +.... +EXPORT_FUNCTION.3rtapi +MODULE_AUTHOR.3rtapi +MODULE_DESCRIPTION.3rtapi +MODULE_LICENSE.3rtapi +RTAPI_MP_ARRAY_INT.3rtapi +RTAPI_MP_ARRAY_LONG.3rtapi +RTAPI_MP_ARRAY_STRING.3rtapi +RTAPI_MP_INT.3rtapi +RTAPI_MP_LONG.3rtapi +RTAPI_MP_STRING.3rtapi +intro.3rtapi +rtapi_app_exit.3rtapi +rtapi_app_main.3rtapi +rtapi_clock_set_period.3rtapi +rtapi_delay.3rtapi +rtapi_delay_max.3rtapi +rtapi_exit.3rtapi +rtapi_get_clocks.3rtapi +rtapi_get_msg_level.3rtapi +rtapi_get_time.3rtapi +rtapi_inb.3rtapi +rtapi_init.3rtapi +rtapi_module_param.3rtapi +RTAPI_MP_ARRAY_INT.3rtapi +RTAPI_MP_ARRAY_LONG.3rtapi +RTAPI_MP_ARRAY_STRING.3rtapi +RTAPI_MP_INT.3rtapi +RTAPI_MP_LONG.3rtapi +RTAPI_MP_STRING.3rtapi +rtapi_mutex.3rtapi +rtapi_outb.3rtapi +rtapi_print.3rtap +rtapi_prio.3rtapi +rtapi_prio_highest.3rtapi +rtapi_prio_lowest.3rtapi +rtapi_prio_next_higher.3rtapi +rtapi_prio_next_lower.3rtapi +rtapi_region.3rtapi +rtapi_release_region.3rtapi +rtapi_request_region.3rtapi +rtapi_set_msg_level.3rtapi +rtapi_shmem.3rtapi +rtapi_shmem_delete.3rtapi +rtapi_shmem_getptr.3rtapi +rtapi_shmem_new.3rtapi +rtapi_snprintf.3rtapi +rtapi_task_delete.3rtpi +rtapi_task_new.3rtapi +rtapi_task_pause.3rtapi +rtapi_task_resume.3rtapi +rtapi_task_start.3rtapi +rtapi_task_wait.3rtapi +undocumented.3rtapi +.... diff --git a/docs/src/hal/components_de.txt b/docs/src/hal/components_de.txt index d05faa6..86b98f5 100644 --- a/docs/src/hal/components_de.txt +++ b/docs/src/hal/components_de.txt @@ -1,3 +1,6 @@ +:lang: de +:toc: + = HAL Components[[cha:HAL-Components]] == Commands and Userspace Components[[sec:Commands-and-Userspace-Components]] @@ -6,597 +9,381 @@ All of the commands in the following list have man pages. Some will have expanded descriptions, some will have limited descriptions. Also, all of the components listed below have man pages. From these two lists you know what components exist, -and you can use `man n name` to get additional information. +and you can use 'man n name' to get additional information. To view the information in the man page, in a terminal window type: -*man axis* (or perhaps *man 1 axis* if your system requires it.) - -*axis* = AXIS EMC (The Enhanced Machine Controller) Graphical User Interface. + -*axis-remote* = AXIS Remote Interface. + -*comp* = Build, compile and install EMC HAL components. + -*emc* = EMC (The Enhanced Machine Controller). + -*gladevcp* = Virtual Control Panel for EMC2 based on Glade, Gtk and HAL widgets. + -*gs2* = HAL userspace component for Automation Direct GS2 VFD's. + -*halcmd* = Manipulate the Enhanced Machine Controller HAL from the command line. + -*hal_input* = Control HAL pins with any Linux input device, including USB HID devices. + -*halmeter* = Observe HAL pins, signals, and parameters. + -*halrun* = Manipulate the Enhanced Machine Controller HAL from the command line. + -*halsampler* = Sample data from HAL in realtime. + -*halstreamer* = Stream file data into HAL in real time. + -*halui* = Observe HAL pins and command EMC through NML. + -*io* = Accepts NML I/O commands, interacts with HAL in userspace. + -*iocontrol* = Accepts NML I/O commands, interacts with HAL in userspace. + -*pyvcp* = Virtual Control Panel for EMC2. + -*shuttlexpress* = control HAL pins with the ShuttleXpress device made by Contour Design. + +---- +man axis (or perhaps 'man 1 axis' if your system requires it.) +---- +[horizontal] +axis:: AXIS EMC (The Enhanced Machine Controller) Graphical User Interface. +axis-remote:: AXIS Remote Interface. +comp:: Build, compile and install EMC HAL components. +emc:: EMC (The Enhanced Machine Controller). +gladevcp:: Virtual Control Panel for EMC2 based on Glade, Gtk and HAL widgets. +gs2:: HAL userspace component for Automation Direct GS2 VFD's. +halcmd:: Manipulate the Enhanced Machine Controller HAL from the command line. +hal_input:: Control HAL pins with any Linux input device, including USB HID devices. +halmeter:: Observe HAL pins, signals, and parameters. +halrun:: Manipulate the Enhanced Machine Controller HAL from the command line. +halsampler:: Sample data from HAL in realtime. +halstreamer:: Stream file data into HAL in real time. +halui:: Observe HAL pins and command EMC through NML. +io:: Accepts NML I/O commands, interacts with HAL in userspace. +iocontrol:: Accepts NML I/O commands, interacts with HAL in userspace. +pyvcp:: Virtual Control Panel for EMC2. +shuttlexpress:: control HAL pins with the ShuttleXpress device made by Contour Design. == Realtime Components[[sec:Realtime-Components]] Some of these will have expanded descriptions from the man pages. Some will have limited descriptions. All of the components have man pages. -From this list you know what components exist and can use `man n name` to +From this list you know what components exist and can use 'man n name' to get additional information in a terminal window. -=== abs (((abs))) - -Compute the absolute value and sign of the input signal. - -=== and2 (((and2))) - -Two-input AND gate. For out to be true both inputs must be true. - -=== at_pid (((at_pid))) - -Proportional/integral/derivative controller with auto tuning. - -=== axis (((axis))) - -Accepts NML motion commands, interacts with HAL in realtime. - -=== biquad (((biquad))) - -Biquad IIR filter - -=== bldc_hall3 (((bldc_hall3))) - -3-wire Bipolar trapezoidal commutation BLDC motor driver using Hall sensors. - -=== blend (((blend))) - -Perform linear interpolation between two values. - -=== charge_pump (((charge_pump))) - -Create a square-wave for the "charge pump" input of some controller boards. - -=== clarke2 (((clarke2))) - -Two input version of Clarke transform. - -=== clarke3 (((clarke3))) - -Clarke (3 phase to cartesian) transform. - -=== clarkeinv (((clarkeinv))) - -Inverse Clarke transform. - -=== classicladder (((classicladder))) - -Realtime software PLC based on ladder logic. See Classic Ladder manual for more information. - -=== comp (((comp))) - -Two input comparator with hysteresis. - -=== constant (((constant))) - -Use a parameter to set the value of a pin. +[horizontal] +abs:: (((abs)))Compute the absolute value and sign of the input signal. -=== conv_bit_s32 (((conv_bit_s32))) +and2:: (((and2)))Two-input AND gate. For out to be true both inputs must be true. -Convert a value from bit to s32. |