User Tools

Site Tools


connections

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
Next revision Both sides next revision
connections [2020/06/02 09:08]
emozolyak [Adding built-in device connections]
connections [2021/07/21 13:05]
emozolyak [Diagnostic preset registers]
Line 2: Line 2:
 The connection determines which communication driver and what parameters WebHMI will use to exchange data with the equipment. The list of the connection settings and their meaning is given in this section.  The connection determines which communication driver and what parameters WebHMI will use to exchange data with the equipment. The list of the connection settings and their meaning is given in this section. 
  
-There are 2 options to create a new connection - use the //New Connection// button on //Registers// page or use //Add device// dialog, which allows to load built-in register maps for some devices. (The latter will be explained in the end of the section.)+There are 2 options to create a new connection
 +  *Use the //New Connection// button on //Registers// page  
 +  *Use //Add device// dialog, which allows to load built-in preset register maps for some devices. (The latter will be explained in the end of the section.)
  
 {{ ::add_conn_new_1.png?direct&600 |}} {{ ::add_conn_new_1.png?direct&600 |}}
Line 9: Line 11:
 ===== Basic Info Tab ===== ===== Basic Info Tab =====
 After selecting a connection to edit, the page with **Basic info** tab is opened: After selecting a connection to edit, the page with **Basic info** tab is opened:
-{{ :conn_basic_tab_review.png?direct&600 |}}+ 
 +{{ ::new_conn_add_figures.png?direct&600 |}}
  
 The group **(1)** of settings is common for any kind of communication protocol:  The group **(1)** of settings is common for any kind of communication protocol: 
Line 16: Line 19:
   ***Serial number** - for documenting purposes, to track physical device used in this connection   ***Serial number** - for documenting purposes, to track physical device used in this connection
   ***SKU** - for documenting purposes, manufacturer model number to identify the type of device (Stock Keeping Unit)   ***SKU** - for documenting purposes, manufacturer model number to identify the type of device (Stock Keeping Unit)
-  ***Category** - grouping connections into logical groups, for organising a large list of devices.+  ***Category** - grouping connections into logical groups, for organizing a large list of devices.
   ***Device Model** - type of device and its protocol to connect to   ***Device Model** - type of device and its protocol to connect to
   ***Protocol** - more specific protocol subtype, if there are many options (like RTU/ASCII/TCP etc. )   ***Protocol** - more specific protocol subtype, if there are many options (like RTU/ASCII/TCP etc. )
Line 23: Line 26:
 The rest settings **(2)** of **Basic tab** may vary depending on type of protocol (below those ones for Modbus TCP): The rest settings **(2)** of **Basic tab** may vary depending on type of protocol (below those ones for Modbus TCP):
   ***Device address** - the address of the connected device on the network   ***Device address** - the address of the connected device on the network
-  ***Address base (offset)** - to automatically shift the register address before apllying it to the transmission telegram (for Modbus family protocols).+  ***Address base (offset)** - to automatically shift the register address before applying it to the transmission telegram (for Modbus family protocols).
   ***TCP port*** - TCP port used for the protocol   ***TCP port*** - TCP port used for the protocol
   ***Unit identificator**  - slave Id in the Modbus network. This number passes through Modbus TCP gateways to serial bus.    ***Unit identificator**  - slave Id in the Modbus network. This number passes through Modbus TCP gateways to serial bus. 
Line 36: Line 39:
  
 ==== TCP networks ==== ==== TCP networks ====
-{{ :comm_tab_for_tcp.png?direct&600 |}}+{{ ::new_conn_comm_properties.png?direct&600 |}} 
   ***Timeout**,ms - Timeout for response on the bus, ms.   ***Timeout**,ms - Timeout for response on the bus, ms.
   ***Read errors to skip scan** - System will stop trying to read connection if there will be more than X errors in requesting registers.   ***Read errors to skip scan** - System will stop trying to read connection if there will be more than X errors in requesting registers.
Line 48: Line 52:
 ==== Serial networks ==== ==== Serial networks ====
 Below only the settings unique for serial bus are explained. Please refer to previous section.  Below only the settings unique for serial bus are explained. Please refer to previous section. 
-{{ :comm_tab_for_serial.png?direct&800 |}}+ 
 +{{ ::serial_com_options_fig.png?direct&600 |}} 
 + 
   -**(1)** - these are standard serial port settings   -**(1)** - these are standard serial port settings
   -**Stabilization pause**,ms - Pause to stabilize the RS-485 bus before initiating an exchange for this connection. (Sometimes it may be necessary when operating at a high speed or on an inconsistent line, with a specific device - the end of the transmission with the previous device causes a transient process that can interfere with the line for the next device)   -**Stabilization pause**,ms - Pause to stabilize the RS-485 bus before initiating an exchange for this connection. (Sometimes it may be necessary when operating at a high speed or on an inconsistent line, with a specific device - the end of the transmission with the previous device causes a transient process that can interfere with the line for the next device)
   -**Mode** - //Normal// mode is when WebHMI polls the device. //Virtual UART// mode is when WebHMI activates special driver to enable external access to that serial port via TCP socket. Please refer for more details to [[Virtual UART]] function page.   -**Mode** - //Normal// mode is when WebHMI polls the device. //Virtual UART// mode is when WebHMI activates special driver to enable external access to that serial port via TCP socket. Please refer for more details to [[Virtual UART]] function page.
  
-===== Adding built-in device connections =====+===== Add preset device connections ===== 
 +Beginning with 4.0.4161 there is a new function ''Add device'' designed to facilitate connection between WebHMI, when using a 7bit(tm) devices. 
  
-There are built-in connections you can add in one-click from the register list tree.+There are preset connections you can add in one-click from the register list tree.
  
-{{ ::add_conn_new_2.png?direct&400 |}}+{{ ::preset_device_insert.png?direct&600 |}}
  
-This feature is available since the fw version of 4.0.4161. If some device can be nested inside another (e.g. 7bit AipPoint sensor inside 7bit AirGate MQTT connection or WebHMI Health registers inside other WebHMI internal connection) the option to create a category in that connection will be offered. +<wrap em>After the creation, you need to edit connection to finish it creation: replace default net address  
 +and enable the connection.</wrap> 
 + 
 +==== Diagnostic preset registers ==== 
 +There are also a diagnostic solution for your project included. \\  
 +It is called "WebHMI Health registers"
 + 
 +{{ ::add_health_registers.png?direct&600 |}} 
 + 
 +It is a bunch of registers, which intended to show the status of WebHMIThe logging option is turned on for them, so you can immediately analize the system behaviour in custom graphs. 
 + 
 +{{ ::health_registers_example.png?direct&600 |}} 
 + 
 +If the registers of the device being added can be nested inside another similar connection (e.g. 7bit(tm) AipPoint sensor inside 7bit(tm) AirGate MQTT connection or WebHMI Health registers inside other WebHMI internal connection) the option to create a category in that connection will be offered. 
  
 {{ ::add_device_1.png?direct&400 |}} {{ ::add_device_1.png?direct&400 |}}
  
-  Don't forget to correct the default settings for network address, port etc. after adding, because the devices are  +
-  added with default presets.+