Драйвер контрольно-кассовой техники v.10
Макросы | Перечисления | Функции
Инициализация/деинициализация библиотеки

Методы для инициализации и деинициализации библиотеки libfptr10. Подробнее...

Макросы

#define LIBFPTR_SETTING_LIBRARY_PATH   L"LibraryPath"
 Путь к зависимостям библиотеки. Подробнее...
 
#define LIBFPTR_SETTING_MODEL   L"Model"
 Модель ККТ. Подробнее...
 
#define LIBFPTR_SETTING_PORT   L"Port"
 Идентификатор канала обмена с ККТ. Подробнее...
 
#define LIBFPTR_SETTING_BAUDRATE   L"BaudRate"
 Скорость канала RS232. Подробнее...
 
#define LIBFPTR_SETTING_BITS   L"Bits"
 Битность канала RS232. Подробнее...
 
#define LIBFPTR_SETTING_PARITY   L"Parity"
 Четность канала RS232. Подробнее...
 
#define LIBFPTR_SETTING_STOPBITS   L"StopBits"
 Количество стоп-битов канала RS232. Подробнее...
 
#define LIBFPTR_SETTING_IPADDRESS   L"IPAddress"
 IP-адрес ККТ. Подробнее...
 
#define LIBFPTR_SETTING_IPPORT   L"IPPort"
 IP-порт ККТ. Подробнее...
 
#define LIBFPTR_SETTING_MACADDRESS   L"MACAddress"
 MAC-адрес ККТ канала Bluetooth. Подробнее...
 
#define LIBFPTR_SETTING_COM_FILE   L"ComFile"
 Название порта канала RS232. Подробнее...
 
#define LIBFPTR_SETTING_USB_DEVICE_PATH   L"UsbDevicePath"
 Путь к устройсву для канала USB (Linux). Подробнее...
 
#define LIBFPTR_SETTING_BT_AUTOENABLE   L"AutoEnableBluetooth"
 Флаг автоматического включения адаптера Bluetooth при подключении. Подробнее...
 
#define LIBFPTR_SETTING_BT_AUTODISABLE   L"AutoDisableBluetooth"
 Флаг автоматического отключения адаптера Bluetooth при отключении. Подробнее...
 
#define LIBFPTR_SETTING_ACCESS_PASSWORD   L"AccessPassword"
 Пароль доступа к ККТ. Подробнее...
 
#define LIBFPTR_SETTING_USER_PASSWORD   L"UserPassword"
 Пароль пользователя ККТ по умолчанию. Подробнее...
 
#define LIBFPTR_SETTING_OFD_CHANNEL   L"OfdChannel"
 Настройка ОФД-канала библиотеки. Подробнее...
 
#define LIBFPTR_SETTING_EXISTED_COM_FILES   L"ExistedComFiles"
 Список существующих в системе COM-портов. Константа для метода libfptr_util_mapping(). Подробнее...
 

Перечисления

enum  libfptr_model {
  LIBFPTR_MODEL_UNKNOWN = 0, LIBFPTR_MODEL_ATOL_AUTO = 500, LIBFPTR_MODEL_ATOL_11F = 67, LIBFPTR_MODEL_ATOL_15F = 78,
  LIBFPTR_MODEL_ATOL_20F = 81, LIBFPTR_MODEL_ATOL_22F = 63, LIBFPTR_MODEL_ATOL_25F = 57, LIBFPTR_MODEL_ATOL_30F = 61,
  LIBFPTR_MODEL_ATOL_42FS = 77, LIBFPTR_MODEL_ATOL_50F = 80, LIBFPTR_MODEL_ATOL_52F = 64, LIBFPTR_MODEL_ATOL_55F = 62,
  LIBFPTR_MODEL_ATOL_60F = 75, LIBFPTR_MODEL_ATOL_77F = 69, LIBFPTR_MODEL_ATOL_90F = 72, LIBFPTR_MODEL_ATOL_91F = 82,
  LIBFPTR_MODEL_ATOL_92F = 84, LIBFPTR_MODEL_ATOL_SIGMA_10 = 86
}
 Модель ККТ Подробнее...
 
