Add modbus input plugin (#6154)

2020-01-29 04:18:58 -06:00
parent 99da6f4883
commit 9389099820
7 changed files with 1059 additions and 0 deletions
--- a/plugins/inputs/modbus/README.md
+++ b/plugins/inputs/modbus/README.md
@@ -0,0 +1,84 @@
+# Telegraf Input Plugin: Modbus
+
+The Modbus plugin collects Discrete Inputs, Coils, Input Registers and Holding Registers via Modbus TCP or Modbus RTU/ASCII
+
+### Configuration:
+
+```toml
+ ## Connection Configuration
+ ##
+ ## The module supports connections to PLCs via MODBUS/TCP or
+ ## via serial line communication in binary (RTU) or readable (ASCII) encoding
+ ##
+ ## Device name
+ name = "Device"
+ 
+ ## Slave ID - addresses a MODBUS device on the bus
+ ## Range: 0 - 255 [0 = broadcast; 248 - 255 = reserved]
+ slave_id = 1
+ 
+ ## Timeout for each request
+ timeout = "1s"
+ 
+ # TCP - connect via Modbus/TCP
+ controller = "tcp://localhost:502"
+ 
+ # Serial (RS485; RS232)
+ #controller = "file:///dev/ttyUSB0"
+ #baud_rate = 9600
+ #data_bits = 8
+ #parity = "N"
+ #stop_bits = 1
+ #transmission_mode = "RTU"
+ 
+ 
+ ## Measurements
+ ##
+ 
+ ## Digital Variables, Discrete Inputs and Coils
+ ## name    - the variable name
+ ## address - variable address
+ 
+ discrete_inputs = [
+   { name = "Start",          address = [0]},   
+   { name = "Stop",           address = [1]},
+   { name = "Reset",          address = [2]},
+   { name = "EmergencyStop",  address = [3]},
+ ]
+ coils = [
+   { name = "Motor1-Run",     address = [0]},
+   { name = "Motor1-Jog",     address = [1]},
+   { name = "Motor1-Stop",    address = [2]},
+ ] 
+ 
+ ## Analog Variables, Input Registers and Holding Registers
+ ## name       - the variable name 
+ ## byte_order - the ordering of bytes 
+ ##  |---AB, ABCD   - Big Endian
+ ##  |---BA, DCBA   - Little Endian
+ ##  |---BADC       - Mid-Big Endian
+ ##  |---CDAB       - Mid-Little Endian
+ ## data_type  - UINT16, INT16, INT32, UINT32, FLOAT32, FLOAT32-IEEE (the IEEE 754 binary representation)
+ ## scale      - the final numeric variable representation
+ ## address    - variable address
+ 
+ holding_registers = [
+   { name = "PowerFactor", byte_order = "AB",   data_type = "FLOAT32", scale=0.01,  address = [8]},
+   { name = "Voltage",     byte_order = "AB",   data_type = "FLOAT32", scale=0.1,   address = [0]},
+   { name = "Energy",      byte_order = "ABCD", data_type = "FLOAT32", scale=0.001, address = [5,6]},
+   { name = "Current",     byte_order = "ABCD", data_type = "FLOAT32", scale=0.001, address = [1,2]},
+   { name = "Frequency",   byte_order = "AB",   data_type = "FLOAT32", scale=0.1,   address = [7]},
+   { name = "Power",       byte_order = "ABCD", data_type = "FLOAT32", scale=0.1,   address = [3,4]},
+ ]
+ input_registers = [
+   { name = "TankLevel",   byte_order = "AB",   data_type = "INT16",   scale=1.0,     address = [0]},
+   { name = "TankPH",      byte_order = "AB",   data_type = "INT16",   scale=1.0,     address = [1]},
+   { name = "Pump1-Speed", byte_order = "ABCD", data_type = "INT32",   scale=1.0,     address = [3,4]},
+ ]
+```
+### Example Output:
+
+```
+$ ./telegraf -config telegraf.conf -input-filter modbus -test
+modbus.InputRegisters,host=orangepizero Current=0,Energy=0,Frecuency=60,Power=0,PowerFactor=0,Voltage=123.9000015258789 1554079521000000000
+```