2540
правок
Изменения
→Запросы к весовому комплексу
=Дата изменения документации=
=Общие сведения о протоколе=
{{Внимание|запрещается одновременно обновлять базу товаров в параллельных сессиях.}}
Допускается параллельное выполнение таких операций как копирование файлов или копирование считывание файлов.
==Запросы к весовому комплексу==
Запрос обязательно должен содержать следующие поля:
==Ответы от весового комплекса==
Ответ обязательно содержать следующие поля:
==Объект "''data''"==
В объекте <code>'''{{ProtocolCommand|data'''</code> }} передаются дополнительные данные, необходимые для выполнения или являющиеся результатом выполнения команд.Постоянно в объекте дата присутствуют поля <code>'''{{ProtocolCommand|application'''</code> <code>'''}} {{ProtocolCommand|version'''</code> <code>'''}} {{ProtocolCommand|compile-date'''</code>}}, в которых содержится информация о ПО, которое их сформировало. Данная информация используется в информационных целях. Так же в случае возникновения ошибки присутствует поле <code>'''{{ProtocolCommand|response-ext'''</code>}}, в котором содержится расширенное описание ошибки.
В некоторых командах, пересылающих большие объемы данных, данные предварительно могут быть запакованы архиватором GZip (см. описание команд).
Данная возможность отключается через настройки весового комплекса или в флагом <code>'''{{ProtocolCommand|use-compress'''</code> }} объекте <code>'''{{ProtocolCommand|data'''</code>}}.
Кодировка русских символов: UTF-8
==Получение и установка даты и времени на весах==
При запросе в объекте <code>'''{{ProtocolCommand|data'''</code> }} возвращаются дата/время с весов.
При установке в объекте <code>'''{{ProtocolCommand|data'''</code> }} передаются дата/время с весов.
==Начало и окончание загрузки товаров и групп==
Команда <code>'''{{ProtocolCommand|BeginUpdate'''</code> }} подается перед загрузкой товаров и/или групп внутренний буфер приема данных в этот момент очищается и весы готовы к приему данных, если команда подается повторно - данные, уже приняты на тот момент удаляются.
Команда <code>'''{{ProtocolCommand|EndUpdate'''</code> }} подается после передачи всех данных. После передачи этой команды данные анализируются, сохраняются во внутреннюю базу весов и происходит обновление информации на экране.
Изначально включается режим обновления/добавления товаров и групп. Если после команды <code>'''{{ProtocolCommand|BeginUpdate'''</code> }} передать команду <code>'''{{ProtocolCommand|ClearGoodsAndGropus'''</code>}}, то включается режим замены базы данных (перед обработкой загруженных данных база данных в весах очищается).
Данная команда позволяет получить текущее состояние весов: заблокированы или нет, текущий вес, состояние ошибки и др. информацию о весах.
При запросе в объекте <code>'''{{ProtocolCommand|data'''</code> }} данные статуса весов.
==Запуск ротации логов программы и архивов, создаваемых программой==
{ "id" : 1, "command" : "RotateLog", "data" : { "application" : "R1ScaleTester", "version" : "0.0.0.1", "compile-date" : "09-08-2017" } }
</source>
==Получение текущего протокола работы весов==
Данная команда позволяет получить текущий файл протокола работы весов.
Данные могут быть предварительно запакованы архиватором GZip (отключается в настройках весов). Так же флаг использования компрессии можно предать в объекте <code>'''{{ProtocolCommand|"data": "use-compress"'''</code> }} : 1 или 0. Далее данные кодируются в BASE-64. В объекте <code>'''{{ProtocolCommand|data'''</code> }} возвращаются данные лог файла <code>'''{{ProtocolCommand|log-file-data'''</code> }} и размер файла <code>'''{{ProtocolCommand|log-file-size'''</code>}}.
"response-code" : 0
"data" : { "log-file-size" : "120000", "log-file-data" : "данные-лог-файла" }
</source>
==Вывод сообщения на экран весов==
Данная команда позволяет выводить на экран текстовые сообщения. Возможно сопровождать вывод сообщения звуковым сигналом.
В объекте {{ProtocolCommand|data}} передается сообщение и другие параметры.
{{ProtocolCommand|message}} - текст сообщения;
{{ProtocolCommand|message-for-led}} - текст сообщения для светодиодного индикатора (если он установлен);
{{ProtocolCommand|beep}} - разрешить звуковой сигнал;
{{ProtocolCommand|time}} - длительность вывода сообщения в мс.
Запрос:
<source lang="json">
"command" : "DisplayMessage"
"data" : { "message" : "Текс сообщения", "beep" : "true", "time" : "1000" }
</source>
Ответ:
<source lang="json">
"response" : "Ok"
"response-code" : 0
</source>
==Блокировка и разблокировка работы весов==
Данная команда позволяет выполнить удаленную блокировку "{{ProtocolCommand|LockScale" }} и разблокировку "{{ProtocolCommand|UnlockScale" }} работы весов, например в случае поломок принтера.
В объекте "{{ProtocolCommand|data" }} передается пароль "{{ProtocolCommand|password" }} на проводимую операцию (изменяется в настройках весов).
==Обнуление веса и тарирование весов==
Данная команда позволяет удаленно выполнить обнуление веса "{{ProtocolCommand|ZeroWeight" }} или произвести тарирование "{{ProtocolCommand|TareWeight" }} весов.
В объекте "{{ProtocolCommand|data" }} передается пароль "{{ProtocolCommand|password" }} на проводимую операцию (изменяется в настройках весов).
==Перезагрузка и выключение весов==
Данная команда позволяет удаленно выполнить перезагрузку "{{ProtocolCommand|RebootScale" }} или произвести выключение "{{ProtocolCommand|PowerOffScale" }} весов.
В объекте "{{ProtocolCommand|data" }} передается пароль "{{ProtocolCommand|password" }} проводимую операцию (изменяется в настройках весов).
Стандартный пароль для перезагрузки и выключения: {{Password|255}}
==Перезапуск и завершение работы ПО весов==
Данная команда позволяет удаленно выполнить перезагрузку "{{ProtocolCommand|RestartApp" }} или завершить работу "{{ProtocolCommand|ShutdownApp" }} основного ПО весов.
В объекте "{{ProtocolCommand|data" }} передается пароль "{{ProtocolCommand|password" }} проводимую операцию (изменяется в настройках весов).
Стандартный пароль для перезагрузки и выключения: {{Password|255}}
</source>
==Получение информации о файле, картинке, шаблоне этикетки или других файла списка файлов в каталоге программы на весах, удаление и добавление файлов==Данная команда позволяет получить информацию о файлесписок файлов или каталогов в указанном каталоге. Начальным путем для поиска файлов является каталог программы. Для получения информации необходимо передать каталог {{ProtocolCommand|search-dir}}, маску файлов {{ProtocolCommand|files-mask}} и флаг поиска файлов или каталогов {{ProtocolCommand|search-files}}. В ответ информация приходит виде списка в поле {{ProtocolCommand|files-list}}. Запрос: <source lang="json"> "command" : "GetFileList", "data" : { "search-dir" : "./Data/Images/", "files-mask" : "*.png", "search-files" : true }</source> Ответ: <source lang="json"> "response" : "Ok", "response-code" : 0, "data" : { "search-dir" : "./Data/", "files-list" : ["goods.no.picture.png", "r1s.select.goods.action.png"] }</source> ==Добавление, удаление и получение файлов и каталогов на/с весов==
{{ProtocolCommand|file-name}} - имя файла
{{ProtocolCommand|file-data}} - данные файла./Data/Images/ Кодируются в BASE- картинки, используемые программой64.
{{ProtocolCommand|file-md5}} - контрольная сумма файла./Data/Labels/ Рассчитывается до кодировки данных в BASE- шаблоны этикеток64.
{{ProtocolCommand|use-compress}} - использование компрессии данных в GZip./Data/Media/ - звуки, используемые программой
{{ProtocolCommand|"MultiPart"}} - блочный режим передачи данных.Использование нескольких пакетов при приеме/Data/Lic/ - лицензии для программыпередаче файлов.
{{ProtocolCommand|"part-data-no"}} - номер текущего пакета при блочном приеме/передаче файлов. Отсчет с 0./Settings/ - настройки программы и экранные формы
{{ProtocolCommand|"total-parts"}} - общее количество пакетов при блочном приеме/передаче файлов../Exchange/Flags/ - флаги создаваемые программой в результате событий на весах
В объекте {{ProtocolCommand|data}} передается имя необходимого каталога {{ProtocolCommand|dir-name}}../Exchange/Log/BadFiles/ - протоколы обработки неуспешно импортированных данных
При добавлении файла в объекте {{ProtocolCommand|data}} в поле {{ProtocolCommand|file-data}} передаются данные файла, а в поле {{ProtocolCommand|file-md5}} - контрольная сумма файла рассчитанная по алгоритму MD5 до кодирования в BASE-64.При передаче файла частями {{ProtocolCommand|file-md5}} передается только в последнем пакете и содержит контрольную сумма всего файла./Exchange/Reports/ - отчеты, создаваемые программой
Данные могут быть предварительно запакованы архиватором GZip (отключается в настройках весов). Так же флаг использования компрессии можно предать в объекте {{ProtocolCommand|"data": "use-compress"}} : ''1'' или ''0'' или ''true''/''false''. При использовании блочной передачи файлов архиватором пакуется каждая часть отдельно. После паковки блока, данные кодируются в BASE-64.
<source lang="json">
"data" : {
"file-name" : "./Data/Images/goods.no.picture.png" , "file-data" : "данные-файла", "usefile-compressmd5" : 1"9caa7d76e8e08b56256594f39c13e7d8"
}
<--
"response" : "Ok",
"response-code" : 0
</source>
<source lang="json">
--> Первая часть "command" : "AddFile", "data" : { "file-name" : "./Data/Images/goods.no.picture.png", "file-data" : "данные-файла", "part-data-no" : 0, "total-parts" : 5 } <-- "response" : "Ok", "response-code" : 0, "data" : { "part-data-no" : 0, "total-parts" : 5 } ... -->Последующие части "command" : "PartDataSended", "data" : { "file-name" : "./Data/Images/goods.no.picture.png", "file-data" : "данные-файла", "part-data-no" : 3, "total-parts" : 5, "use-compress" : 1 } <-- "response" : "MultiPart", "response-code" : 1, "data" : { "part-data-no" : 3, "total-parts" : 5 } ... -->Последняя часть "command" : "PartDataSended",
"data" : {
"file-name" : "./Data/Images/goods.no.picture.png", "file-sizedata" : "12332данные-файла", "part-data-no": 4, "total-parts" : 5, "use-compress" : 1, "file-md5" : "e455d2b43b6157b50e8f502ac77aad139caa7d76e8e08b56256594f39c13e7d8"
}
<--
"response" : "MultiPart",
"response-code" : 1,
"data" : {
"part-data-no" : 4,
"total-parts" : 5
}
</source>
==Выполнение команды весами==
Данная команда позволяет выполнить команды на весах.
Данная команда позволяет полностью очистить базу товаров и групп перед загрузкой новых товаров и групп.
Если данная команда не передается, то включается режим обновления/добавления товаров.
Очистка данных производится только если добавляется хотя бы один товар.
'''Если данная команда передается отдельно от других команд, производится полная очистка базы товаров (удаляются все товары и группы).'''
Запрос:
Перед использование данных команд, необходимо передать на весы команду '''''{{ProtocolCommand|BeginUpdate'''''}}, а по окончании работы с товарами передается команда '''''{{ProtocolCommand|EndUpdate'''''}}. При необходимости очистки базы товаров на весах, между передачами команд '''''{{ProtocolCommand|BeginUpdate/EndUpdate'''''}}, так же необходимо передать команду {{ProtocolCommand|ClearGoodsAndGroups}}. При использовании команд обновления ({{ProtocolCommand|UpdateGoods}} и {{ProtocolCommand|UpdateGroups}}), если товара или группы нет в базе весов - товар или группа создаются и сообщение об ошибке не передается. Разница между командами {{ProtocolCommand|UpdateХХХ}} и {{ProtocolCommand|AddXXX}} заключается в минимальном наборе параметров, которые необходимо передаются на весы, что бы не возникло ошибки при приеме команды. Так для для команды {{ProtocolCommand|AddGoods}} необходимо передать: номер товара, название товар, группу-владелец и цену. Для команды {{ProtocolCommand|UpdateGoods}}: только номер товара. Если при использовании команд удаления ({{ProtocolCommand|RemoveGoods}} и {{ProtocolCommand|RemoveGroups}}) товар или группа не найден - передается ошибка '''''ClearGoodsAndGroupsтовар не найден'''''. В объекте {{ProtocolCommand|data}} передаются все необходимые параметры товара или группы.
*Поля данных товара:
{{ProtocolCommand|goods-valid-date}} - дата/время окончания срока годности (формат:'''''goodsdd-shelfMM-lifeyyyy hh:mm''''' - срок годности в днях. Если число отрицательно - в часах).
{{ProtocolCommand|goods-sale-before-date}} - дата/время окончания продажи товара (формат:'''''goodsdd-weightMM-unityyyy hh:mm''''' - весовая единица товара). Для версии 1.0.2.21 и старше.
{{ProtocolCommand|goods-shelf-life}} - срок годности в днях. Если число отрицательно:'''''в часах. {{ProtocolCommand|goods-weight-unit}} - весовая единица товара. {{ProtocolCommand|goods-tare''''' }} - вес тары товара. {{ProtocolCommand|goods-message-x}} - текстовые сообщения для печати на этикетке, где х номер строки текстового сообщения. Расширенные сообщения (номера с 6 и выше) введены начиная с сборки 4121. // "goods-message-1" - текстовое сообщение // "goods-message-2" - ингредиенты // "goods-message-3" - страна происхождения // "goods-message-4" - реклама // "goods-message-5" - данные для второго ШК // "goods-message-6" - пищевая ценность / энергетическая ценность // "goods-message-7" - условия хранения // "goods-message-8" - изготовлено // "goods-message-9" - срок годности // "goods-message-10" - изготовитель // "goods-message-11" - картинка для этикетки
*Для успешного добавления товара необходимо передать как минимум следующие поля:
*В поле '''''{{ProtocolCommand|goods-picture-filename''''' }} и '''''{{ProtocolCommand|goods-second-picture-filename''''' }} передается имя файла картинки для товара или группы. Указанный файл должен присутсвовать присутствовать в каталоге '''''{{Путь к файлу|./Data/PicturesImages/'''''}}. Можно располагать файлы в подкаталогах.
*Данные могут быть предварительно запакованы архиватором GZip (отключается в настройках весов). Так же флаг использования компрессии можно предать в объекте '''''{{ProtocolCommand|data''''': '''''use-compress''''' }} : 1 или 0.
:Далее данные кодируются в BASE-64.
*Срок годности товара имеет следующие значение:
*Поля "{{ProtocolCommand|goods-message-x" }} служат для передачи дополнительной текстовой информации, печатаемой на этикетке.
:Перечень соответствия сообщений и элементов шаблона этикетки:
:"{{ProtocolCommand|goods-message-1" }} - текстовое сообшениесообщение
:"{{ProtocolCommand|goods-message-2" }} - ингридиентыингредиенты
:"{{ProtocolCommand|goods-message-3" }} - страна происхождения
:"{{ProtocolCommand|goods-message-4" }} - реклама
*Поля данных группы:
*Для успешного добавления группы необходимо передать как минимум следующие поля:
Сокращения используемые в таблице:
'''''D ''''' - отдел
'''''L ''''' - № товара
'''''I ''''' - код магазина
'''''P ''''' - цена
'''''Q ''''' - вес
'''''CRC ''''' - контрольная сумма
| 52 || EAN8 || DD(2) IIIII(5) CRC(1) || Не поддерживание (введен для совместимости)
|-
| '''99=...119''' || EAN13 || Пользовательские штрихкоды ||Тип ШК задается в структуре пользовательского кода начиная с версии 1.0.2.21|-| '''200''' || || Пользовательский штрихкод, индивидуальный для каждого товара || Тип ШК задается в данных каждого товара индивидуально с версии 1.0.2.23
|}
Изменение пользовательских ШК описано {{Описано в разделе|Настройка_пользовательского_штрихкода}}.
==Добавление или связывание шаблонов этикеток==
Данная команда служат для передачи на весы шаблонов этикеток и установки связи между именами файлов шаблонов этикеток и номерами этикеток, которые используются в параметрах товаров.
При установке связи между именем файла шаблона этикетки, необходимо предварительно загрузить файл на весы в каталог {{Путь к файлу|./Data/Labels}}.
Если файл отсутвует отсутствует - связь не будет установлена.
В случае передачи данных шаблона в команде имя файла генерируется автоматически.
Перед использование данной команды, необходимо передать на весы команду "{{ProtocolCommand|BeginUpdate"}}, а по окончании работы с товарами передается команда "{{ProtocolCommand|EndUpdate"}}. Можно использовать эти команду в едином цикле с обновление информации о товарах.
Данные шаблонов, если передаются прямо в команде, могут быть предварительно запакованы архиватором GZip (отключается в настройках весов).
Так же флаг использования компрессии можно предать в объекте {{ProtocolCommand|"data": "use-compress" }} : 1 или 0.
Далее данные кодируются в BASE-64.
Поля данных этикетки:
==Изменение номера и названия магазина==
Возможна передача до 4-х строк названия магазина.
Перед использование данной команды, необходимо передать на весы команду "{{ProtocolCommand|BeginUpdate"}}, а по окончании работы передается команда "{{ProtocolCommand|EndUpdate"}}. Можно использовать эти команду в едином цикле с обновление информации о товарах.
Поля данных этикетки:
"storesettings-name": "enImageRecognition", "settings-1 - название магазина строка 1 value": false, }}</source>
Для получения нескольких настроек одновременно можно при передаче использовать список c названиями настроек.Для этого необходимо записать имена настроек в список {{ProtocolCommand|items-list}}. Значения так же возвращаются в списке {{ProtocolCommand|items-list}}. <source lang="json"store>{ "id": 18, "command": "GetSettings", "data": { "application": "PyR1SensorDriver", "version": "0.0.1.0", "version-build": "1", "compile-date": "26.07.2022", "password": "11b9842e0a271ff252c1903e7132cd68", "crypted-password": true, "items-list": [{"settings-name": "enImageRecognition"}, {"settings-2 - название магазина строка 2 name": "enDebug"}] }}</source>
<source lang="storejson">{ "id": 18, "response": "Ok", "response-code": 0 "data": { "application": "R1 Sensor.", "compile-date": "26-07-2022", "version": "1.0.2.22", "version-build": 4153, "items-list": [{"settings-name": "enImageRecognition", "settings-value": "true"}, {"settings-name": "enDebug", "settings-4 value": "true"}] },}</source> === Изменение значения настроек === Команда для изменения настроек на весах: {{ProtocolCommand|SetSettings}} При изменении настроек используется тоже имя настройки, что и при получении значения настройки. В поле {{ProtocolCommand|settings- name}} передается название магазина строка 4 необходимого параметра настроек, а поле {{ProtocolCommand|settings-valuе}} само значение. <source lang="json">{ "id": 18, "command": "SetSettings", "data": { "application": "PyR1SensorDriver", "version": "0.0.1.0", "version-build": "1", "compile-date": "26.07.2022", "password": "11b9842e0a271ff252c1903e7132cd68", "crypted-password": true, "settings-name": "enImageRecognition", "settings-value": "true" }}</source> Ответ: <source lang="json">{ "id": 18, "response": "Ok", "response-code": 0 "data": { "application": "R1 Sensor.", "compile-date": "26-07-2022", "version": "1.0.2.22", "version-build": 4153 },}</source> Для изменения нескольких настроек одновременно можно при передаче использовать список.Для этого необходимо записать настройки в список {{ProtocolCommand|items-list}} <source lang="json">{ "id": 18, "command": "SetSettings", "data": { "application": "PyR1SensorDriver", "version": "0.0.1.0", "version-build": "1", "compile-date": "26.07.2022", "password": "11b9842e0a271ff252c1903e7132cd68", "crypted-password": true, "items-list": [{"settings-name": "enImageRecognition", "settings-value": "true"}, {"settings-name": "enDebug", "settings-value": "true"}] }}</source> В ответе на данную команду присутствует список со статусами изменения каждой из переданных настроек: <source lang="json">{ "id": 18, "response": "Ok", "response-code": 0 "data": { "application": "R1 Sensor.", "compile-date": "26-07-2022", "version": "1.0.2.22", "version-build": 4153 "items-list": [{"enImageRecognition": True}, {"enDebug": True}] }}</source> ==Перезапуск системы распознавания товаров== Данная команда служат для перезапуска системы распознавания товаров после изменения настроек системы. При передаче данной команды необходимо передавать пароль для изменения настроек (этот пароль используется так же для входа в режим настроек на весах). При передаче пароля рекомендуется передавать MD5 сумму пароля в поле {{ProtocolCommand|password}} и значение {{ProtocolCommand|"crypted-password": true}}. Если пароль передается в открытом виде, что не рекомендуется по соображениям безопасности, то нужно передать значение {{ProtocolCommand|"crypted-password": false}}. <source lang="json">{ "id": 6, "command": "RestartImageRecognitionSystem", "data": { "application": "PyR1SensorDriver", "version": "0.0.1.0", "version-build": "1", "compile-date": "26.07.2022", "password": "11b9842e0a271ff252c1903e7132cd68", "crypted-password": true }}</source> Ответ: <source lang="json">{ "id": 6, "response": "Ok", "response-code": 0 "data": { "application": "R1 Sensor.", "compile-date": "26-07-2022", "version": "1.0.2.22", "version-build": 4153 },}</source>
=Перечень ошибок=
При возникновении ошибок в ответе содержится текстовый ответ и код, сообщающие о возникшей ошибке.
Так же в объект "{{ProtocolCommand|data" }} добавляется поле с расширенным описание ошибки "{{ProtocolCommand|response-ext"}}.
При работе с весами возможны следующие ошибки: