Skip to content

Commit

Permalink
Corrected pin names and formatting of motion(9) man page
Browse files Browse the repository at this point in the history
The pin names for acc-cmd and vel-cmd had an incorrect joint- prefix.
Verified the correct name looking at src/emc/motion/motion.c.

In the process, fixed incorrect formatting of is-unlocked pin in manual
page to match other pins.
  • Loading branch information
petterreinholdtsen committed Jun 17, 2023
1 parent f6c36b9 commit 7645507
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions docs/man/man9/motion.9
Original file line number Diff line number Diff line change
Expand Up @@ -276,8 +276,8 @@ The velocity limit for the teleop planner
and are subject to change or removal at any time.)

.TP
\fBjoint.\fIN\fB.joint\-acc\-cmd\fR OUT FLOAT \fB(DEBUG)\fR
The joint's commanded acceleration
\fBjoint.\fIN\fB.acc\-cmd\fR OUT FLOAT \fB(DEBUG)\fR
The joint's commanded acceleration.

.TP
\fBjoint.\fIN\fB.active\fR OUT BIT \fB(DEBUG)\fR
Expand Down Expand Up @@ -362,7 +362,7 @@ TRUE if the joint is using the "free planner" and has come to a stop
Should be attached to the index\-enable pin of the joint's encoder to enable homing to index pulse

.TQ
\fBjoint.N.is\-unlocked\fR IN BIT
\fBjoint.\fIN\fB.is\-unlocked\fR IN BIT
Indicates joint is unlocked (see JOINT UNLOCK PINS).

.TP
Expand Down Expand Up @@ -432,8 +432,8 @@ TRUE if the axis is a locked joint (typically a rotary) and a move
is commanded (see JOINT UNLOCK PINS).

.TP
\fBjoint.\fIN\fB.joint\-vel\-cmd\fR OUT FLOAT \fB(DEBUG)\fR
The joint's commanded velocity
\fBjoint.\fIN\fB.vel\-cmd\fR OUT FLOAT \fB(DEBUG)\fR
The joint's commanded velocity.

.TP
\fBjoint.\fIN\fB.wheel\-jog\-active\fR OUT BIT \fB(DEBUG)\fR
Expand Down

0 comments on commit 7645507

Please sign in to comment.