enum  libfptr_port { LIBFPTR_PORT_COM = 0, LIBFPTR_PORT_USB, LIBFPTR_PORT_TCPIP, LIBFPTR_PORT_BLUETOOTH }
 Способ соединения с ККТ Подробнее...
 
enum  libfptr_baudrate {
  LIBFPTR_PORT_BR_1200 = 1200, LIBFPTR_PORT_BR_2400 = 2400, LIBFPTR_PORT_BR_4800 = 4800, LIBFPTR_PORT_BR_9600 = 9600,
  LIBFPTR_PORT_BR_19200 = 19200, LIBFPTR_PORT_BR_38400 = 38400, LIBFPTR_PORT_BR_57600 = 57600, LIBFPTR_PORT_BR_115200 = 115200
}
 Скорость соединения (RS232) Подробнее...
 
enum  libfptr_bits { LIBFPTR_PORT_BITS_7 = 7, LIBFPTR_PORT_BITS_8 = 8 }
 Количество бит в байте (RS232) Подробнее...
 
enum  libfptr_parity {
  LIBFPTR_PORT_PARITY_NO = 0, LIBFPTR_PORT_PARITY_ODD, LIBFPTR_PORT_PARITY_EVEN, LIBFPTR_PORT_PARITY_MARK,
  LIBFPTR_PORT_PARITY_SPACE
}
 Четность (RS232) Подробнее...
 
enum  libfptr_stopbits { LIBFPTR_PORT_SB_1 = 0, LIBFPTR_PORT_SB_1_5, LIBFPTR_PORT_SB_2 }
 Количество стоп-битов (RS232) Подробнее...
 
enum  libfptr_ofd_channel { LIBFPTR_OFD_CHANNEL_NONE = 0, LIBFPTR_OFD_CHANNEL_USB, LIBFPTR_OFD_CHANNEL_PROTO }
 Канал обмена с ОФД Подробнее...
 

Функции

DTOX_SHARED_EXPORT const char *DTOX_SHARED_CCA libfptr_get_version_string ()
 Возвращает версию библиотеки как строку. Подробнее...
 
DTOX_SHARED_EXPORT int DTOX_SHARED_CCA libfptr_create (libfptr_handle *handle)
 Создает дескриптор для работы с ККТ. Подробнее...
 
DTOX_SHARED_EXPORT int DTOX_SHARED_CCA libfptr_set_settings (libfptr_handle handle, const wchar_t *settings)
 Настраивает дескриптор для работы с ККТ. Подробнее...
 
DTOX_SHARED_EXPORT void DTOX_SHARED_CCA libfptr_destroy (libfptr_handle *handle)
 Удаляет дескриптор для работы с ККТ. Подробнее...
 
DTOX_SHARED_EXPORT int DTOX_SHARED_CCA libfptr_get_settings (libfptr_handle handle, wchar_t *value, int size)
 Возвращает текущие настройки дескриптора. Подробнее...
 
DTOX_SHARED_EXPORT int DTOX_SHARED_CCA libfptr_get_single_setting (libfptr_handle handle, const wchar_t *key, wchar_t *value, int size)
 Возвращает значение указанной настройки дескриптора. Подробнее...
 
DTOX_SHARED_EXPORT void DTOX_SHARED_CCA libfptr_set_single_setting (libfptr_handle handle, const wchar_t *key, const wchar_t *value)
 Устанавливает значение указанной настройки дескриптору. Подробнее...
 
DTOX_SHARED_EXPORT int DTOX_SHARED_CCA libfptr_apply_single_settings (libfptr_handle handle)
 Применяет настройки дескриптора. Подробнее...
 

Подробное описание

Методы для инициализации и деинициализации библиотеки libfptr10.

Макросы

◆ LIBFPTR_SETTING_ACCESS_PASSWORD

#define LIBFPTR_SETTING_ACCESS_PASSWORD   L"AccessPassword"

Пароль доступа к ККТ.

См. определение в файле libfptr10.h строка 949

◆ LIBFPTR_SETTING_BAUDRATE

#define LIBFPTR_SETTING_BAUDRATE   L"BaudRate"

Скорость канала RS232.

См. определение в файле libfptr10.h строка 894

◆ LIBFPTR_SETTING_BITS

#define LIBFPTR_SETTING_BITS   L"Bits"

Битность канала RS232.

См. определение в файле libfptr10.h строка 899

◆ LIBFPTR_SETTING_BT_AUTODISABLE

#define LIBFPTR_SETTING_BT_AUTODISABLE   L"AutoDisableBluetooth"

Флаг автоматического отключения адаптера Bluetooth при отключении.

См. определение в файле libfptr10.h строка 944

◆ LIBFPTR_SETTING_BT_AUTOENABLE

#define LIBFPTR_SETTING_BT_AUTOENABLE   L"AutoEnableBluetooth"

Флаг автоматического включения адаптера Bluetooth при подключении.

См. определение в файле libfptr10.h строка 939

◆ LIBFPTR_SETTING_COM_FILE

#define LIBFPTR_SETTING_COM_FILE   L"ComFile"

Название порта канала RS232.

См. определение в файле libfptr10.h строка 929

◆ LIBFPTR_SETTING_EXISTED_COM_FILES

#define LIBFPTR_SETTING_EXISTED_COM_FILES   L"ExistedComFiles"

Список существующих в системе COM-портов. Константа для метода libfptr_util_mapping().

См. определение в файле libfptr10.h строка 964

◆ LIBFPTR_SETTING_IPADDRESS

#define LIBFPTR_SETTING_IPADDRESS   L"IPAddress"

IP-адрес ККТ.

См. определение в файле libfptr10.h строка 914

◆ LIBFPTR_SETTING_IPPORT

#define LIBFPTR_SETTING_IPPORT   L"IPPort"

IP-порт ККТ.

См. определение в файле libfptr10.h строка 919

◆ LIBFPTR_SETTING_LIBRARY_PATH

#define LIBFPTR_SETTING_LIBRARY_PATH   L"LibraryPath"

Путь к зависимостям библиотеки.

См. определение в файле libfptr10.h строка 879

◆ LIBFPTR_SETTING_MACADDRESS

#define LIBFPTR_SETTING_MACADDRESS   L"MACAddress"

MAC-адрес ККТ канала Bluetooth.

См. определение в файле libfptr10.h строка 924

◆ LIBFPTR_SETTING_MODEL

#define LIBFPTR_SETTING_MODEL   L"Model"

Модель ККТ.

См. определение в файле libfptr10.h строка 884

◆ LIBFPTR_SETTING_OFD_CHANNEL

#define LIBFPTR_SETTING_OFD_CHANNEL   L"OfdChannel"

Настройка ОФД-канала библиотеки.

См. определение в файле libfptr10.h строка 959

◆ LIBFPTR_SETTING_PARITY

#define LIBFPTR_SETTING_PARITY   L"Parity"

Четность канала RS232.

См. определение в файле libfptr10.h строка 904

◆ LIBFPTR_SETTING_PORT

#define LIBFPTR_SETTING_PORT   L"Port"

Идентификатор канала обмена с ККТ.

См. определение в файле libfptr10.h строка 889

◆ LIBFPTR_SETTING_STOPBITS

#define LIBFPTR_SETTING_STOPBITS   L"StopBits"

Количество стоп-битов канала RS232.

См. определение в файле libfptr10.h строка 909

◆ LIBFPTR_SETTING_USB_DEVICE_PATH

#define LIBFPTR_SETTING_USB_DEVICE_PATH   L"UsbDevicePath"

Путь к устройсву для канала USB (Linux).

См. определение в файле libfptr10.h строка 934

◆ LIBFPTR_SETTING_USER_PASSWORD

#define LIBFPTR_SETTING_USER_PASSWORD   L"UserPassword"

Пароль пользователя ККТ по умолчанию.

См. определение в файле libfptr10.h строка 954

Перечисления

◆ libfptr_baudrate

Скорость соединения (RS232)

Элементы перечислений
LIBFPTR_PORT_BR_1200 

1200 бод

LIBFPTR_PORT_BR_2400 

2400 бод

LIBFPTR_PORT_BR_4800 

4800 бод

LIBFPTR_PORT_BR_9600 

9600 бод

LIBFPTR_PORT_BR_19200 

19200 бод

LIBFPTR_PORT_BR_38400 

38400 бод

LIBFPTR_PORT_BR_57600 

57600 бод

LIBFPTR_PORT_BR_115200 

115200 бод

См. определение в файле libfptr10.h строка 988

◆ libfptr_bits

Количество бит в байте (RS232)

Элементы перечислений
LIBFPTR_PORT_BITS_7 

7 бит

LIBFPTR_PORT_BITS_8 

8 бит

См. определение в файле libfptr10.h строка 1013

◆ libfptr_model

Модель ККТ

Список возможных значений для параметра LIBFPTR_PARAM_MODEL

Элементы перечислений
LIBFPTR_MODEL_UNKNOWN 

Неизвестна

LIBFPTR_MODEL_ATOL_AUTO 

Автоматически (АТОЛ)

LIBFPTR_MODEL_ATOL_11F 

АТОЛ 11Ф

LIBFPTR_MODEL_ATOL_15F 

АТОЛ 15Ф

LIBFPTR_MODEL_ATOL_20F 

АТОЛ 20Ф

LIBFPTR_MODEL_ATOL_22F 

АТОЛ 22Ф (АТОЛ FPrint-22ПТК)

LIBFPTR_MODEL_ATOL_25F 

АТОЛ 25Ф

LIBFPTR_MODEL_ATOL_30F 

АТОЛ 30Ф

LIBFPTR_MODEL_ATOL_42FS 

АТОЛ 42ФС

LIBFPTR_MODEL_ATOL_50F 

АТОЛ 50Ф

LIBFPTR_MODEL_ATOL_52F 

АТОЛ 52Ф

LIBFPTR_MODEL_ATOL_55F 

АТОЛ 55Ф

LIBFPTR_MODEL_ATOL_60F 

АТОЛ 60Ф

LIBFPTR_MODEL_ATOL_77F 

АТОЛ 77Ф

LIBFPTR_MODEL_ATOL_90F 

АТОЛ 90Ф

LIBFPTR_MODEL_ATOL_91F 

АТОЛ 91Ф

LIBFPTR_MODEL_ATOL_92F 

АТОЛ 92Ф

LIBFPTR_MODEL_ATOL_SIGMA_10 

АТОЛ Sigma 10 (АТОЛ 150Ф)

См. определение в файле libfptr10.h строка 835

◆ libfptr_ofd_channel

Канал обмена с ОФД

Требует дополнительной настройки ККТ!

Элементы перечислений
LIBFPTR_OFD_CHANNEL_NONE 

Не предоставлять канал обмена (в случае, если организована передача данных с помощью прямого выхода ККТ в Интернет)

LIBFPTR_OFD_CHANNEL_USB 

Предоставить для ККТ канал обмена через USB (EthernetOverUsb)

LIBFPTR_OFD_CHANNEL_PROTO 

Предоставить для ККТ канал обмена средствами протокола

См. определение в файле libfptr10.h строка 1666

◆ libfptr_parity

Четность (RS232)

Элементы перечислений
LIBFPTR_PORT_PARITY_NO 

Нет четности

LIBFPTR_PORT_PARITY_ODD 

Четность

LIBFPTR_PORT_PARITY_EVEN 

Нечетность

LIBFPTR_PORT_PARITY_MARK 

Установлен

LIBFPTR_PORT_PARITY_SPACE 

Сброшен

См. определение в файле libfptr10.h строка 1026

◆ libfptr_port

Способ соединения с ККТ

Элементы перечислений
LIBFPTR_PORT_COM 

RS232 / Virtual COM.

LIBFPTR_PORT_USB 

USB.

LIBFPTR_PORT_TCPIP 

Ethernet и Wi-Fi.

LIBFPTR_PORT_BLUETOOTH 

Bluetooth.

См. определение в файле libfptr10.h строка 971

◆ libfptr_stopbits

Количество стоп-битов (RS232)

Элементы перечислений
LIBFPTR_PORT_SB_1 

1 стоп-бит

LIBFPTR_PORT_SB_1_5 

1.5 стоп-битов

LIBFPTR_PORT_SB_2 

