Описание работы и основных функций программы
Данная документация поставляется в комплекте с программой, скачать её отдельно в формате INF можно по этой ссылке.

Окно программы и объект "Электропитание"

Программа Monitor for APC UPS (USB) v 0.17 (далее "программа") разрабатывалась в OS/2, предназначена для применения в OS/2 (eComStation) и не имеет версий для других операционных систем.

Программа работает в текстовом режиме, может запускаться в оконном или полноэкранном сеансе OS/2. Во время своей работы программа создает на рабочем столе значок, показывающий текущее состояние ИБП (при необходимости создание значка можно отключить). При двойном клике на данном значке показывается подробная информация о состоянии ИБП.

Кроме того, информация о состоянии ИБП, при наличии в системе драйвера ACPI/APM, передаётся на системный объект "Электропитание" ("Power"), что позволяет видеть состояние электропитания в различных виджетах eCenter, eComCenter и т.д.

В случае отключения электропитания автоматическое завершение работы программ и операционной системы производится по одному из следующих событий, в зависимости от того, какое наступит в первую очередь:

• появление сигнала ИБП "крайне низкий заряд батареи";
• снижение уровня заряда батареи ИБП ниже заданной величины;
• снижение времени, которое может обеспечить заряд батареи ниже заданной величины;
• завершение времени задержки до выключения.

Кроме того, выключение системы можно произвести с клавиатуры, нажав клавишу "2" в окне программы, или при помощи команды через именованный поток (NPipe).

В случае возникновения определённых событий, как то отключение и подключение электроэнергии, при критическом разряде батареи ИБП, а также при старте и завершении работы программы, возникновении ошибки возможно исполнение программой заданных пользователем команд.

Инструкция по установке и настройке
1. Установка программы

• В случае необходимости, обновить USBCALLS.DLL и USBRESMG.SYS. Найти новую версию можно по одной из этих ссылок: Ссылка1 или Ссылка2
• Установить программу средствами WarpIn, запустив "Inst_mAPCUPS017.exe".
• Подключить USB-кабель ИБП и запустить Configuration editor для определения параметров устройства.
• В случае необходимости настроить конфигурацию программы.
• Запустить программу или перезагрузить систему.
• Для пользователей eComStation, или если Вы используете eStyler: запустите настройку программы eStyler (eStylerLite) и в расширенные параметры закрытия системы добавьте запуск следующего скрипта:
  
  CMD /C x:\Programs\mAPCUPS\CloseMon.cmd
  
  где "x" -- диск, на который установлена программа.
  

Это позволит корректно завершать работу программы при завершении работы системы штатными средствами.

2. Настройка конфигурации

Настройка конфигурации программы производится при помощи редактора конфигурации. Все внесённые изменения, кроме состава запускаемых модулей программы, применяются немедленно после закрытия редактора.
Описание значений, задаваемых в конфигурации:

• Вкладка "Modules"

На данной вкладке определяются модули программы, которые будут запускаться и использоваться в её работе. Для применения изменений в составе запускаемых модулей требуется перезапуск программы.

The unit for creation named pipe (NPipe) -- модуль создания программой именованного потока (NPipe), необходим для обеспечения взаимосвязи программы с другими программами и скриптами, в том числе со скриптом чтения состояния ИБП.

The unit for tracking pressing of keys -- модуль слежения за нажатием клавиш, необходим для обеспечения возможности завершения работы программы или системы при помощи клавиатуры.

The unit for periodic status scan of the UPS -- модуль периодического опроса состояния ИБП и выполнения определённых действий в зависимости от полученных данных. Это, собственно, и есть основной модуль программы.

The unit for creation of an icon of a condition of the UPS -- модуль создания на рабочем столе иконки, отражающей текущее состояние электропитания и ИБП.

Примечание. Некоторые сочетания модулей нелогичны и эти сочетания блокируются.

• Вкладка "Variables"

На данной вкладке задаются значения, используемые в работе программы.

Секция "UPS Identifier" -- здесь можно определить ИБП, с которым будет работать программа, а также выключить или включить принудительную очистку буфера USB-канала. Параметры "ProductID" и "Device" можно ввести вручную в шестнадцатиричном формате, либо определить автоматически, нажав на кнопку "Find".

Секция "Timings" -- здесь можно задать временные интервалы, определяющие периодичность опроса состояния ИБП и время завершения работы системы в случае отключения электроэнергии.

Секция "Logging level" -- здесь можно определить уровень ведения протокола работы программы и имя файла, в который будет сохранён протокол.

Секция "Status icon" -- здесь можно определить расположение на рабочем столе иконки состояния ИБП и время задержки до её создания.

• Вкладка "Commands"

На данной вкладке можно изменить команду операционной системы на завершение работы и выключение питания ("ShutDown command"), а также задать команды, выполняемые при различных событиях.

Примечание 1. Программа "shutdown o", задаваемая по умолчанию, является частью "eStylerLite for eComStation" и если Вы не имеете её, либо другой подобной программы, то можете скачать по этой ссылке.

Примечание 2. Команды выполняются из корневой директории системного диска, поэтому либо следует указывать полный путь, либо добавить путь к исполняемым файлам в PATH. Примеры команд:

net send Administrator Power fail!

c:\Tools\Editor.exe c:\Programs\mAPCUPS\mAPCUPS.log

