Edge Gateway Modbus Adapter

Edge Gateway Home > Modbus Adapter

Modbus Protocol Connection

protocol	Enum	Connection mode of Modbus device. Allowed values are TCP and Serial. As of now only TCP is supported.
ip_address	String	Machine IP address of the Modbus connection.
port	Number	Port number of Modbus connection.
datetime_config	Object	Optional. Configuration object to read date time tag values for this connection.
datetime_tag	Object	Optional. The tag from which thing date time needs to read.

datetime_config object

text_format	String	The format in which date time values needs to be converted to string e.g. EEE, dd MMM yyyy HH mm ss.SSS z.  Refer to https://docs.oracle.com/javase/8/docs/api/java/time/format/DateTimeFormatter.html to get an idea of formatting values.
time_zone	String	The time zone in which date time values are stored
offset_ms	Number	The offset in milliseconds from which date time values should be considered. A 0 offset indicates 01 Jan 1970 00:00:00 GMT/UTC.

datetime_tag object

tag_type	Enum	Allowed values are InputRegister and HoldingRegister.
device_id	Number	Modbus device id from where data to be read.
read_count	Number	Number of bytes to be read from the date_addr or time_addr.
endian	Boolean	True value denotes big endian byte order which is default in Modbus, False value indicate little endian byte order.
date_addr	Number	Offset address of Modbus device id. This address stores number of days from offset_ms specified in datetime_config.
time_addr	Number	Offset address of Modbus device id. This address stores number of milli seconds offset from date_addr.

Modbus Read Tag

tag_id	String	Unique tag id defined in the context of the current thing_config. This is used further in metric_mappings or derived_tags or monitor_tag_ids to refer to this tag value.
tag_type	Enum	Allowed values are InputRegister, InputDiscrete, HoldingRegister and Coil. Types InputDiscrete and Coil can only hold boolean values.
val_type	Enum	Allowed values are boolean, integer, long, float, double, datetime_text and datetime_long. This indicates the type of tag value to be read from Modbus device address. In case of  tag_type InputDiscrete or Coil only boolean is considered.
device_id	Number	Modbus device id from where data to be read.
ref_addr	Number	Offset address of Modbus device id. This is applicable for val_type boolean, integer, long, float, double.
read_count	Number	Optional, Default 2. Number of bytes to be read from the ref_addr or date_addr or time_addr.
endian	Boolean	Optional, Default True. This value denotes big endian byte order which is default in Modbus, False value indicate little endian byte order. Applicable in case of tag_type InputRegister or HoldingRegister.
bit_index	Number	Optional, Default 0. Bit index used in case of boolean values read from tag_type InputDiscrete or Coil.
date_addr	Number	Offset address of Modbus device id from where date is read. This is applicable for val_type datetime_text, datetime_long. This address stores number of days from offset_ms of datetime_config value.
time_addr	Number	Offset address of Modbus device id from where time is read. This is applicable for val_type datetime_text, datetime_long. This address stores number of milli seconds offset from date_addr.

Modbus Write Tag

tag_id	String	Unique tag id defined in the context of the current thing_config. This is used in Datonis instruction json to address this Modbus tag.
tag_type	Enum	Allowed values are HoldingRegister and Coil. Type Coil can only hold boolean values.
val_type	Enum	Allowed values are boolean, integer, long, float, double. This indicates the type of tag value to be write to Modbus device address. In case of  tag_type Coil only boolean is considered.
device_id	Number	Modbus device id from where data to be read.
ref_addr	Number	Offset address of Modbus device id. This is applicable for val_type boolean, integer, long, float, double.
endian	Boolean	Optional, Default True. This value denotes big endian byte order which is default in Modbus, False value indicate little endian byte order. Applicable in case of tag_type InputRegister or HoldingRegister.
bit_index	Number	Optional, Default 0. Bit index used in case of boolean values read from tag_type InputDiscrete or Coil.

Read Tags Explained