avatar  

Log out

Recently viewed tickets

Siemens S7 collector

The purpose of this article is to be a reference for Siemens S7 collector part
of the full Data Collection Module documentation

Prerequisite:

A Starter package (SiteManager + accounts) 
A Siemens S7 capable device
Other sections in DCM:



The Collectors (array of objects, mandatory ) list elements contains the following fields:
FunctionTypeImportanceDescription
CollectorNamestringmandatoryUnique name (within this confguration file) of a device to collect data from. (This is the name used in the agent configuration). Follows the normal rules for names.
CollectorDesriptionstringoptionalDescription of this collector. For your use, no system function)
CollectorIPAddrstringoptionalDefault IP address (or DNS name) for the device to be polled. The agent Target IP address will take precedence over this.
CollectorPortnointeger > 0 and < 65535optionalDefault port number for the device to be polled. The agent Target Port number will take precedence over this. If neither CollectorPortno , nor agent Target Port Number is specified, the appropriate port will be used, depending on the Protocol parameter value.
Aliasstring optionalThis is the CollectorName of another collector, from which, all the parameters (expect CollectorName , CollectorDescription , CollectorIPAddr and CollectorPortno ) are copied from. An alias cannot refer to another alias.
Protocolstring-enum mandatoryThe protocol used to collected data. Currently 3 possible values exists: "OPC-UA/TCP", "Modbus/TCP", "Http/GET" and "Simulator".
ConnectRetryMininteger > 0 mandatoryMinimum number of seconds before trying to reestablish a connection to the device being sampled. An exponential backoff algorithm is used to retry connection establishment, starting after ConnectRetryMin and increasing to ConnectRetryMax.
ConnectRetryMaxinteger > 0mandatoryMaxumin number of seconds before trying to reestablish a connection to the device being sampled.
S7AccessObjectoptionalcollection of parameters needed to access a given S7/TCP server.
SamplePointsArray of objectsmandatoryList of samples to be collected, possibly aggregated and stored in the Store'n'Forward database.

S7Access


The S7Access object contains the following elements:
FunctionTypeImportanceDescription
S7Modelstring-enummandatoryThe PLC model/typeThe supported values are "S7-200", "S7-300" and "S7-1200".
S7RackInteger >= 0 and <= 7, optionalThe Rack number for this unit. If not present, the value 0 is used.
S7SlotInteger >= 0 and <= 31optionalThe Slot number for this unit. If not present, the values 1 is used.
S7ConnectionTypestring-enumoptionalThe connection type used by this collector. The supported values are "PG", "OP" and "APP". If not present, the value "OP" is used.
S7TimeoutInteger > 0, optionalThe default timeout (in millisecond) for all S7 requests. If not present, the value 3000 is used.
S7LocalTSAPInteger >= 0 and <= 65536optionalThe local protocol TSAP value needed to access the S7 server. If not present, 256 is used.


Samplepoint items

