Versions Compared

Old Version 1

changes.mady.by.user Paulo Tsuchiya

Saved on

compared with

New Version 2

changes.mady.by.user Paulo Tsuchiya

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Easy Heading Macro
headingIndent40
navigationTitleOn this page
selectorh2,h3
wrapNavigationTexttrue
navigationExpandOptiondisable-expand-collapse

There are 2 independent

There are 2 independent ways to use this protocol, uUsing a TagProvider or as a DeviceChannel in the Module Device.

  • TagProvider: allows to use the database addresses directly without creating any Tags nor mappings in the Project.
  • DeviceChannel: create Project Tags and map to the database addresses, allowing more control over names and data blocks. Use the Solution Import Tags to setup automatically the mapping.

This document has only the specific information about the device connection settings and its address syntax.

Refer to the User Guide for more information on the Device Module or on UNS TagProvider Connections.

On this page:

Table of Contents
maxLevel3
minLevel2
stylenone

Summary

Communication Driver Information

Driver name

InfluxDB

Assembly Name

T.ProtocolDriver.InfluxDB

Assembly Version

<< get from XML >>

Available for Linux

<< get from XML >>

Devices supported 

InfluxDB databases. << Versions ?? >>

Manufacturer

InfluxData

Protocol

Proprietary    <<<  isso ou Rest API > >>>>

PC Requirements

Ethernet port


Channels Configuration

There is no configuration settings necessary for this interface.


Nodes Configuration

PrimaryStation  or SecondaryStation

Thestationparametersare:

  • IPAddress:InfluxDBDatabaseServerAddress.Defaultvalueislocalhost.
  • Port:InfluxDBDatabaseServer PortNumber.Defaultvalueis8086.
  • ConnectionType:SpecifiestheConnectionTypewiththeDatabaseServer.Optionsare:
    1. UserCredentials:Connection willbe made usingUserNameand Passwordvalidation.
    2. Token:Connectionwillbemadeusingsecuritytokenvalidation.
  • UserName:UserName usedtoverifycredentials.Validfor UserCredentialsConnectionType.
  • Password:Passwordused toverifycredentials.ValidforUserCredentialsConnectionType.
  • Token:Tokenusedtoverifycredentials. ValidforTokenConnectionType.
  • Database:Databaseinwhichclientwillconnectto.
  • Bucket:Bucketinwhichclientwillconnectto.IfConnectionparametersarecorrectlyfilled,youshould see all buckets available in the ComboBox DropDown.
  • Organization:Organization definedforuserinInfluxDBDatabaseServer.


Note
Alwaysuse theTestbuttontoverifytheconnectionstatus.


Points Configuration

Theaddressparametersare:

  • Measurement:MeasurementinwhichTagWillbeassignedinInfluxDBTable.
    • IfPointisaProjectTagandmeasurement fieldisblank, MainTagName(Name definedin Edit → Tags>Objects)willbe used.
    • IfPointiffromTagProviderand measurement fieldisblank,ProviderName willbe used.
  • Field:FieldinwhichTagWillbeassignedinInfluxDBTable.Ifblank,TagAttibutewillbeused(element of default types, like Integer, Decimal, etc).
  • UseTemplateAsCustomColumns:FlagindicatingifTemplateswhichTagbelongstowillbeusedas Custom Columns in InfluxDB Table. Default value is true.

IfPointisfromTagProviderandCheckBoxistrue,aColumncalledTagProviderPathwillbecreated with the path leading to the TagProvider asset.

  • AdditionalCustomColumns:ListofUser-DefinedCustomColumns,separatedbycomma,tomapa variable in the Database.

Syntax: <ColumName>= <ColumnValue>

Youcanadd,removeoreditcustomcolumnsinthedialogwindowat’+’button.


Example

Toillustratetheresultofasucessfullconfigurationwewillmakethefollowingassumptions.

  • TheTagisstructured as:

Tag Structure

  • TheAddressisconfigured as:
    1. Measurement:Panel1.
    2. Field:””.[Leaveitblanksoourattributesareused].
    3. UseTemplateAsCustomColumns:true.
    4. AdditionalCustomColumns:Owner=PC1.

Thisconfiguration willresult inthe followingTable insideInfluxDB:

Table Created in InfluxDB.

Reading Data

ToReadbackthesevalues,allyouhavetodoisuseanotherTag,ofsame”Panel”Templateanduse the same Custom Column Configuration.

Working with Arrays

WhenTagAttributeisArray,anewcolumncalledArrayIndexwillbecreatedandpopulated with the indexes. An example is illustrated below:

Table Created in InfluxDB for Array Tag



Troubleshoot

The status of the driver execution can be observed through the platform built-in diagnostic tools. Refer to Devices - Using Diagnostic Tools.

<<<< Anything to add here ? >>>>>>

Driver

Revision

Revision  History

InfluxDB Driver Revision History

Version 

Notes

<<< from XML >>>>

Initial release on new documentation standards


In this section...:

Page Tree
root@parent
spaces93DRAFT