Difference between revisions of "Edge Gateway Modbus Adapter"

From Datonis
Jump to: navigation, search
(Created page with " Edge Gateway Home > '''Modbus Adapter''' == Modbus Protocol Connection == {| class="wikitable" |protocol |Enum |Connection mode of Modbus device. Al...")
 
(Removed deprecated documentation)
 
(2 intermediate revisions by the same user not shown)
Line 14: Line 14:
 
| colspan="1" |Number
 
| colspan="1" |Number
 
| colspan="1" |Port number of Modbus connection.
 
| colspan="1" |Port number of Modbus connection.
−
|-
 
−
| colspan="1" |datetime_config
 
−
| colspan="1" |Object
 
−
| colspan="1" |Optional. Configuration object to read date time tag values for this connection.
 
−
|-
 
−
| colspan="1" |datetime_tag
 
−
| colspan="1" |Object
 
−
| colspan="1" |Optional. The tag from which thing date time needs to read.
 
 
|}
 
|}
  
−
=== datetime_config object ===
+
== Modbus Read Tag ==
 
{| class="wikitable"
 
{| class="wikitable"
−
|text_format
+
|tag_id
 
|String
 
|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. 
+
|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.
−
Refer to https://docs.oracle.com/javase/8/docs/api/java/time/format/DateTimeFormatter.html to get an idea of formatting values.
 
 
|-
 
|-
−
| colspan="1" |time_zone
 
−
| colspan="1" |String
 
−
| colspan="1" |The time zone in which date time values are stored
 
−
|-
 
−
| colspan="1" |offset_ms
 
−
| colspan="1" |Number
 
−
| colspan="1" |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 ===
 
−
{| class="wikitable"
 
 
| colspan="1" |tag_type
 
| colspan="1" |tag_type
 
| colspan="1" |Enum
 
| colspan="1" |Enum
−
| colspan="1" |Allowed values are InputRegister and HoldingRegister.
+
| colspan="1" |Allowed values are InputRegister, InputDiscrete, HoldingRegister and Coil. Types InputDiscrete and Coil can only hold boolean values.
 
|-
 
|-
−
|device_id
+
| colspan="1" |val_type
−
|Number
+
| colspan="1" |Enum
−
|Modbus device id from where data to be read.
+
| colspan="1" |Allowed values are boolean, short, integer, long, float, double. 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.
 
|-
 
|-
−
|read_count
+
| colspan="1" |device_id
−
|Number
+
| colspan="1" |Number
−
|Number of bytes to be read from the date_addr or time_addr.
+
| colspan="1" |Modbus device id from where data to be read.
 
|-
 
|-
−
|endian
+
| colspan="1" |ref_addr
−
|Boolean
+
| colspan="1" |Number
−
|True value denotes big endian byte order which is default in Modbus, False value indicate little endian byte order.
+
| colspan="1" |Offset address of Modbus device id. This is applicable for val_type boolean, short, integer, long, float, double.
 
|-
 
|-
−
| colspan="1" |date_addr
+
| colspan="1" |read_count
 
| colspan="1" |Number
 
| colspan="1" |Number
−
| colspan="1" |Offset address of Modbus device id. This address stores number of days from offset_ms specified in datetime_config.
+
| colspan="1" |Optional, Default 2. Number of bytes to be read from the ref_addr.
 +
|-
 +
| colspan="1" |endian
 +
| colspan="1" |Boolean
 +
| colspan="1" |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.
 
|-
 
|-
−
| colspan="1" |time_addr
+
| colspan="1" |bit_index
 
| colspan="1" |Number
 
| colspan="1" |Number
−
| colspan="1" |Offset address of Modbus device id. This address stores number of milli seconds offset from date_addr.
+
| colspan="1" |Optional, Default 0. Bit index used in case of boolean values read from tag_type InputDiscrete or Coil.
 
|}
 
|}
  
−
== Modbus Protocol Tag ==
+
== Modbus Write Tag ==
 
{| class="wikitable"
 
{| class="wikitable"
 
|tag_id
 
|tag_id
 
|String
 
|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.
+
|Unique tag id defined in the context of the current thing_config. This is used in Datonis instruction json to address this Modbus tag.
 
|-
 
|-
 
| colspan="1" |tag_type
 
| colspan="1" |tag_type
 
| colspan="1" |Enum
 
| colspan="1" |Enum
−
| colspan="1" |Allowed values are InputRegister, InputDiscrete, HoldingRegister and Coil. Types InputDiscrete and Coil can only hold boolean values.
+
| colspan="1" |Allowed values are HoldingRegister and Coil. Type Coil can only hold boolean values.
 
|-
 
|-
 
| colspan="1" |val_type
 
| colspan="1" |val_type
 
| colspan="1" |Enum
 
| colspan="1" |Enum
−
| colspan="1" |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 
+
| colspan="1" |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.
−
tag_type InputDiscrete or Coil only boolean is considered.
 
 
|-
 
|-
 
| colspan="1" |device_id
 
| colspan="1" |device_id
Line 88: Line 71:
 
| colspan="1" |ref_addr
 
| colspan="1" |ref_addr
 
| colspan="1" |Number
 
| colspan="1" |Number
−
| colspan="1" |Offset address of Modbus device id. This is applicable for val_type boolean, integer, long, float, double.
+
| colspan="1" |Offset address of Modbus device id. This is applicable for val_type boolean, short, integer, long, float, double.
−
|-
 
−
| colspan="1" |read_count
 
−
| colspan="1" |Number
 
−
| colspan="1" |Number of bytes to be read from the ref_addr or date_addr or time_addr.
 
 
|-
 
|-
 
| colspan="1" |endian
 
| colspan="1" |endian
 
| colspan="1" |Boolean
 
| colspan="1" |Boolean
−
| colspan="1" |True 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.
+
| colspan="1" |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.
 
|-
 
|-
 
| colspan="1" |bit_index
 
| colspan="1" |bit_index
 
| colspan="1" |Number
 
| colspan="1" |Number
−
| colspan="1" |Bit index used in case of boolean values read from tag_type InputDiscrete or Coil.
+
| colspan="1" |Optional, Default 0. Bit index used in case of boolean values read from tag_type InputDiscrete or Coil.
−
|-
 
−
| colspan="1" |date_addr
 
−
| colspan="1" |Number
 
−
| colspan="1" |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.
 
−
|-
 
−
| colspan="1" |time_addr
 
−
| colspan="1" |Number
 
−
| colspan="1" |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.
 
 
|}
 
|}
 +
 +
== Read Tags Explained ==
 +
[[File:Edge Modbus.png|1056x1056px]]
 +
 +
[[File:Edge Modbus 2.png|1056x1056px]]

Latest revision as of 09:51, 8 December 2017

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.

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, short, integer, long, float, double. 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, short, integer, long, float, double.
read_count Number Optional, Default 2. Number of bytes to be read from the ref_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.

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, short, 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

Edge Modbus.png

Edge Modbus 2.png

Retrieved from "https://docs.datonis.io/mediawiki/index.php?title=Edge_Gateway_Modbus_Adapter&oldid=520"