The SamplePoints objects contains the following elements:
FunctionTypeImportanceDescription
SampleNamestringmandatoryName of this sampled value (sometimes called a tagname). Follows the normal rules for names.
SampleDescriptionstringoptionalis a text description of this sample value.
SampleUnitstringoptionalis a description of the unit of messurement for this sample.
SampleGroupstringoptionaldesignates (in some datasrvs) that all samplepoints in that group should be handled (displayed) together. The DCM system itself places no meaning on this group affiliation.
SamplesSavedinteger > 0mandatoryis the number of values collected that is saved as minimum in the Store'n'Forward database. If set to 0 the Samplepoint isn't stored in the S'n'F database and thus not delivered to cloud, but can be used for aggregations.
OnlySaveOnChangedbooloptionalcontrol if new sample values should only be saved to the store-and-forward database if the values have changed since last sample. If not set, it is false.
SampleDataTypestring-enummandatoryThe type of data collected. The possible values are: "bool" (1 bit), "sbyte" (8 bit signed), "byte" (8 bit unsigned), "int16" (16 bit signed), "uint16" (16 bit unsigned), "int32" (32 signed), "uint32" (32 bit unsigned), "int64" (64 bit signed), "uint64" (64 bit unsigned), "float" (32 bit), "double" (64 bit), "string" (variable text up to 24575 bytes. Includes terminating NUL), "data" (variable variable data up to 24575 bytes).
SampleLowerLimitinteger/doubleoptionalThe lower limit for the collected data. If the collected data value is less than SampleLowerLimit it is evaluated inaccordance to SampleLimitDiscard and SampleLimitAlarm.
SampleUpperLimitinteger/doubleoptionalThe upper limit for the collected data. If the collected data value is more than SampleUpperLimit it is evaluated inaccordance to SampleLimitDiscard and SampleLimitAlarm.
SampleLimitDiscardboolmaybe-optionalControls if a sample limit violation results in the sample value being discarded. Mandatory if either SampleLowerLimit or SampleUpperLimit is present.
SampleLimitAlarmboolmaybe-optionalControls if a sample limit violation generates an alarm. Mandatory if either SampleLowerLimit or SampleUpperLimit is present.
S7VarObjectmaybe-optionalDescription of how to address a specific datavalue from an S7 server. Mandatory of the protocol type is "S7/TCP".



S7Var

The S7Var object contains the following fields:
FunctionTypeImportanceDescription
S7PLCVarStringmandatory)This is absolute address of an S7 PLC variable using the S7 international syntax.
S7SampleIntervalinteger >= 0mandatoryThe number of seconds between each sample of this S7 variable. If the interval is 0, only eventdriven polling is used.
S7TimeoutInteger > 0optionalTimeout (in millisecs) for reading this S7 variable. If not present, the S7Timeout value from S7Access is used.
The S7 PLC variable absolute address syntax is as follow:

AREA[DBNO][TYPE]BYTEOFFSET[.BITPOS].

Here AREA can one of the following strings:
• "I" or "E" for Digital input.
• "Q" or "A" for Digital output.
• "AI" or "AE" for Analog input.
• "AQ" or "AA" for Analog output.
• "M" for internal memory.
• "SM" for special memory. (Only for S7-200).
• "DB" for data block.
• "DI" for indirect data block.
• "L" for local variables (Corresponds to DB2 area).
• "V" for global variables (Corresponds to DB1 area).
• "C" or "Z" for counters (For S7-200 this is the IEC Counter type).
• "T" for timers (For S7-200 this is the IEC Timer type).
while DBNO is only used if AREA is "DB" or "DI".
TYPE can be one of the following strings:
• "B" for byte (unsigned 8bit value)
• "C" for char (signed 8bit value)
• "W" for word (unsigned 16bit value)
• "WI" or "WINT" for word (signed 16bit value)
• "D" for doubleword (unsigned 32bit value)
• "DI" or "DINT" for double word (signed 32bit value)
• "R" for real (IEEE floating point 32bit value)
• "X" or "" for bit (1bit value)
BYTEOFFSET is the offset within the AREA, where this value starts. It is a decimal number between 0 and 16777215.
If the TYPE is "X" (or ""), an additional BITPOS is used to designate which bit within the BYTEOFFSET is addressed. BITPOS is a digit between 0 and 7.


{
 "CollectorDescription": "S71500 example",
 "CollectorName": "s7-1500",
 "ConnectRetryMax": 240,
 "ConnectRetryMin": 2,
 "Protocol": "S7/TCP",
 "S7Access": {
 "S7Model": "S7-1200",
 "S7Rack": 0,
 "S7Slot": 1
 },
 "SamplePoints": [
 {
 "SampleName": "DB1500Switch1",
 "SampleDescription": "DB1500DState0 S7",
 "SampleDataType": "bool",
 "SampleUnit": "On/Off",
 "SamplesSaved": 1000
 "S7Var": {
   "S7PLCVar": "DB1500X0.0",
   "S7SampleInterval": 1
   },
  }
 ]
}
See complete Siemens S7 examples here:
Creation date: 11/12/2019 14:08 (skr@secomea.com)      Updated: 09/09/2020 10:38 (tvo@secomea.com)