2540
правок
Изменения
→Запросы к весовому комплексу
=Дата изменения документации=
=Общие сведения о протоколе=
{{Внимание|запрещается одновременно обновлять базу товаров в параллельных сессиях.}}
Допускается параллельное выполнение таких операций как копирование файлов или копирование считывание файлов и обновление базы товаров.
:При подсоединении к весам, они выдают пакет соединения.
:В ответ на этот пакет в течении 30 секунд необходимо передать пакет установки связи. В случае истечения таймаута весы закрывают соединение.
Запрос обязательно должен содержать следующие поля:
Ответ обязательно содержать следующие поля:
{{ProtocolCommand|id}} - идентификатор запроса.
В некоторых командах, пересылающих большие объемы данных, данные предварительно могут быть запакованы архиватором GZip (см. описание команд).
Данная возможность отключается через настройки весового комплекса или в флагом "''{{ProtocolCommand|use-compress''" }} объекте "''{{ProtocolCommand|data''"}}.
Кодировка русских символов: UTF-8
Запрос:
<source lang="json"> "command" : "Link"</source>
Ответ:
<source lang="json"> "response" : "Ok" "response-code" : 0</source>
Пример:
<source lang="json">
{ "id" : 1, "command" : "Link", "data" : { "application" : "R1ScaleTester", "version" : "0.0.0.1", "compile-date" : "09-08-2017" } } { "id" : 1, "response" : "Ok", "response-code" : 0, "data" : { "application" : "R1 Self Service Soft.", "version" : "1.0.2.11", "compile-date" : "09-08-2017" } }
</source>
Запрос:
<source lang="json"> "command" : "TestLink"</source>
Ответ:
<source lang="json"> "response" : "Ok" "response-code" : 0</source>
Пример:
<source lang="json">
{ "id" : 1, "command" : "TestLink", "data" : { "application" : "R1ScaleTester", "version" : "0.0.0.1", "compile-date" : "09-08-2017" } } { "id" : 1, "response" : "Ok", "response-code" : 0, "data" : { "application" : "R1 Self Service Soft.", "version" : "1.0.2.11", "compile-date" : "09-08-2017" } }
</source>
==Получение и установка даты и времени на весах==
При запросе в объекте "{{ProtocolCommand|data" }} возвращаются дата/время с весов.
При установке в объекте "{{ProtocolCommand|data" }} передаются дата/время с весов.
Запрос:
<source lang="json"> "command" : "GetDateTime" "command" : "SetDateTime"</source>
Ответ:
<source lang="json"> "response" : "Ok" "response-code" : 0 "data" : { "date" : "21-08-2015", "time" : "12:00:00" }</source>
Пример:
<source lang="json">
{ "id" : 1, "command" : "GetDateTime", "data" : { "application" : "R1ScaleTester", "version" : "0.0.0.1", "compile-date" : "09-08-2017" } } { "id" : 1, "response" : "Ok", "response-code" : 0, "data" : { "date" : "21-08-2015", "time" : "12:00:00", "application" : "R1ScaleTester", "version" : "0.0.0.1", "compile-date" : "09-08-2017" } }
{ "id" : 1, "command" : "SetDateTime", "data" : { "date" : "21-08-2015", "time" : "12:00:00", "application" : "R1ScaleTester", "version" : "0.0.0.1", "compile-date" : "09-08-2017" } } { "id" : 1, "response" : "Ok", "response-code" : 0, "data" : { "application" : "R1 Self Service Soft.", "version" : "1.0.2.11", "compile-date" : "09-08-2017" } }
</source>
==Начало и окончание загрузки товаров и групп==
Команда "{{ProtocolCommand|BeginUpdate" }} подается перед загрузкой товаров и/или групп внутренний буфер приема данных в этот момент очищается и весы готовы к приему данных, если команда подается повторно - данные, уже приняты на тот момент удаляются.
Команда "{{ProtocolCommand|EndUpdate" }} подается после передачи всех данных. После передачи этой команды данные анализируются, сохраняются во внутреннюю базу весов и происходит обновление информации на экране.
Изначально включается режим обновления/добавления товаров и групп. Если после команды "{{ProtocolCommand|BeginUpdate" }} передать команду "{{ProtocolCommand|ClearGoodsAndGropus"}}, то включается режим замены базы данных (перед обработкой загруженных данных база данных в весах очищается).
Запрос:
<source lang="json"> "command" : "BeginUpdate" "command" : "EndUpdate"</source>
Ответ:
<source lang="json"> "response" : "Ok" "response-code" : 0</source>
Пример:
<source lang="json">
{ "id" : 1, "command" : "BeginUpdate", "data" : { "application" : "R1ScaleTester", "version" : "0.0.0.1", "compile-date" : "09-08-2017" } } { "id" : 1, "response" : "Ok", "response-code" : 0, "data" : { "application" : "R1ScaleTester", "version" : "0.0.0.1", "compile-date" : "09-08-2017" } }
{ "id" : 1, "command" : "EndUpdate", "data" : { "application" : "R1ScaleTester", "version" : "0.0.0.1", "compile-date" : "09-08-2017" } } { "id" : 1, "response" : "Ok", "response-code" : 0, "data" : { "application" : "R1 Self Service Soft.", "version" : "1.0.2.11", "compile-date" : "09-08-2017" } }
</source>
Данная команда позволяет получить текущее состояние весов: заблокированы или нет, текущий вес, состояние ошибки и др. информацию о весах.
При запросе в объекте "{{ProtocolCommand|data" }} данные статуса весов.
Запрос:
<source lang="json"> "command" : "GetState",</source>
Ответ:
<source lang="json"> "response" : "Ok" "response-code" : 0</source> Пример:<source lang="json"> { "id" : 1, "command" : "GetState", "data" : { "application" : "R1ScaleTester", "version" : "0.0.0.1", "compile-date" : "09-08-2017" } }</source> {{ProtocolCommand|error-state}} - флаг наличия ошибки на весах; {{ProtocolCommand|error}} - код ошибки; {{ProtocolCommand|error-text}} - текстовое описание ошибки; {{ProtocolCommand|lock-state}} - флаг ручной блокировки весов;
{{ProtocolCommand|user-inactive-time}} - время с последней активности весов (нажатия на тач-экран);
{{ProtocolCommand|scale-serial-number}} - заводской номер;
"scalegoods-versioncount" "groups- версия весового модуля;count""labels-count"
"scaleerror-serialcode""error-numberstate"" error- заводской номер;text"
"operationlock-systemstate" "packing-mode""user-inactive-time""image-recognition- тип операционной системы;active""image-recognition-camera-error""price-checker-active""voice-control-active"
"hostnamelicensed" - имя хоста весов;
"usercurrent-namealgoritm" - имя пользователя, под которым запущено ПО весов;
"currentweight""weight-timestability""weight-datetare" - текущее время и дата;
"disksscale-model""scale-version""scale-serial-number"" scale-serial- перечень дисков (актуально для Windows версии);number-ext"
"freeoperation-system""cpu-diskmodel"" cpu- свободного места на системном диске;serial-number""cpu-temperature""hostname""user-name"
"freecurrent-worktime-diskdate" "hardware-rtc-state""version- свободного места на рабочем диске;build"
"freescreen-memoryresolution" - свободно оперативной памяти;
"screenlast-resolutionimport-datetime"" last-import- разрешение экрана;status"
"systemeth-upip-timeaddress" "eth- время со старта системы;mac""wifi-ip-address""wifi-mac"
==Запуск ротации логов программы и архивов, создаваемых программой==
Запрос:
<source lang="json"> "command" : "RotateLog",</source>
Ответ:
<source lang="json"> "response" : "Ok" "response-code" : 0</source>
Пример:
<source lang="json">
{ "id" : 1, "command" : "RotateLog", "data" : { "application" : "R1ScaleTester", "version" : "0.0.0.1", "compile-date" : "09-08-2017" } }
</source>
==Получение текущего протокола работы весов==
Данная команда позволяет получить текущий файл протокола работы весов.
Данные могут быть предварительно запакованы архиватором GZip (отключается в настройках весов). Так же флаг использования компрессии можно предать в объекте {{ProtocolCommand|"data": "use-compress" }} : 1 или 0. Далее данные кодируются в BASE-64. В объекте "{{ProtocolCommand|data" }} возвращаются данные лог файла "{{ProtocolCommand|log-file-data" }} и размер файла "{{ProtocolCommand|log-file-size"}}.
Запрос:
<source lang="json"> "command" : "GetLog"</source>
Ответ:
<source lang="json"> "response" : "Ok" "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="response-codejson" > "command" : "DisplayMessage" "data" : { "message" : "Текс сообщения", "beep" : "true", "time" : "1000" }</source> Ответ: 0
<source lang="datajson" : { > "log-file-sizeresponse" : "120000Ok", "log-fileresponse-datacode" : "данные-лог-файла" }0</source>
==Блокировка и разблокировка работы весов==
Данная команда позволяет выполнить удаленную блокировку "{{ProtocolCommand|LockScale" }} и разблокировку "{{ProtocolCommand|UnlockScale" }} работы весов, например в случае поломок принтера.
В объекте "{{ProtocolCommand|data" }} передается пароль "{{ProtocolCommand|password" }} на проводимую операцию (изменяется в настройках весов).
Запрос:
<source lang="json"> "command" : "LockScale" "command" : "UnlockScale" "data" : { "password" : "239" }</source> Ответ:
<source lang="commandjson"> "response" : "UnlockScaleOk" "response-code" : 0</source>
<source lang="response-codejson"> "command" : 0"ZeroWeight" "command" : "TareWeight" "data" : { "password" : "239" }</source>
==Перезагрузка и выключение весов==
Данная команда позволяет удаленно выполнить перезагрузку {{ProtocolCommand|RebootScale}} или произвести выключение {{ProtocolCommand|PowerOffScale}} весов.
<source lang="json"> "command" : "RebootScale", "command" : "PowerOffScale", "data" : { "password" : "239255" }</source>
Ответ:
<source lang="json"> "response" : "Ok" "response-code" : 0</source>
==Перезагрузка Перезапуск и выключение завершение работы ПО весов==Данная команда позволяет удаленно выполнить перезагрузку "Reboot" {{ProtocolCommand|RestartApp}} или произвести выключение "Shutdown" завершить работу {{ProtocolCommand|ShutdownApp}} основного ПО весов.
В объекте "{{ProtocolCommand|data" }} передается пароль "{{ProtocolCommand|password" }} проводимую операцию (изменяется в настройках весов).
Стандартный пароль для перезагрузки и выключения: {{Password|255}}
Запрос:
<syntaxhighlight source lang="json"> "command" : "RebootRestartApp", "command" : "ShutdownShutdownApp", "data" : { "password" : "255" }</syntaxhighlightsource>
Ответ:
<syntaxhighlight source lang="json"> "response" : "Ok", "response-code" : 0</syntaxhighlightsource> ==Получение списка файлов в каталоге==Данная команда позволяет получить список файлов или каталогов в указанном каталоге. Начальным путем для поиска файлов является каталог программы. Для получения информации необходимо передать каталог {{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|"MultiPart"}} - блочный режим передачи данных. Использование нескольких пакетов при приеме/передаче файлов.
{{ProtocolCommand|"total-parts"}} - общее количество пакетов при блочном приеме/передаче файлов./Data/Images/ - картинки, используемые программой
Например: для получения файла-картинки имя файла должно быть таким {{ProtocolCommand|"file-name" : "./Data/MediaImages/ - звуки, используемые программойgoods.no.picture.png"}}.
В объекте {{ProtocolCommand|data}} передается имя необходимого файла {{ProtocolCommand|file-name}}, а возвращается информация о файле: {{ProtocolCommand|file-name}} {{ProtocolCommand|file-size}} - размер файла в байтах, {{ProtocolCommand|file-data}} - данные файла файла или части файла, {{ProtocolCommand|file-md5}} - контрольная сумма блока данных в поле {{ProtocolCommand|file-data}} до кодирования в BASE-64 рассчитанная по алгоритму MD5./Data/Lic/ - лицензии для программы
В объекте {{ProtocolCommand|data}} передается имя необходимого каталога {{ProtocolCommand|dir-name}}./Settings/ - настройки программы и экранные формы
При добавлении файла в объекте {{ProtocolCommand|data}} в поле {{ProtocolCommand|file-data}} передаются данные файла, а в поле {{ProtocolCommand|file-md5}} - контрольная сумма файла рассчитанная по алгоритму MD5 до кодирования в BASE-64../Exchange/Flags/ При передаче файла частями {{ProtocolCommand|file- флаги создаваемые программой md5}} передается только в результате событий на весахпоследнем пакете и содержит контрольную сумма всего файла.
Данные могут быть предварительно запакованы архиватором GZip (отключается в настройках весов).Так же флаг использования компрессии можно предать в объекте {{ProtocolCommand|"data": "use-compress"}} : ''1'' или ''0'' или ''true''/''false''./Exchange/Import/ При использовании блочной передачи файлов архиватором пакуется каждая часть отдельно. После паковки блока, данные кодируются в BASE- импортируемые данные64.
При передаче/запросе больших файлов можно использовать передачу файлов частями (получение файлов более 16384 байт с весов всегда выполняется по частям).При передаче по частям необходимо в первом пакете использовать команду {{ProtocolCommand|AddFile}} и в объект данных {{ProtocolCommand|data}} добавить поля {{ProtocolCommand|"total-parts" : ''xxx''}} и {{ProtocolCommand|"part-data-no" : 0}}./Exchange/Log/BadFiles/ - протоколы обработки неуспешно импортированных данных
В поле {{ProtocolCommand|total-parts}} вместо ''xxx'' нужно передать общее количество частей файла../Exchange/Reports/ - отчеты, создаваемые программой
В поле {{ProtocolCommand|part-data-no}} передается номер текущего пакет. Начиная с '''0'''.
Поле {{ProtocolCommand|"commandMultiPart" : "GetFileInfo"1}} используется в ответе на команду передачи по частям.
<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" : 4, "total-parts" : 5, "use-compress" : 1, "file-md5" : "9caa7d76e8e08b56256594f39c13e7d8" } <-- "response" : "MultiPart", "response-code" : 1, "Okdata": { "part-data-no" : 4, "total-parts" : 5 }
==Выполнение команды весами==
Данная команда позволяет выполнить команды на весах.
{{Внимание|Данная команда пока не реализована.}}
Запрос:
<source lang="json"> "command" : "ExecuteCommand"</source>
Ответ:
<source lang="json"> "response" : "Ok" "response-code" : 0</source>
==Очистка базы товаров и групп==
Данная команда позволяет полностью очистить базу товаров и групп перед загрузкой новых товаров и групп.
Если данная команда не передается, то включается режим обновления/добавления товаров.
Очистка данных производится только если добавляется хотя бы один товар.
'''Если данная команда передается отдельно от других команд, производится полная очистка базы товаров (удаляются все товары и группы).'''
Запрос:
<source lang="json"> "command" : "ClearGoodsAndGroups"</source>
Ответ:
<source lang="json"> "response" : "Ok" "response-code" : 0</source> ==Добавление товаров, обновление или удаление товаров и групп товаров==Данные команды служат для изменение базы товаров в весах. Перед использование данных команд, необходимо передать на весы команду {{ProtocolCommand|BeginUpdate}}, а по окончании работы с товарами передается команда {{ProtocolCommand|EndUpdate}}. При необходимости очистки базы товаров на весах, между передачами команд {{ProtocolCommand|BeginUpdate/EndUpdate}}, так же необходимо передать команду {{ProtocolCommand|ClearGoodsAndGroups}}. При использовании команд обновления ({{ProtocolCommand|UpdateGoods}} и {{ProtocolCommand|UpdateGroups}}), если товара или группы нет в базе весов - товар или группа создаются и сообщение об ошибке не передается. Разница между командами {{ProtocolCommand|UpdateХХХ}} и {{ProtocolCommand|AddXXX}} заключается в минимальном наборе параметров, которые необходимо передаются на весы, что бы не возникло ошибки при приеме команды. Так для для команды {{ProtocolCommand|AddGoods}} необходимо передать: номер товара, название товар, группу-владелец и цену. Для команды {{ProtocolCommand|UpdateGoods}}: только номер товара.
В объекте {{ProtocolCommand|data}} передаются все необходимые параметры товара или группы.
{{ProtocolCommand|goods-name-2}} - второе название товара для печати на этикетке.
{{ProtocolCommand|goods-barcode-struct}} - номер структуры штрих-кода товара для версии 1.0.2.21 и старше.
// "goods-weightmessage-unit1" - весовая еденица товара.текстовое сообщение // "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" - картинка для этикетки
*Для успешного добавления товара необходимо передать как минимум следующие поля:
*Формат дат: '''''dd.MM.yyyy hh:mm'''''
*В поле {{ProtocolCommand|goods-picture-filename}} и {{ProtocolCommand|goods-second-picture-filename}} передается имя файла картинки для товара или группы. Указанный файл должен присутствовать в каталоге {{Путь к файлу|./Data/Images/}}. Можно располагать файлы в подкаталогах.
*Срок годности товара имеет следующие значение:
*Поля {{ProtocolCommand|goods-message-x}} служат для передачи дополнительной текстовой информации, печатаемой на этикетке.
*Поля данных группы:
*Для успешного добавления группы необходимо передать как минимум следующие поля:
Запрос:
<source lang="json"> "command" : "AddGoods" "command" : "UpdateGoods" "command" : "RemoveGoods" "command" : "AddGroups" "command" : "UpdateGroups" "command" : "RemoveGroups"</source>
<source lang="commandjson"> "response" : "Ok" "response-code" : 0</source> ===Весовые типы товаров (Weight Unit)=== {| class="RemoveGoodswikitable"|-! Код !! Тип !! Название|-| 0 || 50g || 50 грамм|-| 1 || G || грамм|-| 2 || 10g || 10 грамм|-| 3 || 100g || 100 грамм|-| 4 || Kg || килограмм|-| 5 || Oz || унция|-| 6 || Pb || фунт|-| 7 || 500g || 500 грамм|-| 8 || 600g || 600 грамм|-| 9 || PSCg || 50 грамм|-| 10 || PSCKg || штучный грамм|-| 11 || PSCOz || штучный килограмм|-| 12 || PSCg || штучная унция|-| 13 || PSCLb || штучный фунт|} ===Типы штрихкодов товаров (Barcode Type)=== Сокращения используемые в таблице: '''''D''''' - отдел '''''L''''' - № товара '''''I''''' - код магазина '''''P''''' - цена
{| class="response" : "Okwikitable"|-! Код !! Тип !! Содержание !! Примечание|-| 0 || EAN13 || DD(2) IIIIIIIIII(10) CRC(1) |||-| 1 || EAN13 || DD(2) IIIIII(6) PPPP(4) CRC(1) |||-| 2 || EAN13 || DD(2) IIIII(5) PPPPP(5) CRC(1) |||-| 3 || EAN13 || DD(2) IIII(4) PPPPPP(6) CRC(1) |||-| 4 || EAN13 || DD(2) III(3) PPPPPPP(7) CRC(1) |||-| 5 || EAN13 || DD(2) IIIIII(6) Q.QQQ(4) CRC(1) |||-| 6 || EAN13 || DD(2) IIIIII(6) QQ.QQ(4) CRC(1) |||-| 7 || EAN13 || DD(2) IIIII(5) QQ.QQQ(5) CRC(1) |||-| 8 || EAN13 || DD(2) IIIII(5) QQQQ.Q(5) CRC(1) |||-| 9 || EAN13 || DD(2) IIIII(5) QQQQQ(5) CRC(1) |||-| 10 || EAN13 || 20(2) IIIIIIIIII(10) CRC(1) |||-| 11 || EAN13 || 21(2) IIIIII(6) PPPP(4) CRC(1) |||-| 12 || EAN13 || 22(2) IIIII(5) PPPPP(5) CRC(1) |||-| 13 || EAN13 || 23(2) IIII(4) PPPPPP(6) CRC(1) |||-| 14 || EAN13 || 24(2) III(3) PPPPPPP(7) CRC(1) |||-| 15 || EAN13 || 25(2) IIIIII(6) Q.QQQ(4) CRC(1) |||-| 16 || EAN13 || 26(2) IIIIII(6) QQ.QQ(4) CRC(1) |||-| 17 || EAN13 || 27(2) IIIII(5) QQ.QQQ(5) CRC(1) |||-| 18 || EAN13 || 28(2) IIIII(5) QQQQ.Q(5) CRC(1) |||-| 19 || EAN13 || EAN13, 29(2) IIIII(5) QQQQQ(5) CRC(1) |||-| 20 || - || Не печатать штрихкод |||-| 21 || EAN13 || D(1) IIIIIII(7) PPPP(4) CRC(1) |||-| 22 || EAN13 || D(1) IIIIII(6) PPPPP(5) CRC(1) |||-| 23 || EAN13 || D(1) IIIII(5) PPPPPP(6) CRC(1) |||-| 24 || EAN13 || D(1) IIII(4) PPPPPPP(7) CRC(1) |||-| 25 || EAN13 || D(1) IIIIIII(7) Q.QQQ(4) CRC(1) |||-| 26 || EAN13 || D(1) IIIIIII(7) QQ.QQ(4) CRC(1) |||-| 27 || EAN13 || D(1) IIIIII(6) QQ.QQQ(5) CRC(1) |||-| 28 || EAN13 || D(1) IIIIII(6) QQQQ.Q(5) CRC(1) |||-| 29 || EAN13 || D(1) IIIIII(6) QQQQQ(5) CRC(1) |||-| 30 || EAN13+5 || D(1) IIIIII(6) PPPPP(5) QQ.QQQ(5) CRC(1) || Не поддерживание (введен для совместимости)|-| 31 || EAN13+5 || D(1) IIIIII(6) PPPPP(5) QQQQ.Q(5) CRC(1) || Не поддерживание (введен для совместимости)|-| 32 || EAN13+5 || D(1) IIIIII(6) PPPPP(5) QQQQQ(5) CRC(1) || Не поддерживание (введен для совместимости)|-| 33 || EAN13+5 || D(1) IIIIII(6) PPPPP(5) QQ.QQQ(5) CRC(1) || Не поддерживание (введен для совместимости)|-| 34 || EAN13+5 || D(1) IIIIII(6) PPPPP(5) QQQQ.Q(5) CRC(1) || Не поддерживание (введен для совместимости)|-| 35 || EAN13+5 || D(1) IIIIII(6) PPPPP(5) QQQQQ(5) CRC(1) || Не поддерживание (введен для совместимости)|-| 36 || EAN18 || D(1) LLLLLL(6) IIII(4) RR(2) QQ.QQQ(5) || Не поддерживание (введен для совместимости)|-| 37 || EAN18 || D(1) LLLLLL(6) IIII(4) RR(2) QQQQ.Q(5) || Не поддерживание (введен для совместимости)|-| 38 || EAN18 || D(1) LLLLLL(6) IIII(4) RR(2) QQQQQ(5) || Не поддерживание (введен для совместимости)|-| 50 || EAN8 || IIIIIII(7) CRC(1) || Не поддерживание (введен для совместимости)|-| 51 || EAN8 || D(1) IIIIII(6) CRC(1) || Не поддерживание (введен для совместимости)|-| 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.
Запрос:
<source lang="json"> "command" : "AddLabel"</source>
Ответ:
<source lang="json"> "response" : "Ok" "response-code" : 0</source>
Поля данных этикетки:
==Изменение номера и названия магазина==
Возможна передача до 4-х строк названия магазина.
Перед использование данной команды, необходимо передать на весы команду "{{ProtocolCommand|BeginUpdate"}}, а по окончании работы передается команда "{{ProtocolCommand|EndUpdate"}}. Можно использовать эти команду в едином цикле с обновление информации о товарах.
Запрос:
<source lang="json"> "command" : "AddStoreParams"</source> Ответ: <source lang="json"> "response" : "Ok" "response-code" : 0</source> Поля данных этикетки: {{ProtocolCommand|store-no}} - номер магазина. {{ProtocolCommand|store-name-1}} - название магазина строка 1 {{ProtocolCommand|store-name-2}} - название магазина строка 2 {{ProtocolCommand|store-name-3}} - название магазина строка 3 {{ProtocolCommand|store-name-4}} - название магазина строка 4 ==Настройки весов==Данные команды служат для получения списка настроек весов, а так же получения или изменения самих значений настроек на весах. При передаче данных команд необходимо передавать пароль для изменения настроек (этот пароль используется так же для входа в режим настроек на весах). При передаче пароля рекомендуется передавать MD5 сумму пароля в поле {{ProtocolCommand|password}} и значение {{ProtocolCommand|"crypted-password": true}}. Если пароль передается в открытом виде, что не рекомендуется по соображениям безопасности, то нужно передать значение {{ProtocolCommand|"crypted-password": false}}. === Получение списка настроек === Команда для получения настроек с весов {{ProtocolCommand|GetSettingsList}}: <source lang="json">{ "id": 4, "command": "GetSettingsList", "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": 4, "response" : "Ok", "response-code": 0 "data": { "application": "R1 Sensor.", "compile-date": "26-07-2022", "version": "1.0.2.22", "version-build": 4153, "settings-read-list": [{"settings-name": "enDebug", "settings-type": 1, "settings-type-name": "bool", "settings-value": true}, {"settings-name": "enLog", "settings-type": 1, "settings-type-name": "bool", "settings-value": true}], "settings-write-list": [{"settings-name": "enDebug", "settings-type": 1, "settings-type-name": "bool", "settings-value": true}, {"settings-name": "enLog", "settings-type": 1, "settings-type-name": "bool", "settings-value": true}] }}</source> Возвращаемые значения: {{ProtocolCommand|settings-read-list}} - Список настроек доступных для чтения. {{ProtocolCommand|settings-write-list}} - Список настроек доступных для изменения. В списках возвращается перечень настроек со следующими параметрами: {{ProtocolCommand|settings-name}} - название настройки. Используется для чтения и изменения. {{ProtocolCommand|settings-type}} - числовое представление типа значения настройки. {{ProtocolCommand|settings-type-name}} - название типа значения настройки. {{ProtocolCommand|settings-value}} - текущее значение настройки. === Получение значения настроек === В поле {{ProtocolCommand|settings-name}} передается название необходимого параметра настроек, а поле {{ProtocolCommand|settings-valuе}} само значение. Команда для получения значений настроек с весов {{ProtocolCommand|GetSettings}}: <source lang="json">{ "id": 4, "command": "GetSettings", "data": { "application": "PyR1SensorDriver", "version": "0.0.1.0", "version-build": "1", "compile-date": "26.07.2022", "password": "11b9842e0a271ff252c1903e7132cd68", "crypted-password": true, "settings-name": "enImageRecognition" }}
Ответ:
Если пароль передается в открытом виде, что не рекомендуется по соображениям безопасности, то нужно передать значение {{ProtocolCommand|"storecrypted-nopassword" - номер магазина: false}}.
<source lang="storejson">{ "id": 6, "command": "RestartImageRecognitionSystem", "data": { "application": "PyR1SensorDriver", "version": "0.0.1.0", "version-namebuild": "1", "compile-2 date": "26.07.2022", "password": "11b9842e0a271ff252c1903e7132cd68", "crypted- название магазина строка 2 password": true }}</source>
<source lang="storejson">{ "id": 6, "response": "Ok", "response-namecode": 0 "data": { "application": "R1 Sensor.", "compile-4 date": "26- название магазина строка 4 07-2022", "version": "1.0.2.22", "version-build": 4153 },}</source>
=Перечень ошибок=
При возникновении ошибок в ответе содержится текстовый ответ и код, сообщающие о возникшей ошибке.
Так же в объект "{{ProtocolCommand|data" }} добавляется поле с расширенным описание ошибки "{{ProtocolCommand|response-ext"}}.
При работе с весами возможны следующие ошибки:
Ошибок нет, команда выполнена успешно:
<source lang="json"> "response" : "Ok" "response-code" : 0 "data" </source>
Истек таймаут соединения при установке связи или во время работы:
<source lang="json"> "response" : "Abort" "response-code" : -1</source>
Ошибка данных команды или некорректные данные:
В поле "response-ext" : "Error"возвращается расширенное описание ошибки.
<source lang="json"> "response" : "Error" "response-code" : -2 "data" : { "response-ext" : "Unknown command" }</source>
Ошибка выполнения команды (например: при установке даты/времени):
В поле "response-ext" : "ExecError"возвращается расширенное описание ошибки.
<source lang="json"> "response" : "ExecError" "response-code" : -3 "data" : { "response-ext" : "Error sync date/time (-1)." }</source>