Skip to content

Commit b073948

Browse files
committed
mesa_modbus: Add to the docs build
1 parent 523710e commit b073948

3 files changed

Lines changed: 26 additions & 13 deletions

File tree

docs/src/Submakefile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,7 @@ DOC_SRCS_EN := \
6565
drivers/gs2.adoc \
6666
drivers/hostmot2.adoc \
6767
drivers/mb2hal.adoc \
68+
drivers/mesa_modbus.adoc \
6869
drivers/motenc.adoc \
6970
drivers/opto22.adoc \
7071
drivers/pico-ppmc.adoc \

docs/src/drivers/mesa_modbus.adoc

Lines changed: 24 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
:lang: en
2+
:toc:
23

3-
[[cha:mesa_modbusl]]
4+
[[cha:mesa_modbus]]
45

56
= Mesa Modbus =
67

@@ -11,27 +12,29 @@ There are several existing ways to control Modbus devices with LinuxCNC,
1112
and those should also be considered.
1213
They include, but are not limited to:
1314

14-
<<cha:mb2hal>>
15+
<<cha:mb2hal,MB2HAL>>
1516

1617
https://forum.linuxcnc.org/24-hal-components/38733-vfdmod-an-easy-vfd-control-over-modbus-rtu?start=0#162435[vfdmod]
1718

18-
<<cha:cl-programming>>
19+
<<cha:cl-programming,Classic Ladder>>
1920

2021
There are also several drivers for specific VFDs, for example
2122

22-
<<cha:mitsub>>
23+
<<cha:mitsub,Mitsubishi VFD>>
2324

24-
<<hy_gt_vfd>>
25+
<<cha:vfs11-vfd,Toshiba-Schneider VF-S11 VFD>>
2526

26-
<<hy_vfd>>
27+
<<cha:vfs11-vfd,Toshiba-Schneider VF-S11 VFD>>
2728

28-
<<gs2_vfd>>
29+
hy-vfd - HuangYang VFD
2930

30-
<<vfdb_vfd>>
31+
hy-gt-vfd - HuangYang GT VFD
3132

32-
<<vfs11_vfd>>
33+
gs2-vfd - Automation Direct GS2 VFD
3334

34-
<<wj200_vfd>>
35+
vfdb-vfd - Delta VFD-B VFD
36+
37+
wj200-vfd - Hitachi wj200 VFD
3538

3639
For most applications (especially the "hy" (HuangYang) VFDs which do not
3740
actually conform to true modbus) it is likely to be less work to use
@@ -152,6 +155,7 @@ system runs as fast as it can.
152155

153156
The fault codes returned in "last error" are
154157

158+
[width="90%",options="header"]
155159
|===
156160
|Code|Fault
157161
|1|Illegal Function
@@ -256,8 +260,9 @@ HAL_S32.
256260

257261
The supported Modbus command types are:
258262

259-
[cols=description, code]
263+
[width="90%",options="header"]
260264
|===
265+
|Description|Code|
261266
|Read Coils|1|
262267
|Read Discrete Inputs|2|
263268
|Read Multiple Holding Registers|3|
@@ -288,9 +293,11 @@ necessary except in the special case of the 'modcompile all' command,
288293
which will compile and install all .mod files in the current directory.
289294

290295
----
291-
./modcompile my_file.mod
296+
/modcompile my_file.mod
292297
----
298+
293299
or
300+
294301
----
295302
./modcompile all
296303
----
@@ -300,10 +307,13 @@ or
300307
----
301308
sudo apt-get install linuxcnc-uspace-dev
302309
----
310+
303311
or
312+
304313
----
305314
sudo apt-get install linuxcnc-dev
306315
----
316+
307317
if using RTAI kernel realtime.
308318

309319
Alternatively the package should be installable with the Synaptic
@@ -315,7 +325,7 @@ The Mesa serial ports have separate pins for Tx and Tx pairs. For RS422
315325
Modbus RTU communications these should be connected at the Mesa card
316326
Tx+ to Rx+ and Tx- to Rx-.
317327

318-
Nore that there are differing naming standards for Modbus pins.
328+
Note that there are differing naming standards for Modbus pins.
319329
Typically Rx+ and TX+ will connect to the B- pin on the modbus device
320330
and Rx- and Tx- will connect to the A+ pin. (ie, +/- will appear
321331
reversed.
@@ -365,3 +375,4 @@ mesaflash --device 7i96 --addr 10.10.10.10 --rpo 0x6500
365375
mesaflash --device 7i96 --addr 10.10.10.10 --rpo 0x6500
366376
----
367377

378+
// vim: set syntax=asciidoc:

docs/src/index.tmpl

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -181,6 +181,7 @@ function setup_page(){
181181
<li><a href="drivers/gs2.html">GS2 Driver</a></li>
182182
<li><a href="drivers/hostmot2.html">Mesa HostMot2 Driver</a></li>
183183
<li><a href="drivers/mb2hal.html">Modbus to HAL Driver</a></li>
184+
<li><a href="drivers/mesa_modbus.html">Modbus framework for Mesa cards</a></li>
184185
<li><a href="drivers/mitsub-vfd.html">Mitsubishi VFD Driver</a></li>
185186
<li><a href="drivers/motenc.html">Motenc Driver</a></li>
186187
<li><a href="drivers/opto22.html">Opto22 Driver</a></li>

0 commit comments

Comments
 (0)