Класс QModbusDevice
Класс QModbusDevice является базовым классом для классов Modbus, QModbusServer и QModbusClient. Подробнее...
| Заголовок: | #include <QModbusDevice> |
| qmake: | QT += serialbus |
| С момента: | Qt 5.6 |
| Наследуется от: | QObject |
| Наследуется: |
Открытые типы
| перечисление | ConnectionParameter { SerialPortNameParameter, SerialParityParameter, SerialBaudRateParameter, SerialDataBitsParameter, ..., UserParameter } |
| перечисление | Error { NoError, ReadError, WriteError, ConnectionError, ..., UnknownError } |
| перечисление | State { UnconnectedState, ConnectingState, ConnectedState, ClosingState } |
Открытые функции
| QModbusDevice(QObject *parent = nullptr) | |
| ~QModbusDevice() | |
| bool | connectDevice() |
| QVariant | connectionParameter(int parameter) const |
| void | disconnectDevice() |
| Error | error() const |
| QString | errorString() const |
| void | setConnectionParameter(int parameter, const QVariant &value) |
| State | state() const |
- 31 открытых функций, унаследованных от QObject
Сигналы
| void | errorOccurred(QModbusDevice::Error error) |
| void | stateChanged(QModbusDevice::State state) |
- 2 сигнала, унаследованных от QObject
Защищённые функции
| virtual void | close() = 0 |
| virtual bool | open() = 0 |
| void | setError(const QString &errorText, QModbusDevice::Error error) |
| void | setState(QModbusDevice::State newState) |
- 9 защищённых функций, унаследованных от QObject
Дополнительные наследуемые члены
- 1 свойство, унаследованное от QObject
- 1 открытый слот, унаследованный от QObject
- 11 статических открытых членов, унаследованных от QObject
Подробное описание
Класс QModbusDevice является базовым классом для классов Modbus, QModbusServer и QModbusClient.
Документация по типам членов
перечисление QModbusDevice::ConnectionParameter
Это перечисление описывает возможные значения, которые можно установить для подключения устройства Modbus.
Общие значения (и связанные типы):
| Константа | Значение | Описание |
|---|---|---|
QModbusDevice::SerialPortNameParameter |
0 |
Это параметр, содержащий последовательный порт, используемый для связи с устройством, например, COM1. QString
|
QModbusDevice::SerialParityParameter |
1 |
Этот параметр содержит режим проверки чётности. QSerialPort::Parity
|
QModbusDevice::SerialBaudRateParameter |
2 |
Этот параметр содержит скорость передачи данных для связи. QSerialPort::BaudRate
|
QModbusDevice::SerialDataBitsParameter |
3 |
Этот параметр содержит биты данных в кадре. QSerialPort::DataBits
|
QModbusDevice::SerialStopBitsParameter |
4 |
Этот параметр содержит количество стоповых битов в кадре. QSerialPort::StopBits
|
QModbusDevice::NetworkPortParameter |
5 |
Этот параметр содержит сетевой порт. int
|
QModbusDevice::NetworkAddressParameter |
6 |
Этот параметр содержит адрес хоста для сетевой связи. QString
|
Пользовательские параметры:
| Константа | Значение | Описание |
|---|---|---|
QModbusDevice::UserParameter |
0x100 |
Первый параметр, который можно использовать для пользовательских целей. QVariant
|
перечисление QModbusDevice::Error
Это перечисление описывает все возможные ошибки.
| Константа | Значение | Описание |
|---|---|---|
QModbusDevice::NoError |
0 |
Ошибок не произошло. |
QModbusDevice::ReadError |
1 |
Во время операции чтения произошла ошибка. |
QModbusDevice::WriteError |
2 |
Во время операции записи произошла ошибка. |
QModbusDevice::ConnectionError |
3 |
При попытке открыть бэкенд произошла ошибка. |
QModbusDevice::ConfigurationError |
4 |
При попытке установить параметр конфигурации произошла ошибка. |
QModbusDevice::TimeoutError |
5 |
Произошёл таймаут во время ввода-вывода. Операция ввода-вывода не завершилась в заданный период времени. |
QModbusDevice::ProtocolError |
6 |
Произошла ошибка протокола Modbus. |
QModbusDevice::ReplyAbortedError |
7 |
Ответ был прерван из-за отключения устройства. |
QModbusDevice::UnknownError |
8 |
Произошла неизвестная ошибка. |
перечисление QModbusDevice::State
Это перечисление описывает все возможные состояния устройства.
| Константа | Значение | Описание |
|---|---|---|
QModbusDevice::UnconnectedState |
0 |
Устройство отключено. |
QModbusDevice::ConnectingState |
1 |
Устройство подключается. |
QModbusDevice::ConnectedState |
2 |
Устройство подключено к сети Modbus. |
QModbusDevice::ClosingState |
3 |
Устройство закрывается. |
Документация по функциям-членам
QModbusDevice::QModbusDevice(QObject *parent = nullptr)
Создаёт устройство Modbus с указанным parent.
QModbusDevice::~QModbusDevice()
Удаляет экземпляр QModbusDevice.
[pure virtual protected] void QModbusDevice::close()
Эта функция отвечает за закрытие соединения Modbus. Реализация должна гарантировать, что состояние экземпляра state() установлено в QModbusDevice::UnconnectedState.
См. также disconnectDevice().
bool QModbusDevice::connectDevice()
Подключает устройство к сети Modbus. Возвращает true при успехе; в противном случае false.
Эта функция вызывает open() как часть своей реализации.
QVariant QModbusDevice::connectionParameter(int parameter) const
Возвращает значение, связанное с заданным параметром соединения parameter. Возвращаемое значение может быть пустым.
По умолчанию QModbusDevice инициализируется некоторыми общими значениями. Параметры последовательного порта: чётность, скорость 19200 бит в секунду, 8 бит данных и 1 стоп-бит. Параметры сетевого подключения: адрес хоста — локальный хост, порт — 502.
Примечание: Для успешного подключения по последовательному каналу необходимо установить SerialPortNameParameter на допустимый порт связи. Информация о допустимых последовательных портах может быть получена из QSerialPortInfo.
Примечание: Если устройство уже подключено, настройки учитываются после повторного подключения устройства.
См. также setConnectionParameter() и ConnectionParameter.
void QModbusDevice::disconnectDevice()
Отключает устройство.
Эта функция вызывает close() как часть своей реализации.
Error QModbusDevice::error() const
Возвращает состояние ошибки устройства.
См. также setError() и QModbusDevice::Error.
[signal] void QModbusDevice::errorOccurred(QModbusDevice::Error error)
Этот сигнал излучается при возникновении ошибки типа error.
QString QModbusDevice::errorString() const
Возвращает текстовое описание ошибки устройства.
См. также QModbusDevice::Error.
[pure virtual protected] bool QModbusDevice::open()
Эта функция вызывается connectDevice(). Подклассы должны предоставить реализацию, возвращающую true при успешном подключении Modbus или false в противном случае.
Реализация должна гарантировать, что состояние экземпляра state() установлено в QModbusDevice::ConnectedState при успехе; в противном случае QModbusDevice::UnconnectedState.
См. также connectDevice().
void QModbusDevice::setConnectionParameter(int parameter, const QVariant &value)
Устанавливает значение parameter в value. Если parameter уже существует, предыдущее значение перезаписывается. Действующее или активное соединение не затрагивается такими изменениями параметров.
См. также ConnectionParameter и connectionParameter().
[protected] void QModbusDevice::setError(const QString &errorText, QModbusDevice::Error error)
Устанавливает состояние ошибки устройства. Реализации устройств ModBus должны использовать эту функцию в случае ошибки для установки типа error и описания errorText.
См. также error() и QModbusDevice::Error.
[protected] void QModbusDevice::setState(QModbusDevice::State newState)
Устанавливает состояние устройства в newState. Реализации устройств Modbus должны использовать эту функцию для обновления состояния устройства.
См. также state().
State QModbusDevice::state() const
Возвращает текущее состояние устройства.
См. также setState() и stateChanged().
[signal] void QModbusDevice::stateChanged(QModbusDevice::State state)
Этот сигнал излучается каждый раз, когда состояние устройства изменяется. Новое состояние представлено state.
См. также setState() и state().
© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/archives/qt-5.6/qmodbusdevice.html
