2540
правок
Изменения
Перейти к навигации
Перейти к поиску
0611.0611.2019 2022 года.
"''{{ProtocolCommand|id''" }} - идентификатор запроса. Можно использовать для проверки, что ответ идет на ту команду, на которую посылался запрос."''{{ProtocolCommand|command''" }} - выполняемый запрос или команда.объект "''Объект {{ProtocolCommand|data''" }} - в данном объекте передаются дополнительные данные, необходимые для выполнения запроса или команды. Так же в этом поле содержится информация о ПО которое сформировало запрос. {{Внимание|Максимальный размер пакета принимаемый весами 1024000 байт! Рекомендуется использовать пакеты не более 16348 байт.}}
"''id''" - идентификатор запроса.
"''response''" - текстовое описание ответа весов (результат выполнения команды или запроса).
"''response-code''" - цифровое код ответа весов (результат выполнения команды или запроса)
объект "''data''" - в данном объекте передаются дополнительные данные, являющиеся результатом выполнения команды. Так же в этом поле содержится информация о ПО весов.
"{{ProtocolCommand|error-state" }} - флаг наличия ошибки на весах;
"{{ProtocolCommand|error" }} - код ошибки;
"{{ProtocolCommand|error-text" }} - текстовое описание ошибки;
"{{ProtocolCommand|lock-state" }} - флаг ручной блокировки весов;
"{{ProtocolCommand|packing-mode" }} - флаг включения режима фасовки;
"{{ProtocolCommand|user-inactive-time" }} - время с последней активности весов (нажатия на тач-экран);
"{{ProtocolCommand|licensed" }} - флаг состояния лицензии;
"{{ProtocolCommand|database-type" }} - тип внутренней базы данных (0 - xml, 1 - sqlite);
"{{ProtocolCommand|weight" }} - текущий вес;
"{{ProtocolCommand|weight-tare" }} - текущая тара;
"{{ProtocolCommand|weight-stability" }} - флаг стабильности веса;
"{{ProtocolCommand|scale-model" }} - модель весов;
"{{ProtocolCommand|scale-version" }} - версия весового модуля;
"{{ProtocolCommand|scale-serial-number" }} - заводской номер;
"{{ProtocolCommand|operation-system" }} - тип операционной системы;
"{{ProtocolCommand|hostname" }} - имя хоста весов;
"{{ProtocolCommand|user-name" }} - имя пользователя, под которым запущено ПО весов;
"{{ProtocolCommand|current-time-date" }} - текущее время и дата;
"{{ProtocolCommand|disks" }} - перечень дисков (актуально для Windows версии);
"{{ProtocolCommand|free-system-disk" }} - свободного места на системном диске;
"{{ProtocolCommand|free-work-disk" }} - свободного места на рабочем диске;
"{{ProtocolCommand|free-memory" }} - свободно оперативной памяти;
"{{ProtocolCommand|screen-resolution" }} - разрешение экрана;
"{{ProtocolCommand|system-up-time" }} - время со старта системы; "goods-count""groups-count""labels-count" "error-code""error-state""error-text" "lock-state""packing-mode""user-inactive-time""image-recognition-active""image-recognition-camera-error""price-checker-active""voice-control-active" "licensed" "current-algoritm" "weight""weight-stability""weight-tare" "scale-model""scale-version""scale-serial-number""scale-serial-number-ext" "operation-system""cpu-model""cpu-serial-number""cpu-temperature""hostname""user-name" "current-time-date""hardware-rtc-state""version-build" "screen-resolution" "last-import-datetime""last-import-status" "eth-ip-address""eth-mac""wifi-ip-address""wifi-mac"
Для получение информации о файлеДанные команды позволяют получать файлы с весов, находящимся в подкаталогах, необходимо в имя файла включить путь до необходимого файлаудалять файлы на весах и передавать файлы на весы. Начальным точкой для поиска файлов является каталог программы.
Вне каталога программы можно получить доступ только к каталогу "Exchange"Для работы с файлами, находящимся в котором содержится протокол работыподкаталогах, данные для импорта, отчеты и т.днеобходимо в имя файла включить путь до необходимого файла.
Например: для получения информации о картинке имя файла должно быть таким "file-name" : ".Вне каталога программы можно получить доступ только к каталогу {{Путь к файлу|/Dataopt/Images/goods.no.pictureExchange}}, в котором содержится протокол работы, данные для импорта, отчеты и т.png"д.
В объекте "data" передается имя необходимого файла "file-name", а возвращается информация о файлеКоманды: "file-name", "file-size" - размер файла в байтах, "file-date" - дата/время последнего изменения файла, "file-md5" - контрольная сумма файла расчитанная по алгоритму MD5.
При добавлении файла в объекте "data" в поле "file-data" передаются данные файла, а в поле "file-md5" - контрольная сумма файла расчитанная по алгоритму MD5.Запрос:
Данные могут быть предварительно запакованы архиватором GZip (отключается в настройках весов). Так же флаг использования компрессии можно предать в объекте <source lang="datajson"> "command" : "AddFile" "command" : "GetFile" "command" : "GetFileInfo" "command" : "RemoveFile" "command" : "AddDir" "command": "use-compressRemoveDir" "command" : 1 или 0."PartDataReceived" "command" : "PartDataSended"</source>
Далее данные кодируются в BASE-64.Поля используемые при работе с файлами:
Стандартные пути к файлам:{{ProtocolCommand|file-size}} - размер файла
../Exchange/Import/ - импортируемые данные
.Например: для получения файла-картинки имя файла должно быть таким {{ProtocolCommand|"file-name" : "./ExchangeData/LogImages/ - протокол работы программыgoods.no.picture.png"}}.
../Exchange/Log/ProcessedFiles/ В объекте {{ProtocolCommand|data}} передается имя необходимого файла {{ProtocolCommand|file-name}}, а возвращается информация о файле: {{ProtocolCommand|file-name}} {{ProtocolCommand|file-size}} - размер файла в байтах, {{ProtocolCommand|file-data}} - данные файла файла или части файла, {{ProtocolCommand|file-md5}} - протоколы обработки успешно импортированных контрольная сумма блока данныхв поле {{ProtocolCommand|file-data}} до кодирования в BASE-64 рассчитанная по алгоритму MD5.
ЗапросПример передачи файла:
"command" : "GetFileInfo" "command" : "RemoveFile"--> "command" : "AddFile",
ОтветПри передаче/запросе больших файлов можно использовать передачу файлов частями (получение файлов более 16384 байт с весов всегда выполняется по частям). При передаче по частям необходимо в первом пакете использовать команду {{ProtocolCommand|AddFile}} и в объект данных {{ProtocolCommand|data}} добавить поля {{ProtocolCommand|"total-parts" : ''xxx''}} и {{ProtocolCommand|"part-data-no" : 0}}. В поле {{ProtocolCommand|total-parts}} вместо ''xxx'' нужно передать общее количество частей файла. В поле {{ProtocolCommand|part-data-no}} передается номер текущего пакет. Начиная с '''0'''. Остальные части файла передаются с помощью команд {{ProtocolCommand|PartDataSended}}, а принимаются с помощью команд {{ProtocolCommand|PartDataReceived}}. Поле {{ProtocolCommand|"MultiPart" : 1}} используется в ответе на команду передачи по частям. Т.е. последовательность следующая:
Данная '''Если данная команда должна быть передана передается после команды "{{ProtocolCommand|BeginUpdate"}}, то включается режим очистки данных при передаче товаров.'''
При использовании команд обновления ("UpdateGoods" и "UpdateGroups"){{ProtocolCommand|goods-full-name-2}} - второе название товара для вывода на экранную кнопку товара. Если данное поле не задано, если товара или группы нет в базе весов значение берется из поля {{ProtocolCommand|goods-name- товар или группа создаются и сообщение об ошибке не передается2}}.
Разница между командами "UpdateХХХ{{ProtocolCommand|goods-price}} - цена товара. Можно передавать как строку: '''''" и "AddXXX" заключается в минимальном наборе параметров, которые необходимо передаются на весы, что бы не возникло ошибки при приеме команды123. Так для для команды 55"AddGoods" необходимо передать: номер товара''''', название товар, группу-владелец и цену. Для команды "UpdateGoods"можно как число: только номер товара123.55
Если {{ProtocolCommand|goods-dep}} - отдел товара. Используется как префикс при использовании команд удаления ("RemoveGoods" и "RemoveGroups") товар или группа не найден формировании штрих-кода товара, если так задано в структуре штрих- передается ошибка "товар не найден"кода.
В объекте "data" передаются все необходимые параметры {{ProtocolCommand|goods-barcode}} - штрих-код товара (для режима прайс-чекера) или группыописание структуры штрих-кода, если номер структуры равен 200. Для версии 1.0.2.21 и старше.
Команды "Remove..." обрабатываются в последнюю очередь. Т.е. сначала производится очистка базы дынных, далее производится добавление товаров/групп и потом удаление товаров/групп{{ProtocolCommand|goods-barcode-type}} - номер структуры штрих-кода товара.
Поля данных {{ProtocolCommand|goods-action}} - признак акционности (скидка) товара:(используется для вывода на кнопке товара специальной картинки).
"{{ProtocolCommand|goods-no" is- номер товара. Номер должен быть уникален. Поиск popular}} - признак популярности товара при добавлении/обновлении ведется по этому полю(используется для вывода этих товаров в отдельное поле на форме выбора товаров).
"{{ProtocolCommand|goods-addice-code" percent}} - дополнительный номер товарпроцент '''''ледяной глазури''''' в весе товара. Может использоваться при формировании штрих-кода товараВ формате от '''''0.0''''' до '''''99.99'''''.
"{{ProtocolCommand|goods-displaylabel}} -number" - дополнительный номер товара. Данный номер можно вывести на кнопку товара. По данному номеру возможно сортировать товары внутри группы. "goods-name" - название товара для печати на этикеткешаблона этикетки.
"{{ProtocolCommand|goods-fulllabel2}} -name" номер 2- название товара для вывода на кнопку товара. Если данное поле не задано, значение берется из поля "goods-name"го шаблона этикетки.
"{{ProtocolCommand|goods-price" discount- цена товара. Можно передавать как строку: "123.55", можно как число: 123label}} - номер шаблона этикетки для печати скидочных товаров.55
"{{ProtocolCommand|goods-dep" discount- отдел товара. Используется при формировании штрихprice}} -кода товарацена со скидкой.
"{{ProtocolCommand|goods-barcodediscount-type" percent}} - тип структуры штрих-кода товарапроцент скидки.
"{{ProtocolCommand|goods-action" discount- признак акционности товара type}} - тип скидки (используется для вывода на кнопке товара специальной картинки'''''0''''' - нет скидки).
"{{ProtocolCommand|goods-islimit-popular" quantity}} - признак популярности товара (используется ограничение количества для вывода этих товаров в отдельное поле на форме выбора товаров)этикетку при использовании скидок.
"{{ProtocolCommand|goods-iceowner-percent" group}} - процент "ледяной глазури" в весе группа-владелец товара.
"{{ProtocolCommand|goods-label" picture- номер шаблона этикеткиbytes}} - картинка товара (массив байт). Устаревший параметр. Не рекомендуется использовать данный параметр, используете {{ProtocolCommand|goods-picture-filename}}.
"{{ProtocolCommand|goods-label2" picture- номер шаблона 2filename}} -го этикеткиимя файла картинки товара.
"{{ProtocolCommand|goods-discountsecond-label" picture- номер шаблона этикетки filename}} - имя файла дополнительной картинки товара. Обычно используется для вывода на экран выводимый после печати скидочных товаровэтикетки.
"{{ProtocolCommand|goods-discountpacking-price" date}} - цена со скидкойдата/время паковки (формат: '''''dd-MM-yyyy hh:mm''''').
"{{ProtocolCommand|goods-discountproduced-type" date}} - тип скидки дата/время производства (0 формат: '''''dd- нет скидкиMM-yyyy hh:mm''''').
"{{ProtocolCommand|goods-ownervalid-group" date}} - группадата/время окончания срока годности (формат: '''''dd-владелец товараMM-yyyy hh:mm''''').
"{{ProtocolCommand|goods-picturesale-bytes" before- картинка date}} - дата/время окончания продажи товара (массив байтформат: '''''dd-MM-yyyy hh:mm'''''). Для версии 1.0.2.21 и старше.
"{{ProtocolCommand|goods-pictureshelf-filename" life}} - имя файла картинки товарасрок годности в днях. Если число отрицательно: в часах.
"{{ProtocolCommand|goods-secondweight-pictureunit}} -filename" - имя файла дополнительной картинки весовая единица товара.
"{{ProtocolCommand|goods-producedtare}} -date" - дата производствавес тары товара.
"{{ProtocolCommand|goods-shelfmessage-life" x}} - срок годноститекстовые сообщения для печати на этикетке, где х номер строки текстового сообщения. Расширенные сообщения (номера с 6 и выше) введены начиная с сборки 4121.
"goods-tare" - вес тары товара.
"goods-message-x" - текстовые сообщения для печати на этикетке.
Для успешного добавления товара необходимо передать как минимум следующие поля:{{ProtocolCommand|goods-no}}, {{ProtocolCommand|goods-name}}, {{ProtocolCommand|goods-price}},
"goods-no", "goods-name", "goods-price",
Формат даты производства: "dd.MM.yyyy hh:mm"
В поле "goods-picture-filename" и "goods-second-picture-filename" передается имя файла картинки для товара или группы. Указанный файл должен присутсвовать *Данные могут быть предварительно запакованы архиватором GZip (отключается в каталоге "настройках весов)./Data/Pictures/". Можно располагать файлы Так же флаг использования компрессии можно предать в подкаталогахобъекте {{ProtocolCommand|data: use-compress}} : 1 или 0.
Данные могут быть предварительно запакованы архиватором GZip (отключается в настройках весов). Так же флаг использования компрессии можно предать :Далее данные кодируются в объекте "data": "useBASE-compress" : 1 или 064.
Далее данные кодируются в BASE-64.
Срок '''''0''''' - срок годности товара имеет следующие значение:не задан
0 '''''-х''''' - срок годности не задануказан часах
-'''''х ''''' - срок годности указан часахв днях
х - срок годности указан в днях
Поля "goods-message-x" служат для передачи дополнительной текстовой информации, печатаемой на этикетке.:Перечень соответствия сообщений и элементов шаблона этикетки:
Перечень соответсвия сообщений и элементов шаблона этикетки:{{ProtocolCommand|goods-message-1}} - текстовое сообщение
":{{ProtocolCommand|goods-message-1" 2}} - текстовое сообшениеингредиенты
":{{ProtocolCommand|goods-message-2" 3}} - ингридиентыстрана происхождения
":{{ProtocolCommand|goods-message-3" 4}} - страна происхожденияреклама
"goods-message-4" - реклама
Поля данных {{ProtocolCommand|group-no}} - номер группы:.
"{{ProtocolCommand|group-no" name}} - номер название группы.
"{{ProtocolCommand|group-name" picture- название filename}} - имя файла картинки группы.
"{{ProtocolCommand|group-second-picture-filename" }} - имя файла второй картинки группы. Используется для вывода на экраны товаров.
"{{ProtocolCommand|group-picture-bytes" }} - картинка товара (массив байт). Устаревший параметр. Не рекомендуется использовать данный параметр, используете {{ProtocolCommand|group-picture-filename}}.
"{{ProtocolCommand|group-owner-group" }} - номер группы-владельца.
"{{ProtocolCommand|group-no"}}, "{{ProtocolCommand|group-name"}}
"{{ProtocolCommand|label-no" }} - номер шаблона этикетки.
"{{ProtocolCommand|label-filename-format" }} - имя файла c форматом шаблона этикетки. Файл должен находится в каталоге {{Путь к файлу|./Data/Labels}}.
"{{ProtocolCommand|label-filename-map" }} - имя файла с задним фоном шаблона этикетки. Файл должен находится в каталоге {{Путь к файлу|./Data/Labels}}.
"{{ProtocolCommand|label-format-bytes" }} - данные формата шаблона этикетки (массив байт).
"{{ProtocolCommand|label-map-bytes" }} - данные заднего фона шаблона этикетки (массив байт).
"{{ProtocolCommand|label-filename" }} - номер группы-владельца. Только для использования с весами LS215.
"{{ProtocolCommand|label-bytes" }} - данные шаблона этикетки (массив байт). Только для использования с весами LS215.
"{{ProtocolCommand|use-compress" }} - флаг использования компрессии данных
"{{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" }} </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-name": "enImageRecognition", "settings-value": false, }}</source> Для получения нескольких настроек одновременно можно при передаче использовать список c названиями настроек.Для этого необходимо записать имена настроек в список {{ProtocolCommand|items-list}}. Значения так же возвращаются в списке {{ProtocolCommand|items-list}}. <source lang="json">{ "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-name": "enDebug"}] }}</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": [{"settings-name": "enImageRecognition", "settings-value": "true"}, {"settings-name": "enDebug", "settings-value": "true"}] },}</source>
"store-name-1 - название магазина строка 1
"store-name-2 - название магазина строка 2 === Изменение значения настроек ===
"store-name-3 - название магазина строка 3 Команда для изменения настроек на весах: {{ProtocolCommand|SetSettings}}
→Запросы к весовому комплексу
=Дата изменения документации=
=Общие сведения о протоколе=
{{Внимание|запрещается одновременно обновлять базу товаров в параллельных сессиях.}}
Допускается параллельное выполнение таких операций как копирование файлов или копирование считывание файлов.
==Запросы к весовому комплексу==
Запрос обязательно должен содержать следующие поля:
==Ответы от весового комплекса==
Ответ обязательно содержать следующие поля:
{{ProtocolCommand|id}} - идентификатор запроса.
{{ProtocolCommand|response}} - текстовое описание ответа весов (результат выполнения команды или запроса).
{{ProtocolCommand|response-code}} - цифровое код ответа весов (результат выполнения команды или запроса).
Объект {{ProtocolCommand|data}} - в данном объекте передаются дополнительные данные, являющиеся результатом выполнения команды. Так же в этом поле содержится информация о ПО весов.
==Объект "''data''"==
В объекте "''{{ProtocolCommand|data''" }} передаются дополнительные данные, необходимые для выполнения или являющиееся являющиеся результатом выполнения команд.Постоянно в объекте дата присутствуют поля "''{{ProtocolCommand|application''" "''}} {{ProtocolCommand|version''" "''}} {{ProtocolCommand|compile-date''"}}, в которых содержится информация о ПО, которое их сформировало. Данная информация используется в информационных целях. Так же в случае возникновения ошибки присутсвует присутствует поле "{{ProtocolCommand|response-ext"}}, в котором содержится расширенное описание ошибки.
В некоторых командах, пересылающих большие объемы данных, данные предварительно могут быть запакованы архиватором GZip (см. описание команд).
Данная возможность отключается через настройки весового комплекса или в флагом "''{{ProtocolCommand|use-compress''" }} объекте "''{{ProtocolCommand|data''"}}.
Кодировка русских символов: UTF-8
==Получение и установка даты и времени на весах==
При запросе в объекте "{{ProtocolCommand|data" }} возвращаются дата/время с весов.
При установке в объекте "{{ProtocolCommand|data" }} передаются дата/время с весов.
==Начало и окончание загрузки товаров и групп==
Команда "{{ProtocolCommand|BeginUpdate" }} подается перед загрузкой товаров и/или групп внутренний буфер приема данных в этот момент очищается и весы готовы к приему данных, если команда подается повторно - данные, уже приняты на тот момент удаляются.
Команда "{{ProtocolCommand|EndUpdate" }} подается после передачи всех данных. После передачи этой команды данные анализируются, сохраняются во внутреннюю базу весов и происходит обновление информации на экране.
Изначально включается режим обновления/добавления товаров и групп. Если после команды "{{ProtocolCommand|BeginUpdate" }} передать команду "{{ProtocolCommand|ClearGoodsAndGropus"}}, то включается режим замены базы данных (перед обработкой загруженных данных база данных в весах очищается).
Данная команда позволяет получить текущее состояние весов: заблокированы или нет, текущий вес, состояние ошибки и др. информацию о весах.
При запросе в объекте "{{ProtocolCommand|data" }} данные статуса весов.
==Запуск ротации логов программы и архивов, создаваемых программой==
{ "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>
==Вывод сообщения на экран весов==
Данная команда позволяет выводить на экран текстовые сообщения. Возможно сопровождать вывод сообщения звуковым сигналом.
В объекте {{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}}) товар или группа не найден - передается ошибка '''''товар не найден'''''. В объекте {{ProtocolCommand|data}} передаются все необходимые параметры товара или группы. Команды {{ProtocolCommand|Remove...}} обрабатываются в последнюю очередь. Т.е. сначала производится очистка базы данных, далее производится добавление товаров/групп и потом удаление товаров/групп. {{Внимание2|Параметры {{ProtocolCommand|goods-picture-bytes}} и {{ProtocolCommand|group-picture-bytes}} являются устаревшими и не рекомендованы к использованию. Используете параметры передающие имена файлов-картинок и загружайте файлы картинок отдельно. Это позволяет более экономично использовать дисковое пространство и использовать будущие расширения протокола весов.}} В версиях ПО старше '''1.0.2.22 сборка 4168''' добавлена возможность групповой передачи товаров. Для этого список товаров загружается в поле {{ProtocolCommand|goods-list}}. *Поля данных товара: {{ProtocolCommand|goods-no}} - номер товара. '''Номер должен быть уникален.''' Поиск товара при добавлении/обновлении ведется по этому полю. {{ProtocolCommand|goods-add-code}} - дополнительный номер товар. Может использоваться при формировании штрих-кода товара. {{ProtocolCommand|goods-display-number}} - дополнительный номер товара. Данный номер можно вывести на кнопку товара. По данному номеру возможно сортировать товары внутри группы. {{ProtocolCommand|goods-name}} - название товара для печати на этикетке. {{ProtocolCommand|goods-name-2}} - второе название товара для печати на этикетке. {{ProtocolCommand|goods-full-name}} - название товара для вывода на экранную кнопку товара. Если данное поле не задано, значение берется из поля {{ProtocolCommand|goods-name}}.
{{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}} служат для передачи дополнительной текстовой информации, печатаемой на этикетке.
*Поля данных группы:
*Для успешного добавления группы необходимо передать как минимум следующие поля:
Сокращения используемые в таблице:
'''''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"}}. Можно использовать эти команду в едином цикле с обновление информации о товарах.
Поля данных этикетки:
При изменении настроек используется тоже имя настройки, что и при получении значения настройки. В поле {{ProtocolCommand|settings-name}} передается название необходимого параметра настроек, а поле {{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"}, {"storesettings-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-4 code": 0 "data": { "application": "R1 Sensor.", "compile-date": "26-07- название магазина строка 4 2022", "version": "1.0.2.22", "version-build": 4153 },}</source>
=Перечень ошибок=
При возникновении ошибок в ответе содержится текстовый ответ и код, сообщающие о возникшей ошибке.
Так же в объект "{{ProtocolCommand|data" }} добавляется поле с расширенным описание ошибки "{{ProtocolCommand|response-ext"}}.
При работе с весами возможны следующие ошибки:
