Merge pull request #1630 from hansu/docs-2.8

 Improved Modbus to Hal docs + man page (2.8)

Author: hansu

docs/man/man1/mb2hal.1

@@ -26,18 +26,67 @@
 .\"
 .\"
 .\"
-.TH mb2hal "1" "January 1, 2016" "Modbus to HAL" "LinuxCNC Documentation"
+.TH mb2hal "1" "November 20, 2021" "Modbus to HAL" "LinuxCNC Documentation"
 .SH NAME
 \fBmb2hal\fR - HAL userspace component for Modbus
 .SH SYNOPSIS
-.B mb2hal
-.RI [OPTIONS]
+.TP
+Default component name:
+loadusr -W mb2hal config=config_file.ini
+.TP
+Custom component name: 
+loadusr -Wn mymodule mb2hal config=config_file.ini
+
+
 .br
 .SH DESCRIPTION
 MB2HAL is a generic userspace HAL component to communicate with one or more
-Modbus devices.
+Modbus devices. It supoorts Modbus RTU and Modbus TCP.
+
 .PP
-See the Documents for more information on mb2hal
+See 
+.UR http://linuxcnc.org/docs/html/drivers/mb2hal.html 
+.UE
+for more information.
+
+.SH PINS
+
+.SS fnct_02_read_discrete_inputs:
+.TP
+.B mb2hal.m.n\fR bit out
+.SS fnct_03_read_holding_registers:
+.SS fnct_04_read_input_registers:
+.TP
+.B mb2hal.m.n.float\fR float out
+.TQ
+.B mb2hal.m.n.int\fR s32 out
+.SS fnct_06_write_single_register:
+.TP
+.B mb2hal.m.n\fR float in
+NELEMENTS needs to be 1 or PIN_NAMES must contain just one name.
+.SS fnct_15_write_multiple_coils:
+.TP
+.B mb2hal.m.n\fR bit in
+.SS fnct_16_write_multiple_registers:
+.TP
+.B mb2hal.m.n\fR float in
+.RE
+
+.SS Each transaction
+.TQ
+.B mb2hal.m.num_errors\fR u32 in
+Error counter
+.RE
+
+.br
+m = HAL_TX_NAME or transaction number if not set, n = element number (NELEMENTS) 
+.br
+Example: 
+.br
+mb2hal.00.01.<type> (transaction=00, second register=01 (00 is the first one))
+.br
+mb2hal.TxName.01.<type> (HAL_TX_NAME=TxName, second register=01 (00 is the first one))
+
 .SH AUTHOR
 Victor Rocco
 .SH LICENSE

docs/src/Submakefile

@@ -617,6 +617,7 @@ $(DOC_TARGETS_HTML): $(DOC_DIR)/html/%.html: $(DOC_SRCDIR)/%.html
 		mkdir -p objects/image-cache; \
 		HTML_LATEX_CACHE=objects/image-cache $(DOC_SRCDIR)/html-latex-images $$HTML_FILE || (X=$$?; rm $$HTML_FILE; exit $$X); \
 	done
+	cp -f ../src/hal/user_comps/mb2hal/mb2hal_HOWTO.ini $(DOC_DIR)/html/drivers/
 	touch $@
 
 # Define a target-specific variable called STYLES_SCRIPTS_DIR, which has