Differences

This shows you the differences between two versions of the page.

--- steam:settingsdescription:start [2020/08/21 09:03]
alkhiami
+++ steam:settingsdescription:start [2020/08/21 10:56] (current)
brinkhaus
@@ Line 1: / Line 1: @@
-settings_template.xml shows an example for creating a system structure.
+''settings.xml'' is the central settings file for Steam.
-The whole program will depends on this information to creat the bassis structure of the system and
-to tell the program in which mode it should operate and how the data should be sent.
+The whole program depends on this information to create the base structure of the system and
+configures, in which mode it should operate and how data should be processed.
-at start, the first thing the program will do, is scanning the XML file to bring the informations needed for the system.
+The XML is read directly at start of Steam. In case of any error in the XML file, the program stops and gives at the Terminal or in the loggerFile an error message.
-in case of any error in the xml file, the program will stops and give at the Terminal or in the loggerFile an error message,
-which shows in which place the data has not been entered correctly.
-The program will continue to process the data, only if the xml file has been correctly created.
-here is more informations about the xml file :
+Steam only starts processing data, if the xml file has been correctly read.
-the program will works in tow main threads (SamplingThread and ProcessingThread),
-the operation mode for these threads  will be defined as follows
-<SamplingThread-type> : here will be given in which mode the data Source will sample the Data.
+The program works in tow main threads (SamplingThread and ProcessingThread). The operation mode for these threads  is defined as follows:
-there is the following options :  { ETHERCAT , MODBUS , CLIENT , DUMMY , ADAS }
-if the Client Mode has been entered, this thread will try to connect to a server to bring the data(as a Source) and
-send it to the ProcessingThread to be worked.
-if the Dummy Mode has been entered, the program will generate dummy data for testing purpose.
+<code>
+<SamplingThread-type>
+</code>
-<ProcessingThread-type> : here will be given in which mode the data will be processed.
+Mode the data Source will sample data. Valid options: { ETHERCAT , MODBUS , CLIENT , DUMMY , ADAS }
-there is the following options : { SERVER , CSV , MQTT }
-if the server Mode has been entered: a new thread will be created to work as server
-and the ProcessingThread will use this server to send the data to a client.
-if the CSV Mode has been entered: the processed data will be written in a CSV file.
+If the CLIENT Mode is entered, the thread will not read a conventional data source but will instead connect to an external Steam-Server and reads its data.
-if the MQTT Mode has been entered: the processed data will be sent in form of json structure to a mosquito server.
+If the DUMMY Mode has been entered, the program will generate dummy data for testing purpose.
-for MQTT Configurations, the user should configure the fields which start with MQTT.
+<code>
+<ProcessingThread-type>
+</code>
-you can add as many modules as you want to the system, and as many terminals as you want to the module.
+Mode the data is processed. Valid options: { SERVER , CSV , MQTT }
-for adding a new I/O module to the system, make sure to a add it like in the template.
-each terminal in the modules can be described with different characters, which help to describe the hardware connected to it.
+If the SERVER Mode has been entered, Steam creates a TCP server to which an other steam instance may connect in CLIENT mode.
+If the CSV Mode has been entered: the processed data will be written in a CSV file.
+If the MQTT Mode has been entered: the processed data will be sent in form of a JSON structure to a mosquito server. For MQTT configurations, the user should configure the fields which start with MQTT.
+In the modes ETHERCAT , MODBUS the system can be configured to read analog and digital values from Modbus or EtherCAT sources. The names and parameters of the terminals can be configured in the respective fields.

Knowledge Base of Brinkhaus GmbH

User Tools

Site Tools

Differences

Page Tools