Merge pull request #37 from RapidScada/develop

Merge Develop to Master (v.5.2.1)

Author: 2mik

ScadaComm/OpenKPs/KpEmail/KpEmailLogic.cs

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016 Mikhail Shiryaev
+ * Copyright 2017 Mikhail Shiryaev
  * 
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -20,7 +20,7 @@
  * 
  * Author   : Mikhail Shiryaev
  * Created  : 2016
- * Modified : 2016
+ * Modified : 2017
  * 
  * Description
  * Sending email notifications.
@@ -265,7 +265,7 @@ public override void Session()
                 writeState = false;
             }
 
-            Thread.Sleep(ReqParams.Delay);
+            Thread.Sleep(ScadaUtils.ThreadDelay);
         }
 
         /// <summary>
@@ -289,6 +289,9 @@ public override void SendCmd(Command cmd)
                     {
                         if (SendMessage(message))
                             lastCommSucc = true;
+
+                        // задержка позволяет ограничить скорость отправки писем
+                        Thread.Sleep(ReqParams.Delay);
                     }
                     else
                     {

ScadaComm/OpenKPs/KpEmail/KpEmailView.cs

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016 Mikhail Shiryaev
+ * Copyright 2017 Mikhail Shiryaev
  * 
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -20,7 +20,7 @@
  * 
  * Author   : Mikhail Shiryaev
  * Created  : 2016
- * Modified : 2016
+ * Modified : 2017
  */
 
 using Scada.Comm.Devices.AB;
@@ -35,6 +35,12 @@ namespace Scada.Comm.Devices
     /// </summary>
     public class KpEmailView : KPView
     {
+        /// <summary>
+        /// Версия библиотеки КП
+        /// </summary>
+        internal const string KpVersion = "5.0.0.0";
+
+
         /// <summary>
         /// Конструктор для общей настройки библиотеки КП
         /// </summary>
@@ -79,6 +85,17 @@ public override string KPDescr
             }
         }
 
+        /// <summary>
+        /// Получить версию библиотеки КП
+        /// </summary>
+        public override string Version
+        {
+            get
+            {
+                return KpVersion;
+            }
+        }
+
         /// <summary>
         /// Получить прототипы каналов КП по умолчанию
         /// </summary>

ScadaComm/OpenKPs/KpEmail/Properties/AssemblyInfo.cs

@@ -1,5 +1,5 @@
-using System.Reflection;
-using System.Runtime.CompilerServices;
+using Scada.Comm.Devices;
+using System.Reflection;
 using System.Runtime.InteropServices;
 
 // General Information about an assembly is controlled through the following 
@@ -9,8 +9,8 @@
 [assembly: AssemblyDescription("")]
 [assembly: AssemblyConfiguration("")]
 [assembly: AssemblyCompany("")]
-[assembly: AssemblyProduct("KpEmail")]
-[assembly: AssemblyCopyright("Copyright © 2016")]
+[assembly: AssemblyProduct("Rapid SCADA")]
+[assembly: AssemblyCopyright("Copyright © 2016-2017")]
 [assembly: AssemblyTrademark("")]
 [assembly: AssemblyCulture("")]
 
@@ -32,5 +32,5 @@
 // You can specify all the values or you can default the Build and Revision Numbers 
 // by using the '*' as shown below:
 // [assembly: AssemblyVersion("1.0.*")]
-[assembly: AssemblyVersion("1.0.0.0")]
-[assembly: AssemblyFileVersion("1.0.0.0")]
+[assembly: AssemblyVersion(KpEmailView.KpVersion)]
+[assembly: AssemblyFileVersion(KpEmailView.KpVersion)]

ScadaData/ScadaData.Svc/ScadaData.Svc.csproj

@@ -31,9 +31,6 @@
     <DocumentationFile>bin\Release\ScadaData.Svc.XML</DocumentationFile>
   </PropertyGroup>
   <ItemGroup>
-    <Reference Include="ScadaData">
-      <HintPath>..\ScadaData\bin\Release\ScadaData.dll</HintPath>
-    </Reference>
     <Reference Include="System" />
     <Reference Include="System.Configuration.Install" />
     <Reference Include="System.ServiceProcess" />
@@ -47,6 +44,12 @@
     <Compile Include="Properties\AssemblyInfo.cs" />
     <Compile Include="SvcProps.cs" />
   </ItemGroup>
+  <ItemGroup>
+    <ProjectReference Include="..\ScadaData\ScadaData.csproj">
+      <Project>{c5dc293f-13ca-435f-a7db-4ba91639c292}</Project>
+      <Name>ScadaData</Name>
+    </ProjectReference>
+  </ItemGroup>
   <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
   <!-- To modify your build process, add your task inside one of the targets below and uncomment it. 
        Other similar extension points exist, see Microsoft.Common.targets.

