Руководство программиста
ПРОГРАММНЫЙ КОМПЛЕКС СБОРА И ОБРАБОТКИ БИОМЕТРИЧЕСКИХ ДАННЫХ «БИОД»
Аннотация
Настоящий документ предназначен для программиста как руководство по инсталляции и настройке конфигурации программного комплекса сбора и обработки биометрических данных «БИОД» (ПК «ЦТЛ.БИОД»).
В руководстве программиста программного комплекса сбора и обработки биометрических данных «БИОД» описан порядок обращения к ПК «ЦТЛ.БИОД», процессов установки и настройки программного комплекса на условиях его конкретного применения, дано описание способов проверки, позволяющих сделать общее заключение о работоспособности программного комплекса.
1. НАЗНАЧЕНИЕ И УСЛОВИЯ ПРИМЕНЕНИЯ
1.1. Обозначение и наименование программы
1.1.1. Наименование изделия - Программный комплекс сбора и обработки биометрических данных «БИОД».
1.1.2. Краткое наименование - ПК «ЦТЛ.БИОД».
1.1.3. Файлы для установки:
- biod.tar.gz;
- biodterm-server.tar.gz
1.2. Назначение и функции программы
1.2.1. ПК «ЦТЛ.БИОД» предназначен для решения комплекса задач по высокоуровневому управлению периферийным оборудованием и специальным программным обеспечением сторонних производителей.
1.2.2. Посредством вызовов удаленных процедур ПК «ЦТЛ.БИОД» предоставляет доступ к функциям следующего оборудования:
- блоку управления светом;
- блоку управления калиткой.
1.2.3. Приложения, входящие в ПК «ЦТЛ.БИОД», обеспечивают проверку работы ПК.
1.3. Сведения о программных средствах, обеспечивающих работу ПК «ЦТЛ.БИОД»
1.3.1. Операционная система: Astra Linux 1.7 SE Х86-64.
1.3.2. Для работы ПК «ЦТЛ.БИОД» используются компоненты из состава операционной системы.
2. ХАРАКТЕРИСТИКА ПРОГРАММНОГО КОМПЛЕКСА
2.1. Структура программного комплекса
2.1.1. ПК «ЦТЛ.БИОД» представляет собой монолитное приложение, содержащее в своем составе библиотеки и модули сопряжения с оборудованием, предоставляемым их разработчиками.
2.1.2. Структура и алгоритм работы ПК изображены на рисунке 1.
ПРОГРАММНЫЙ КОМПЛЕКС СБОРА И ОБРАБОТКИ БИОМЕТРИЧЕСКИХ ДАННЫХ «БИОД»
Аннотация
Настоящий документ предназначен для программиста как руководство по инсталляции и настройке конфигурации программного комплекса сбора и обработки биометрических данных «БИОД» (ПК «ЦТЛ.БИОД»).
В руководстве программиста программного комплекса сбора и обработки биометрических данных «БИОД» описан порядок обращения к ПК «ЦТЛ.БИОД», процессов установки и настройки программного комплекса на условиях его конкретного применения, дано описание способов проверки, позволяющих сделать общее заключение о работоспособности программного комплекса.
1. НАЗНАЧЕНИЕ И УСЛОВИЯ ПРИМЕНЕНИЯ
1.1. Обозначение и наименование программы
1.1.1. Наименование изделия - Программный комплекс сбора и обработки биометрических данных «БИОД».
1.1.2. Краткое наименование - ПК «ЦТЛ.БИОД».
1.1.3. Файлы для установки:
- biod.tar.gz;
- biodterm-server.tar.gz
1.2. Назначение и функции программы
1.2.1. ПК «ЦТЛ.БИОД» предназначен для решения комплекса задач по высокоуровневому управлению периферийным оборудованием и специальным программным обеспечением сторонних производителей.
1.2.2. Посредством вызовов удаленных процедур ПК «ЦТЛ.БИОД» предоставляет доступ к функциям следующего оборудования:
- блоку управления светом;
- блоку управления калиткой.
1.2.3. Приложения, входящие в ПК «ЦТЛ.БИОД», обеспечивают проверку работы ПК.
1.3. Сведения о программных средствах, обеспечивающих работу ПК «ЦТЛ.БИОД»
1.3.1. Операционная система: Astra Linux 1.7 SE Х86-64.
1.3.2. Для работы ПК «ЦТЛ.БИОД» используются компоненты из состава операционной системы.
2. ХАРАКТЕРИСТИКА ПРОГРАММНОГО КОМПЛЕКСА
2.1. Структура программного комплекса
2.1.1. ПК «ЦТЛ.БИОД» представляет собой монолитное приложение, содержащее в своем составе библиотеки и модули сопряжения с оборудованием, предоставляемым их разработчиками.
2.1.2. Структура и алгоритм работы ПК изображены на рисунке 1.
ПК ЦТЛ.БИОД
2.2. Установка программного комплекса
2.2.1. Предустановочные действия
2.2.1.1. Перед установкой ПК, программист должен ознакомиться с документацией:
1) 643 .ЦТЛС.00001-01 31 01 «Описание применения»;
2)643.ЦТЛС.00001-01 91 01 «Инструкция по установке»;
2.2.2. Состав и содержание дистрибутивного носителя данных:
1) установочный файл с расширением tar.gz:
- biod.tar.gz;
- biodterm-server.tar.gz;
2) файл контрольной суммы с расширением .md5:
- biod.tar.gz.md5;
- biodterm-server.tar.gz.md5.
2.2.3. Порядок установки программного комплекса
2.2.3.1. Подробный порядок установки ПК описан в документе 643.ЦТЛС.00003-01 91 01 «Инструкция по установке».
2.2.1. Предустановочные действия
2.2.1.1. Перед установкой ПК, программист должен ознакомиться с документацией:
1) 643 .ЦТЛС.00001-01 31 01 «Описание применения»;
2)643.ЦТЛС.00001-01 91 01 «Инструкция по установке»;
2.2.2. Состав и содержание дистрибутивного носителя данных:
1) установочный файл с расширением tar.gz:
- biod.tar.gz;
- biodterm-server.tar.gz;
2) файл контрольной суммы с расширением .md5:
- biod.tar.gz.md5;
- biodterm-server.tar.gz.md5.
2.2.3. Порядок установки программного комплекса
2.2.3.1. Подробный порядок установки ПК описан в документе 643.ЦТЛС.00003-01 91 01 «Инструкция по установке».
3. ОБРАЩЕНИЕ К ПРОГРАММНОМУ КОМПЛЕКСУ
3.1. Управление программным комплексом
3.1.1. Взаимодействие прикладного ПО осуществляется по протоколу HTTP/JSON.
3.1.1.1. Под процессами в данном документе понимаются следующие действия выполняемые ПК «ЦТЛ.БИОД»:
1) управление освещением;
2) управление калитками.
3.1.1.2. При старте любого процесса ПК «ЦТЛ.БИОД» формирует уникальный идентификатор, который передаётся во всех сообщениях, имеющих отношение к данному процессу.
3.1.1.3. Любой процесс начинается с сообщения о начале процесса, внутри которого передаётся идентификатор процесса и заканчивается сообщением об окончании процесса, в котором сообщается о статусе выполненного процесса: процесс выполнен без ошибок или передаются возникшие при выполнении процесса ошибки.
3.1.1.4. После сообщения об окончания процесса все данные, хранящиеся в ПК «ЦТЛ.БИОД», относящиеся к данному процессу из ПК, удаляются.
3.1.1.5. В промежутке между началом и окончанием процесса ПК «ЦТЛ.БИОД» можно запросить о текущем статусе процесса передав уникальный идентификатор. В ответ 11110 должно вернуть текущий статус или ошибку о том, что процесс не найден.
3.1.1.6. Идентификатор процесса далее по документу поименован как processID.
3.1.1.7. Все процессы должны происходить в рамках сеанса обслуживания одного субъекта. В начале регистрации в ПК «ЦТЛ.БИОД» передаётся идентификатор прохода, после окончания регистрации передаётся соответствующая команда.
3.1.1.8. Если в ПК «ЦТЛ.БИОД» нет активного идентификатора прохода, то никакие новые процессы не начинаются. ПК «ЦТЛ.БИОД» возвращает ошибку.
3.1.1.9. Идентификатор прохода далее по документу поименован как passID
3.1.2. Настройка параметров информационного взаимодействия через конфигурационный файл
3.1.2.1. Конфигурационный файл представляет собой простую структуру «ключ-значение» с описанием каждого параметра непосредственно в нем. Для изменения параметров информационного взаимодействия, необходимо отредактировать данные в этом файле текстовым редактором. Пример стандартного конфигурационного файла информационного взаимодействия:
[Gates]
enable=true
timeout=10
orphan_baud_rate=9600
acms_card_id_pattem=" [A-Za-zO-9] {6,256} " acms_card_id_mathing_lsb_min=24 Gatel/SN=000011
Gate 1 /wicket 1 /index=0
Gate 1 /w icket 1 /end_s witch_index=0
Gate 1 /wicket 1 /reversed=false
Gate2/SN=301156
Gate2/wicket 1 /index=0
Gate2/wicket 1 / end_switch_index=O
Gate2/wicketl/reversed=false
[Main]
AutoScan=true
CtrlPanelTab=O
FS_Cache=/var/run/ssm-arm/cache
KeepCache=true
V isualDebug=false
Protocol_level=3
Protocoljath=/var/log/ssm-arm
[Mise]
DisplayHttpHeaders=true
[Network]
InPort=8080
OutUrl=http://localhost:3000/biodendpoint
3.1.3. Настройка параметров управления калитками через конфигурационный файл
3.1.3.1. Настройка параметров управления калитками производится в файле /usr/local/share/ssm-arm/ssm.ini. Пример стандартного конфигурационного файла управления калитками:
[Gates]
enable=true
timeout=10
orphan_baud_rate=9600
acms_card_id_pattem=" [A-Za-zO-9] {6,256}" acms_card_id_mathing_lsb_min=24
Gatel/SN=000011
Gate 1 /w icket 1 /index=0
Gate 1 /wicket 1 /end_s witch_index=0
Gate 1 /wicket 1 /reversed=false
Gate 1 /wicket2/index= 1
Gate 1 /wicket2/end_s witch_index=0
Gate 1 /wicket2/reversed=false
Gate2/SN=301156
Gate2/wicket 1 /index=0
Gate2/wicket 1 / end_switch_index=O
Gate2/wicket 1 /reversed=false
Gate2/wicket2/index=2
Gate2/wicket2/end_switch_index=0
Gate2/wicket2/reversed=false
4. ВХОДНЫЕ И ВЫХОДНЫЕ ДАННЫЕ
4.1. Описание методов API
4.1.1. Общие сведения
4.1.1.1. Запрос к процессам ПК производится посредством метода POST, с отправкой JSON-сообщения, содержащего команду и параметры.
4.1.1.2. Логика запроса к API, на примере инструмента curl:
curl —header "Content-Type: application/json" \
—request POST \
—url 'http://localhost:8080'\
—data' {"getStatus": { }}'
Ответ:
{"getStatus": {"Error":"","OutURL":"localhost","ReadError":"","Status":"Success","passI
D":"0","processID":"0"}}
Error - информация о возникших ошибках;
OutURL - URL который будет вызываться для доставки сообщений от 11110.
Замещает значение из конфигурационного файла;
ReadError - Дублирует значение ХХХ.Еггог;
Status - Возможные значения: Success - при отсутствии ошибок; Error - при наличии ошибок;
passID - идентификатор прохода;
processID - уникальный идентификатор процесса
4.1.2. Запрос параметров информационного взаимодействия с помощью тестового приложения
4.1.2.1. Запрос инициализации текущих процессов в ПК
3.1. Управление программным комплексом
3.1.1. Взаимодействие прикладного ПО осуществляется по протоколу HTTP/JSON.
3.1.1.1. Под процессами в данном документе понимаются следующие действия выполняемые ПК «ЦТЛ.БИОД»:
1) управление освещением;
2) управление калитками.
3.1.1.2. При старте любого процесса ПК «ЦТЛ.БИОД» формирует уникальный идентификатор, который передаётся во всех сообщениях, имеющих отношение к данному процессу.
3.1.1.3. Любой процесс начинается с сообщения о начале процесса, внутри которого передаётся идентификатор процесса и заканчивается сообщением об окончании процесса, в котором сообщается о статусе выполненного процесса: процесс выполнен без ошибок или передаются возникшие при выполнении процесса ошибки.
3.1.1.4. После сообщения об окончания процесса все данные, хранящиеся в ПК «ЦТЛ.БИОД», относящиеся к данному процессу из ПК, удаляются.
3.1.1.5. В промежутке между началом и окончанием процесса ПК «ЦТЛ.БИОД» можно запросить о текущем статусе процесса передав уникальный идентификатор. В ответ 11110 должно вернуть текущий статус или ошибку о том, что процесс не найден.
3.1.1.6. Идентификатор процесса далее по документу поименован как processID.
3.1.1.7. Все процессы должны происходить в рамках сеанса обслуживания одного субъекта. В начале регистрации в ПК «ЦТЛ.БИОД» передаётся идентификатор прохода, после окончания регистрации передаётся соответствующая команда.
3.1.1.8. Если в ПК «ЦТЛ.БИОД» нет активного идентификатора прохода, то никакие новые процессы не начинаются. ПК «ЦТЛ.БИОД» возвращает ошибку.
3.1.1.9. Идентификатор прохода далее по документу поименован как passID
3.1.2. Настройка параметров информационного взаимодействия через конфигурационный файл
3.1.2.1. Конфигурационный файл представляет собой простую структуру «ключ-значение» с описанием каждого параметра непосредственно в нем. Для изменения параметров информационного взаимодействия, необходимо отредактировать данные в этом файле текстовым редактором. Пример стандартного конфигурационного файла информационного взаимодействия:
[Gates]
enable=true
timeout=10
orphan_baud_rate=9600
acms_card_id_pattem=" [A-Za-zO-9] {6,256} " acms_card_id_mathing_lsb_min=24 Gatel/SN=000011
Gate 1 /wicket 1 /index=0
Gate 1 /w icket 1 /end_s witch_index=0
Gate 1 /wicket 1 /reversed=false
Gate2/SN=301156
Gate2/wicket 1 /index=0
Gate2/wicket 1 / end_switch_index=O
Gate2/wicketl/reversed=false
[Main]
AutoScan=true
CtrlPanelTab=O
FS_Cache=/var/run/ssm-arm/cache
KeepCache=true
V isualDebug=false
Protocol_level=3
Protocoljath=/var/log/ssm-arm
[Mise]
DisplayHttpHeaders=true
[Network]
InPort=8080
OutUrl=http://localhost:3000/biodendpoint
3.1.3. Настройка параметров управления калитками через конфигурационный файл
3.1.3.1. Настройка параметров управления калитками производится в файле /usr/local/share/ssm-arm/ssm.ini. Пример стандартного конфигурационного файла управления калитками:
[Gates]
enable=true
timeout=10
orphan_baud_rate=9600
acms_card_id_pattem=" [A-Za-zO-9] {6,256}" acms_card_id_mathing_lsb_min=24
Gatel/SN=000011
Gate 1 /w icket 1 /index=0
Gate 1 /wicket 1 /end_s witch_index=0
Gate 1 /wicket 1 /reversed=false
Gate 1 /wicket2/index= 1
Gate 1 /wicket2/end_s witch_index=0
Gate 1 /wicket2/reversed=false
Gate2/SN=301156
Gate2/wicket 1 /index=0
Gate2/wicket 1 / end_switch_index=O
Gate2/wicket 1 /reversed=false
Gate2/wicket2/index=2
Gate2/wicket2/end_switch_index=0
Gate2/wicket2/reversed=false
4. ВХОДНЫЕ И ВЫХОДНЫЕ ДАННЫЕ
4.1. Описание методов API
4.1.1. Общие сведения
4.1.1.1. Запрос к процессам ПК производится посредством метода POST, с отправкой JSON-сообщения, содержащего команду и параметры.
4.1.1.2. Логика запроса к API, на примере инструмента curl:
curl —header "Content-Type: application/json" \
—request POST \
—url 'http://localhost:8080'\
—data' {"getStatus": { }}'
Ответ:
{"getStatus": {"Error":"","OutURL":"localhost","ReadError":"","Status":"Success","passI
D":"0","processID":"0"}}
Error - информация о возникших ошибках;
OutURL - URL который будет вызываться для доставки сообщений от 11110.
Замещает значение из конфигурационного файла;
ReadError - Дублирует значение ХХХ.Еггог;
Status - Возможные значения: Success - при отсутствии ошибок; Error - при наличии ошибок;
passID - идентификатор прохода;
processID - уникальный идентификатор процесса
4.1.2. Запрос параметров информационного взаимодействия с помощью тестового приложения
4.1.2.1. Запрос инициализации текущих процессов в ПК
4.1.2.1.1. Входные параметры
4.1.2.1.2. Выходные параметры
4.1.2.2. Запрос статуса ППО
4.1.2.2.1. Входные параметры: нет.
4.1.2.2.2. Выходные параметры
4.1.2.2.2. Выходные параметры
4.1.2.З. Управление освещением
4.1.2.З.1. Запрос установки параметров освещения
4.1.2.З.1. Запрос установки параметров освещения
4.1.2.3.1.2.Выходные параметры
4.1.2.4.3. Выходные параметры
1) Положительный ответ
1) Положительный ответ
5. ПРОВЕРКА ПРОГРАММНОГО КОМПЛЕКСА
5.1. Порядок проверки работоспособности программного комплекса описан в документе 643.ЦТЛС.00004-01 51 01 «Программа и методика испытаний».
6. СООБЩЕНИЯ
6.1. Сообщения о стандартных ошибках, выдаваемые программисту описаны в таблице .
5.1. Порядок проверки работоспособности программного комплекса описан в документе 643.ЦТЛС.00004-01 51 01 «Программа и методика испытаний».
6. СООБЩЕНИЯ
6.1. Сообщения о стандартных ошибках, выдаваемые программисту описаны в таблице .
5. ПРОВЕРКА ПРОГРАММНОГО КОМПЛЕКСА
5.1. Порядок проверки работоспособности программного комплекса описан в документе 643.ЦТЛС.00004-01 51 01 «Программа и методика испытаний».
6. СООБЩЕНИЯ
6.1. Сообщения о стандартных ошибках, выдаваемые программисту описаны в таблице .
5.1. Порядок проверки работоспособности программного комплекса описан в документе 643.ЦТЛС.00004-01 51 01 «Программа и методика испытаний».
6. СООБЩЕНИЯ
6.1. Сообщения о стандартных ошибках, выдаваемые программисту описаны в таблице .
6.2. В каждом сообщении ПК «ЦТЛ.БИОД» возвращает статус подготовки
информации или выполнения действия, приведшего к формированию данного сообщения (описано в таблице 2):
информации или выполнения действия, приведшего к формированию данного сообщения (описано в таблице 2):
