Skip to content

docs: Update man1 pages to reflect the HAL API changes. #4597

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
grandixximo merged 1 commit into from
Sep 29, 2026
+597 −588
Merged

docs: Update man1 pages to reflect the HAL API changes. #4597

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 26 additions & 26 deletions docs/src/man/man1/gs2_vfd.1.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,87 +66,87 @@ and writes to the GS2 via a modbus connection.

== PINS

<name>.DC-bus-volts (float, out)::
<name>.DC-bus-volts (real, out)::
from the VFD

<name>.at-speed (bit, out)::
<name>.at-speed (bool, out)::
when drive is at commanded speed

<name>.err-reset (bit, in)::
<name>.err-reset (bool, in)::
reset errors sent to VFD

<name>.firmware-revision (s32, out)::
<name>.firmware-revision (sint, out)::
from the VFD

<name>.frequency-command (float, out)::
<name>.frequency-command (real, out)::
from the VFD

<name>.frequency-out (float, out)::
<name>.frequency-out (real, out)::
from the VFD

<name>.is-stopped (bit, out)::
<name>.is-stopped (bool, out)::
when the VFD reports 0 Hz output

<name>.load-percentage (float, out)::
<name>.load-percentage (real, out)::
from the VFD

<name>.motor-RPM (float, out)::
<name>.motor-RPM (real, out)::
from the VFD

<name>.output-current (float, out)::
<name>.output-current (real, out)::
from the VFD

<name>.output-voltage (float, out)::
<name>.output-voltage (real, out)::
from the VFD

<name>.power-factor (float, out)::
<name>.power-factor (real, out)::
from the VFD

<name>.scale-frequency (float, out)::
<name>.scale-frequency (real, out)::
from the VFD

<name>.speed-command (float, in)::
<name>.speed-command (real, in)::
speed sent to VFD in RPM. It is an error to send a speed faster than
the Motor Max RPM as set in the VFD.

<name>.spindle-fwd (bit, in)::
<name>.spindle-fwd (bool, in)::
1 for FWD and 0 for REV sent to VFD

<name>.spindle-on (bit, in)::
<name>.spindle-on (bool, in)::
1 for ON and 0 for OFF sent to VFD, only on when running

<name>.spindle-rev (bit, in)::
<name>.spindle-rev (bool, in)::
1 for ON and 0 for OFF, only on when running

<name>.status-1 (s32, out)::
<name>.status-1 (sint, out)::
Drive Status of the VFD (see the GS2 manual)

<name>.status-2 (s32, out)::
<name>.status-2 (sint, out)::
Drive Status of the VFD (see the GS2 manual) Note that the value is a
sum of all the bits that are on. So a 163 which means the drive is in
the run mode is the sum of 3 (run) + 32 (freq set by serial) + 128
(operation set by serial).

== PARAMETERS

<name>.error-count (s32, RW)::
<name>.error-count (sint, RW)::

<name>.loop-time (float, RW)::
<name>.loop-time (real, RW)::
how often the modbus is polled (default 0.1)

<name>.nameplate-HZ (float, RW)::
<name>.nameplate-HZ (real, RW)::
Nameplate Hz of motor (default 60)

<name>.nameplate-RPM (float, RW)::
<name>.nameplate-RPM (real, RW)::
Nameplate RPM of motor (default 1730)

<name>.retval (s32, RW)::
<name>.retval (sint, RW)::
the return value of an error in HAL

<name>.tolerance (float, RW)::
<name>.tolerance (real, RW)::
speed tolerance (default 0.01)

<name>.ack-delay (s32, RW)::
<name>.ack-delay (sint, RW)::
number of read/write cycles before checking at-speed (default 2)

== SEE ALSO
Expand Down
46 changes: 22 additions & 24 deletions docs/src/man/man1/hal_input.1.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,35 +71,39 @@ instance, to export keyboard LEDs to HAL without exporting keys, use

=== For buttons

**input.**_N_**.btn-**_name_ bit out
**input.**_N_**.btn-**_name_ bool out

**input.**_N_**.btn-**_name_**-not** bit out::
**input.**_N_**.btn-**_name_**-not** bool out::
Created for each button on the device.

=== For keys

**input.**_N_**.key-**_name_
**input.**_N_**.key-**_name_ bool out

**input**_N_**.key-**_name_**-not**::
**input**_N_**.key-**_name_**-not** bool out::
Created for each key on the device.

=== For absolute axes

**input.**_N_**.abs-**_name_**-counts** s32 out
**input.**_N_**.abs-**_name_**-counts** sint out

**input.**_N_**.abs-**_name_**-position** float out
**input.**_N_**.abs-**_name_**-position** real out

**input.**_N_**.abs-**_name_**-scale** parameter float rw
**input.**_N_**.abs-**_name_**-is-pos** bool out

**input.**_N_**.abs-**_name_**-offset** parameter float rw
**input.**_N_**.abs-**_name_**-is-neg** bool out

**input.**_N_**.abs-**_name_**-fuzz** parameter s32 rw
**input.**_N_**.abs-**_name_**-scale** real in

