Режимы работы

SmartPipe имеет три режима работы (MODE):

• DEFAULT MODE - устройство работает как стандартный UART-COM1 адаптер. В этот режим устройство переходит когда список правил(Rules) пуст ;

Кофигурация:    MODE: DEFAULT   PIPES: UART1 <-> COM1    ITYPE: CHAR.

• STREAM MODE - устройство работает со списком правил и выполняет команды правил.В этот режим устройство переходит когда список правил(Rules) не пуст ;

Кофигурация:   MODE: STREAM   PIPES: конфигурируеться в правилах    ITYPE: конфигурируеться в правилах.

• COMMAND MODE - устройство работает в интерактивном режиме - передача данных в каналах обмена приостанавливаеться и заданный интерфейс подключаеться к командной оболочке (shell) устройства.

Кофигурация:   MODE: COMMAND   PIPES: отключенны    ITYPE: CHAR.

Конфигурация каналов

SmartPipe может работать с внешними устройствами через три последовательных порта:

• UART1 -  аппаратный Serial порт с тремя сигналми (RXD/TXD/GND) работающий по протоколу UART.
• COM1 -  виртуальный Serial порт работающий по протоколу USB.
• COM2 -  виртуальный Serial порт работающий по протоколу USB.

Для передачи и обработки данных эти порты могут быть "соединенны" между собой в каналы (pipes).

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

• Канал direct - передает необработанные данные между UART1 и COM1 портами.
• Канал test - передает и обрабатывает  данные между COM1 и COM2 портами, а также передает "эхо" в UART1 порте.
• Канал filter - передает и обрабатывает  данные между UART1 и COM1 портами, а также передает необработанные данные между UART1 и COM2 портами.

Тип входного потока

Поток данных, приходящих на входные порты SmartPipe, может обрабатываться в двух разных режимах (ITYPE) :

•  CHAR - режим посимвольного ввода, как только символ появляется на входе устройства он тут же пересылается по каналу на выход.

В этом режиме правила отключены. Режим удобен когда устройство работает как стандартный UART/USB адаптер.

•  LINE - режим построчного ввода, данные со входа устройства обрабатываются и передаются на выход только при получении символа "Подача строки" LF(0x0A).

В этом режиме правила включены и будут применяться к входящим строкам. Режим удобен когда устройство работает c логами от устройств и может фильтровать и обрабатывать их.

Перекючение между ITYPE режимами происходит нажатием комбинации клавиш CTRL-Q/CTRL-W/Enter.

Формат правила

Формат правила:

[Label ]:[Template];;[command value [value]]; [command value]; [command];

---

• Label - метка области действия правила;
• Template - шаблон  поиска строки (wildcard).Используються мета-символы:
  
  • * - символ замены любой строки символов;
  • ? - символ замены любого одиночного символа;
  • \ - символ "экранирования " для символов ';' | '*' | '?' | '@' | '\'
    
  • @ - символ пустой строки
• command - команда конфигурации или обработки найденной строки(см.закладку Команды правил );
• value - параметер для command ;

---

 Поведение SmirtPipe описываеться набором правил. Каждое правило состоит из полей: имя группы (Label); шаблона (Template) и списка команд. Каждая входная строка проверяеться на совпадение с полем шаблона из правил. При совпадении строки и шаблона, выполняеться список команд правила.

Все правила храняться в устройстве в виде списка. Список правил текущей группы выполняються последовательно с "головы" списка, при этом входная строка после обработки в одном правиле поступает в вход следующего.

Все правила в устройстве разбиты на группы. Проверка соответсвия текущей строки шаблону правила производиться только для текущей группы правил. Это позволяет уменьшить количество операций проверки для каждой строки лога. Текущая группа правил может быть установленна командой begin . Если в правиле номер группы не указан то считается, что правило относиться к группе 0.

Поле шаблона правила - это стандартная строка wildcard поиска c символами-джокерами:

• символом * - для замены любой строки символов (например: *find*);
• символом ? - для замены любого одиночного символа (например: find?);
• символом @ - для обозначения пустой строки
• символом \ - для экранирования других символов-джокеров {*?\;@} например: find\*) ;

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

Список команд (см.закладку Команды правил ) - это набор SmartPipe комманд, перечисленых через ';'.

Добавление правила в список.
Правило можно добавить в список с помощью следующих shell комманд (см.закладку Команды правил ) :

•     add rule - добавляет правило rule в вершину списока;
•     insert num rule - добавляет правило rule в num позицию списка;
•     up [-i=pos] rule - заменят правило на позиции pos в списке на правило rule , без параметра -i происходит замена правила на позиции 0;

Удаление правил из списока.
Правила можно удалить из списока с помощью следующих shell комманд (см.закладку Команды правил ) :

•     rm num - удаляет правило на позиции num в списке;
•     eraseall - удаляет все правила из списка;

Kоманды правил

Команды shell

Командная оболочка shell предназначенна для конфигурации устройства в режиме работы COMMAND MODE.

Для перехода из STREAM/DEFAULT MODE в COMMAND MODE  необходимо в терминальной программе, подключенной к интерфейсу, нажать последовательность клавиш "CTRL-Q/CTRL-S/Enter", после этого устройство переходит в COMMAND MODE и в терминале появиться строка приглашения ("sLog:").

Для обратного перехода из COMMAND MODE в STREAM/DEFAULT MODE необходимо вызвать shell команду exit.

Командная оболочка shell поддерживает следующие команды:

help [command]  - выводит описание shell команды , если команда вызвана без параметра выводит краткое описание всех shell команд;

ver - выводит номер версии устройства;

list [-f] -выводит список правил, при применении ключа -f список выводиться ввиде набора up команд;

rule num - выводит подробное описание правила c номером num из списка;

add rule - добавляет правило rule в вершину списока;

insert num rule - добавляет правило rule в num позицию списка;

up [-i=pos] rule - заменят правило на позиции pos в списке на правило rule , без параметра -i происходит замена правила на позиции 0;

rm num - удаляет правило на позиции num в списке;

eraseall - удаляет все правила из списка;

exit - переводит устройство в STREAM/DEFAULT MODE режим.