Skip to content

Commit c735427

Browse files
committed
Updated readme.
1 parent 6326f80 commit c735427

File tree

1 file changed

+32
-3
lines changed

1 file changed

+32
-3
lines changed

README.md

Lines changed: 32 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,35 @@ Under development. Based on [LinuxCNC specification](http://linuxcnc.org/docs/2.
3535
| $364 - Ok High Voltage | - | This sets the voltage threshold below which Arc OK signal is valid.|
3636
| $365 - Ok Low Voltage | - | This sets the voltage threshold above which the Arc OK signal is valid.|
3737

38-
#### Supported M-Codes
38+
#### Auxiliary I/O
39+
40+
| Setting | Description |
41+
|-------------------------|-------------|
42+
| $366 - Arc voltage port | This sets which analog input port to use for the arc voltage signal. Set to -1 to not use any.<sup>1</sup> |
43+
| $367 - Arc ok port | This sets which digital input port to use for the arc ok signal. Set to -1 to not use any.<sup>2</sup> |
44+
| $368 - Cutter down port | This sets which digital input port to use for the cutter down signal. Set to -1 to not use any. |
45+
| $369 - Cutter up port | This sets which digital input port to use for the cutter up signal. Set to -1 to not use any. |
46+
47+
<sup>1</sup> This pin/port is required to enable voltage controlled THC.
48+
<sup>2</sup> This pin/port is required to enable the plugin.
49+
50+
Tip: use the `$PINS` command to list available pins. The port number is the number following the "_Aux in_" text, an example: `[PIN:P3.2,Aux in 0,P0]`.
51+
52+
#### $674 - Plugin options
53+
54+
| Bit | Value |Description |
55+
|-----|-------|------------|
56+
| 0 | 1 | Enable virtual ports. |
57+
| 1 | 2 | Sync Z position. Update the Z position when THC control ends. |
58+
59+
Add the _Value_ fields for the functionality to enable to get the one to use for the setting.
60+
61+
> [!NOTE]
62+
> Virtual ports will shadow any real ports with the same port number. Some dummy ports may also be added.
63+
64+
#### Virtual ports
65+
66+
Virtual ports are controlled by regular M-Codes.
3967

4068
* `M62 P2` will disable THC \(Synchronized with Motion\)
4169

@@ -56,11 +84,12 @@ The maximum percentage allowed is 100%, values above this will be set to 100%.
5684

5785
#### Dependencies:
5886

59-
Driver must support a number of [ioports ports](../../templates/ioports.c).
87+
Driver must support a number of auxiliary I/O ports, at least one digital input for the arc ok signal.
88+
Some drivers support the MCP3221 I2C ADC, when enabled it can be used for the arc voltage signal.
6089

6190
#### Credits:
6291

6392
LinuxCNC documentation linked to above.
6493

6594
---
66-
2021-08-10
95+
2024-01-26

0 commit comments

Comments
 (0)