**input.**_N_**.abs-**_name_**-flat** parameter s32 rw
**input.**_N_**.abs-**_name_**-offset** real in

**input.**_N_**.abs-**_name_**-min** parameter s32 r
**input.**_N_**.abs-**_name_**-fuzz** sint in

**input.**_N_**.abs-**_name_**-max** parameter s32 r::
**input.**_N_**.abs-**_name_**-flat** sint in

**input.**_N_**.abs-**_name_**-min** parameter sint r

**input.**_N_**.abs-**_name_**-max** parameter sint r::
Created for each absolute axis on the device.
Device positions closer than *flat* to *offset* are reported as *offset* in *counts*,
and *counts* does not change until the device position changes by at least *fuzz*.
Expand All @@ -110,19 +114,13 @@ instance, to export keyboard LEDs to HAL without exporting keys, use

=== For relative axes

**input.**_N_**.rel-**_name_**-counts** s32 out

**input.**_N_**.rel-**_name_**-position** float out

**input.**_N_**.rel-**_name_**-reset** bit in

**input.**_N_**.rel-**_name_**-scale** parameter float rw
**input.**_N_**.rel-**_name_**-counts** sint out

**input.**_N_**.rel-**_name_**-absolute** parameter s32 rw
**input.**_N_**.rel-**_name_**-position** real out

**input.**_N_**.rel-**_name_**-precision** parameter s32 rw
**input.**_N_**.rel-**_name_**-reset** bool in

**input.**_N_**.rel-**_name_**-last** parameter s32 rw::
**input.**_N_**.rel-**_name_**-scale** real in::
Created for each relative axis on the device.
As long as *reset* is true, *counts* is reset to zero regardless of any past or current axis movement.
Otherwise, *counts* increases or decreases according to the motion of the axis. *counts* is divided by position-scale to give *position*.
Expand All @@ -135,9 +133,9 @@ instance, to export keyboard LEDs to HAL without exporting keys, use

=== For LEDs

**input.**_N_**.led-**_name_ bit out
**input.**_N_**.led-**_name_ bool in

**input.**_N_**.led-**_name_**-invert** parameter bit rw::
**input.**_N_**.led-**_name_**-invert** bool in::
Created for each LED on the device.

== PERMISSIONS AND UDEV
Expand Down
8 changes: 4 additions & 4 deletions docs/src/man/man1/hal_manualtoolchange.1.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,13 @@ the tool table.

== PINS

*hal_manualtoolchange.number* s32 in::
*hal_manualtoolchange.number* sint in::
Receives last programmed T- number.
*hal_manualtoolchange.change* bit in::
*hal_manualtoolchange.change* bool in::
Receives signal to do tool change.
*hal_manualtoolchange.changed* bit out::
*hal_manualtoolchange.changed* bool out::
Signifies that the tool change is complete.
*hal_manualtoolchange.change_button* bit in::
*hal_manualtoolchange.change_button* bool in::
Pin to allow an external switch to signify that the tool change is complete.

== USAGE
Expand Down
4 changes: 2 additions & 2 deletions docs/src/man/man1/halcmd.1.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ requested component with a call to *dlopen(3)*.
(OBSOLETE - use *net* instead) (_new_ __sig__nal) Creates a new HAL
signal called _signame_ that may later be used to connect two or more
HAL component pins. _type_ is the data type of the new signal, and
must be one of "*bit*", "*s32*", "*u32*", or "*float*". Fails if a
must be one of "*bool*", "*sint*", "*uint*", or "*real*". Fails if a
signal of the same name already exists.
*delsig* _signame_::
(__del__ete __sig__nal) Deletes HAL signal _signame_. Any pins
Expand Down Expand Up @@ -266,7 +266,7 @@ If _item_ is omitted (or *all*), *save* does the equivalent of *comp*, *alias*,
'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 -t**datatype** where datatype is
the data type (e.g., 'float') in this case, the listed pins, signals,
the data type (e.g., 'real') 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.
*print* [_message_]::
Expand Down
2 changes: 2 additions & 0 deletions docs/src/man/man1/halcompile.1.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,8 @@ components.
Extra arguments passed to the C-compiler.
*--extra-link-args*=_args_::
Extra arguments passed to the linker.
*-w*,*--werror*::
Treat warnings as errors.

== DESCRIPTION

Expand Down
6 changes: 3 additions & 3 deletions docs/src/man/man1/halstreamer.1.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,10 @@ unable to keep up with even slow streaming rates.

Each line of input must match the pins that are attached to the FIFO,
for example, if the *streamer* config string was "ffbs"
then each line of input must consist of two floats, a bit, and a signed integer,
in that order and separated by whitespace. Floats must be formatted as required by *strtod*(3),
then each line of input must consist of two reals, a bool, and a signed integer,
in that order and separated by whitespace. Reals must be formatted as required by *strtod*(3),
signed and unsigned integers must be formatted as required by *strtol*(3) and *strtoul*(3),
and bits must be either '0' or '1'.
and bools must be either '0' or '1'.

Input lines that begin with '#' will be treated as comments and silently skipped.

Expand Down
Loading
Loading