mb2hal: updated and fixed sample configuration

Author: hansu

src/hal/user_comps/mb2hal/mb2hal_HOWTO.ini

@@ -5,14 +5,17 @@
 #Using HAL_MODULE_NAME=mb2hal or nothing (default): loadusr -W mb2hal config=config_file.ini
 #Using HAL_MODULE_NAME=mymodule: loadusr -Wn mymodule mb2hal config=config_file.ini
 
-#Common section
+# ++++++++++++++++++++++++
+# Common section
+# ++++++++++++++++++++++++
 [MB2HAL_INIT]
 
 #OPTIONAL: Debug level of init and INI file parsing.
 # 0 = silent.
 # 1 = error messages (default).
 # 2 = OK confirmation messages.
 # 3 = debugging messages.
+# 4 = maximum debugging messages (only in transactions).
 INIT_DEBUG=3
 
 #OPTIONAL: HAL module (component) name. Defaults to "mb2hal".
@@ -26,8 +29,11 @@ HAL_MODULE_NAME=mb2hal
 SLOWDOWN=0.0
 
 #REQUIRED: The number of total Modbus transactions. There is no maximum.
-TOTAL_TRANSACTIONS=9
+TOTAL_TRANSACTIONS=7
 
+# ++++++++++++++++++++++++
+# Transactions
+# ++++++++++++++++++++++++
 #One transaction section is required per transaction, starting at 00 and counting up sequentially.
 #If there is a new link (not transaction), you must provide the REQUIRED parameters 1st time.
 #Warning: Any OPTIONAL parameter not specified are copied from the previous transaction.
@@ -84,10 +90,10 @@ MB_SLAVE_ID=1
 #REQUIRED: The first element address.
 FIRST_ELEMENT=0
 
-#REQUIRED unless PINN_NAMES is specified: The number of elements.
+#REQUIRED unless PIN_NAMES is specified: The number of elements.
 #It is an error to specify both NELEMENTS and PIN_NAMES
 #The pin names will be sequential numbers e.g mb2hal.plcin.01
-NELEMENTS=16
+#NELEMENTS=4
 
 #REQUIRED unless NELEMENTS is specified: A list of element names.
 #these names will be used for the pin names, e.g mb2hal.plcin.cycle_start
@@ -101,20 +107,25 @@ PIN_NAMES=cycle_start,stop,feed_hold
 #    fnct_06_write_single_register    (06 = 0x06)
 #    fnct_15_write_multiple_coils     (15 = 0x0F)
 #    fnct_16_write_multiple_registers (16 = 0x10)
-
-#fnct_02_read_discrete_inputs: creates boolean output HAL pins.
-#fnct_03_read_holding_registers: creates a floating point output HAL pins.
-#                           also creates a u32 output HAL pins.
-#fnct_04_read_input_registers: creates a floating point output HAL pins.
-#                         also creates a u32 output HAL pins.
-#fnct_06_write_single_register: creates a floating point input HAL pin.
-#	NELEMENTS needs to be 1 or PIN_NAMES must contain just one name
-#fnct_15_write_multiple_coils: creates boolean input HAL pins.
-#fnct_16_write_multiple_registers: creates a floating point input HAL pins.
-
-#The pins are named based on component name, transaction number and order number.
-#Example: mb2hal.00.01 (transaction=00, second register=01 (00 is the first one))
-
+#
+# Created pins:
+# fnct_02_read_discrete_inputs:
+#     mb2hal.m.n         (bit out)
+# fnct_03_read_holding_registers:
+# fnct_04_read_input_registers:
+#     mb2hal.m.n.float   (float out)
+#     mb2hal.m.n.int     (s32 out)
+# fnct_06_write_single_register:
+#     mb2hal.m.n         (float in)
+#     NELEMENTS needs to be 1 or PIN_NAMES must contain just one name.
+# fnct_15_write_multiple_coils:
+#     mb2hal.m.n         (bit in)
+# fnct_16_write_multiple_registers:
+#     mb2hal.m.n         (float in)
+#
+# m = HAL_TX_NAME or transaction number if not set, n = element number (NELEMENTS) or name from PIN_NAMES
+# Example: mb2hal.00.01.<type> (transaction=00, second register=01 (00 is the first one))
+#          mb2hal.TxName.01.<type> (HAL_TX_NAME=TxName, second register=01 (00 is the first one))
 MB_TX_CODE=fnct_03_read_holding_registers
 
 #OPTIONAL: Response timeout for this transaction. In INTEGER ms. Defaults to 500 ms.
