Приложение А: Консольное использование программы

В программе реализован консольный режим работы для автоматического считывания и обновления данных в БД проекта, а также экспорта хозучетной статистики в xls-файл.

Формат запуска

[<Путь>]bar_shell[.exe] <Ключи>

Где:

•<Путь> — путь к программе;

•<Ключи> — параметры с заданными значениями, которые определяют консольную работу программы.

Перед названием параметра ставится два знака минус; после наименования параметра ставится пробел, а затем указывается значение параметра (при необходимости). Например:

--mode read+export
--data=events

Описание параметров

•?, h, help — отображение подсказок по консольным ключам;

•show-console — отображение консольного окна (если данный параметр не указан, то консольное окно не отображается);

•mode — выбор режима извлечения данных (read|export|read+export; по умолчанию — read); read — вычитывает информацию из устройства в базу данных; export — экспортирует из базы данных архив событий или хозучетную статистику в зависимости от ключа data;

•data — выбор данных, какие будут читаться из устройства или экспортироваться из базы данных (events|trends|stats|events+trends|events+stats|events+trends+stats|trends+stats; по умолчанию — events+trends+stats); events — архив событий, trends — архив трендов, stats — хозучетная статистика);

 Примечание: параметр trends используется только при извлечении данных из устройства в базу данных.

•ip — задание IP-адреса устройства (формат: Х.Х.Х.Х);

•serial — выбор порта (для Windows: com1|com2|...; по умолчанию — com1; для Linux: /dev/ttyS0|/dev/ttyS1|...; по умолчанию /dev/ttyS0);

•addr — выбор адреса устройства (1|2|...|0; по умолчанию — 0, т. е. широковещательный обмен);

•device-name — задание наименования устройства в базе данных (обязательный параметр, если mode имеет значение export);

•bdb-file — задание пути и названия файла базы данных (обязательный параметр);

•output-dir — задание названия пути для экспорта данных из базы данных (по  умолчанию совпадает с путем к файлу базы данных);

•output-file — задание названия файла для экспорта данных из базы данных (обязательный параметр, если mode имеет значение export);

•format — выбор формата экспортируемых данных архива и/или хозучетной статистики (формат: xlsx|xml|html|csv; по умолчанию xml; используется, только если параметр data имеет значение events и/или stats);

•date — задание начальной даты и периода извлекаемых данных хозучетной статистики (формат: [dd.mm.yyyy][?(d|m|y)]; используется, только если параметр data имеет значение stats);

•param — указание наименования параметра, по которому требуется экспортировать хозучетные данные (используется, только если параметр data имеет значение stats).

Примеры для Windows

"C:\Program Files (x86)\IC Ecoresurs\ArchiveReader\bar_shell" --ip 192.168.1.241 --mode read --bdb-file d:\test.bdb

bar_shell --serial=com2 -–addr=2 --mode=export --device-name=b311_1 --bdb-file=test.bdb --data=stats --format=xlsx --output-file=d:\test\myout.xlsx

bar_shell.exe --mode read --bdb-file d:\test.bdb --data stats --format xml --output_dir d:\xml_files

bar_shell --ip 192.168.0.216 --mode export --bdb-file d:\test.bdb --data stats --format xlsx --output_file d:\test\my_stats.xlsx --date 01.06.2025?m

Примеры для Linux

/usr/share/ecores/bar/bar_shell --show-console --mode export --bdb-file test.bdb --data stats --format xml --output_dir /home/user1/Desktop/test/xml_files

/usr/share/ecores/bar/bar_shell --mode export --bdb-file folder1/test.bdb --data events --format xml --output_file events.xml

./bar_shell --serial /dev/ttyS1 -–addr 4 --mode read --bdb-file /home/user1/Desktop/test/test.bdb

/usr/share/ecores/bar/bar_shell --ip 192.168.0.201 --mode export --bdb-file /test/my_base.bdb --data stats --format html --output_dir ./test --param ai01.01

Устаревшие ключи

•use_tcp — использование интерфейса Ethernet вместо RS-485; достаточно использовать ключ ip;

•show_console — теперь show-console;

•out — теперь output-file и output-dir;

•port — теперь serial;

•path — теперь bdb-file;

•device_name — теперь device-name.