CoreSerial¶

public interface CoreSerial¶: New in version AS: 1.21

Интерфейс последовательного устройства.

Methods¶

getConfig¶

String getConfig()¶

Возвращает JSON строку с конфигурацией подключения к устройству.

Returns:: JSON строка.

getListenerFactoryOperation¶

String getListenerFactoryOperation()¶

Возвращает имя операции-фабрики слушателей CoreSerialListener.

Операция может возвращать:

Экземпляр CoreSerialListener
Экземпляр класса, реализующего методы CoreSerialListener, но не являющегося прямым наследником интерфейса.
Экземпляр Wrapper, декорирующий экземпляр CoreSerialListener или экземпляр класса, реализующего методы CoreSerialListener, но не являющегося прямым наследником интерфейса.

Returns:: Имя операции

getState¶

String getState()¶

Возвращает код текущего состояния связи с последовательным устройством на клинете:

Closed - Связь не установлена. Устройство закрыто.
Opening - Выполняется ожидание открытия устройства.
Opened - Связь установлена. Устройство открыто.
Closing - Выполняется ожидание закрытия устройства.

Returns:: “Closed” | “Opening” | “Opened” | “Closing”.

isStarted¶

boolean isStarted()¶

Флаг указывает, что у объекта был вызван метод start() и не вызван stop(java.lang.Exception).

Returns:: true, если устройство запущено.

setConfig¶

void setConfig(String value)¶

Устанавливает строку конфигурации устройства.

Список возможных параметров JSON-строки конфигурации:

+----------+-------------------+-------------------------------------------------------------------------+--------------+---------------------+
| Поле     | Тип данных        | Описание                                                                | По умолчанию | Примечание          |
+----------+-------------------+-------------------------------------------------------------------------+--------------+---------------------+
| portname | строка            | Имя открываемого последовательного порта                                |              | Имя получается из   |
|          |                   |                                                                         |              | результата вызова   |
|          |                   |                                                                         |              | getComDevices()     |
+----------+-------------------+-------------------------------------------------------------------------+--------------+---------------------+
| baudrate | целое число       | Скорость передачи данных через последовательный порт                    | 9600         | Может отсутствовать |
+----------+-------------------+-------------------------------------------------------------------------+--------------+---------------------+
| databits | целое число       | Размер символа                                                          | 8            | Может отсутствовать |
|          |                   | Допустимые значения: 5, 6, 7 и 8                                        |              |                     |
+----------+-------------------+-------------------------------------------------------------------------+--------------+---------------------+
| parity   | строка            | Проверка четности                                                       | "no"         | Может отсутствовать |
|          |                   | Допустимые значения:                                                    |              |                     |
|          |                   | - "no" (NoParity), - отключает контроль четности                        |              |                     |
|          |                   | - "odd" (OddParity), - количество единичных битов должно быть нечетным  |              |                     |
|          |                   | - "even" (EventParity), - количество единичных битов должно быть четным |              |                     |
|          |                   | - "mark" (MarkParity), - бит четности всегда равен 1                    |              |                     |
|          |                   | - "space" (SpaceParity), - бит четности всегда равен 0                  |              |                     |
+----------+-------------------+-------------------------------------------------------------------------+--------------+---------------------+
| stopbits | строка            | Количество стоповых битов                                               | "1"          | Может отсутствовать |
|          |                   | Допустимые значения:                                                    |              |                     |
|          |                   | - "1" (OneStopBit), - 1 стоповый бит                                    |              |                     |
|          |                   | - "1.5" (OnePointFiveStopBits), - 1.5 стоповых бита                     |              |                     |
|          |                   | - "2" (TwoStopBits), - 2 стоповых бита                                  |              |                     |
+----------+-------------------+-------------------------------------------------------------------------+--------------+---------------------+
| rts      | логический        | Признак готовности к отправке (ReadyToSend)                             | true         | Может отсутствовать |
+----------+-------------------+-------------------------------------------------------------------------+--------------+---------------------+
| dtr      | логический        | Признак готовности терминала данных (DataTerminalReady)                 | true         | Может отсутствовать |
+----------+-------------------+-------------------------------------------------------------------------+--------------+---------------------+

Parameters:

value – JSON строка

Throws:

ApplicationException – Если выполняется установка значения в запущенном состоянии.

setListenerFactoryOperation¶

void setListenerFactoryOperation(String value)¶

Устанавливает имя операции-фабрики слушателей CoreSerialListener.

Parameters:

value – Имя операции

start¶

void start()¶

Метод открывает слушателя событий и последовательное устройство.

Throws:

ApplicationException –
- Не указана конфигурация.
- Не указано имя операции-фабрики.
- Устройство уже стартовало.
- Устройство уже открыто другой выборкой.

stop¶

void stop(Exception cause)¶

Метод закрывает последовательное устройство и слушателя событий.

Parameters:

cause – исключение или null