2 стоп-бита

См. определение в файле libfptr10.h строка 1045

Функции

◆ libfptr_apply_single_settings()

DTOX_SHARED_EXPORT int DTOX_SHARED_CCA libfptr_apply_single_settings ( libfptr_handle  handle)

Применяет настройки дескриптора.

Применяет настройки, переданные с помощью libfptr_set_single_setting(), к дескриптору. Вызов метода вызывает отключение от ККТ и повторную установку связи, если соединения до вызова метода было установлено.

Пример использования:

Аргументы
handleДескриптор
Возвращаемые значения
-1Ошибка
0Успех

◆ libfptr_create()

DTOX_SHARED_EXPORT int DTOX_SHARED_CCA libfptr_create ( libfptr_handle handle)

Создает дескриптор для работы с ККТ.

Создает дескриптор handle для работы с ККТ, служащий для идентификации устройства внутри библиотеки. Созданный дескриптор используется во всем методах библиотеки, связанным с работой с ККТ. Память для дескриптора выделяется внутри библиотеки. Освободить её нужно с помощью libfptr_destroy().

Аргументы
handleДескриптор
Возвращаемые значения
-1Ошибка
0Успех

◆ libfptr_destroy()

DTOX_SHARED_EXPORT void DTOX_SHARED_CCA libfptr_destroy ( libfptr_handle handle)

Удаляет дескриптор для работы с ККТ.

Аргументы
handleДескриптор

◆ libfptr_get_settings()

DTOX_SHARED_EXPORT int DTOX_SHARED_CCA libfptr_get_settings ( libfptr_handle  handle,
wchar_t *  value,
int  size 
)

Возвращает текущие настройки дескриптора.

Аргументы
handleДескриптор
valueБуфер для строки с настройками
sizeРазмер буфера
Возвращает
Требуемый размер буфера (с учетом '\0')

◆ libfptr_get_single_setting()

DTOX_SHARED_EXPORT int DTOX_SHARED_CCA libfptr_get_single_setting ( libfptr_handle  handle,
const wchar_t *  key,
wchar_t *  value,
int  size 
)

Возвращает значение указанной настройки дескриптора.

Пример использования:

std::vector<wchar_t> ip_addr(1024);
int size = libfptr_get_single_setting(handle, LIBFPTR_SETTING_IPADDRESS, &ip_addr[0], ip_addr.size());
if (size > mapping.length())
{
ip_addr.resize(size);
libfptr_get_single_setting(handle, LIBFPTR_SETTING_IPADDRESS, &ip_addr[0], ip_addr.size());
}
std::wcout << std::wstring(&ip_addr[0]) << std::endl;
Аргументы
handleДескриптор
keyНазвание настройки
valueБуфер для строки со значением настройки
sizeРазмер буфера
Возвращает
Требуемый размер буфера (с учетом '\0')

◆ libfptr_get_version_string()

DTOX_SHARED_EXPORT const char* DTOX_SHARED_CCA libfptr_get_version_string ( )

Возвращает версию библиотеки как строку.

Возвращает
Строка с версией библиотеки

◆ libfptr_set_settings()

DTOX_SHARED_EXPORT int DTOX_SHARED_CCA libfptr_set_settings ( libfptr_handle  handle,
const wchar_t *  settings 
)

Настраивает дескриптор для работы с ККТ.

При установке соединения с ККТ будут использованы настройки settings. Также settings содержат настройки дескриптора.

Формат настроек - JSON (подробнее на странице Настройки библиотеки)

Аргументы
handleДескриптор
settingsНастройки
Возвращаемые значения
-1Ошибка
0Успех

◆ libfptr_set_single_setting()

DTOX_SHARED_EXPORT void DTOX_SHARED_CCA libfptr_set_single_setting ( libfptr_handle  handle,
const wchar_t *  key,
const wchar_t *  value 
)

Устанавливает значение указанной настройки дескриптору.

Указанные таким образом настройки применятся после вызова libfptr_apply_single_settings().

Пример использования приведен в описании libfptr_apply_single_settings().

Аргументы
handleДескриптор
keyНазвание настройки
valueЗначение настройки