CL-Softwares
/
telegraf
8
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update opcua readme (#8075)

This commit is contained in:
Samantha Wang 2020-09-03 14:37:42 -07:00 committed by GitHub
parent b1bce91345
commit f4e5b0ef63
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 49 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

98
plugins/inputs/opcua/README.md
View File

@ -1,74 +1,74 @@
# Telegraf Input Plugin: opcua_client
# OPC UA Client Input Plugin
The opcua_client plugin retrieves data from OPCUA slave devices
The `opcua` plugin retrieves data from OPC UA client devices.
Telegraf minimum version: Telegraf 1.16
Plugin minimum tested version: 1.16
### Configuration:
```toml
# ## Connection Configuration
# ##
# ## The plugin supports connections to PLCs via OPCUA
# ##
# ## Device name
name = "opcua_rocks"
[[inputs.opcua]]
## This plugin supports connections to PLCs via OPC UA.
##
## Device name
name = "localhost"
#
# # OPC UA Endpoint URL
endpoint = "opc.tcp://opcua.rocks:4840"
## OPC UA Endpoint URL
endpoint = "opc.tcp://localhost:4840"
#
# ## Read Timeout
# ## add an arbitrary timeout (seconds) to demonstrate how to stop a subscription
# ## with a context.
## Read Timeout. Add an arbitrary timeout (seconds) to demonstrate how to stop a subscription with a context.
timeout = 30
#
# # Time Inteval, default = 10s
time_interval = "5s"
## Time Interval (Default = 10s)
time_interval = "10s"
#
# # Security policy: None, Basic128Rsa15, Basic256, Basic256Sha256. Default: auto
## Security policy: None, Basic128Rsa15, Basic256, Basic256Sha256.
security_policy = "None"
#
# # Security mode: None, Sign, SignAndEncrypt. Default: auto
## Security mode: None, Sign, SignAndEncrypt.
security_mode = "None"
#
# # Path to cert.pem. Required for security mode/policy != None. If cert path is not supplied, self-signed cert and key will be generated.
# # certificate = "/etc/telegraf/cert.pem"
## Path to cert.pem. Required for security mode/policy != None. If cert path is not supplied, self-signed cert and key will be generated.
## certificate = "/etc/telegraf/cert.pem"
#
# # Path to private key.pem. Required for security mode/policy != None. If key path is not supplied, self-signed cert and key will be generated.
# # private_key = "/etc/telegraf/key.pem"
## Path to private key.pem. Required for security mode/policy != None. If key path is not supplied, self-signed cert and key will be generated.
## private_key = "/etc/telegraf/key.pem"
#
# # To authenticate using a specific ID, select chosen method from 'Certificate' or 'UserName'. Else use 'Anonymous.' Defaults to 'Anonymous' if not provided.
# # auth_method = "Anonymous"
## To authenticate using a specific ID, select 'Certificate' or 'UserName'. Default is "Anonymous"
## auth_method = "Anonymous"
#
# # Required for auth_method = "UserName"
# # username = "myusername"
## Required for auth_method = "UserName"
## username = "myusername"
#
# # Required for auth_method = "UserName"
# # password = "mypassword"
## Required for auth_method = "UserName"
## password = "mypassword"
#
# ## Measurements
# ## node id to subscribe to
# ## name - the variable name
# ## namespace - integer value 0 thru 3
# ## identifier_type - s=string, i=numeric, g=guid, b=opaque
# ## identifier - tag as shown in opcua browser
# ## data_type - boolean, byte, short, int, uint, uint16, int16, uint32, int32, float, double, string, datetime, number
# ## Template - {name="", namespace="", identifier_type="", identifier="", data_type="", description=""},
## Node ID configuration
## name - the variable name
## namespace - integer value 0 thru 3
## identifier_type - s=string, i=numeric, g=guid, b=opaque
## identifier - tag as shown in opcua browser
## data_type - boolean, byte, short, int, uint, uint16, int16, uint32, int32, float, double, string, datetime, number
## Example: {name="ProductUri", namespace="0", identifier_type="i", identifier="2262", data_type="string", description="http://open62541.org"}
nodes = [
{name="ProductName", namespace="0", identifier_type="i", identifier="2261", data_type="string", description="open62541 OPC UA Server"},
{name="ProductUri", namespace="0", identifier_type="i", identifier="2262", data_type="string", description="http://open62541.org"},
{name="ManufacturerName", namespace="0", identifier_type="i", identifier="2263", data_type="string", description="open62541"},
{name="", namespace="", identifier_type="", identifier="", data_type="", description=""},
{name="", namespace="", identifier_type="", identifier="", data_type="", description=""},
]
## Guide:
## An OPC UA node ID may resemble: "n=3,s=Temperature"
## In this example, n=3 is indicating the namespace is '3'.
## s=Temperature is indicting that the identifier type is a 'string' and the indentifier value is 'Temperature'
## This temperature node may have a current value of 79.0, which would possibly make the value a 'float'.
## To gather data from this node you would need to enter the following line into 'nodes' property above:
## {name="SomeLabel", namespace="3", identifier_type="s", identifier="Temperature", data_type="float", description="Some description."},
```
### Example Output:
### Example Node Configuration
An OPC UA node ID may resemble: "n=3,s=Temperature". In this example:
- n=3 is indicating the `namespace` is 3
- s=Temperature is indicting that the `identifier_type` is a string and `identifier` value is 'Temperature'
- This example temperature node has a value of 79.0, which makes the `data_type` a 'float'.
To gather data from this node enter the following line into the 'nodes' property above:
```
{name="LabelName", namespace="3", identifier_type="s", identifier="Temperature", data_type="float", description="Description of node"},
```
### Example Output
```
opcua,host=3c70aee0901e,name=Random,type=double Random=0.018158170305814902 1597820490000000000