KRModbusClient.pas

Константы

• MBC_ERRORS_COUNT – количество ошибок модуля
• mbceAskLimit – ошибка превышения лимита ожидания ответа от потока
• mbceFileNotFount – файл не найден
• mbceFileDeleteError – ошибка удаления файла
• mbceFileOpenForReadError – ошибка открытия файла для чтения
• mbceFileReadError – ошибка чтения файла
• mbceFileOpenForWriteError – ошибка открытия файла для записи
• mbceFileWriteError – ошибка записи файла
• MBC_ERRORS_MSG – список сообщений о ошибках

Типы данных

• TMBCError – тип ошибки модуля (integer)
• TMBReadFunction – стандартные функции чтения протокола Modbus
  • mbrfReadHoldingRegisters – функция чтения значения регистров (0x03)
  • mbrfReadInputRegisters – функция чтения значения входящих регистров (0x04)
• TMBWriteFunction – стандартные функции записи протокола Modbus
  • mbwfWriteHoldingRegister – функция записи одного регистра (0x06)
  • mbwfWriteHoldingRegisters – функция записи нескольких регистров (0x10)
• TMCVarType – тип значения переменной
  • MCT_BYTE – беззнаковый целочисленный байт
  • MCT_WORD – беззнаковое 16-битное целочисленное значение
  • MCT_DWORD – беззнаковое 32-битное целочисленное значение
  • MCT_SMALLINT – 16-битное целочисленное значение
  • MCT_INT – 32-битное целочисленное значение
  • MCT_SINGLE – 32-битное значение с плавающей точкой
  • MCT_STRING – строка фиксированной длины. Длина указывается в свойстве StrLen
  • MCT_DWSTR – строка переменной длины. Данные передаются последовательно, используя два регистра
  • MCT_WD_STREAM – беззнаковое 16-битное целочисленное значение. Является элементом массива с индексом указанным в свойстве StreamIndex. Для передачи данных используется два регистра
  • MCT_DW_STREAM – беззнаковое 32-битное целочисленное значение. Является элементом массива с индексом указанным в свойстве StreamIndex. Для передачи данных используется два регистра
  • MCT_BT_STREAM – беззнаковый целочисленный байт. Является элементом массива с индексом указанным в свойстве StreamIndex. Для передачи данных используется один регистр
  • MCT_SINT_STREAM – 16-битное целочисленное значение. Является элементом массива с индексом указанным в свойстве StreamIndex. Для передачи данных используется два регистра
  • MCT_INT64 – 64-битное целочисленное значение
  • MCT_FILE – набор регистров для работы с файлами. Для передачи данных используется количество регистров заданное в свойстве FileRegs, плюс один регистр для управления процессом
  • MCT_ARRAY – доступ к переменному количеству регистров. Для установки количества считываемых регистров используется свойство ArrayLen
  • MCT_UINT64 – беззнаковое 64-битное целочисленное значение
  • MCT_DOUBLE – 64-битное значение с плавающей точкой

TKRMBRegFileInfo = record crc16: Word; size: Cardinal; dtCreation: TDateTime; dtLastAccess: TDateTime; dtLastModification: TDateTime; end;

• TKRMBRegFileInfo – структура, содержащая информацию о файле
  • crc16 – контрольная сумма
  • size – размер файла
  • dtCreation – дата создания
  • dtLastAccess – дата последнего доступа
  • dtLastModification – дата последнего изменения
  • –

Классы

Класс TKRMBRegister

Родительский класс TKRVariable

TKRMBRegister – класс для чтения и установки значения в удаленную переменную по протоколу Modbus

Свойства класса TKRMBRegister

property ReadFunction: TMBReadFunction;

• ReadFunction – функция для чтения значения

property WriteFunction: TMBWriteFunction;

• WriteFunction – функция для записи значения

property MCVarType: TMCVarType;

• MCVarType – тип переменной

property RegisterIndex: Word;

• RegisterIndex – индекс регистра

property CfgReadFunc: TKRIniCfgParam;

• CfgReadFunc – конфигурационная переменная TKRIniCfgParam, для хранения номера функции чтения

property CfgWriteFunc: TKRIniCfgParam;

• CfgWriteFunc – конфигурационная переменная TKRIniCfgParam, для хранения номера функции записи

property CfgRegisterIndex: TKRIniCfgParam;

• CfgRegisterIndex – конфигурационная переменная TKRIniCfgParam, для хранения индекса регистра

property ArrayLen: word;

• ArrayLen – количество регистров в массиве. Используется при MCVarType равном MCT_ARRAY

property StrLen: Byte;

• StrLen – длина строковой переменной с учетом символа конца строки. Используется если тип переменной MCT_STRING. Значение должно быть кратно двум

property StreamIndex: byte;

