Класс QModbusServer

Класс QModbusServer — интерфейс для приема и обработки запросов Modbus. Подробнее...

• Список всех членов, включая унаследованные

Открытые типы

Открытые функции

• 7 открытых функций унаследовано от QModbusDevice
• 31 открытых функций унаследовано от QObject

Сигналы

• 2 сигнала унаследовано от QModbusDevice
• 2 сигнала унаследовано от QObject

Защищенные функции

• 4 защищенных функции унаследовано от QModbusDevice
• 9 защищенных функций унаследовано от QObject

Дополнительные унаследованные члены

• 1 свойство унаследовано от QObject
• 1 открытый слот унаследовано от QObject
• 11 статических открытых членов унаследовано от QObject

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

Класс QModbusServer — интерфейс для приема и обработки запросов Modbus.

В сетях Modbus может быть несколько серверов Modbus. Серверы Modbus читаются/записываются клиентом Modbus, представленным QModbusClient. QModbusServer взаимодействует с бэкендом Modbus, предоставляя пользователям удобный API.

Документация типов членов

перечисление QModbusServer::Option

Каждый сервер Modbus имеет набор связанных с ним значений, каждое со своим собственным параметром.

Общие параметры (и соответствующие типы):

Параметры пользователя:

Для параметров пользователя разработчик должен определить используемые типы и гарантировать, что компоненты используют правильные типы при доступе и установке значений.

Документация функций членов

QModbusServer::QModbusServer(QObject *parent = nullptr)

Конструктор сервера Modbus со заданным parent.

bool QModbusServer::data(QModbusDataUnit *newData) const

Возвращает значения в диапазоне регистров, заданном newData.

newData должен содержать допустимый тип регистра, начальный адрес и значение количества. Возвращаемый newData будет содержать значения регистров, связанные с заданным диапазоном.

Если newData содержит допустимый тип регистра, но отрицательный начальный адрес, возвращается вся карта регистров, а newData соответствующим образом размерен.

См. также setData().

bool QModbusServer::data(QModbusDataUnit::RegisterType table, quint16 address, quint16 *data) const

Считывает данные, хранящиеся на сервере Modbus. Сервер Modbus имеет четыре таблицы (table), и каждая из них имеет уникальное поле address, которое используется для чтения data из желаемого поля. См. QModbusDataUnit::RegisterType для получения дополнительной информации о разных таблицах. Возвращает false если адрес находится вне диапазона карты или тип регистра даже не определен.

См. также QModbusDataUnit::RegisterType и setData().

Возвращает значение void QModbusServer::dataWritten(QModbusDataUnit::RegisterType register, int address, int size)

Этот сигнал излучается, когда клиент Modbus записал одно или несколько полей данных в сервер Modbus. Сигнал содержит информацию о записанных полях:

• тип регистра, который был записан,
• адрес первого поля, которое было записано,
• и размер последовательных полей, которые были записаны, начиная с адреса.

Сигнал не излучается, когда поля, которые должны быть записаны, не изменились из-за отсутствия изменения значения.

[virtual protected] QModbusResponse QModbusServer::processPrivateRequest(const QModbusPdu &request)

Эта функция должна быть реализована пользовательскими серверами Modbus. Она вызывается функцией processRequest() в случае, если заданная request не является стандартным запросом Modbus.

Переопределение этой функции позволяет обрабатывать дополнительные коды функций и подкоды функций, не указанные в спецификации протокола Modbus Application Protocol 1.1b. Реализации должны повторно вызвать эту функцию, чтобы гарантировать, что для всех неизвестных кодов функций, которые не обрабатываются пользовательской реализацией Modbus, возвращается ответ об исключении.

Эта реализация по умолчанию возвращает QModbusExceptionResponse с кодом функции request и кодом ошибки, установленным как «незаконная функция».

См. также processRequest().

[virtual protected] QModbusResponse QModbusServer::processRequest(const QModbusPdu &request)

Обрабатывает запрос клиента Modbus request и возвращает ответ Modbus. Эта функция возвращает QModbusResponse или QModbusExceptionResponse в зависимости от характера запроса.

Реализация по умолчанию этой функции обрабатывает все стандартные коды функций Modbus, как определено в спецификации протокола Modbus Application Protocol 1.1b. Все остальные коды функций Modbus, не включённые в спецификацию, передаются функции processPrivateRequest().

Стандартная обработка запросов по стандартным кодам функций Modbus может быть переопределена путём пере реализации этой функции. Переопределение должно обрабатывать соответствующий тип запроса и возвращать соответствующий ответ QModbusResponse. Типичной причиной может быть фильтрация запросов кода функций для значений данных для ограничения доступа к чтению/записи и кодов функций, нежелательных в конкретных реализациях, таких как диагностика последовательного канала в сетях Ethernet или транспортных слоях Modbus Plus.

Примечание: Эта функция не должна переопределяться для предоставления пользовательской реализации для типов нестандартных запросов Modbus.

См. также processPrivateRequest().

[virtual] bool QModbusServer::processesBroadcast() const

Подклассы должны реализовать эту функцию, если транспортный уровень должен обрабатывать широковещательные запросы. Тогда реализация должна вернуть true если текущий обрабатываемый запрос является широковещательным запросом; в противном случае false. Реализация по умолчанию всегда возвращает false.

Примечание: Значение возврата этой функции имеет смысл только изнутри processRequest() или processPrivateRequest(), в противном случае она может только сообщить, что последний обработанный запрос был широковещательным запросом.

[virtual protected] bool QModbusServer::readData(QModbusDataUnit *newData) const

Считывает значения в диапазоне регистров, заданном newData, и записывает данные обратно в newData. Возвращает true при успехе или false если newData 0, диапазон newData выходит за пределы диапазона карты или registerType() не существует.

Примечание: Подклассы, которые реализуют чтение из другого хранилища, отличного от стандартного, также должны реализовать setMap() и writeData().

См. также setMap() и writeData().

int QModbusServer::serverAddress() const

Возвращает адрес этой инстанции сервера Mobus.

См. также setServerAddress().

bool QModbusServer::setData(const QModbusDataUnit &newData)

Записывает newData в карту сервера Modbus. Возвращает false если диапазон newData выходит за пределы диапазона карты.

Если вызов был успешным, излучается сигнал dataWritten(). Обратите внимание, что сигнал не излучается, когда адресной регистр не изменился. Это может произойти, когда newData содержит точно такие же значения, что и регистр уже. Тем не менее, эта функция возвращает true в таких случаях.

См. также data().

bool QModbusServer::setData(QModbusDataUnit::RegisterType table, quint16 address, quint16 data)

Записывает данные в сервер Modbus. Сервер Modbus имеет четыре таблицы (table) и каждая имеет уникальное поле address, которое используется для записи data в нужное поле. Возвращает false если адрес выходит за пределы диапазона карты.

Если вызов был успешным, излучается сигнал dataWritten(). Обратите внимание, что сигнал не излучается, когда data не изменилось. Тем не менее, эта функция возвращает true в таких случаях.

См. также QModbusDataUnit::RegisterType, data() и dataWritten().

[virtual] bool QModbusServer::setMap(const QModbusDataUnitMap &map)

Устанавливает зарегистрированную структуру карты для запросов от других клиентов ModBus в map. Значения регистров инициализируются нулём. Возвращает true при успехе; в противном случае false.

Если эта функция не вызывается до подключения, настраивается регистр по умолчанию с нулевыми записями.

Примечание: Вызов этой функции отбрасывает любые значения регистров, которые были установлены ранее.

void QModbusServer::setServerAddress(int serverAddress)

Устанавливает адрес для этой инстанции сервера Modbus в serverAddress.

См. также serverAddress().

[virtual] bool QModbusServer::setValue(int option, const QVariant &newValue)

Устанавливает newValue для option и возвращает true при успехе; false в противном случае.

Примечание: Если тип, связанный с параметром, quint8 или quint16 и тип newValue больше, данные будут усечены или преобразование завершится неудачей.

См. также value().

[virtual] QVariant QModbusServer::value(int option) const

Возвращает значение для option или недействительное значение QVariant, если параметр не задан.

См. также setValue().

[virtual protected] bool QModbusServer::writeData(const QModbusDataUnit &newData)

Записывает newData в карту сервера Modbus. Возвращает true при успехе или false если диапазон newData находится за пределами диапазона карты или registerType() не существует.

Примечание: Подклассы, которые реализуют запись в другой хранилище, отличном от стандартного, также должны реализовать setMap() и readData(). Сигнал dataWritten() также должен быть выпущен внутри реализации функций.

См. также setMap(), readData() и dataWritten().