НТП “Энергоконтроль” Программное обеспечение комплекса технических средств “Энергия+” Программа «OPC сервер для преобразователя «Энергия-ТМ» Руководство оператора. 46.50561850.00082-01 34 01 2019 2 АННОТАЦИЯ В данном документе описана программа "OPC сервер для преобразователя "Энергия-ТМ": возможности, настройка и порядок работы с ней. Версия документа 6.6.0 от 1.03.2019. 3 СОДЕРЖАНИЕ 1. Введение............................................................................................ 5 1.1. Условия поставки ........................................................................ 5 1.2. Назначение .................................................................................. 5 1.3. Установка и удаление ................................................................. 6 2. Программа "OPC сервер для преобразователя "Энергия-ТМ"" ....... 6 2.1. Общие сведения.......................................................................... 6 2.2. Перечень интерфейсов DA ......................................................... 7 2.3. Основное окно программы в целом .......................................... 10 2.4. Режим настройки ....................................................................... 12 2.5. Протоколирование работы программы .................................... 13 Приложение. ........................................................................................ 15 4 1. Введение 1. Введение 1.1. Условия поставки Программное обеспечение, описываемое в данном документе, является дополнительным компонентом для БПО КТС "Энергия+" версии 6. Данное программное обеспечение разработано и поставляется ООО "НТП Энергоконтроль" на условиях лицензионного соглашения, текст которого приведен в Приложении к этому руководству. Юридический адрес предприятия и адрес для переписки: 442963, г. Заречный, Пензенская область, ул. Ленина, 4A. Директор предприятия: Журавлева Елена Анатольевна. Главный конструктор: Жуков Сергей Анатольевич. Приемная: тел. (8412) 61-39-82; 61-39-83 (тел./факс) E-Mail: [email protected] http://www.energocontrol.ru Служба сопровождения ПО: E-Mail: [email protected] Приведенные в тексте наименования продуктов или названия компаний использованы лишь в целях идентификации и принадлежат владельцам. 1.2. Назначение Программа "OPC сервер для преобразователя "Энергия-ТМ"" представляет собой совмещенные сервер OPC DA и сервер OPC HDA и служит для получения оперативных и архивных данных от преобразователей измерительных "Энергия-ТМ", предназначенных для измерений всех видов неэлектрических энергоносителей. Сервер OPC DA имеет имя "e6opcTM_DA" и соответствует Custom Interface Specification версии 2.03. Сервер OPC HDA имеет имя "e6opcTM_HDA" и соответствует OPC Historical Data Access Specification версии 1.20. 5 2. Программа "OPC сервер для преобразователя "Энергия-ТМ"" 1.3. Установка и удаление Для установки программы необходимо запустить файл установки Setup_OPC_TM.msi с дистрибутивного носителя и далее следовать инструкциям инсталляционного пакета. Следует учесть, что программа создает служебные файлы в каталоге установки, поэтому этот каталог должен быть доступен для записи и не должен виртуализироваться. После успешного завершения установки создается папка, в которой помещаются ярлыки вызова программы и файла помощи. Удаление программ осуществляется обычным образом: через штатное средство Windows ( для Windows XP: "Пуск" - "Панель управления" "Установка и удаление программ"; для Windows 7 и выше: "Пуск" - "Панель управления" - "Программы и компоненты" ). 2. Программа "OPC сервер для преобразователя "Энергия-ТМ"" 2.1. Общие сведения Программа "OPC сервер для преобразователя "Энергия-ТМ"" представляет собой совмещенные сервер OPC DA и сервер OPC HDA и служит для получения оперативных и архивных данных от преобразователей "Энергия-ТМ". Сервер OPC DA имеет имя "e6opcTM_DA" и соответствует Custom Interface Specification версии 2.03. Сервер OPC HDA имеет имя "e6opcTM_HDA" и соответствует OPC Historical Data Access Specification версии 1.20. Программа имеет визуальное окно для настройки и наблюдения за ее состоянием. Программа может находиться в одном из двух состояний: работа или настройка. В рабочем режиме программа ожидает и обрабатывает запросы клиентов, выдавая запрошенные данные. В режиме настройки программа позволяет добавить, удалить, изменить настройки подключения к обслуживаемым преобразователям. Перейти в режим настройки можно только при отсутствии подключенных клиентов. ОРС-сервер запускается автоматически при подключении к нему клиентов, но может запускаться и автономно. Если сервер был запущен автономно, то и завершение работы следует также производить "вручную". Если же сервер был запущен автоматически, вследствие подключения 6 2. Программа "OPC сервер для преобразователя "Энергия-ТМ"" клиента, то он завершит свою работу также автоматически, при отключении последнего клиента. Программа "ОРС-сервер" поддерживает до 10-ти одновременно подключенных клиентов. После запуска сервер поочередно пытается подключиться ко всем преобразователям, указанным в настройках. Если таковых нет, то сервер переходит в состояние OPC_STATUS_NOCONFIG. Если не удается подключиться ни к одному преобразователю, то сервер переходит в состояние OPC_STATUS_COMM_FAULT. При нормальной работе сервер после запуска переходит в состояние OPC_STATUS_RUNNING. 2.2. Перечень интерфейсов DA Методы большинства интерфейсов выполняют стандартные для ОРС-сервера действия. Особенности учитываются в следующих интерфейсах: - IOPCServer - учитывает особенности взаимодействия со преобразователями, являющимися поставщиками данных; - IOPCBrowseServerAddressSpace - выдает информацию о структуре данных, которые можно получить от преобразователей; - IOPCItemProperties - выдает дополнительные данные по объектам. Ниже приведен полный перечень интерфейсов и их методов, поддерживаемых сервером ОРС DA. IOPCServer AddGroup GetErrorString GetGroupByName GetStatus RemoveGroup CreateGroupEnumerator IOPCCommon SetLocaleID GetLocaleID QueryAvailableLocaleIDs GetErrorString SetClientName 7 2. Программа "OPC сервер для преобразователя "Энергия-ТМ"" IOPCServerPublicGroups (optional) GetPublicGroupByName RemovePublicGroup IOPCBrowseServerAddressSpace (optional) QueryOrganization ChangeBrowsePosition BrowseOPCItemIDs GetItemID BrowseAccessPaths - не реализован (всегда возвращает E_NOTIMPL) IPersistFile (optional) IsDirty Load Save SaveCompleted GetCurFileName IConnectionPointContainer EnumConnectionPoints FindConnectionPoint IOPCItemProperties QueryAvailableProperties GetItemProperties LookupItemIDs IOPCItemMgt AddItems ValidateItems RemoveItems SetActiveState SetClientHandles SetDatatypes CreateEnumerator IOPCGroupStateMgt GetState SetState SetName CloneGroup 8 2. Программа "OPC сервер для преобразователя "Энергия-ТМ"" IOPCPublicGroupStateMgt (optional) GetState MoveToPublic IOPCSyncIO Read Write IOPCAsyncIO2 Read Write Cancel2 Refresh2 SetEnable GetEnable IEnumOPCItemAttributes Next Skip Reset Clone Не поддерживаются следующие (устаревшие) интерфейсы: IOPCAsyncIO (old) Read Write Cancel Refresh IDataObject (old) Dadvise Dunadvise Методы большинства интерфейсов выполняют стандартные для ОРС-HDA сервера действия. Особенности учитываются в следующих интерфейсах: - IOPCHDA_Server - учитывает особенности взаимодействия со преобразователями, являющимися поставщиками данных; 9 2. Программа "OPC сервер для преобразователя "Энергия-ТМ"" - IOPCHDA_Browser - выдает информацию о структуре данных, которые можно получить от преобразователей; - IOPCHDA_SyncRead - выдает запрашиваемые данные. Ниже приведен перечень интерфейсов и их методов, поддерживаемых сервером ОРС HDA. IOPCServer GetAggregates GetHistorianStatus GetItemHandles ReleaseItemHandles ValidateItemIDs CreateBrowse IOPCCommon SetLocaleID GetLocaleID QueryAvailableLocaleIDs GetErrorString SetClientName IOPCHDA_SyncRead ReadRaw IOPCHDA_Browser GetEnum ChangeBrowsePosition GetItemID GetBranchPosition 2.3. Основное окно программы в целом Основное окно программы "OPC сервер для преобразователя "Энергия-ТМ"" предназначено для просмотра состояния программы и настройки. 10 2. Программа "OPC сервер для преобразователя "Энергия-ТМ"" При непосредственном запуске программа оставляет основное окно в развернутом состоянии. При опосредованном запуске (создание объекта в клиентской программе) программа сворачивается в область системных уведомлений (System Tray). Основное окно программы может быть развернуто/свернуто при помощи щелчка мышью на значке программы в области системных уведомлений. В левой верхней части окна программы выдается информация о состоянии сервера и количестве подключенных клиентов. Ниже расположены кнопки перехода в рабочий режим и режим настройки (см. Режим настройки). В правой верхней части расположен переключатель подробности протоколирования (см. Протоколирование работы программы). 11 2. Программа "OPC сервер для преобразователя "Энергия-ТМ"" Среднюю часть окна программы занимает список преобразователей. Для каждого преобразователя приводится порт и адрес подключения, статус преобразователя, отклонение времени преобразователям от времени компьютера, температура внутри прибора и напряжение элемента резервного питания (подробнее см. в документе «Преобразователь измерительный многофункциональный программируемый «Энергия-ТМ». Руководство по эксплуатации НЕКМ.426489.011 РЭ»). Правее располагаются кнопки для редактирования списка преобразователей. Кнопки активны в режиме в режиме настройки (см. Режим настройки). В нижней части расположено поле для показа последних строк протокола работы программы. 2.4. Режим настройки В режиме настройки программа позволяет добавить, удалить, изменить настройки подключения к обслуживаемым преобразователям. Перейти в режим настройки можно только при отсутствии подключенных клиентов. Для перехода в режим настройки необходимо нажать кнопку "Настройка". После этого станут активными кнопки редактирования, расположенные справа от списка преобразователей. С их помощью можно добавить, изменить и удалить описание преобразователя. Преобразователь описывается параметрами подключения в следующем окне: Следует учесть, что программа создает файл с настройками в каталоге установки, поэтому этот каталог должен быть доступен для записи и не должен виртуализироваться. 12 2. Программа "OPC сервер для преобразователя "Энергия-ТМ"" 2.5. Протоколирование работы программы Программа ведет протокол работы в виде простого текстового файла с именем k6opcTM.log ограниченного размера. При достижении предельного размера файл переименовывается в k6opcTM.lo, при этом более старый файл удаляется. Подробность протокола определяется переключателями в правой верхней части основного окна программы. При нормальной работе рекомендуется выставлять минимальный уровень протоколирования. В случае возникновения проблем может помочь подробное протоколирование. Полное протоколирование включает в себя детальную информацию по обмену с преобразователями и рекомендуется только в крайних случаях, поскольку приводит к чрезмерному разрастанию протокола работы и, как следствие, утере более ранних записей. Записи протокола работы также дублируются в поле, расположенное в нижней части окна программы, что позволяет оперативно следить за действиями программы. Следует учесть, что программа создает файл протокола в каталоге установки, поэтому этот каталог должен быть доступен для записи и не должен виртуализироваться. 13 2. Программа "OPC сервер для преобразователя "Энергия-ТМ"" 14 Приложение. Приложение. Лицензионное соглашение о предоставлении права на использование программных продуктов ООО НТП «Энергоконтроль» ООО НТП «Энергоконтроль» готово предоставить Вам Лицензию на данный Программный продукт, только если Вы примете все условия настоящего лицензионного соглашения (далее – "Соглашение"). Внимательно ознакомьтесь с условиями и положениями настоящего Соглашения. При просмотре текста Соглашения на экране монитора используйте движок в правой части окна для прокрутки текста на экране, чтобы прочитать остальную часть Соглашения. Если Вы нажмете кнопку "Согласен" и продолжите установку, то Вы тем самым обязуетесь соблюдать все условия Соглашения, и Программный продукт будет установлен. Если Вы не желаете или не можете соблюдать настоящее Соглашение и не согласны со всеми его условиями и положениями, выберите "Не согласен", в результате чего загрузка Программного продукта будет прекращена. В этом случае в течение 60 дней с момента приобретения верните Программный продукт (диски, документацию и все прочие предметы, вложенные в упаковку, без механических и иных повреждений, исключающих дальнейшее использование) в пункт приобретения, приложив документальное подтверждение о дате приобретения и мотивированный отказ, и Вам будет полностью возвращена уплаченная сумма. Если Вы используете данный Программный продукт, то это означает Ваше согласие соблюдать все условия, изложенные в настоящем Соглашении. Всякое копирование или использование Программного продукта ООО НТП «Энергоконтроль», за исключением разрешенного в настоящем Соглашении, противозаконно и является нарушением авторского права по законам Российской Федерации (или Вашей страны). Если Вы копируете или используете данный Программный продукт без разрешения ООО НТП «Энергоконтроль», Вы нарушаете закон и можете понести ответственность перед ООО НТП «Энергоконтроль» за причиненный ущерб, а также можете быть привлечены к уголовной ответственности согласно действующему законодательству. 1. Предоставление лицензии. Документом, удостоверяющим Ваше право на использование Программного продукта, является прилагаемая к Соглашению Лицензия с уникальным номером, в которой указан приобретенный Вами Программ15 Приложение. ный продукт и Ваше предприятие, как лицензиат. В этом же документе при необходимости указывается количество Клиентских программ, которые Вы можете устанавливать на рабочие места, и срок действия лицензии. ООО НТП «Энергоконтроль» предоставляет Вам на условиях настоящего Соглашения неисключительное, не подлежащее передаче право на использование данного Программного продукта, состоящего из: программы для промышленного использования (Рабочая версия, WORK); программы для обучения (Демонстрационная версия, DEMO); программы для использования на рабочем месте оператора (Клиентские программы); программной документации (Документация) на оборудовании, которое находится в Вашей собственности и под Вашим контролем. Примечание. Демонстрационная версия Программного продукта и Клиентские программы не входят в обязательный комплект поставки Программного продукта. Для обеспечения защиты Программного продукта от копирования и неправомочного использования Программный продукт может поставляться с устройством, обеспечивающим такую защиту. Наличие данного устройства отражено в документации комплекта поставки. Рабочая версия, WORK. Настоящее Соглашение разрешает одновременную установку и использование данного Программного продукта в любое время на одном рабочем месте, именуемом "Специализированный вычислительный комплекс" (СВК). Демонстрационная версия, DEMO. Вы имеете право устанавливать Демонстрационную версию на любом компьютере, находящемся в Вашей собственности и под Вашим контролем. Вы имеете право использовать Демонстрационную версию с целью обучения персонала, а также в качестве рабочего места для разработки, отладки собственных программ формирования различных видов отчетных документов и т.п. целей. Вы не можете использовать Демонстрационную версию для коммерческих целей. Клиентские программы. Вы имеете право установить Клиентские программы на рабочие места, количество которых указано в Лицензии на Программный продукт. Документация. Вы имеете право сделать копии Документации в количестве, соответствующем числу компьютеров, на которых установлены Демонстрационные версии и Рабочая версия. Резервная копия. Независимо от того, какую версию Программного 16 Приложение. продукта Вы приобрели, по настоящему Соглашению Вы имеете право сделать только одну резервную копию Программного продукта. Использовать резервную копию для установки Программного продукта на второй СВК запрещается. Обновление. Если данный Программный продукт получен Вами как обновление к Программному продукту, на который Вы ранее получили Лицензию, Вы имеете право установить обновление на такое количество СВК и рабочих мест, которое указано в Вашей Лицензии. Вы можете сохранять более раннюю версию данного Программного продукта, на которую Вы ранее получили Лицензию, и не удалять ее, а также, если это необходимо, использовать более раннюю версию исключительно в целях 1) установки обновления, на которое предоставляется Лицензия по настоящему Соглашению, и 2) в целях архивного (резервного) копирования для обеспечения повторной установки обновления, на которое предоставляется Лицензия по настоящему Соглашению, если первоначальная установка оказалась неудачной. 2. Ограничения Вы не вправе: 1) копировать и использовать Программный продукт и Документацию, за исключением случаев, разрешенных настоящим Соглашением; 2) восстанавливать исходный код Программного продукта, выполнять реинжениринг баз данных Программного продукта, декомпилировать и дизассемблировать Программный продукт; 3) распространять, сдавать в аренду, предоставлять взаймы или продавать как полностью, так и по частям программы, Документацию или любые иные компоненты Программного продукта, предоставляемого по настоящему Соглашению, равно как и передавать право на их использование по сублицензионным договорам и иным образом передавать их какому-либо лицу без предварительного письменного согласия ООО НТП «Энергоконтроль»; 4) размещать Программный продукт в Интернете или иной глобальной вычислительной (информационной) сети; 5) удалять, изменять или каким-либо образом скрывать любые имеющиеся в Программном продукте уведомления о праве собственности, ярлыки и маркировку; 6) использовать какое-либо оборудование, устройства, программные или иные средства, служащие для целей обхода или снятия какой-либо формы защиты от копирования, используемой ООО НТП «Энергоконтроль» в связи с Программным продуктом. 17 Приложение. 3. Авторское право Право собственности и авторские права на Программный продукт и сопутствующие материалы, а также на любые копии, сделанные Вами, сохраняются за ООО НТП «Энергоконтроль» и его лицензиарами. Несанкционированное копирование Программного продукта, равно как и невыполнение вышеуказанных ограничений, приводит к автоматическому прекращению действия Лицензии. По настоящему Соглашению Вам не предоставляется никаких прав на интеллектуальную собственность. 4. Общая ограниченная гарантия ООО НТП «Энергоконтроль» гарантирует, что Программный продукт поддерживает все возможности и функции, прямо описанные в Документации, и что носители, на которых поставлен Программный продукт, и устройства защиты от копирования не имеют каких-либо дефектов изготовления или использованных материалов при нормальных условиях эксплуатации. За исключением приведенных выше ограниченных гарантий, ООО НТП «Энергоконтроль» не предоставляет и Вы не получаете какихлибо гарантий, выраженных в явной форме, подразумеваемых, установленных на основании законодательства или по договоренности с Вами. ООО НТП «Энергоконтроль» не гарантирует бесперебойную или безошибочную работу Программного продукта. Единственной формой ответственности ООО НТП «Энергоконтроль» и Вашим исключительным средством судебной защиты в случае нарушения гарантийных обязательств, предоставляемых настоящим Соглашением, является обязательство, по выбору ООО НТП «Энергоконтроль», либо предпринять попытку по исправлению или обходу неисправности, либо заменить бракованные носители и документацию, либо возместить уплаченную стоимость Программного продукта и прекратить действие Лицензии. Применение указанных мер осуществляется при условии документально установленного брака, возвращения бракованных носителей, Документации без механических и иных повреждений, с наличием всех гарантийных пломб и печатей. Срок действия настоящей гарантии устанавливается в течение 12 (двенадцати) месяцев с момента продажи Программного продукта. 5. Ограничение ответственности Ни при каких обстоятельствах ООО НТП «Энергоконтроль» не несет ответственности за какие-либо убытки или ущерб, включая утрату данных, упущенную выгоду, расходы на возмещение и иные случайные или кос- 18 Приложение. венные убытки, связанные с использованием Программного продукта или с невозможностью использования такового, независимо от обстоятельств и основания возникновения этой ответственности. Это ограничение действительно, даже если ООО НТП «Энергоконтроль» или какой-либо распространитель продукции ООО НТП «Энергоконтроль» были предупреждены о возможности таких убытков или ущерба. Вы признаете, что сумма, уплаченная за Программный продукт при его приобретении, отражает данное распределение рисков. ООО НТП «Энергоконтроль» не несет какой-либо ответственности за утрату, порчу вследствие пожара, наводнения или иных обстоятельств непреодолимой силы, хищение Программного продукта. В частности, ООО НТП «Энергоконтроль» не обязан заменять утраченный, испорченный или похищенный Программный продукт. Вы единолично несете ответственность за предупреждение утраты, порчи или хищения Программного продукта. 6. Общие положения Лицензия на Программный продукт становится недействительной без особых уведомлений или действий со стороны ООО НТП «Энергоконтроль» в случае если Вы, лицензиат, объявляетесь банкротом, заключаете соглашение с Вашими кредиторами или начинаете процедуру ликвидации. Настоящее Соглашение представляет собой полный объем договоренности, достигнутой между нами, и заменяет собой все прочие сообщения и рекламные материалы в отношении Программного продукта. Если какое-либо положение настоящих условий Соглашения становится недействительным или неприводимым в исполнение, все прочие условия настоящего Соглашения полностью остаются в силе. 26.11.2014 19