@@ -127,9 +138,9 @@ MB_BYTE_TIMEOUT_MS=500
 
 #OPTIONAL: Instead of giving the transaction number, use a name.
 #Example: mb2hal.00.01 could become mb2hal.plcin.01
-#The name must not exceed 32 characters.
+#The name must not exceed 28 characters.
 #NOTE: when using names be careful that you dont end up with two transactions
-#usign the same name.
+#using the same name.
 HAL_TX_NAME=remoteIOcfg
 
 #OPTIONAL: Maximum update rate in HZ. Defaults to 0.0 (0.0 = as soon as available = infinit).
@@ -147,7 +158,7 @@ DEBUG=1
 #ILLEGAL_FUNCTION        -0x01 the FUNCTION code received in the query is not allowed or invalid.
 #ILLEGAL_DATA_ADDRESS    -0x02 the DATA ADDRESS received in the query is not an allowable address for the slave or is invalid.
 #ILLEGAL_DATA_VALUE      -0x03 a VALUE contained in the data query field is not an allowable value or is invalid.
-#SLAVE_DEVICE_FAILURE    -0x04 SLAVE (or MASTER) device unrecoverable FAILUER while attemping to perform the requested action.
+#SLAVE_DEVICE_FAILURE    -0x04 SLAVE (or MASTER) device unrecoverable FAILURE while attempting to perform the requested action.
 #SERVER_FAILURE          -0x04 (see above).
 #ACKNOWLEDGE             -0x05 This response is returned to PREVENT A TIMEOUT in the master.
 #                              A long duration of time is required to process the request in the slave.
@@ -167,16 +178,15 @@ DEBUG=1
 
 [TRANSACTION_01]
 MB_TX_CODE=fnct_02_read_discrete_inputs
-FIRST_ELEMENT=1024
-NELEMENTS=24
-HAL_TX_NAME=remoteIOin
+FIRST_ELEMENT=1280
+NELEMENTS=8
+HAL_TX_NAME=readStatus
 MAX_UPDATE_RATE=0.0
-DEBUG=1
 
 [TRANSACTION_02]
 MB_TX_CODE=fnct_15_write_multiple_coils
-FIRST_ELEMENT=1280
-NELEMENTS=8
+FIRST_ELEMENT=150
+NELEMENTS=10
 HAL_TX_NAME=remoteIOout
 MAX_UPDATE_RATE=0.0
 
@@ -197,37 +207,25 @@ MAX_UPDATE_RATE=0.0
 DEBUG=1
 
 [TRANSACTION_04]
-MB_TX_CODE=fnct_03_read_holding_registers
-FIRST_ELEMENT=4
+MB_TX_CODE=fnct_04_read_input_registers
+FIRST_ELEMENT=12
 NELEMENTS=3
 HAL_TX_NAME=XDrive02
-MAX_UPDATE_RATE=0.0
+MAX_UPDATE_RATE=10.0
 DEBUG=1
 
 [TRANSACTION_05]
-MB_TX_CODE=fnct_03_read_holding_registers
-FIRST_ELEMENT=9
+MB_TX_CODE=fnct_06_write_single_register
+FIRST_ELEMENT=20
 NELEMENTS=1
 HAL_TX_NAME=XDrive03
 MAX_UPDATE_RATE=0.0
+DEBUG=1
 
 [TRANSACTION_06]
-MB_TX_CODE=fnct_03_read_holding_registers
-FIRST_ELEMENT=1024
-NELEMENTS=1
+MB_TX_CODE=fnct_16_write_multiple_registers
+FIRST_ELEMENT=55
+NELEMENTS=8
 HAL_TX_NAME=XDrive04
-MAX_UPDATE_RATE=0.0
-
-[TRANSACTION_07]
-MB_TX_CODE=fnct_03_read_holding_registers
-FIRST_ELEMENT=1030
-NELEMENTS=2
-HAL_TX_NAME=XDrive05
-MAX_UPDATE_RATE=0.0
-
-[TRANSACTION_08]
-MB_TX_CODE=fnct_03_read_holding_registers
-FIRST_ELEMENT=1033
-NELEMENTS=1
-HAL_TX_NAME=XDrive06
-MAX_UPDATE_RATE=0.0
+MAX_UPDATE_RATE=10.0
+DEBUG=1