Внимание! Будьте осторожными при назначении команд. Например, назначив запуск ресурсоёмких задач в параметрах "reduction of a charge of the battery of the UPS to 25%" или "a program termination" можно сильно подвесить систему перед выключением, тем самым не дав быстро и корректно выполнить выключение компьютера.

3. Альтернативный автозапуск программы

Инсталлятор программы создает в папке автозапуска тень программного объекта "APC UPS monitor", но начиная с версии 0.08.1 имеется возможность автоматически запускать программу из файла CONFIG.SYS. Такой автоматический запуск программы имеет свои плюсы и минусы -- программа при таком запуске не видна в "Списке окон", сообщения во время работы программы можно увидеть только в файле протокола, недоступно управление с клавиатуры и т.п.

Внимание! В случае автозапуска программы из файла CONFIG.SYS будет невозможно выполнение программой всех команд, заданных в конфигурации, кроме команды на выключения компьютера.

Для запуска программы из файла CONFIG.SYS при старте системы необходимо вручную выполнить следующие действия:

• удалить за ненадобностью из папки автозапуска тень программного объекта "APC UPS monitor";
• при помощи редактора конфигурации программы отключить запуск модуля слежения за нажатием клавиш:
  
  
  и установить ведение полного протокола работы программы (рекомендуется):
  
  
  
• добавить в конец файла CONFIG.SYS строку:
  
  run=x:\Programs\mAPCUPS\mAPCUPS.exe 14,5
  
  где "x" -- диск, на который установлена программа;
  "14,5" -- величина задержки создания иконки на рабочем столе. В качестве альтернативы можно увеличить значение "Delay before creation of an icon" в редакторе конфигурации.
  
  Увеличение задержки необходимо для корректного создания иконки состояния на рабочем столе, значение подбирается экспериментально и зависит от скорости загрузки системы на Вашем компьютере.
  
  
• перезагрузить систему.

4. Удаление программы

• деинсталлировать программу средствами WarpIn;
• если Вы использовали альтернативный автозапуск программы и вносили вручную изменения в файл CONFIG.SYS, то удалите из него все внесённые Вами изменения;
• запустите настройку программы eStyler (eStylerLite) и из расширенных параметров закрытия системы удалите запуск скрипта:
  
  CMD /C x:\Programs\mAPCUPS\CloseMon.cmd
  
  
• деинсталлируйте драйвер USBECD в соответствии с инструкцией к нему.

Управление работой программы через именованный поток (NPipe)
Начиная с версии 0.06b получение информации о состоянии ИБП и управление работой монитора можно осуществлять через именованный поток (NPipe). Это позволяет организовывать связь монитора с другими программами, в том числе позволяет создавать для него различные графические оболочки ("фронтэнды").

При запуске монитор создает поток с именем "\PIPE\UPSMON", по которому осуществляется прием-передача команд и данных.

Список обрабатываемых команд и возвращаемых данных:

LINK	-	Запрос состояния канала связи ИБП - программа. Возвращает строку "OK" или "FAIL".
MANUF	-	Запрос названия фирмы-производителя ИБП. Возвращает строку с названием фирмы-производителя, полученную от ИБП.
PROD	-	Запрос названия ИБП. Возвращает строку с названием устройства, полученную от ИБП.
SN	-	Запрос серийного номера ИБП. Возвращает строку с серийным номером, полученную от ИБП.
BC	-	Запрос текущего уровня заряда батареи ИБП. Возвращает строку с уровнем заряда батареи ИБП в процентном выражении.
ERT	-	Запрос возможного времени работы ИБП от батареи. Возвращает строку с данным значением в секундах, полученную от ИБП.
PS	-	Запрос состояния сетевого напряжения. Возвращает строку "GOOD" или "FAIL!".
SF	-	Запрос флага статуса ИБП. Возвращает строку из шести цифр, где: первые две цифры ("00" или "01") -- состояние заряда батареи; вторые две цифры ("00" или "01") -- состояние разряда батареи; последние две цифры ("08", "10", "50" или "хх") -- состояние работы ИБП. "хх" -- неприменимо для используемого протокола.
SHTDWN_T	-	Запрос времени до выключения системы. В случае работы от сети возвращается строка со значением периода времени в секундах, на которое будет задержано выключение системы при переходе на работу от батареи. В большинстве случаев оно будет равно значению "ShutDownInterval", заданному в конфигурации монитора.
LOG	-	Запрос имени лог-файла. Возвращается строка с именем файла и путем (если был задан), либо строка "Log is disabled", если протокол не ведется.
CLOSE	-	Команда на завершение работы программы.
SHUTDOWN	-	Команда на завершение работы системы и выключение компьютера.
RCONFIG	-	Команда обновления конфигурации. Программа заново считывает конфигурационный файл и возвращает номер своей версии.

Вывод информации REXX-скриптом "Status.cmd"

Кроме описанных возвращаемых данных, в случае возникновения ошибки чтения информации из ИБП, в ответ на запрос может быть возвращена строка с другим значением или ошибкой. На неизвестные, либо ошибочные команды и запросы возвращается строка "Unknown message!"

Примеры работы с данным именованным потоком можно посмотреть в прилагаемых REXX-скриптах "Status.cmd" и "PowerOff.cmd".