ScadaDoc/ScadaDoc/ScadaDoc.csproj

@@ -96,6 +96,7 @@
     <Content Include="content\en\modules\index.html" />
     <Content Include="content\en\modules\mod-auto-control-files\mod_auto_control_en.png" />
     <Content Include="content\en\modules\mod-db-export.html" />
+    <Content Include="content\en\modules\mod-rapid-gate.html" />
     <Content Include="content\en\modules\plg-chart-pro.html" />
     <Content Include="content\en\modules\plg-dashboard.html" />
     <Content Include="content\en\modules\plg-elastic-report-files\interface_table_en.png" />
@@ -119,6 +120,7 @@
     <Content Include="content\ru\modules\mod-auto-control-files\mod_auto_control_ru.png" />
     <Content Include="content\ru\modules\mod-auto-control.html" />
     <Content Include="content\ru\modules\mod-db-export.html" />
+    <Content Include="content\ru\modules\mod-rapid-gate.html" />
     <Content Include="content\ru\modules\plg-elastic-report-files\interface_table_ru.png" />
     <Content Include="content\ru\modules\plg-elastic-report.html" />
     <Content Include="content\ru\modules\plg-dashboard.html" />

ScadaDoc/ScadaDoc/content/en/installation-and-run/module-installation.html

@@ -20,8 +20,8 @@ <h2 id="modules">Installation of Server Modules</h2>
         <li>In case of using Windows 8 or higher, find C:\SCADA\ScadaServer\Mod\Mod*.dll, open the file properties and unblock the file.</li>
         <li>Run the Server graphical shell and go to the Modules page.</li>
         <li>Click the <img src="../../common-images/plus.png" /> button, then use the file dialog to select the module library and apply the changes with the <img src="../../common-images/apply.png" /> button.</li>
-        <li>Perform the configuration of the module specified in the module documentation.</li>
         <li>Start the Server service using the <img src="../../common-images/start.png" /> button.</li>
+        <li>Perform the configuration of the module specified in the module documentation.</li>
     </ol>
 
     <h2 id="drivers">Installation of Communicator Drivers</h2>
@@ -41,7 +41,7 @@ <h2 id="plugins">Installation of Webstation Plugins</h2>
         <li>Unzip the plugin installation package.</li>
         <li>Copy all the files from the SCADA folder of the plugin installation package to the Rapid SCADA installation directory, the default is C:\SCADA, with the hierarchy of directories retained.</li>
         <li>In case of using Windows 8 or higher, find C:\SCADA\ScadaWeb\bin\Plg*.dll, open the file properties and unblock the file.</li>
-        <li>Login the web application as administrator and go to <em>Main Menu &gt; Plugins</em>.</li>
+        <li>Login the web application as administrator and go to <em>Main Menu &gt; Plugins &gt; Installed</em>.</li>
         <li>Find the new plugin on the page and click the <em>Activate</em> link.</li>
         <li>Perform the configuration of the plugin specified in the plugin documentation.</li>
     </ol>

ScadaDoc/ScadaDoc/content/en/modules/mod-auto-control.html

@@ -24,9 +24,8 @@ <h2>Overview</h2>
     <p>Each trigger contains a set of commands which are sent if the trigger fires. The information about firing of the triggers is accessible on the <em>Log</em> page or directly from the ModAutoControl.log file. This file is located in Server logs directory C:\SCADA\ScadaServer\Log</p>
 
     <h2>Installation</h2>
-    <p>Automatic control module is installed in accordance with <a href="../installation-and-run/module-installation.html#modules">the general sequence of installing Server modules</a>. The module library file is ModAutoControl.dll. After connecting the module, you need to perform several additional actions:</p>
+    <p>Automatic Control Module is installed in accordance with <a href="../installation-and-run/module-installation.html#modules">the general sequence of installing Server modules</a>. The module library file is ModAutoControl.dll. After adding the module, you need to perform several additional actions:</p>
     <ol>
-        <li>Start the Server service using the <img src="../../common-images/start.png" /> button.</li>
         <li>Click the <em>Properties</em> button to open the module configuration form </li>
         <li>Go to the <em>Registration</em> page and register the module using the hyperlinks on the form.</li>
         <li>Configure the module by creating triggers and commands.</li>

ScadaDoc/ScadaDoc/content/en/modules/mod-rapid-gate.html

@@ -0,0 +1,37 @@
+<!DOCTYPE html>
+<html>
+<head>
+    <title>Rapid Gate Module - Rapid SCADA Documentation</title>
+    <meta charset="utf-8" />
+    <link href="../../../css/scadadoc.min.css" rel="stylesheet" type="text/css" />
+    <script type="text/javascript" src="../../../js/jquery.min.js"></script>
+    <script type="text/javascript" src="../../../js/scadadoc.js"></script>
+</head>
+<body>
+    <h1>Rapid Gate Module</h1>
+    <h2>Overview</h2>
+    <p>Rapid Gate Module is designed to synchronize data between several Rapid SCADA instances. The module allows to setup a backup server, as well as provides data transfer from SCADA installed on remote locations to the primary SCADA.</p>
+
+    <h2>Installation</h2>
+    <p>Rapid Gate Module is installed in accordance with <a href="../installation-and-run/module-installation.html#modules">the general sequence of installing Server modules</a>. The module library file is ModRapidGate.dll. After adding the module, you need to perform several additional actions:</p>
+    <ol>
+        <li>Open the module log C:\SCADA\ScadaServer\Log\ModRapidGate.log in a text editor and copy a computer code.</li>
+        <li>Register the module by contacting the developers or using <a href="http://trial.rapidscada.net/?prod=ModRapidGate" target="_blank">the trial key generator</a>. A register key must be stored in C:\SCADA\ScadaServer\Config\ModRapidGate_Reg.xml between RegKey tags.</li>
+        <li>Configure the module (see the section below).</li>
+        <li>Restart the Server service by clicking <img src="../../common-images/restart.png" />.</li>
+    </ol>
+
+    <h2>Configuring</h2>
+    <p>To cofigure Rapid Gate Module, edit C:\SCADA\ScadaServer\Config\ModRapidGate.xml using a text editor. The settings contains the connection parameters for the SCADA server (target server) to which data are transferred and from which commands are received.</p>
+    <p>Note that you usually need to configure the firewall on the target server to allow connections with it over the network.</p>
+
+    <h2>Algorithm</h2>
+    <p>The algorithm of Rapid Gate Module has the following features:</p>
+    <ol>
+        <li>The module transmits only the data that are received from Communicator. The values of the calculated input channels are not transmitted.</li>
+        <li>The data is transmitted to the same input channel numbers to which they are received.</li>
+        <li>The transmitted values are already calculated by the formulas of the input channels, which can result in double applying of the formulas on the target server. Therefore, when using the module, it is recommended that calculations be performed in separate input channels of the calculated type.</li>
+        <li>The module has a data transfer queue, which allows restoring data in case of a short-term connection failure with a target server.</li>
+    </ol>
+</body>
+</html>

ScadaDoc/ScadaDoc/content/ru/installation-and-run/module-installation.html

@@ -20,8 +20,8 @@ <h2 id="modules">Установка модулей Сервера</h2>
         <li>Если используется Windows 8 и выше, найти файл библиотеки модуля C:\SCADA\ScadaServer\Mod\Mod*.dll, открыть его свойства и разблокировать файл.</li>
         <li>Запустить графическую оболочку Сервера и перейти на страницу Модули.</li>
         <li>Щёлкнуть по кнопке добавления модуля <img src="../../common-images/plus.png" />, затем с помощью файлового диалога выбрать библиотеку модуля и применить изменения кнопкой <img src="../../common-images/apply.png" />.</li>
-        <li>Выполнить действия по настройке модуля, указанные в документации на конкретный модуль.</li>
         <li>Запустить службу Сервера с помощью кнопки <img src="../../common-images/start.png" />.</li>
+        <li>Выполнить действия по настройке модуля, указанные в документации на конкретный модуль.</li>
     </ol>
 
     <h2 id="drivers">Установка драйверов Коммуникатора</h2>
@@ -41,7 +41,7 @@ <h2 id="plugins">Установка плагинов Вебстанции</h2>
         <li>Распаковать архив дистрибутива плагина.</li>
         <li>Скопировать все файлы из папки SCADA дистрибутива плагина в директорию установки Rapid SCADA, по умолчанию C:\SCADA, с сохранением иерархии директорий.</li>
         <li>Если используется Windows 8 и выше, найти файл библиотеки плагина C:\SCADA\ScadaWeb\bin\Plg*.dll, открыть его свойства и разблокировать файл.</li>
-        <li>Выполнить вход в веб-приложение как администратор и перейти на страницу <em>Главное меню &gt; Плагины</em>.</li>
+        <li>Выполнить вход в веб-приложение как администратор и перейти на страницу <em>Главное меню &gt; Плагины &gt; Установленные</em>.</li>
         <li>Найти на странице новый плагин и щёлкнуть по ссылке <em>Активировать</em>.</li>
         <li>Выполнить действия по настройке плагина, указанные в документации на конкретный плагин.</li>
     </ol>

ScadaDoc/ScadaDoc/content/ru/modules/mod-auto-control.html

@@ -26,7 +26,6 @@ <h2>Обзор</h2>
     <h2>Установка</h2>
     <p>Модуль автоматического управления устанавливается в соответствии с <a href="../installation-and-run/module-installation.html#modules">общей последовательностью установки модулей Сервера</a>. Файл библиотеки модуля - ModAutoControl.dll. После подключения модуля необходимо выполнить несколько дополнительных действий:</p>
     <ol>
-        <li>Запустить службу Сервера с помощью кнопки <img src="../../common-images/start.png" />.</li>
         <li>Нажать кнопку <em>Свойства</em>, чтобы открыть форму конфигурации программного модуля.</li>
         <li>Перейти на страницу <em>Регистрация</em> и зарегистрировать модуль, используя гиперссылки, размещённые на форме.</li>
         <li>Сконфигурировать модуль, создав триггеры и команды.</li>

ScadaDoc/ScadaDoc/content/ru/modules/mod-rapid-gate.html

@@ -0,0 +1,37 @@
+<!DOCTYPE html>
+<html>
+<head>
+    <title>Модуль Быстрый шлюз - Документация Rapid SCADA</title>
+    <meta charset="utf-8" />
+    <link href="../../../css/scadadoc.min.css" rel="stylesheet" type="text/css" />
+    <script type="text/javascript" src="../../../js/jquery.min.js"></script>
+    <script type="text/javascript" src="../../../js/scadadoc.js"></script>
+</head>
+<body>
+    <h1>Модуль Быстрый шлюз</h1>
+    <h2>Обзор</h2>
+    <p>Модуль Быстрый шлюз предназначен для синхронизации данных между несколькими экземплярами Rapid SCADA. Модуль позволяет организовать работу резервного сервера, а также обеспечивает передачу данных от SCADA, установленных на удалённых объектах, на главную SCADA.</p>
+
+    <h2>Установка</h2>
+    <p>Модуль автоматического управления устанавливается в соответствии с <a href="../installation-and-run/module-installation.html#modules">общей последовательностью установки модулей Сервера</a>. Файл библиотеки модуля - ModRapidGate.dll. После подключения модуля необходимо выполнить несколько дополнительных действий:</p>
+    <ol>
+        <li>Открыть журнал работы модуля C:\SCADA\ScadaServer\Log\ModRapidGate.log в текстовом редакторе и скопировать код компьютера. </li>
+        <li>Зарегистрировать модуль, связавшись с разработчиками или с помощью <a href="http://trial.rapidscada.net/?prod=ModRapidGate&lang=ru" target="_blank">сервиса генерации демо-ключей</a>. Регистрационный ключ сохраняется в файле C:\SCADA\ScadaServer\Config\ModRapidGate_Reg.xml между тегами RegKey.</li>
+        <li>Сконфигурировать модуль (см. ниже).</li>
+        <li>Перезапустить службу Сервера с помощью кнопки <img src="../../common-images/restart.png" />.</li>
+    </ol>
+
+    <h2>Конфигурирование</h2>
+    <p>Чтобы сконфигурировать модуль Быстрый шлюз, необходимо отредактировать файл C:\SCADA\ScadaServer\Config\ModRapidGate.xml с помощью текстового редактора. В настройках указываются параметры подключения к тому cерверу SCADA (целевому серверу), на который будут передаваться данные и с которого будут приниматься команды ТУ.</p>
+    <p>Обратите внимание, что на целевом сервере обычно небходимо настроить брандмауэр, чтобы разрешить подключение к нему по сети.</p>
+
+    <h2>Алгоритм работы</h2>
+    <p>Алгоритм работы модуля Быстрый шлюз имеет следующие функциональные особенности:</p>
+    <ol>
+        <li>Модуль передаёт только те данные, которые поступают от Коммуникатора. Значения дорасчётных входных каналов не передаются.</li>
+        <li>Данные передаются на те же номера входных каналов, на которые они были получены.</li>
+        <li>Передаваемые значения уже посчитаны по формулам входных каналов, что может привести в двойному применению формул на целевом сервере. Поэтому при использовании модуля рекомендуется вычисления по формулам выполнять в отдельных дорасчётных входных каналах.</li>
+        <li>Модуль имеет очередь передачи данных, что позволяет восстанавливать данные при кратковременном обрыве соединения с целевым сервером.</li>
+    </ol>
+</body>
+</html>