• StreamIndex – индекс элемента в массиве. Используется при типах данных MCT_WD_STREAM, MCT_DW_STREAM, MCT_BT_STREAM, MCT_SINT_STREAM

property AskLimit: byte;

• AskLimit – максимальное количество попыток получить ответ от обработчика. Используется в тех переменных, для которых на стороне удаленного устройства используется дополнительный обработчик данных, а именно MCT_WD_STREAM, MCT_DW_STREAM, MCT_BT_STREAM, MCT_SINT_STREAM, MCT_DWSTR, MCT_FILE

property FileRegs: byte;

• FileRegs – количество регистров используемых для приема/передачи данных файла

property HighByteFirst: boolean;

• HighByteFirst – последовательность байт в каждом слове. Для типа MBC_STRING просто последовательность байт от старшего к младшему или наоборот

property HighWordFirst: boolean;

• HighWordFirst – последовательность слов. Актуально для 32-битных и 64-битных значений

property HighDWordFirst: boolean;

• HighDWordFirst – последовательность двойных слов. Актуально для 64-битных значений

События класса TKRMBRegister

property OnFile: TNotifyEvent;

• OnFile – вызывается, когда процесс работы с файлом (копирование на устройство, копирование с устройства, удаление, получение характеристик файла) завершился, вне зависимости от того произошла ошибка или нет

Методы класса TKRMBRegister

procedure UpdateReadPack;

• UpdateReadPack – обновляет запрос чтения. Запрос чтения значения изменяется только при изменении индекса и количества регистров. По этом нет смысла его генерировать при каждом обновлении значения, и он хранится в памяти. Но если возникает необходимость его обновить, используется данный метод

procedure UpdateValueAsync;

• UpdateValueAsync – асинхронное обновление значения

procedure FileDelete(AFileName: String);

• FileDelete – удаление файла на удаленном устройстве
  • AFileName – имя удаляемого файла

procedure FileRead(AFileName: String; AFile: TStream);

• FileRead – чтение файла с удаленного устройства и запись его в поток
  • AFileName – имя файла на удаленном устройстве
  • AFile – поток, для сохранения данных из удаленного файла

procedure FileWrite(AFileName: String; AFile: TStream);

• FileWrite – запись файла на удаленное устройство
  • AFileName – имя файла на удаленном устройстве
  • AFile – поток, данные которого будут переданы в удаленный файл

function FileDeleteAsinc(AFileName: String): boolean;

• FileDeleteAsinc – асинхронное удаление файла на удаленном устройстве
  • AFileName – имя удаляемого файла

function FileReadAsinc(AFileName: String; AFile: TStream): boolean;

• FileReadAsinc – асинхронное чтение файла с удаленного устройства и запись его в поток
  • AFileName – имя файла на удаленном устройстве
  • AFile – поток, для сохранения данных из удаленного файла

function FileWriteAsinc(AFileName: String; AFile: TStream): boolean;

• FileWriteAsinc – асинхронная запись файла на удаленное устройство
  • AFileName – имя файла на удаленном устройстве
  • AFile – поток, данные которого будут переданы в удаленный файл

function FileInfoAsinc(AFileName: String; AFileInfo: PKRMBRegFileInfo): boolean;

• FileInfoAsinc – асинхронное получение характеристик удаленного файла
  • AFileName – имя файла на удаленном устройстве
  • AFileInfo – указатель на структуру TKRMBRegFileInfo, куда будут записаны характеристики удаленного файла

procedure FileInfo(AFileName: String; AFileInfo: PKRMBRegFileInfo);

• FileInfo – получение характеристик удаленного файла
  • AFileName – имя файла на удаленном устройстве
  • AFileInfo – указатель на структуру TKRMBRegFileInfo, куда будут записаны характеристики удаленного файла

Класс TKRModbusClient

Родительский класс TKRVariabels

TKRModbusClient – коллекция переменных Modbus класса TKRMBRegister

Свойства класса TKRModbusClient

property Active: boolean;

• Active – включение/выключение модуля

property Modbus: TKRModbusMaster;

• Modbus – свойство для подключения модуля класса TKRModbusMaster

property Addres: byte;

• Addres – адрес удаленного устройства

property MBType: TMBType;

• MBType – тип протокола Modbus TMBType

Методы класса TKRModbusClient

function AddVar(AName: String; AType: TMCVarType; AIndex: word; AInterval: Integer = 0):TKRMBRegister;

• AddVar – добавление переменной TKRMBRegister в коллекцию. Возвращает указатель на объект созданной переменной
  • AName – имя переменной
  • AType – тип переменной TMCVarType
  • AIndex – индекс регистра
  • AInterval – интервал обновления значения переменной (мс). Если переменную не нужно обновлять, то устанавливается ноль

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

• Пример передачи данных по протоколу Modbus на Delphi
• Мини SCADA система на Delphi

Поделиться: