Modbus Input plugin #6154

garciaolais · 2019-07-23T03:11:10Z

This adds a new input plugin for Modbus TCP/RTU protocol

closes #5412

Required for all PRs:

Signed CLA.
Associated README.md updated.
Has appropriate unit tests.

Hello da

Added a datatype to the tag so that the result can be converted to a float32 if required.

fix typo in example telegraf config

fix typo in example config in code

Allow for float32 registers

- implement convert endianness

This reverts commit ac234ee.

danielnelson · 2019-07-25T22:42:36Z

@fdamador Can you review?

Does this supersede #4623?

danielnelson · 2019-07-25T22:45:40Z

@garciaolais To get the tests running you will need to run dep ensure and commit the results.

fdamador · 2019-07-25T23:11:53Z

@fdamador Can you review?

Does this supersede #4623?

Yes, I've already reviewed his code except for the Test projects. Yes. This new commit from @garciaolais supersedes my #4623 plugin.

garciaolais · 2019-07-26T04:04:29Z

@garciaolais To get the tests running you will need to run dep ensure and commit the results.

Done 👍

fdamador · 2019-07-27T00:01:41Z

I've ran the modbust_test.go project and it covers about 77.5% of the code. I'll get some further test code added so that we can get this up to 100%. Will review over the weekend.

garciaolais · 2020-01-26T02:21:16Z

We recently switched to using Go modules instead of dep, you can upgrade by removing Gopkg.lock and Gopkg.toml and then running make && make check, this should modify go.mod and go.sum and you should be good.

Hi

Do I need additional steps?

Maybe update my Makefile or something else.

Because if I remove the Gopkg.* files I get this error...

could not find project Gopkg.toml, use dep init to initiate a manifest

fdamador · 2020-01-26T18:35:58Z

Perhaps this will help https://itiskj.hatenablog.com/entry/2018/08/30/101017 fdamador Sent from XFINITY Connect Mobile App

------ Original Message ------ From: Antonio Garcia To: influxdata/telegraf Cc: fdamador, Mention

Sent: January 25, 2020 at 6:21 PM Subject: Re: [influxdata/telegraf] Modbus Input plugin (#6154) We recently switched to using Go modules instead of dep, you can upgrade by removing Gopkg.lock and Gopkg.toml and then running make && make check, this should modify go.mod and go.sum and you should be good.

Hi Do I need additional steps? Maybe update my Makefile or something else. Because if I remove the Gopkg.* files I get this error... could not find project Gopkg.toml, use dep init to initiate a manifest — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub (#6154?email_source=notifications&email_token=AAMWYEP2PMQFVQ76TZ6LNDTQ7TXRZA5CNFSM4IF7NJAKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEJ5KFJI#issuecomment-578462373), or unsubscribe (https://github.com/notifications/unsubscribe-auth/AAMWYEJG2EKU67XRQPHXJ33Q7TXRZANCNFSM4IF7NJAA).

danielnelson · 2020-01-28T07:22:26Z

@garciaolais Thanks for bearing with me during this transition, perhaps it will help if you merge the master branch? If that's not all there is to it, do you mind if I push to your branch and fix it?

garciaolais · 2020-01-28T13:38:41Z

@garciaolais If that's not all there is to it, do you mind if I push to your branch and fix it?

@danielnelson any help is highly appreciated 👍

serrj-sv · 2020-02-07T17:20:16Z

Is it possible to make a conversion to FLOAT32 more neat?
Using latest nightly, with following config
holding_registers = [ { name = "active_power", byte_order = "ABCD", data_type = "FLOAT32", scale=0.01, address = [50536,50537]}, ]
I get following result:
> modbus,host=influx,name=mon1.pdr1,type=holding_register active_power=99.72999572753906 1581094677000000000
Note amount of digits after point

serrj-sv · 2020-02-07T18:19:34Z

Found one more issue: if host associated with input plugin is down it prevents telegraf service from starting. Service goes into loop with following message:
E! [telegraf] Error running agent: could not initialize input inputs.modbus: dial tcp 10.0.4.70:502: i/o timeout
This one seems related to 3723

danielnelson · 2020-02-07T19:05:56Z

On the float noise, we probably can't improve upon it. Could be interesting to see what value you get if you set the data type to UINT32 with no scale (just to look at the raw value). One thing that could possilby be done is a manual setting for precision and we could round the value. In most cases I would recommend handling this in the tool you are using to display the value.

@garciaolais For the initialization issue, would we be able to remove the connect function out of the Init function?

serrj-sv · 2020-02-07T19:15:13Z

Could be interesting to see what value you get if you set the data type to UINT32 with no scale (just to look at the raw value).

UINT32 (1.0) => FLOAT32 (0.01)
9928 => 99.27999877929688
9979 => 99.79000091552734
9930 => 99.29999542236328
9923 => 99.22999572753906
9917 => 99.16999816894531
9892 => 98.91999816894531

danielnelson · 2020-02-07T22:27:42Z

Oh, yes we can fix this, we just need to convert to float64 before we apply the scale.

garciaolais · 2020-02-09T01:21:14Z

Hi

@danielnelson @serrj-sv

Today I worked in these two issues PR-7002

@serrj-sv If you have a chance please test it 👍

serrj-sv · 2020-02-09T13:59:11Z

@garciaolais
Just tested:

connection issue seems fixed. I'll monitor how it works
for float conversion I get mixed result:
1581256130000000000 95.33
1581256140000000000 95.55
1581256150000000000 95.97
1581256160000000000 96.15
1581256170000000000 96.75
1581256180000000000 96.82000000000001
1581256190000000000 97.18
1581256200000000000 96.94
1581256210000000000 96.24000000000001
1581256220000000000 96.32000000000001
1581256230000000000 95.76
1581256240000000000 95.48
1581256250000000000 95.63
1581256260000000000 95.83
1581256270000000000 96
1581256280000000000 94.79
1581256290000000000 94.63
Not an issue but rather suggestion/feature request: possibility to specify multiple hosts per "input" config section (for cases when you collect data from multiple SIMILAR devices). The way it works with inouts.snmp, for example

garciaolais · 2020-02-09T18:05:08Z

for float conversion I get mixed result:
1581256130000000000 95.33
1581256140000000000 95.55
1581256150000000000 95.97
1581256160000000000 96.15
1581256170000000000 96.75
1581256180000000000 96.82000000000001
1581256190000000000 97.18
1581256200000000000 96.94
1581256210000000000 96.24000000000001
1581256220000000000 96.32000000000001
1581256230000000000 95.76
1581256240000000000 95.48
1581256250000000000 95.63
1581256260000000000 95.83
1581256270000000000 96
1581256280000000000 94.79
1581256290000000000 94.63

@serrj-sv Thanks for your feedback. I think the conversion its the normal result, please check the next example -> float64-golang

and this post -> why-am-i-losing-precision-while-converting-float32-to-float64

fbergroth · 2020-02-10T08:39:26Z

Hi, maybe I'm missing something, but is scale enough for input registers?

I have signals where the values needs to be remapped to a certain range, say [-50, 150], so I would need a way to specify an offset as well (or ideally just (min, max)).`

danielnelson · 2020-02-10T23:25:00Z

@fbergroth Can you open a new feature request?

fbergroth · 2020-02-11T10:35:16Z

@danielnelson Sure: #7009

ToM-MaS · 2020-05-09T00:06:24Z

Hello everyone,
for testing I use a public demo device of a manufacturer.

The manufacturers manual shows this for the Modbus adress list:

Address	Format 	RD/WR 	Unit	Comment
19000 	FLOAT 	RD 	V 	Voltage L1-N
19002 	FLOAT 	RD 	V 	Voltage L2-N
19004 	FLOAT 	RD 	V 	Voltage L3-N
19006 	FLOAT 	RD 	V 	Voltage L1-L2
19008 	FLOAT 	RD 	V 	Voltage L2-L3
19010 	FLOAT 	RD 	V 	Voltage L1-L3

I have configured in telegraf.conf:

[[inputs.modbus]]
  name = "Device_UMG604"
  slave_id = 1

  ## Timeout for each request
  timeout = "1s"

  # TCP - connect via Modbus/TCP
  controller = "t<delete_this>cp:/<delete_this>/umg<delete_this>604.jani<delete_this>tza.de:5<delete_this>02"
 
 input_registers = [
    { name = "Voltage L1-N (V)",   byte_order = "ABCD",   data_type = "FLOAT32",   scale=1.0,     address = [19000,19001]},
  ]

When I click together a query in Chronograph (and modify the query as shown below), the left scale of the graph shows as values: 1.13e+9 Volt or 1.13B Volt. Expected would be something around 230.0 Volt (float value).

SELECT "Voltage L1-N (V)" AS "Voltage L1-N (V)" FROM "telegraf"."autogen"."modbus" WHERE time > :dashboardTime: AND time < :upperDashboardTime: AND "name"='Device_UMG604'

So I had it exported as CSV. It looks like this:

"time","modbus.Voltage L1-N (V)"
"2020-04-26T21:38:50.000Z","1130678532"
"2020-04-26T21:38:55.000Z","1130684293"
"2020-04-26T21:39:00.000Z","1130679969"
"2020-04-26T21:39:05.000Z","1130671574"
"2020-04-26T21:39:10.000Z","1130679470"
"2020-04-26T21:39:15.000Z","1130677593"
"2020-04-26T21:39:20.000Z","1130679974"
"2020-04-26T21:39:25.000Z","1130672015"
"2020-04-26T21:39:30.000Z","1130675830"
"2020-04-26T21:39:35.000Z","1130675929"
"2020-04-26T21:39:40.000Z","1130675135"
"2020-04-26T21:39:45.000Z","1130679073"

1st question:
It seems the values in InfuxDB are integer instead of float32. Is this expected?
Where can or should I change something to get float values in Chronograph? (e.g. the value for the upper example should be around e.g. 230.0 Volt)

2nd question:
How do I set that my modbus device is queried every 100ms? From the CSV values above it seems that there is a new row each 5 seconds. Not sure where this rythm comes from, does anyone know?!

garciaolais · 2020-05-09T20:00:55Z

Hello @ToM-MaS

I can help you with your first question

1st question:
It seems the values in InfuxDB are integer instead of float32. Is this expected?
Where can or should I change something to get float values in Chronograph? (e.g. the value for the upper example should be around e.g. 230.0 Volt)

I read the documentation for your device UMG-604

Please note two things

The byte order in your device
Float values are in IEEE-754

So, I made a little test with my device

My Modbus Device

telegraf.conf

{ name = "VL1-N",byte_order = "ABCD",data_type = "FLOAT32-IEEE", scale=1.0, address = [2,1]}

modbus,host=9e88b516fd94,name=Device,type=holding_register

VL1-N= 228.78521728515625 ✨

PD. You can get the same value with different configuration for example

{ name = "VL1-N-ABCD",
byte_order = "ABCD",
data_type = "FLOAT32-IEEE",
scale=1.0,
address = [2,1]}

{ name = "VL1-N-CDAB",
byte_order = "CDAB",
data_type = "FLOAT32-IEEE",
scale=1.0,
address = [1,2]
}

ToM-MaS · 2020-05-12T17:15:27Z

Hello @garciaolais
the byte order was OK but the "data_type = "FLOAT32-IEEE"" instead of "FLOAT32" gave me sane values.
So I'm wondering where the data type FLOAT32-IEEE is documented? Are there more data types of this kind?

BTW, I solved my question about the query frequency by adding the line interval = "100ms" to the inputs.modbus section:

[[inputs.modbus]]
  ## Query interval for each request
  interval = "100ms"

garciaolais · 2020-05-12T17:40:03Z

So I'm wondering where the data type FLOAT32-IEEE is documented? Are there more data types of this kind?

Hello @ToM-MaS

Well, The device manufacturer define the datatype

You can find a lot of information about it in this link
https://en.wikipedia.org/wiki/Single-precision_floating-point_format

ToM-MaS · 2020-05-12T19:07:48Z

Hello @garciaolais,
I think I understand now what you mean. I think I understand what FLOAT32-IEEE means.

The template configuration of the modbus plugin says about supported formats:
## data_type - INT16, UINT16, INT32, UINT32, INT64, UINT64, FLOAT32, FLOAT32-IEEE (the IEEE 754 binary representation)

So "DOUBLE64" and "DOUBLE64-IEEE" or something similar is not supported?
What about "LONG64", SHORT or STRING?

It would be intersting to know what datatypes are accepted in telegraf.conf besides the ones listed above.
Are the accepted datatype formats defined by the language specification of GO or by the source code of Telegraf / InfluxDB or by something else?

garciaolais and others added 19 commits March 31, 2019 16:55

Add modbus path

2ae7064

First commit

716adff

Hello da

add space

531c86b

add modbus constraint

ac234ee

add readme

bac4a1c

Allow for float32 registers

8d1621c

Added a datatype to the tag so that the result can be converted to a float32 if required.

fix typo in example telegraf config

9d073d5

fix typo in example config in code

cd32ef7

Merge pull request #2 from gregorybrzeski/modbus-fix-typo

e1261cc

fix typo in example telegraf config

Merge pull request #3 from gregorybrzeski/modbus-fix-typo

5c175cb

fix typo in example config in code

Merge branch 'input/modbus' into patch-1

0f1849d

Merge pull request #1 from robinsheehy/patch-1

ad99edd

Allow for float32 registers

Fix datatype

9268303

- Add test

d99586e

- implement convert endianness

Remove comments

282fdb5

Clean code

cdde42e

Revert "add modbus constraint"

eb6a49b

This reverts commit ac234ee.

Merge branch 'master' into input/modbus

41e9a95

add modbus dependencies

d98b45b

danielnelson added the new plugin label Jul 24, 2019

danielnelson mentioned this pull request Jul 25, 2019

Add Modbus Input Plugin #4623

Closed

3 tasks

olais added 4 commits July 25, 2019 21:21

run dep ensure

24b253e

restore Gopkg.* and run dep ensure

6303eee

update dep version, run dep ensure

1743098

run make fmt

ddbda66

danielnelson added 2 commits January 29, 2020 00:56

Merge remote-tracking branch 'origin/master' into input/modbus

cdaadce

Update go.mod/go.sum

d007490

danielnelson approved these changes Jan 29, 2020

View reviewed changes

danielnelson merged commit 9389099 into influxdata:master Jan 29, 2020

garciaolais mentioned this pull request Feb 9, 2020

Fix float conversion and Connection issue #7002

Merged

3 tasks

fbergroth mentioned this pull request Feb 11, 2020

Support scaling modbus values to a range #7009

Closed

athoune pushed a commit to bearstech/telegraf that referenced this pull request Apr 17, 2020

Add modbus input plugin (influxdata#6154)

3149dbd

nadgobpx01 mentioned this pull request May 15, 2020

modbus FLOAT32 wrong values return #7518

Closed

idohalevi pushed a commit to idohalevi/telegraf that referenced this pull request Sep 29, 2020

Add modbus input plugin (influxdata#6154)

ce09e64

arstercz pushed a commit to arstercz/telegraf that referenced this pull request Mar 5, 2023

Add modbus input plugin (influxdata#6154)

423b6b1

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Modbus Input plugin #6154

Modbus Input plugin #6154

garciaolais commented Jul 23, 2019 •

edited by danielnelson

Loading

danielnelson commented Jul 25, 2019

danielnelson commented Jul 25, 2019

fdamador commented Jul 25, 2019

garciaolais commented Jul 26, 2019

fdamador commented Jul 27, 2019

garciaolais commented Jan 26, 2020

fdamador commented Jan 26, 2020 via email

danielnelson commented Jan 28, 2020

garciaolais commented Jan 28, 2020

serrj-sv commented Feb 7, 2020

serrj-sv commented Feb 7, 2020 •

edited

Loading

danielnelson commented Feb 7, 2020

serrj-sv commented Feb 7, 2020 •

edited

Loading

danielnelson commented Feb 7, 2020

garciaolais commented Feb 9, 2020

serrj-sv commented Feb 9, 2020 •

edited

Loading

garciaolais commented Feb 9, 2020 •

edited

Loading

fbergroth commented Feb 10, 2020

danielnelson commented Feb 10, 2020

fbergroth commented Feb 11, 2020

ToM-MaS commented May 9, 2020 •

edited

Loading

garciaolais commented May 9, 2020

ToM-MaS commented May 12, 2020 •

edited

Loading

garciaolais commented May 12, 2020

ToM-MaS commented May 12, 2020 •

edited

Loading

Modbus Input plugin #6154

Modbus Input plugin #6154

Conversation

garciaolais commented Jul 23, 2019 • edited by danielnelson Loading

Required for all PRs:

danielnelson commented Jul 25, 2019

danielnelson commented Jul 25, 2019

fdamador commented Jul 25, 2019

garciaolais commented Jul 26, 2019

fdamador commented Jul 27, 2019

garciaolais commented Jan 26, 2020

fdamador commented Jan 26, 2020 via email

danielnelson commented Jan 28, 2020

garciaolais commented Jan 28, 2020

serrj-sv commented Feb 7, 2020

serrj-sv commented Feb 7, 2020 • edited Loading

danielnelson commented Feb 7, 2020

serrj-sv commented Feb 7, 2020 • edited Loading

danielnelson commented Feb 7, 2020

garciaolais commented Feb 9, 2020

serrj-sv commented Feb 9, 2020 • edited Loading

garciaolais commented Feb 9, 2020 • edited Loading

fbergroth commented Feb 10, 2020

danielnelson commented Feb 10, 2020

fbergroth commented Feb 11, 2020

ToM-MaS commented May 9, 2020 • edited Loading

garciaolais commented May 9, 2020

VL1-N= 228.78521728515625 ✨

ToM-MaS commented May 12, 2020 • edited Loading

garciaolais commented May 12, 2020

ToM-MaS commented May 12, 2020 • edited Loading

garciaolais commented Jul 23, 2019 •

edited by danielnelson

Loading

serrj-sv commented Feb 7, 2020 •

edited

Loading

serrj-sv commented Feb 7, 2020 •

edited

Loading

serrj-sv commented Feb 9, 2020 •

edited

Loading

garciaolais commented Feb 9, 2020 •

edited

Loading

ToM-MaS commented May 9, 2020 •

edited

Loading

ToM-MaS commented May 12, 2020 •

edited

Loading

ToM-MaS commented May 12, 2020 •

edited

Loading