Skip to content

Commit 2098a5f

Browse files
committed
qtdragon -docs: add info on hal bridge
1 parent 0d26f6f commit 2098a5f

File tree

1 file changed

+38
-1
lines changed

1 file changed

+38
-1
lines changed

docs/src/gui/qtdragon.adoc

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -433,14 +433,51 @@ These optional HAL commands will be run after QtDragon has loaded everything els
433433
You can add multiple line. Each one will be called in the order they appear. +
434434
Any HAL command can be used.
435435

436-
.Sample with typical files in INI file to load modules after the GUI is available. Adjusti these to match your actual requirements.
436+
.Sample with typical files in INI file to load modules after the GUI is available. Adjust these to match your actual requirements.
437437
[source,{ini}]
438438
----
439439
[HAL]
440440
POSTGUI_HALCMD = loadusr qtvcp test_probe
441441
POSTGUI_HALCMD = loadusr qtvcp test_led
442442
POSTGUI_HALCMD = loadusr halmeter
443443
----
444+
=== HAL Bridge
445+
Hal Bridge is similar to HALUI - it has HAL pins that communicate with QtDragon. +
446+
These pins could be used with HALUI to built a more frendly control panel. +
447+
448+
- It can report/change the current selected Axis button. +
449+
- The jog rate/increments will be reported. +
450+
- There is a cycle start and pause pin - these call the code in QtDragon rather then the motion controller. +
451+
- If there are macros defined in the INI, there will be pins available the initiate them. +
452+
453+
.Sample entry. remove '-d' to quiet debugging messages
454+
[source,{ini}]
455+
----
456+
[HAL]
457+
HALBRIDGE= hal_bridge -d
458+
----
459+
460+
.Typical HAL pins avaialble:
461+
----
462+
Component Pins:
463+
Owner Type Dir Value Name
464+
38 s32 OUT 0 base-thread.time
465+
29 bit OUT FALSE bridge.axis-x-is-selected
466+
29 bit IN FALSE bridge.axis-x-select
467+
29 bit OUT FALSE bridge.axis-y-is-selected
468+
29 bit IN FALSE bridge.axis-y-select
469+
29 bit OUT FALSE bridge.axis-z-is-selected
470+
29 bit IN FALSE bridge.axis-z-select
471+
29 bit IN FALSE bridge.cycle-pause-in
472+
29 bit IN FALSE bridge.cycle-start-in
473+
29 float OUT 0 bridge.jog-increment
474+
29 float OUT 0 bridge.jog-increment-angular
475+
29 float OUT 15 bridge.jog-rate
476+
29 float OUT 360 bridge.jog-rate-angular
477+
29 s32 OUT -1 bridge.joint-selected
478+
29 bit IN FALSE bridge.macro-cmd-MACRO0
479+
29 bit IN FALSE bridge.macro-cmd-MACRO1
480+
----
444481

445482
=== Builtin Sample Configurations
446483

0 commit comments

Comments
 (0)