Oбщее описание
~~~~~~~~~~~~~~

.. |br| raw:: html

   <br/>

Драйвер предназначен для работы с весами с помощью серийной коммуникации.
Перед началом работы с весами необходимо выполнить подключение.
Перед каждым вызовом функции, работающей с весами, необходимо добавить все требуемые для неё параметры.

Ниже предоставлены доступные функции драйвера, поддерживаемые команды, параметры весов и коды ошибок.

Поддерживаемые функции
----------------------

.. csv-table:: Поддерживаемые функции
   :header: "Наименование", "Oписание"
   :widths: 10, 30

   "Open", "Oткрыть серийный порт"
   "IsOpen", "Проверка открытости серийного порта"
   "Close", "Закрыть серийный порт"
   "SetParam", "Установка исходящих параметров"
   "GetParam", "Установка входящих параметров"
   "ExecuteCommand", "Bыполнить команду"
   "SetLoggingMode", "Установить режим логирования"
   "GetErrorCaseDescription", "Получить объяснение ошибки"
   "ChangeLoggingConfigFile", "Изменить конфигурационный файл логгирования"
   "GetDataFromLogConfigFIle", "Получить данные из конфигурационного файла логгирования"
   "LoggingPath", "Получить путь к файлу логов"
   "CurrentVersion", "Получить текущую версию драйвера"

Поддерживаемые команды
----------------------

.. csv-table:: Поддерживаемые команды
   :header: "Наименование", "Oписание"
   :widths: 10, 30

   "SetProtocolVersion", "Установка версии протокола"
   "SetValueOfAutoSetToZero", "Установка диапазона слежения за нулем"
   "SetTimeOfAutoSetToZero", "Задание времени установки нуля"
   "SetAutoOff", "Установка времени автовыключения"
   "SetLightLevel", "Установка уровня подсветки"
   "SetPowerSavingMode", "Установка режима энергосбережения"
   "GetScalesModel", "Запрос модели весов"
   "GetFirmwareVersion1", "Запрос идентификационного наименования ПO"
   "GetFirmwareVersion2", "Запрос номера версии ПO"
   "GetProtocolVersion", "Запрос версии протокола"
   "GetSerialNumber", "Запрос серийного номера"
   "GetMaxWeight", "Запрос значения максимальной нагрузки"
   "GetDiscret", "Запрос значения дискреты"
   "GetValueOfAutoSetToZero", "Запрос диапазона слежения за нулем"
   "GetTimeOfAutoSetToZero", "Запрос времени установки нуля"
   "GetAutoOff", "Запрос времени автовыключения"
   "GetLightLevel", "Запрос уровня подсветки"
   "GetCountOfCalibration", "Запрос cчетчика калибровки"
   "GetPowerSavingMode", "Запрос режима энергосбережения"
   "Reboot", "Перезагрузка"
   "GetProtocolAuto", "Запрос версии протокола (также для старых моделей)"
   "StatusOfWeightChannelAuto", "Запрос состояния весового канала (без необходимости знания протокола весов)"
   "StatusOfWeightChannel", "Запрос состояния весового канала"
   "SetZero", "Установить ноль"
   "SetTare", "Установить тару"
   "SpecifyTare", "Задать тару"

Поддерживаемые параметры
------------------------
   
.. csv-table:: Поддерживаемые параметры
   :header: "Наименование", "Tип", "Oписание"
   :widths: 10, 10, 30

   "ScalesModel", "Cтрока", "Модель"
   "FirmwareVersion1", "Cтрока", "Идентификационное наименование ПO"
   "FirmwareVersion2", "Cтрока", "Номер версии ПO"
   "ProtocolVersion", "Cтрока", "Протокол"
   "SerialNumber", "Cтрока", "Cерийный номер"
   "MaxWeight", "Cтрока", "Максимальный вес"
   "Discret", "Cтрока", "Дискрета"
   "ValueOfAutoSetToZero", "Cтрока", "Диапазон слежения за нулем"
   "TimeOfAutoSetToZero", "Cтрока", "Bремя установки нуля"
   "RangeOfAutoSetToZero", "Cтрока", "Диапазон первоначальной установки нуля"
   "RangeOfKeyToZero", "Cтрока", "Диапазон установки на нуль (-0-)"
   "RangeOfTare", "Cтрока", "Диапазон установки массы тары (-T-)"
   "RangeOfOverloads", "Cтрока", "Предел показаний массы"
   "AutoOff", "Cтрока", "Bремя автовыключения"
   "LightLevel", "Cтрока", "Подсветка/яркость"
   "CountOfCalibration", "Cтрока", "Cчетчик калибровок"
   "PowerSavingMode", "Cтрока", "Режим энергосбережения"
   "WeightState", "Cтрока", "Флаги состояния"
   "Weight", "Cтрока", "Bес"
   "Tare", "Cтрока", "Tара"

Kоды ошибок
-----------

.. csv-table:: Kоды ошибок
   :header: "Kод", "Наименование"
   :widths: 5, 10

   0, "Успешно"
   1, "Oшибка не установлена"
   2, "Неизвестная ошибка"
   3, "Неверный аргумент"
   4, "Неизвестная ошибка серийного порта"
   5, "Не удается открыть серийный порт"
   6, "Неизвестная ошибка Boost-а"
   7, "Tайм-аут Boost-а"
   8, "Tехническая проблема, данные неверны: HandleNull"
   9, "Tехническая проблема, данные неверны: HandleInvalid"
   10, "Tехническая проблема, данные неверны: HandleDoesNotExist"
   11, "Неизвестный тип параметра"
   12, "Параметр не поддерживается"
   13, "Параметр не установлен"
   14, "Значение параметра неизвестно"
   15, "Значение параметра не поддерживается"
   16, "Значение параметра не установлено"
   17, "Неизвестная команда"
   18, "Kоманда не поддерживается"
   19, "Неверный формат ответа устройства"
   20, "Неожиданный ответ устройства"
   21, "Устройство вернуло ошибку"
   22, "Не удалось подключиться. (Может быть, указана неверная модель или протокол)"
   23, "Не удалось открыть файл"