Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 6 additions & 1 deletion docs/man/man1/modcompile.1
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
.\"
.TH modcompile "1" "2023-07-13" "LinuxCNC Documentation" "The Enhanced Machine Controller"
.SH NAME
modcompile \- Utility for compiling Modbus drivers
modcompile \- Utility for compiling Modbus drivers (SUPERSEDED)

.SH SYNOPSIS

Expand All @@ -35,6 +35,11 @@ modcompile \- Utility for compiling Modbus drivers
\fBmodcompile* [\fB-k\fR] [\fB-n\fR] [\fB-v\fR] module.mod ...

.SH DESCRIPTION
\fBmodcompile\fR and the mesa_modbus framework are superseded by the
\fBhm2_modbus\fR driver and \fBmesambccc\fR-compiled MBCCB files. They remain
available throughout the 2.9 series, but new configurations are encouraged to
migrate.

The \fBmodcompile\fR utility is used to compile modbus drivers that use the PktUART
interface of Mesa cards.

Expand Down
2 changes: 2 additions & 0 deletions docs/src/drivers/mesa_modbus.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@

= Mesa Modbus =

NOTE: The Mesa Modbus framework (modcompile and mesa_modbus) is superseded by the link:../man/man9/hm2_modbus.9.html[hm2_modbus] driver and mesambccc-compiled MBCCB files. It remains available throughout the 2.9 series, but new configurations are encouraged to migrate.

A framework to create custom, realtime, modbus drivers using the Mesa
PktUART component.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/index.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ function setup_page(){
<li><a href="drivers/hal_pi_gpio.html">Raspberry Pi GPIO Driver</a></li>
<li><a href="drivers/hostmot2.html">Mesa HostMot2 Driver</a></li>
<li><a href="drivers/mb2hal.html">Modbus to HAL Driver</a></li>
<li><a href="drivers/mesa_modbus.html">Modbus framework for Mesa cards</a></li>
<li><a href="drivers/mesa_modbus.html">Modbus framework for Mesa cards (superseded)</a></li>
<li><a href="drivers/mitsub-vfd.html">Mitsubishi VFD Driver</a></li>
<li><a href="drivers/motenc.html">Motenc Driver</a></li>
<li><a href="drivers/opto22.html">Opto22 Driver</a></li>
Expand Down
5 changes: 5 additions & 0 deletions src/hal/drivers/mesa-hostmot2/modbus/README.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
NOTE: The mesa_modbus framework (this directory and modcompile) is
superseded by the hm2_modbus driver and mesambccc-compiled .mbccb
files. It remains available throughout the 2.9 series, but new
configurations are encouraged to migrate.

Do not edit mesa_modbus.c (Unless you are sure that you want to, of
course).
Create a new xxxxx.mod file that describes your particular modbus device
Expand Down
5 changes: 5 additions & 0 deletions src/hal/drivers/mesa-hostmot2/modbus/modcompile.py
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,11 @@ def main():
if len(args) < 1:
raise SystemExit("No modules found (*.mod files) to compile.");

print("NOTE: modcompile and the mesa_modbus framework are superseded by the"
" hm2_modbus driver and mesambccc-compiled .mbccb files. They remain"
" available throughout the 2.9 series, but new configurations are"
" encouraged to migrate.", file=sys.stderr)

# Create a temporary directory and copy the C template into it
tempdir = tempfile.mkdtemp(prefix="modcompile")
BASE = os.path.abspath(os.path.join(os.path.dirname(sys.argv[0]), ".."))
Expand Down